Struct conrod::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.

Methods

impl State

pub fn new() -> State

Returns a fresh new input state

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

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

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for State

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq for State

fn eq(&self, other: &State) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &State) -> bool

This method tests for !=.