Struct keeshond::input::Input

pub struct Input { /* private fields */ }

Manages player input bindings and allows reading key/button presses and axes

Implementations

impl Input

pub fn add_action(&mut self, name: &str)

Creates a new input action with the given name.

pub fn add_bind(&mut self, name: &str, key: &str)

Adds an input binding to the given action. If the action doesn’t exist, it will be created. See the module-level documentation for a list of key names.

pub fn clear_binds(&mut self, name: &str)

Removes all the bindings from the given action.

pub fn deadzone(&self, composite_axis: &str) -> Option<f64>

Gets the deadzone for the given composite axis. See the module-level documentation for a list of composite axis names.

pub fn set_deadzone(&mut self, composite_axis: &str, deadzone: f64) -> bool

Sets the deadzone for the given composite axis. See the module-level documentation for a list of composite axis names.

pub fn down_once(&self, name: &str) -> bool

Returns true if the given action was pressed this frame

pub fn up_once(&self, name: &str) -> bool

Returns true if the given action was released this frame

pub fn held(&self, name: &str) -> bool

Returns true if the given action is currently being held

pub fn time_held(&self, name: &str) -> u64

Returns the number of frames that the given action was held for, or 0 if it is not held.

pub fn time_released(&self, name: &str) -> u64

Returns the number of frames that the given action was released for, or 0 if it is not released.

pub fn axis(&self, name: &str) -> f64

Returns the current value between 0.0 and 1.0 for the axis associated with the given action. This will only return the value of an individual positive/negative component. If you want a combined positive/negative range, see Input::paired_axis().

pub fn paired_axis(&self, name_neg: &str, name_pos: &str) -> f64

Returns the current value between -1.0 and 1.0 for the negative and positive part associated with the negative and positive actions, respectively.

pub fn paired_axis_2d(
    &self,
    name_left: &str,
    name_right: &str,
    name_up: &str,
    name_down: &str
) -> (f64, f64)

Returns the current values between -1.0 and 1.0 for the 2D axis given four actions representing each cardinal direction. The distance is capped at a Euclidean distance value of 1.0 to avoid overly large diagonal values for sticks with square gates.

pub fn angle_and_distance(
    &self,
    name_left: &str,
    name_right: &str,
    name_up: &str,
    name_down: &str
) -> (f64, f64)

Returns the current angle and distance for the 2D axis given four actions representing each cardinal direction. The distance is capped at a Euclidean distance value of 1.0 to avoid overly large diagonal values for sticks with square gates.

pub fn four_way_direction(
    &self,
    name_left: &str,
    name_right: &str,
    name_up: &str,
    name_down: &str
) -> Option<InputDirection4>

Returns the currently pressed four-way direction given four actions representing each cardinal direction. If no direction is held, or the 2D axis is too close to a diagonal, returns None.

pub fn eight_way_direction(
    &self,
    name_left: &str,
    name_right: &str,
    name_up: &str,
    name_down: &str
) -> Option<InputDirection8>

Returns the currently pressed eight-way direction given four actions representing each cardinal direction. If no direction is held, returns None.

pub fn cursor_position(&self) -> (f64, f64)

Returns the current mouse cursor position in game screen coordinates. These are not raw window coordinates. For example, if you have a game at 320x224 and the window is scaled to 640x448, then placing your cursor in the bottom right of the window’s client area will return a position close to (320, 224).

pub fn cursor_motion(&self) -> (f64, f64)

Returns the amount that the mouse moved this logic frame. This is not guaranteed to match 1-to-1 with the values returned from Input::cursor_position(). With the cursor unlocked, the motion may not match with the reported position if the window is a different size from the game’s base size. With the cursor locked, the motion is taken from raw mouse input if available, so it most likely will not match with the reported position even if the values are scaled up or down.

pub fn cursor_visible(&self) -> bool

Returns true if the mouse cursor is displayed when it is over the game window.

pub fn set_cursor_visible(&mut self, visible: bool)

Sets whether the mouse cursor is displayed when it is over the game window.

pub fn cursor_locked(&self) -> bool

Returns true if the mouse cursor is currently locked.

pub fn set_cursor_locked(&mut self, locked: bool)

Sets whether the mouse cursor is locked. When locked, the cursor will be trapped inside the window, and Input::cursor_motion() will report raw mouse motion if available.