Struct Input

pub struct Input(/* private fields */);

This structure is used by send_inputs to store information for synthesizing input events such as keystrokes, mouse movement, and mouse clicks.

Example

use winput::{Input, Action};

let input = Input::from_char('A', Action::Press);
winput::send_inputs(&[input]);

Implementations

impl Input

pub fn from_char(c: char, action: Action) -> Option<Input>

Creates an Input that causes the given action to be taken on the given character. If the given character is above 0x0000ffff, None is returned.

Example

use winput::{Input, Action};

let input = Input::from_char('A', Action::Press).unwrap();
winput::send_inputs(&[input]);

pub fn from_vk(vk: Vk, action: Action) -> Input

Creates an Input that causes the given action to be taken on the given Virtual-Key Code.

Example

use winput::{Input, Action, Vk};

let input = Input::from_vk(Vk::Enter, Action::Press);
winput::send_inputs(&[input]);

pub fn from_button(button: Button, action: Action) -> Input

Creates an Input that causes the given action to be taken on the given mouse button.

Example

use winput::{Button, Action, Input};

let input = Input::from_button(Button::Left, Action::Press);
winput::send_inputs(&[input]);

pub fn from_motion(motion: MouseMotion) -> Self

Creates an Input that causes the mouse to move according to the given MouseMotion.

Example

use winput::{MouseMotion, Input};

let motion = MouseMotion::Relative {
    dx: 100, // 100 pixels right
    dy: 50, // 50 pixels down
};

let input = Input::from_motion(motion);

winput::send_inputs(&[input]);

pub fn from_wheel(motion: f32, direction: WheelDirection) -> Self

Creates an Input that causes the mouse wheel to rotate by the given amount and in the given WheelDirection.

When the given direction is vertical, a positive motion means the wheel rotates forward, away from the user; a negative value means the wheel rotates backward, toward the user.

When the given direction is horizontal, a positive motion means the wheel rotates to the right; a negative value means the wheel rotates to the left.

Example

use winput::{WheelDirection, Input};

let input = Input::from_wheel(100.0, WheelDirection::Vertical);
winput::send_inputs(&[input]);

Trait Implementations

impl Clone for Input

fn clone(&self) -> Input

Returns a duplicate of the value.

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

Performs copy-assignment from source.