docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class TouchPhaseControl

    A control reading a TouchPhase value.

    Inheritance
    object
    InputControl
    InputControl<TouchPhase>
    TouchPhaseControl
    Inherited Members
    InputControl<TouchPhase>.valueType
    InputControl<TouchPhase>.valueSizeInBytes
    InputControl<TouchPhase>.value
    InputControl<TouchPhase>.ReadValue()
    InputControl<TouchPhase>.ReadValueFromPreviousFrame()
    InputControl<TouchPhase>.ReadDefaultValue()
    InputControl<TouchPhase>.ReadValueFromState(void*)
    InputControl<TouchPhase>.ReadValueFromStateWithCaching(void*)
    InputControl<TouchPhase>.ReadUnprocessedValueFromStateWithCaching(void*)
    InputControl<TouchPhase>.ReadUnprocessedValue()
    InputControl<TouchPhase>.ReadValueFromStateAsObject(void*)
    InputControl<TouchPhase>.ReadValueFromStateIntoBuffer(void*, void*, int)
    InputControl<TouchPhase>.WriteValueFromBufferIntoState(void*, int, void*)
    InputControl<TouchPhase>.WriteValueFromObjectIntoState(object, void*)
    InputControl<TouchPhase>.ReadValueFromBufferAsObject(void*, int)
    InputControl<TouchPhase>.CompareValue(void*, void*)
    InputControl<TouchPhase>.ProcessValue(TouchPhase)
    InputControl<TouchPhase>.ProcessValue(ref TouchPhase)
    InputControl<TouchPhase>.FinishSetup()
    InputControl.name
    InputControl.displayName
    InputControl.shortDisplayName
    InputControl.path
    InputControl.layout
    InputControl.variants
    InputControl.device
    InputControl.parent
    InputControl.children
    InputControl.usages
    InputControl.aliases
    InputControl.stateBlock
    InputControl.noisy
    InputControl.synthetic
    InputControl.this[string]
    InputControl.magnitude
    InputControl.ToString()
    InputControl.EvaluateMagnitude()
    InputControl.EvaluateMagnitude(void*)
    InputControl.TryGetChildControl(string)
    InputControl.TryGetChildControl<TControl>(string)
    InputControl.GetChildControl(string)
    InputControl.GetChildControl<TControl>(string)
    InputControl.RefreshConfigurationIfNeeded()
    InputControl.RefreshConfiguration()
    InputControl.m_StateBlock
    InputControl.currentStatePtr
    InputControl.previousFrameStatePtr
    InputControl.defaultStatePtr
    InputControl.noiseMaskPtr
    InputControl.stateOffsetRelativeToDeviceRoot
    InputControl.optimizedControlDataType
    InputControl.CalculateOptimizedControlDataType()
    InputControl.ApplyParameterChanges()
    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
    Touchscreen

    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
    InputControl<TouchPhase>.ReadUnprocessedValueFromState(void*)
    Remarks

    Read value from provided statePtr without any caching.

    See Also
    value

    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
    InputControl<TouchPhase>.WriteValueIntoState(TouchPhase, void*)
    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).

    See Also
    WriteValueFromBufferIntoState(void*, int, void*)

    Extension Methods

    InputControlExtensions.CheckStateIsAtDefault(InputControl)
    InputControlExtensions.CheckStateIsAtDefault(InputControl, void*, void*)
    InputControlExtensions.CheckStateIsAtDefaultIgnoringNoise(InputControl)
    InputControlExtensions.CheckStateIsAtDefaultIgnoringNoise(InputControl, void*)
    InputControlExtensions.CompareState(InputControl, void*, void*)
    InputControlExtensions.CompareState(InputControl, void*, void*, void*)
    InputControlExtensions.CompareStateIgnoringNoise(InputControl, void*)
    InputControlExtensions.FindControlsRecursive<TControl>(InputControl, IList<TControl>, Func<TControl, bool>)
    InputControlExtensions.FindInParentChain<TControl>(InputControl)
    InputControlExtensions.GetStatePtrFromStateEvent(InputControl, InputEventPtr)
    InputControlExtensions.HasValueChangeInEvent(InputControl, InputEventPtr)
    InputControlExtensions.HasValueChangeInState(InputControl, void*)
    InputControlExtensions.IsActuated(InputControl, float)
    InputControlExtensions.IsPressed(InputControl, float)
    InputControlExtensions.ReadDefaultValueAsObject(InputControl)
    InputControlExtensions.ReadValueAsObject(InputControl)
    InputControlExtensions.ReadValueFromEventAsObject(InputControl, InputEventPtr)
    InputControlExtensions.ReadValueIntoBuffer(InputControl, void*, int)
    InputControlExtensions.ResetToDefaultStateInEvent(InputControl, InputEventPtr)
    InputControlExtensions.WriteValueFromObjectIntoEvent(InputControl, InputEventPtr, object)
    InputControlExtensions.WriteValueIntoEvent<TValue>(InputControl, TValue, InputEventPtr)
    InputControlExtensions.WriteValueIntoState(InputControl, void*)
    InputControlExtensions.WriteValueIntoState<TValue>(InputControl, TValue, void*)
    InputControlExtensions.QueueValueChange<TValue>(InputControl<TValue>, TValue, double)
    InputControlExtensions.ReadUnprocessedValueFromEvent<TValue>(InputControl<TValue>, InputEventPtr)
    InputControlExtensions.ReadUnprocessedValueFromEvent<TValue>(InputControl<TValue>, InputEventPtr, out TValue)
    InputControlExtensions.ReadValueFromEvent<TValue>(InputControl<TValue>, InputEventPtr)
    InputControlExtensions.ReadValueFromEvent<TValue>(InputControl<TValue>, InputEventPtr, out TValue)
    InputControlExtensions.WriteValueIntoEvent<TValue>(InputControl<TValue>, TValue, InputEventPtr)
    InputControlExtensions.WriteValueIntoState<TValue>(InputControl<TValue>, void*)
    InputControlExtensions.WriteValueIntoState<TValue>(InputControl<TValue>, TValue, void*)
    InputControlExtensions.WriteValueIntoState<TValue, TState>(InputControl<TValue>, TValue, ref TState)

    See Also

    Touchscreen
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)