Class Pointer

Base class for pointer-style devices moving on a 2D screen.

Inheritance
System.Object
InputControl
InputDevice
Pointer
Mouse
Pen
Touchscreen
Inherited Members
Namespace: UnityEngine.InputSystem
Syntax
public class Pointer : InputDevice, IInputStateCallbackReceiver
Remarks

Note that a pointer may have "multi-point" ability as is the case with multi-touch where multiple touches represent multiple concurrent "pointers". However, for any pointer device with multiple pointers, only one pointer is considered "primary" and drives the pointer controls present on the base class.

Properties

button

Declaration
public ButtonControl button { get; }
Property Value
Type Description
ButtonControl

current

The pointer that was added or used last by the user or null if there is no pointer device connected to the system.

Declaration
public static Pointer current { get; }
Property Value
Type Description
Pointer

delta

Declaration
public Vector2Control delta { get; }
Property Value
Type Description
Vector2Control

displayIndex

Declaration
public IntegerControl displayIndex { get; }
Property Value
Type Description
IntegerControl

phase

Declaration
public PointerPhaseControl phase { get; }
Property Value
Type Description
PointerPhaseControl

pointerId

Declaration
public IntegerControl pointerId { get; }
Property Value
Type Description
IntegerControl

position

The current pointer coordinates in window space.

Declaration
public Vector2Control position { get; }
Property Value
Type Description
Vector2Control
Remarks

Within player code, the coordinates are in the coordinate space of the Display space that is current according to displayIndex. When running with a single display, that means the coordinates will always be in window space of the first display.

Within editor code, the coordinates are in the coordinate space of the current . This means that if you query in , for example, the returned 2D vector will be in the coordinate space of your local GUI (same as ).

pressure

Normalized pressure with which the pointer is currently pressed while in contact with the pointer surface.

Declaration
public AxisControl pressure { get; }
Property Value
Type Description
AxisControl
Remarks

This is only meaningful for pointing devices that support pressure. Mice do not, pens usually do, and touch usually does on mobile platforms.

Note that it is possible for the value to go above 1 even though it is considered normalized. The reason is that calibration on the system can put the maximum pressure point below the physically supported maximum value.

radius

Declaration
public Vector2Control radius { get; }
Property Value
Type Description
Vector2Control

tilt

Declaration
public Vector2Control tilt { get; }
Property Value
Type Description
Vector2Control

twist

Rotation of the pointer around its own axis. 0 means the pointer is facing away from the user (12 'o clock position) and ~1 means the pointer has been rotated clockwise almost one full rotation.

Declaration
public AxisControl twist { get; }
Property Value
Type Description
AxisControl
Remarks

Twist is generally only supported by pens and even among pens, twist support is rare. An example product that supports twist is the Wacom Art Pen.

The axis of rotation is the vector facing away from the pointer surface when the pointer is facing straight up (i.e. the surface normal of the pointer surface). When the pointer is tilted, the rotation axis is tilted along with it.

Methods

AccumulateDelta(Void*, Void*, InputControl<Single>)

Declaration
protected void AccumulateDelta(void *oldStatePtr, void *newStatePtr, InputControl<float> control)
Parameters
Type Name Description
System.Void* oldStatePtr
System.Void* newStatePtr
InputControl<System.Single> control

FinishSetup(InputDeviceBuilder)

Declaration
protected override void FinishSetup(InputDeviceBuilder builder)
Parameters
Type Name Description
InputDeviceBuilder builder
Overrides

MakeCurrent()

Declaration
public override void MakeCurrent()
Overrides

OnRemoved()

Declaration
protected override void OnRemoved()
Overrides

ResetDelta(Void*, InputControl<Single>)

Declaration
protected bool ResetDelta(void *statePtr, InputControl<float> control)
Parameters
Type Name Description
System.Void* statePtr
InputControl<System.Single> control
Returns
Type Description
System.Boolean

Explicit Interface Implementations

IInputStateCallbackReceiver.OnBeforeWriteNewState(Void*, Void*)

Declaration
void IInputStateCallbackReceiver.OnBeforeWriteNewState(void *oldStatePtr, void *newStatePtr)
Parameters
Type Name Description
System.Void* oldStatePtr
System.Void* newStatePtr
Implements

IInputStateCallbackReceiver.OnCarryStateForward(Void*)

Declaration
bool IInputStateCallbackReceiver.OnCarryStateForward(void *statePtr)
Parameters
Type Name Description
System.Void* statePtr
Returns
Type Description
System.Boolean
Implements

IInputStateCallbackReceiver.OnReceiveStateWithDifferentFormat(Void*, FourCC, UInt32, ref UInt32)

Declaration
bool IInputStateCallbackReceiver.OnReceiveStateWithDifferentFormat(void *statePtr, FourCC stateFormat, uint stateSize, ref uint offsetToStoreAt)
Parameters
Type Name Description
System.Void* statePtr
FourCC stateFormat
System.UInt32 stateSize
System.UInt32 offsetToStoreAt
Returns
Type Description
System.Boolean
Implements

Extension Methods