Struct StateEvent

A complete state snapshot for an entire input device.

Inherited Members
Namespace: UnityEngine.InputSystem.LowLevel
Syntax
public struct StateEvent : IInputEventTypeInfo
Remarks

This is a variable-sized event.

Fields

baseEvent

Declaration
public InputEvent baseEvent
Field Value
Type Description
InputEvent

stateFormat

Type code for the state stored in the event.

Declaration
public FourCC stateFormat
Field Value
Type Description
FourCC

Type

Declaration
public const int Type = 1398030676
Field Value
Type Description
Int32

Properties

state

Declaration
public void *state { get; }
Property Value
Type Description
Void*

stateSizeInBytes

Declaration
public uint stateSizeInBytes { get; }
Property Value
Type Description
UInt32

typeStatic

Declaration
public FourCC typeStatic { get; }
Property Value
Type Description
FourCC
Implements

Methods

From(InputDevice, out InputEventPtr, Allocator)

Read the current state of device and create a state event from it.

Declaration
public static NativeArray<byte> From(InputDevice device, out InputEventPtr eventPtr, Allocator allocator = Allocator.Temp)
Parameters
Type Name Description
InputDevice device

Device to grab the state from. Must be a device that has been added to the system.
InputEventPtr eventPtr

Receives a pointer to the newly created state event.
Allocator allocator

Which native allocator to allocate memory for the event from. By default, the buffer is allocated as temporary memory (Temp. Note that this means the buffer will not be valid past the current frame. Use Persistent if the buffer for the state event is meant to persist for longer.
Returns
Type Description
NativeArray<Byte>

Buffer of unmanaged memory allocated for the event.
Exceptions
Type Condition
ArgumentException

device has not been added to the system.
ArgumentNullException

device is null.

From(InputEventPtr)

Declaration
public static StateEvent*From(InputEventPtr ptr)
Parameters
Type Name Description
InputEventPtr ptr
Returns
Type Description
StateEvent*

GetEventSizeWithPayload<TState>()

Declaration
public static int GetEventSizeWithPayload<TState>()
    where TState : struct
Returns
Type Description
Int32
Type Parameters
Name Description
TState

ToEventPtr()

Declaration
public InputEventPtr ToEventPtr()
Returns
Type Description
InputEventPtr

Did you find this page useful? Please give it a rating: