Class TouchPhaseControl
A control reading a TouchPhase value.
Inherited Members
Namespace: UnityEngine.InputSystem.Controls
Assembly: Unity.InputSystem.dll
Syntax
public class TouchPhaseControl : InputControl<TouchPhase>Remarks
This is used mainly by Touchscreen to read phase.
Constructors
TouchPhaseControl()
Default-initialize the control.
Declaration
public TouchPhaseControl()Remarks
Format of the control is FormatInt by default.
See Also
Methods
ReadUnprocessedValueFromState(void*)
Read value from provided statePtr.
Declaration
public override TouchPhase ReadUnprocessedValueFromState(void* statePtr)Parameters
| Type | Name | Description |
|---|---|---|
| void* | statePtr | State pointer to read from. |
Returns
| Type | Description |
|---|---|
| TouchPhase | The controls current value. |
Overrides
Remarks
Read value from provided statePtr without any caching.
See Also
WriteValueIntoState(TouchPhase, void*)
Write a value into state at the given memory.
Declaration
public override void WriteValueIntoState(TouchPhase value, void* statePtr)Parameters
| Type | Name | Description |
|---|---|---|
| TouchPhase | value | Value for the control to store in the state. |
| void* | statePtr | State containing the control's stateBlock. Will receive the state as converted from the given value. |
Overrides
Remarks
Writing values will NOT apply processors to the given value. This can mean that when reading a value from a control after it has been written to its state, the resulting value differs from what was written.
Exceptions
| Type | Condition |
|---|---|
| NotSupportedException | The control does not support writing. This is the case, for example, that compute values (such as the magnitude of a vector). |