Struct three::Input

pub struct Input { /* fields omitted */ }

Controls user and system input from keyboard, mouse and system clock.

Methods

impl Input

pub fn reset(&mut self)

Manually reset current Input state.

Usually there is no need in using this method, because Window resets Input on each update method by default.

It will discard all mouse or raw axes movements and also all keyboard hits. Moreover, delta time will be recalculated.

pub fn delta_time(&self) -> f32

Get current delta time (time since previous frame) in seconds.

Important traits for &'a mut [u8]

impl<'a> Write for &'a mut [u8]impl<'a> Read for &'a [u8]

pub fn keys_hit(&self) -> &[Key]

Get list of all keys hit since the last frame.

pub fn mouse_pos(&self) -> Point2<f32>

Get current mouse pointer position in pixels from top-left.

pub fn mouse_pos_ndc(&self) -> Point2<f32>

Get current mouse pointer position in Normalized Display Coordinates. See map_to_ndc.

Important traits for &'a mut [u8]

impl<'a> Write for &'a mut [u8]impl<'a> Read for &'a [u8]

pub fn mouse_wheel_movements(&self) -> &[f32]

Get list of all mouse wheel movements since last frame.

pub fn mouse_wheel(&self) -> f32

Get summarized mouse wheel movement (the sum of all movements since last frame).

Important traits for &'a mut [u8]

impl<'a> Write for &'a mut [u8]impl<'a> Read for &'a [u8]

pub fn mouse_movements(&self) -> &[Vector2<f32>]

Get list of all mouse movements since last frame in pixels.

Important traits for &'a mut [u8]

impl<'a> Write for &'a mut [u8]impl<'a> Read for &'a [u8]

pub fn mouse_movements_ndc(&self) -> &[Vector2<f32>]

Get list of all mouse movements since last frame in NDC.

Important traits for &'a mut [u8]

impl<'a> Write for &'a mut [u8]impl<'a> Read for &'a [u8]

pub fn axes_movements(&self) -> &[(u8, f32)]

Get list of all raw inputs since last frame.

pub fn mouse_delta(&self) -> Vector2<f32>

Get summarized mouse movements (the sum of all movements since last frame) in pixels.

pub fn mouse_delta_ndc(&self) -> Vector2<f32>

Get summarized mouse movements (the sum of all movements since last frame) in NDC.

pub fn mouse_delta_raw(&self) -> Vector2<f32>

Get summarized raw input along 0 and 1 axes since last frame. It usually corresponds to mouse movements.

pub fn is_focused(&self) -> bool

Return whether Window is in focus or not.

pub fn hit<H: Hit>(&self, hit: H) -> bool

Returns true there is any input info from Button, axis::Key or axis::Raw. Otherwise returns false.

pub fn delta<D: Delta>(&self, delta: D) -> <D as Delta>::Output

Returns the change ('delta') in input state since the last call to Window::update.

This value depends on the type of input device is given.

axis::Key

• None when no updates to the axis are received.
• Some(1) when only positive input to the axis is received.
• Some(-1) when only negative input to the axis is received.
• Some(0) when both positive and negative input to the axis is received.

axis::Raw

• None when no updates to the axis are received and
• Some(x) where x is the sum of positive and negative inputs otherwise.

pub fn timed<D: Delta>(&self, delta: D) -> Option<f32>

Shortcut for delta * delta_time.

pub fn hit_count<C: HitCount>(&self, hit_count: C) -> <C as HitCount>::Output

Returns the amount of:

• Hits for Button as u8.

• Hits for axis::Key as (u8, u8) where first number is for positive direction and the second one is for negative.

Trait Implementations