Struct Keyboard

pub struct Keyboard<Key, Mods>
where
    Key: Copy + PartialEq,
    Mods: Copy + Default,
{ /* private fields */ }

A structure representing the current state of a keyboard.

Implementations

impl<Key, Mods> Keyboard<Key, Mods>

where Key: Copy + PartialEq, Mods: Copy + Default,

pub fn new() -> Self

Trait Implementations

impl<Key, Mods> Clone for Keyboard<Key, Mods>

where Key: Copy + PartialEq + Clone, Mods: Copy + Default + Clone,

fn clone(&self) -> Keyboard<Key, Mods>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Key, Mods> Debug for Keyboard<Key, Mods>

where Key: Copy + PartialEq + Debug, Mods: Copy + Default + Debug,

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

Formats the value using the given formatter.

impl<Key, Mods> Default for Keyboard<Key, Mods>

where Key: Copy + PartialEq, Mods: Copy + Default,

fn default() -> Self

Returns the “default value” for a type.

impl<T> Event<Keyboard<KeyCode, Modifiers>> for Event<T>

fn handle(&self, keyboard: &mut WinitKeyboard)

Modify the state of the provided handler (for example, a Mouse or Keyboard).

impl<K, M> KeyboardInterface for Keyboard<K, M>

where K: Copy + PartialEq, M: Copy + Default,

type Key = K

A type representing a key on a keyboard.

type Mods = M

A type representing the current state of modifier keys.

fn modifiers(&self) -> Self::Mods

Returns the current state of the modifier keys.

fn down(&self, key: Self::Key) -> bool

Returns true if the given key is currently held down.

fn pressed(&self, key: Self::Key) -> bool

Returns true if the given key was pressed this frame.

fn released(&self, key: Self::Key) -> bool

Returns true if the given key was released this frame.

fn text(&self) -> &str

Returns any text that has been entered.

fn clear_presses(&mut self) -> &mut Self

Clears the pressed state of held buttons. Should be called at end of frame.

fn press(&mut self, key: Self::Key) -> &mut Self

Register that a key was pressed down.

fn release(&mut self, key: Self::Key) -> &mut Self

Register that a key was released.

fn set_modifiers(&mut self, modifiers: Self::Mods) -> &mut Self

Register that the current state of the modifier keys has changed.

fn receive_text<S: AsRef<str>>(&mut self, text: S) -> &mut Self

Register that some text was input.

fn receive_char(&mut self, ch: char) -> &mut Self

Register that a character of text was input.

fn handle_event<E: Event<Self>>(&mut self, event: &E) -> &mut Self

Convenience method for handling events. The type of event, E, will vary depending on the windowing library being used.