Struct Keymap

pub struct Keymap<I: Index<usize, Output = R>, R, Ctx, Ev: Debug, PKS, KS, S> { /* private fields */ }

State for a keymap that handles input, and outputs HID keyboard reports.

Implementations

impl<I: Debug + Index<usize, Output = R>, R: Copy + Debug, Ctx: Debug + Context<Event = Ev> + SetKeymapContext, Ev: Copy + Debug, PKS: Debug, KS, S: System<R, Ref = R, Context = Ctx, Event = Ev, PendingKeyState = PKS, KeyState = KS>> Keymap<I, R, Ctx, Ev, PKS, KS, S>

where KS: From<NoOpKeyState> + Copy + Debug,

pub const fn new(key_refs: I, context: Ctx, key_system: S) -> Self

Constructs a new keymap with the given key definitions and context.

pub fn init(&mut self)

Initializes or resets the keyboard to an initial state.

pub fn set_callback(&mut self, callback_id: KeymapCallback, callback_fn: fn())

Registers the given callback to the keymap.

Only one callback is set for each callback id.

pub fn set_callback_extern( &mut self, callback_id: KeymapCallback, callback_fn: extern "C" fn(), )

Registers the given callback to the keymap.

Only one callback is set for each callback id.

pub fn set_ms_per_tick(&mut self, ms_per_tick: u8)

Sets the number of ms per tick().

pub fn handle_input(&mut self, ev: Event)

Handles input events.

pub fn tick(&mut self)

Advances the state of the keymap by one tick.

pub fn pressed_keys(&self) -> Vec<KeyOutput, { MAX_PRESSED_KEYS }>

Returns the the pressed key outputs.

pub fn report_output(&mut self) -> KeymapOutput

Updates the keymap indicating a report is sent; returns the reportable keymap output.

Trait Implementations

impl<I: Debug + Index<usize, Output = R>, R: Debug, Ctx: Debug, Ev: Debug, PKS: Debug, KS: Debug, S: System<R, Ref = R, Context = Ctx, Event = Ev, PendingKeyState = PKS, KeyState = KS>> Debug for Keymap<I, R, Ctx, Ev, PKS, KS, S>

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

Formats the value using the given formatter.