[][src]Struct conrod_core::input::state::State

pub struct State {
    pub mouse: Mouse,
    pub touch: FnvHashMap<Id, Touch>,
    pub widget_capturing_keyboard: Option<Id>,
    pub widget_capturing_mouse: Option<Id>,
    pub widget_under_mouse: Option<Id>,
    pub modifiers: ModifierKey,
}

Holds the current state of user input.

This includes the state of all buttons on the keyboard and mouse, as well as the position of the mouse.

It also includes which widgets, if any, are capturing keyboard and mouse input.

Fields

mouse: Mouse

Mouse position and button state.

touch: FnvHashMap<Id, Touch>

All in-progress touch interactions.

widget_capturing_keyboard: Option<Id>

Which widget, if any, is currently capturing the keyboard

widget_capturing_mouse: Option<Id>

Which widget, if any, is currently capturing the mouse

widget_under_mouse: Option<Id>

The widget that is currently under the mouse cursor.

If the mouse is currently over multiple widgets, this index will represent the top-most, non-graphic-child widget.

modifiers: ModifierKey

Which modifier keys are being held down.

Implementations

impl State[src]

pub fn new() -> State[src]

Returns a fresh new input state

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

Returns a copy of the input::State relative to the given position::Point

Trait Implementations

impl Clone for State[src]

impl Debug for State[src]

impl PartialEq<State> for State[src]

impl StructuralPartialEq for State[src]

Auto Trait Implementations

impl RefUnwindSafe for State

impl Send for State

impl Sync for State

impl Unpin for State

impl UnwindSafe for State

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.