Struct InputEventPtr

Pointer to an InputEvent. Makes it easier to work with InputEvents and hides the unsafe operations necessary to work with them.

Namespace: UnityEngine.InputSystem.LowLevel
Syntax
public struct InputEventPtr : IEquatable<InputEventPtr>
Remarks

Note that event pointers generally refer to event buffers that are continually reused. This means that event pointers should not be held on to. Instead, to hold onto event data, manually copy an event to a buffer.

Constructors

InputEventPtr(InputEvent*)

Initialize the pointer to refer to the given event.

Declaration
public InputEventPtr(InputEvent*eventPtr)
Parameters
Type Name Description
InputEvent* eventPtr

Pointer to an event. Can be null.

Properties

data

Declaration
public readonly InputEvent*data { get; }
Property Value
Type Description
InputEvent*

deviceId

Declaration
public int deviceId { get; set; }
Property Value
Type Description
Int32

handled

Whether the event is considered "handled" and should not be processed further.

Declaration
public bool handled { get; set; }
Property Value
Type Description
Boolean
Remarks

This is used in two ways. Setting it from inside onEvent will cause the event to not be processed further. If it is a StateEvent or DeltaStateEvent, the InputDevice targeted by the event will not receive the state change.

Setting this flag from inside a state change monitor (see AddChangeMonitor(InputControl, IInputStateChangeMonitor, Int64, UInt32)) will prevent other monitors on the same IInputStateChangeMonitor not receiving the state change.

Exceptions
Type Condition
InvalidOperationException

The event pointer instance is not valid.

id

Declaration
public int id { get; set; }
Property Value
Type Description
Int32

sizeInBytes

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

time

Declaration
public double time { get; set; }
Property Value
Type Description
Double

type

Declaration
public readonly FourCC type { get; }
Property Value
Type Description
FourCC

valid

Whether the pointer is not null.

Declaration
public readonly bool valid { get; }
Property Value
Type Description
Boolean

True if the struct refers to an event.

Methods

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
Overrides

Equals(InputEventPtr)

Declaration
public bool Equals(InputEventPtr other)
Parameters
Type Name Description
InputEventPtr other
Returns
Type Description
Boolean
Implements

From(InputEvent*)

Declaration
public static InputEventPtr From(InputEvent*eventPtr)
Parameters
Type Name Description
InputEvent* eventPtr
Returns
Type Description
InputEventPtr

FromInputEventPtr(InputEventPtr)

Declaration
public static InputEvent*FromInputEventPtr(InputEventPtr eventPtr)
Parameters
Type Name Description
InputEventPtr eventPtr
Returns
Type Description
InputEvent*

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides

IsA<TOtherEvent>()

Declaration
public bool IsA<TOtherEvent>()
    where TOtherEvent : struct, IInputEventTypeInfo
Returns
Type Description
Boolean
Type Parameters
Name Description
TOtherEvent

Next()

Declaration
public InputEventPtr Next()
Returns
Type Description
InputEventPtr

ToPointer()

Return the plain pointer wrapped around by the struct.

Declaration
public InputEvent*ToPointer()
Returns
Type Description
InputEvent*

A plain pointer. Can be null.

ToString()

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Operators

Equality(InputEventPtr, InputEventPtr)

Declaration
public static bool operator ==(InputEventPtr left, InputEventPtr right)
Parameters
Type Name Description
InputEventPtr left
InputEventPtr right
Returns
Type Description
Boolean

Implicit(InputEvent* to InputEventPtr)

Declaration
public static implicit operator InputEventPtr(InputEvent*eventPtr)
Parameters
Type Name Description
InputEvent* eventPtr
Returns
Type Description
InputEventPtr

Implicit(InputEventPtr to InputEvent*)

Declaration
public static implicit operator InputEvent*(InputEventPtr eventPtr)
Parameters
Type Name Description
InputEventPtr eventPtr
Returns
Type Description
InputEvent*

Inequality(InputEventPtr, InputEventPtr)

Declaration
public static bool operator !=(InputEventPtr left, InputEventPtr right)
Parameters
Type Name Description
InputEventPtr left
InputEventPtr right
Returns
Type Description
Boolean

Extension Methods