Class TouchControl | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class TouchControl

    A control representing a touch contact.

    Inheritance
    System.Object
    InputControl
    InputControl<TouchState>
    TouchControl
    Inherited Members
    InputControl<TouchState>.valueType
    InputControl<TouchState>.valueSizeInBytes
    InputControl<TouchState>.ReadValue()
    InputControl<TouchState>.ReadValueFromPreviousFrame()
    InputControl<TouchState>.ReadDefaultValue()
    InputControl<TouchState>.ReadValueFromState(Void*)
    InputControl<TouchState>.ReadUnprocessedValue()
    InputControl<TouchState>.ReadValueFromStateAsObject(Void*)
    InputControl<TouchState>.ReadValueFromStateIntoBuffer(Void*, Void*, Int32)
    InputControl<TouchState>.WriteValueFromBufferIntoState(Void*, Int32, Void*)
    InputControl<TouchState>.WriteValueFromObjectIntoState(Object, Void*)
    InputControl<TouchState>.ReadValueFromBufferAsObject(Void*, Int32)
    InputControl<TouchState>.CompareValue(Void*, Void*)
    InputControl<TouchState>.ProcessValue(TouchState)
    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.Item[String]
    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
    Namespace: UnityEngine.InputSystem.Controls
    Syntax
    public class TouchControl : InputControl<TouchState>

    Constructors

    TouchControl()

    Declaration
    public TouchControl()

    Properties

    delta

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

    indirectTouch

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

    isInProgress

    Declaration
    public bool isInProgress { get; }
    Property Value
    Type Description
    System.Boolean

    phase

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

    position

    Absolute position on the touch surface.

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

    press

    Declaration
    public TouchPressControl press { get; }
    Property Value
    Type Description
    TouchPressControl

    pressure

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

    radius

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

    startPosition

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

    startTime

    Declaration
    public DoubleControl startTime { get; }
    Property Value
    Type Description
    DoubleControl

    tap

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

    tapCount

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

    touchId

    The ID of the touch contact as reported by the underlying system.

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

    Methods

    FinishSetup()

    Declaration
    protected override void FinishSetup()
    Overrides
    InputControl.FinishSetup()

    ReadUnprocessedValueFromState(Void*)

    Declaration
    public override TouchState ReadUnprocessedValueFromState(void *statePtr)
    Parameters
    Type Name Description
    System.Void* statePtr
    Returns
    Type Description
    TouchState
    Overrides
    UnityEngine.InputSystem.InputControl<UnityEngine.InputSystem.LowLevel.TouchState>.ReadUnprocessedValueFromState(System.Void*)

    WriteValueIntoState(TouchState, Void*)

    Declaration
    public override void WriteValueIntoState(TouchState value, void *statePtr)
    Parameters
    Type Name Description
    TouchState value
    System.Void* statePtr
    Overrides
    UnityEngine.InputSystem.InputControl<UnityEngine.InputSystem.LowLevel.TouchState>.WriteValueIntoState(UnityEngine.InputSystem.LowLevel.TouchState, System.Void*)

    Extension Methods

    InputControlExtensions.IsActuated(InputControl, Single)
    InputControlExtensions.ReadValueAsObject(InputControl)
    InputControlExtensions.ReadValueIntoBuffer(InputControl, Void*, Int32)
    InputControlExtensions.ReadDefaultValueAsObject(InputControl)
    InputControlExtensions.ReadValueFromEvent<TValue>(InputControl<TValue>, InputEventPtr, out TValue)
    InputControlExtensions.ReadUnprocessedValueFromEvent<TValue>(InputControl<TValue>, InputEventPtr)
    InputControlExtensions.ReadUnprocessedValueFromEvent<TValue>(InputControl<TValue>, InputEventPtr, out TValue)
    InputControlExtensions.WriteValueFromObjectIntoEvent(InputControl, InputEventPtr, Object)
    InputControlExtensions.WriteValueIntoState(InputControl, Void*)
    InputControlExtensions.WriteValueIntoState<TValue>(InputControl, TValue, Void*)
    InputControlExtensions.WriteValueIntoState<TValue>(InputControl<TValue>, TValue, Void*)
    InputControlExtensions.WriteValueIntoState<TValue>(InputControl<TValue>, Void*)
    InputControlExtensions.WriteValueIntoState<TValue, TState>(InputControl<TValue>, TValue, ref TState)
    InputControlExtensions.WriteValueIntoEvent<TValue>(InputControl, TValue, InputEventPtr)
    InputControlExtensions.WriteValueIntoEvent<TValue>(InputControl<TValue>, TValue, InputEventPtr)
    InputControlExtensions.CheckStateIsAtDefault(InputControl)
    InputControlExtensions.CheckStateIsAtDefault(InputControl, Void*, Void*)
    InputControlExtensions.CheckStateIsAtDefaultIgnoringNoise(InputControl)
    InputControlExtensions.CheckStateIsAtDefaultIgnoringNoise(InputControl, Void*)
    InputControlExtensions.CompareStateIgnoringNoise(InputControl, Void*)
    InputControlExtensions.CompareState(InputControl, Void*, Void*, Void*)
    InputControlExtensions.CompareState(InputControl, Void*, Void*)
    InputControlExtensions.HasValueChangeInState(InputControl, Void*)
    InputControlExtensions.HasValueChangeInEvent(InputControl, InputEventPtr)
    InputControlExtensions.GetStatePtrFromStateEvent(InputControl, InputEventPtr)
    InputControlExtensions.QueueValueChange<TValue>(InputControl<TValue>, TValue, Double)
    InputControlExtensions.FindControlsRecursive<TControl>(InputControl, IList<TControl>, Func<TControl, Boolean>)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023