Gondwana.Input.Keyboard.IKeyboardAdapter Interface Reference

Represents an adapter for keyboard input, providing access to the currently pressed keys and active modifier states. More...

Inheritance diagram for Gondwana.Input.Keyboard.IKeyboardAdapter:

Public Member Functions
bool	IsDown (int keyCode)
	Returns true if the specified platform-agnostic key code is currently down. Key codes should be stable integers agreed upon by the adapter and the engine. For WinForms, this should be the Windows Virtual-Key code (0..255).

Properties
KeyboardModifierState	CurrentKeyboardModifiers [get]
	Gets the current state of modifier keys, such as Shift, Ctrl, and Alt. Must be safe to read from the Engine thread at high frequency.

Detailed Description

Represents an adapter for keyboard input, providing access to the currently pressed keys and active modifier states.

This interface is designed to abstract keyboard input handling, allowing retrieval of pressed keys and modifier states. The implementation of the interface is responsible for keyboard polling, etc.

Definition at line 8 of file IKeyboardAdapter.cs.

Member Function Documentation

IsDown()

bool Gondwana.Input.Keyboard.IKeyboardAdapter.IsDown

(

int

keyCode

)

Returns true if the specified platform-agnostic key code is currently down. Key codes should be stable integers agreed upon by the adapter and the engine. For WinForms, this should be the Windows Virtual-Key code (0..255).

Parameters

keyCode

The key code to query.

Returns

true if the key is currently pressed; otherwise, false.

Implemented in Gondwana.Avalonia.Input.Keyboard.AvaloniaKeyboardAdapter, Gondwana.Blazor.Input.Keyboard.BlazorKeyboardAdapter, and Gondwana.WinForms.Input.Keyboard.WinFormsKeyboardAdapter.

Property Documentation

CurrentKeyboardModifiers

KeyboardModifierState Gondwana.Input.Keyboard.IKeyboardAdapter.CurrentKeyboardModifiers

get

Gets the current state of modifier keys, such as Shift, Ctrl, and Alt. Must be safe to read from the Engine thread at high frequency.

Implemented in Gondwana.Avalonia.Input.Keyboard.AvaloniaKeyboardAdapter, Gondwana.Blazor.Input.Keyboard.BlazorKeyboardAdapter, and Gondwana.WinForms.Input.Keyboard.WinFormsKeyboardAdapter.

Definition at line 23 of file IKeyboardAdapter.cs.