Struct InputEventPtr
Pointer to an InputEvent. Makes it easier to work with InputEvents and hides
the unsafe operations necessary to work with them.
Assembly: Unity.InputSystem.dll
public struct InputEventPtr : IEquatable<InputEventPtr>
Constructors
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
Declaration
public InputEvent* data { get; }
Property Value
Declaration
public int deviceId { get; set; }
Property Value
Whether the event is considered "handled" and should not be processed further.
Declaration
public bool handled { get; set; }
Property Value
Exceptions
Declaration
public int id { get; set; }
Property Value
Declaration
public uint sizeInBytes { get; }
Property Value
Declaration
public double time { get; set; }
Property Value
Declaration
public FourCC type { get; }
Property Value
Whether the pointer is not null.
Declaration
public bool valid { get; }
Property Value
| Type |
Description |
| bool |
True if the struct refers to an event.
|
Methods
Declaration
public override bool Equals(object obj)
Parameters
| Type |
Name |
Description |
| object |
obj |
|
Returns
Overrides
Declaration
public bool Equals(InputEventPtr other)
Parameters
Returns
Declaration
public static InputEventPtr From(InputEvent* eventPtr)
Parameters
Returns
Declaration
public static InputEvent* FromInputEventPtr(InputEventPtr eventPtr)
Parameters
Returns
Declaration
public override int GetHashCode()
Returns
Overrides
Declaration
public bool IsA<TOtherEvent>() where TOtherEvent : struct, IInputEventTypeInfo
Returns
Type Parameters
| Name |
Description |
| TOtherEvent |
|
Declaration
public InputEventPtr Next()
Returns
Return the plain pointer wrapped around by the struct.
Declaration
public InputEvent* ToPointer()
Returns
| Type |
Description |
| InputEvent* |
A plain pointer. Can be null.
|
Declaration
public override string ToString()
Returns
Overrides
Operators
Declaration
public static bool operator ==(InputEventPtr left, InputEventPtr right)
Parameters
Returns
Declaration
public static implicit operator InputEventPtr(InputEvent* eventPtr)
Parameters
Returns
Declaration
public static implicit operator InputEvent*(InputEventPtr eventPtr)
Parameters
Returns
Declaration
public static bool operator !=(InputEventPtr left, InputEventPtr right)
Parameters
Returns
Implements
Extension Methods
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.