Struct Mouse 

pub struct Mouse { /* private fields */ }

Provides access to mouse input from all mice on the system.

This type coalesces input from all connected mice into a single interface. It provides access to:

• Mouse position within windows
• Button states (left, right, middle, and others)
• Accumulated scroll deltas

Examples

use app_window::input::mouse::{Mouse, MOUSE_BUTTON_LEFT};

let mouse = Mouse::coalesced().await;

// Check if left button is pressed
if mouse.button_state(MOUSE_BUTTON_LEFT) {
    println!("Left button is pressed");
}

// Get mouse position
if let Some(pos) = mouse.window_pos() {
    println!("Mouse at ({}, {})", pos.pos_x(), pos.pos_y());
}

Platform-specific behavior

On some platforms you must create a window before you can get mouse input.

Implementations

impl Mouse

pub async fn coalesced() -> Self

Creates a new Mouse instance that coalesces input from all mice on the system.

This is the primary way to create a Mouse instance. The returned object will aggregate input from all connected mice.

Examples

use app_window::input::mouse::Mouse;

let mouse = Mouse::coalesced().await;
// Now you can query mouse state

pub fn window_pos(&self) -> Option<MouseWindowLocation>

Returns the MouseWindowLocation

Platform specifics

You may need to create a window first, using APIs in this crate.

pub fn button_state(&self, button: u8) -> bool

Determines if the specified mouse button is currently pressed.

Arguments

• button - The button to check. Use constants like MOUSE_BUTTON_LEFT, MOUSE_BUTTON_RIGHT, or MOUSE_BUTTON_MIDDLE. Other button values (e.g., for mice with additional buttons) may be supported on a best-effort basis.

Returns

true if the button is currently pressed, false otherwise.

Examples

use app_window::input::mouse::{Mouse, MOUSE_BUTTON_LEFT, MOUSE_BUTTON_RIGHT};

let mouse = Mouse::coalesced().await;

if mouse.button_state(MOUSE_BUTTON_LEFT) {
    println!("Left button is pressed");
}

if mouse.button_state(MOUSE_BUTTON_RIGHT) {
    println!("Right button is pressed");
}

pub fn load_clear_scroll_delta(&mut self) -> (f64, f64)

Returns the accumulated scroll delta and resets it to zero.

This method is useful for implementing scroll handling in your application. The scroll delta accumulates between calls, so you should call this periodically (e.g., once per frame) to process scroll events.

Returns

A tuple (delta_x, delta_y) containing the horizontal and vertical scroll amounts since the last call to this method.

Examples

use app_window::input::mouse::Mouse;

let mut mouse = Mouse::coalesced().await;

// In your update loop:
let (scroll_x, scroll_y) = mouse.load_clear_scroll_delta();
if scroll_y != 0.0 {
    println!("Scrolled vertically by {}", scroll_y);
}

Trait Implementations

impl Debug for Mouse

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

Formats the value using the given formatter.

impl Eq for Mouse

impl Hash for Mouse

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Mouse

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

Equality operator ==.

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

Inequality operator !=.