Struct InputEventPtr

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

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 using CopyTo(Void*, Int32).

Constructors

InputEventPtr(InputEvent*)

Declaration

public InputEventPtr(InputEvent*eventPtr)

Parameters

Type	Name	Description
InputEvent*	eventPtr

Properties

data

Declaration

public InputEvent*data { get; }

Property Value

Type	Description
InputEvent*

deviceId

Declaration

public int deviceId { get; set; }

Property Value

Type	Description
System.Int32

handled

Declaration

public bool handled { get; set; }

Property Value

Type	Description
System.Boolean

id

Declaration

public int id { get; set; }

Property Value

Type	Description
System.Int32

sizeInBytes

Declaration

public uint sizeInBytes { get; }

Property Value

Type	Description
System.UInt32

time

Declaration

public double time { get; set; }

Property Value

Type	Description
System.Double

type

Declaration

public FourCC type { get; }

Property Value

Type	Description
FourCC

valid

Declaration

public bool valid { get; }

Property Value

Type	Description
System.Boolean

Methods

CopyTo(Void*, Int32)

Declaration

public void CopyTo(void *buffer, int bufferSize)

Parameters

Type	Name	Description
System.Void*	buffer
System.Int32	bufferSize

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

System.ValueType.Equals(System.Object)

Equals(InputEventPtr)

Declaration

public bool Equals(InputEventPtr other)

Parameters

Type	Name	Description
InputEventPtr	other

Returns

Type	Description
System.Boolean

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.ValueType.GetHashCode()

IsA<TOtherEvent>()

Declaration

public bool IsA<TOtherEvent>()
    where TOtherEvent : struct, IInputEventTypeInfo

Returns

Type	Description
System.Boolean

Type Parameters

Name	Description
TOtherEvent

Next()

Declaration

public InputEventPtr Next()

Returns

Type	Description
InputEventPtr

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.ValueType.ToString()

Operators

Equality(InputEventPtr, InputEventPtr)

Declaration

public static bool operator ==(InputEventPtr left, InputEventPtr right)

Parameters

Type	Name	Description
InputEventPtr	left
InputEventPtr	right

Returns

Type	Description
System.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
System.Boolean