Struct KeyboardState

Default state layout for keyboards.

Implements
Inherited Members
Namespace: UnityEngine.InputSystem.LowLevel
Assembly: Unity.InputSystem.dll
Syntax
public struct KeyboardState : IInputStateTypeInfo
Remarks

Can be used to update the state of Keyboard devices.

// Send input event with A key pressed on keyboard.
InputSystem.QueueStateEvent(Keyboard.current,
    new KeyboardState(Key.A));

Constructors

KeyboardState(params Key[])

Declaration
public KeyboardState(params Key[] pressedKeys)
Parameters
Type Name Description
Key[] pressedKeys
See Also

Fields

keys

Declaration
public byte* keys
Field Value
Type Description
byte*
See Also

Properties

Format

Memory format tag for KeybboardState.

Declaration
public static FourCC Format { get; }
Property Value
Type Description
FourCC

Returns "KEYS".
See Also

format

Declaration
public FourCC format { get; }
Property Value
Type Description
FourCC
See Also

Methods

Press(Key)

Declaration
public void Press(Key key)
Parameters
Type Name Description
Key key
See Also

Release(Key)

Declaration
public void Release(Key key)
Parameters
Type Name Description
Key key
See Also

Set(Key, bool)

Declaration
public void Set(Key key, bool state)
Parameters
Type Name Description
Key key
bool state
See Also

Implements

See Also