[−][src]Struct conrod_core::input::state::mouse::ButtonMap

pub struct ButtonMap { /* fields omitted */ }
[−]

Stores the state of all mouse buttons.

If the mouse button is down, it stores the position of the mouse when the button was pressed

Implementations

impl ButtonMap[src][−]

pub fn new() -> Self[src][−]

Returns a new button map with all states set to None

pub fn relative_to(self, xy: Point) -> Self[src][−]

Returns a copy of the ButtonMap relative to the given Point

pub fn left(&self) -> &ButtonPosition[src][−]

The state of the left mouse button.

pub fn middle(&self) -> &ButtonPosition[src][−]

The state of the middle mouse button.

pub fn right(&self) -> &ButtonPosition[src][−]

The state of the right mouse button.

pub fn press(&mut self, button: Button, xy: Point, widget: Option<Id>)[src][−]

Sets the Button in the Down position.

pub fn release(&mut self, button: Button)[src][−]

Set's the Button in the Up position.

pub fn pressed(&self) -> PressedButtons<'_>ⓘ

Notable traits for PressedButtons<'a>

impl<'a> Iterator for PressedButtons<'a> type Item = (Button, Point, Option<Id>);
[src][−]

An iterator yielding all pressed mouse buttons along with the location at which they were originally pressed.

Trait Implementations

impl Clone for ButtonMap[src][+]

impl Copy for ButtonMap[src]

impl Debug for ButtonMap[src][+]

impl Index<MouseButton> for ButtonMap[src][+]

type Output = ButtonPosition

The returned type after indexing.

impl PartialEq<ButtonMap> for ButtonMap[src][+]

impl StructuralPartialEq for ButtonMap[src]

Auto Trait Implementations

impl RefUnwindSafe for ButtonMap

impl Send for ButtonMap

impl Sync for ButtonMap

impl Unpin for ButtonMap

impl UnwindSafe for ButtonMap

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src][+]

impl<T> Borrow<T> for T where
    T: ?Sized, [src][+]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src][+]

impl<T> From<T> for T[src][+]

impl<T, U> Into<U> for T where
    U: From<T>, [src][+]

impl<T> Style for T where
    T: Any + Debug + PartialEq<T>, [src]

impl<T> ToOwned for T where
    T: Clone, [src][+]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src][+]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src][+]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.