Struct screen_13::input::KeyBuf

pub struct KeyBuf { /* private fields */ }

A container for Window-based keyboard input events.

NOTE: Keys pressed and released during a single update (is that possible, really?) will show as both released and pressed.

Implementations

impl KeyBuf

pub fn any_held(&self) -> bool

Returns true if any keys have been pressed for multiple frames.

pub fn any_pressed(&self) -> bool

Returns true if any keys have been pressed since the last frame.

pub fn any_released(&self) -> bool

Returns true if any keys have been released since the last frame.

pub fn chars(&self) -> impl Iterator<Item = char> + '_

Returns an iterator of characters typed since the last frame.

pub fn update(&mut self)

Call this before handling events.

pub fn handle_event(&mut self, event: &Event<()>) -> bool

Handles a single event.

pub fn is_down(&self, key: KeyCode) -> bool

Returns true if the given key has been pressed since the last frame or held for multiple frames.

pub fn is_held(&self, key: KeyCode) -> bool

Returns true if the given key has been pressed for multiple frames.

pub fn is_pressed(&self, key: KeyCode) -> bool

Returns true if the given key has been pressed since the last frame.

pub fn is_released(&self, key: KeyCode) -> bool

Returns true if the given key has been released since the last frame.

pub fn held(&self) -> impl Iterator<Item = KeyCode> + '_

Returns an iterator of keys pressed for multiple frames.

pub fn pressed(&self) -> impl Iterator<Item = KeyCode> + '_

Returns an iterator of keys pressed since the last frame.

pub fn released(&self) -> impl Iterator<Item = KeyCode> + '_

Returns an iterator of keys released since the last frame.

Trait Implementations

impl Clone for KeyBuf

fn clone(&self) -> KeyBuf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyBuf

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

Formats the value using the given formatter.

impl Default for KeyBuf

fn default() -> KeyBuf

Returns the “default value” for a type.