Interface for pointer events.
actionKey | Returns true if the platform-specific action key is pressed. This key is Cmd on macOS, and Ctrl on all other platforms. |
altitudeAngle | Angle of the stylus relative to the surface, in radians |
altKey | Returns true if the Alt key is pressed. |
azimuthAngle | Angle of the stylus relative to the x-axis, in radians. |
button | Integer that indicates which mouse button is pressed: 0 is the left button, 1 is the right button, 2 is the middle button. |
clickCount | The number of times the button is pressed. |
commandKey | Returns true if the Windows/Cmd key is pressed. |
ctrlKey | Returns true if the Ctrl key is pressed. |
deltaPosition | The difference between the pointer's position during the previous mouse event and its position during the current mouse event. |
deltaTime | The amount of time that has passed since the last recorded change in pointer values, in seconds. |
isPrimary | Returns true if the pointer is a primary pointer |
localPosition | The pointer position in the current target coordinate system. |
modifiers | Flags that hold pressed modifier keys (Alt, Ctrl, Shift, Windows/Cmd). |
pointerId | Identifies the pointer that sends the event. |
pointerType | The type of pointer that created this event. This value is taken from the value defined in `PointerType`. |
position | The pointer position in the Screen or World coordinate system. |
pressedButtons | A bitmask that describes the currently pressed buttons. |
pressure | The amount of pressure currently applied by a touch. If the device does not report pressure, the value of this property is 1.0f. |
radius | An estimate of the radius of a touch. Add `radiusVariance` to get the maximum touch radius, subtract it to get the minimum touch radius. |
radiusVariance | Determines the accuracy of the touch radius. Add this value to the radius to get the maximum touch radius, subtract it to get the minimum touch radius. |
shiftKey | Returns true if the Shift key is pressed. |
tangentialPressure | The pressure applied to an additional pressure-sensitive control on the stylus. |
twist | The rotation of the stylus around its axis, in radians. |
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.