Struct rusty_engine::mouse::MouseState

pub struct MouseState { /* private fields */ }

MouseState represents the end-state of the mouse during the last frame. This should be used for “real time” processing of most input (except mousewheel scrolling), where you only care about the final state of buttons or mouse position for your logic.

If you need to process all mouse events that occurred during a single frame, use the mouse_button_events, mouse_location_events, mouse_motion_events, or mouse_wheel_events fields on Engine.

Implementations

impl MouseState

pub fn location(&self) -> Option<Vec2>

Final location of the mouse this frame. If you want to process all the locations the mouse was at during this frame, see Engine::mouse_location_events instead.

pub fn motion(&self) -> Vec2

The cumulative relative motion of the mouse this frame. If you want to process all the individual relative motions, see `Engine::mouse_motion_events instead.

pub fn wheel(&self) -> MouseWheelState

Returns a MouseWheelState], which is a simplified version of cumulative mouse wheel events. When dealing with mouse wheel movement, you _usually_ don't want this...you want [Engine::mouse_wheel_events` instead.

pub fn pressed(&self, mouse_button: MouseButton) -> bool

Returns true if the mouse button was pressed

pub fn just_pressed(&self, mouse_button: MouseButton) -> bool

Returns true if the mouse button started being pressed during the last frame

pub fn just_released(&self, mouse_button: MouseButton) -> bool

Returns true if the mouse button started being released during the last frame

pub fn pressed_any(&self, mouse_buttons: &[MouseButton]) -> bool

Returns true if any of the indicated mouse buttons were pressed

pub fn just_pressed_any(&self, mouse_buttons: &[MouseButton]) -> bool

Returns true if any of the indicated mouse buttons were just pressed this frame

pub fn just_released_any(&self, mouse_buttons: &[MouseButton]) -> bool

Returns true if any of the indicated mouse buttons were just released this frame

pub fn chain(&self) -> MouseStateChain

Trait Implementations

impl Clone for MouseState

fn clone(&self) -> MouseState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MouseState

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

Formats the value using the given formatter.

impl Default for MouseState

fn default() -> MouseState

Returns the “default value” for a type.

impl Resource for MouseState

where Self: Send + Sync + 'static,