Skip to main content

InputSnapshot

Struct InputSnapshot 

Source
pub struct InputSnapshot { /* private fields */ }
Expand description

Held controls and transitions accumulated for one game frame.

Implementations§

Source§

impl InputSnapshot

Source

pub const fn focused(&self) -> bool

Returns whether the application window currently has keyboard focus.

Source

pub const fn modifiers(&self) -> Modifiers

Returns the latest aggregate modifier state.

Source

pub const fn pointer_position(&self) -> Option<LogicalPosition>

Returns the latest known pointer position in logical window coordinates.

Source

pub fn key_held(&self, key: KeyCode) -> bool

Returns whether key is currently held.

Source

pub fn key_pressed(&self, key: KeyCode) -> bool

Returns whether key became pressed during the current frame.

Source

pub fn key_released(&self, key: KeyCode) -> bool

Returns whether key became released during the current frame.

Source

pub fn pointer_button_held(&self, button: PointerButton) -> bool

Returns whether button is currently held.

Source

pub fn pointer_button_pressed(&self, button: PointerButton) -> bool

Returns whether button became pressed during the current frame.

Source

pub fn pointer_button_released(&self, button: PointerButton) -> bool

Returns whether button became released during the current frame.

Source

pub fn scroll(&self) -> &[ScrollSample]

Returns the ordered scroll transitions accumulated during the current frame.

Trait Implementations§

Source§

impl Debug for InputSnapshot

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for InputSnapshot

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.