Struct ambient_api::prelude::input::Input

pub struct Input {
    pub keys: HashSet<KeyCode>,
    pub mouse_position: Vec2,
    pub mouse_delta: Vec2,
    pub mouse_wheel: f32,
    pub mouse_buttons: HashSet<MouseButton>,
}

The state of a player’s raw input. Get these with get or get_previous.

Fields

keys: HashSet<KeyCode>

All of the keys being pressed this frame.

mouse_position: Vec2

The current position of the mouse.

mouse_delta: Vec2

The movement of the mouse since the last frame. Note that this is not affected by cursor locking, unlike Self::mouse_position.

Use this for any kind of movement that should be relative to the mouse’s position, such as camera rotation.

mouse_wheel: f32

The current scroll position.

mouse_buttons: HashSet<MouseButton>

All of the mouse buttons being pressed this frame.

Implementations

impl Input

pub fn delta(&self, previous: &Input) -> InputDelta

Returns whether or not each input has changed from previous to this Input.

Trait Implementations

impl Clone for Input

fn clone(&self) -> Input

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Input

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

Formats the value using the given formatter.

impl PartialEq for Input

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Input