Struct winput::Mouse

pub struct Mouse;

A zero-sized structure that wraps functions related to the mouse.

Implementations

impl Mouse

pub fn position() -> Result<(i32, i32), WindowsError>

Retrieve the current position of the mouse, in screen coordinates.

Example

use winput::Mouse;

println!("The mouse is at {:?}", Mouse::position());

pub fn set_position(x: i32, y: i32) -> Result<(), WindowsError>

Sets the position of the mouse, in screen coordinates.

Example

use winput::{Vk, Mouse};

Mouse::set_position(50, 50).unwrap();

pub fn scroll(amount: f32)

Synthesizes a vertical scroll event.

If the function fails to synthesize the input, no error is emited and the function fails silently. If you wish to retreive an eventual error, use send_inputs instead.

Example

use winput::Mouse;

Mouse::scroll(1.0).unwrap();

pub fn scrollh(amount: f32)

Synthesizes a horizontal scroll event.

If the function fails to synthesize the input, no error is emited and the function fails silently. If you wish to retreive an eventual error, use send_inputs instead.

Example

use winput::Mouse;

Mouse::scrollh(1.0).unwrap();

pub fn move_relative(dx: i32, dy: i32)

Moves the mouse relatively to its current position, in screen coordinates.

If the function fails to synthesize the input, no error is emited and the function fails silently. If you wish to retreive an eventual error, use send_inputs instead.

Example

use winput::Mouse;

Mouse::move_relative(100, 50).unwrap();

pub fn move_absolute(x: f32, y: f32)

Moves the mouse using absolute normalized coordinates.

If the function fails to synthesize the input, no error is emited and the function fails silently. If you wish to retreive an eventual error, use send_inputs instead.

Example

use winput::Mouse;

// Move the mouse in the center of the main monitor.
Mouse::move_absolute(0.5, 0.5).unwrap();