Pointers
Pointer
devices are defined as InputDevices
that track positions on a 2D surface. Three types of pointers are supported:
Controls
Each of these types implements a common set of controls. For a more detailed descriptions of these controls, refer to their scripting reference.
Control |
Type |
Description |
position |
Vector2Control |
The current pointer coordinates in window space. |
delta |
Vector2Control |
The difference in position since the last frame. |
press |
ButtonControl |
Whether the pointer or it's primary button is pressed down. |
pressure |
AxisControl |
Normalized pressure with which the pointer is currently pressed while in contact with the pointer surface (Only relevant for pressure sensitive devices, such as tablets and some touch screens). |
radius |
Vector2Control |
The size of the area where the finger touches the surface. Only relevant for touch input. |
Window Space
Within player code, the coordinates are in the coordinate space of the player window.
Within editor code, the coordinates are in the coordinate space of the current EditorWindow
. This means that if you query Pointer.current.position
in UnityEditor.EditorWindow.OnGUI
, for example, the returned 2D vector will be in the coordinate space of your local GUI (same as UnityEngine.Event.mousePosition
).
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.