Struct buttons::Keyboard

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

A structure representing the current state of a keyboard.

Methods

impl<Key, Mods> Keyboard<Key, Mods> where
    Key: Copy + PartialEq,
    Mods: Copy + Default, 

pub fn new() -> Self

pub fn modifiers(&self) -> Mods

Returns the current state of the modifier keys.

pub fn begin_frame_input(&mut self) -> KeyboardInput<Key, Mods>

Returns a KeyboardInput structure that can be used to register changes to the state of the keyboard.

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

Returns true if the given key is currently held down.

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

Returns true if the given key was pressed this frame.

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

Returns true if the given key was released this frame.

Trait Implementations

impl<Key: Clone, Mods: Clone> Clone for Keyboard<Key, Mods> where
    Key: Copy + PartialEq,
    Mods: Copy + Default, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Key: Debug, Mods: Debug> Debug for Keyboard<Key, Mods> where
    Key: Copy + PartialEq,
    Mods: Copy + Default, 

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.