docs.unity3d.com
    Show / Hide Table of Contents

    Class DeltaControl

    A control representing a two-dimensional motion vector that accumulates within a frame and resets at the beginning of a frame.

    Inheritance
    Object
    InputControl
    InputControl<Vector2>
    Vector2Control
    DeltaControl
    Inherited Members
    Vector2Control.x
    Vector2Control.y
    Vector2Control.ReadUnprocessedValueFromState(Void*)
    Vector2Control.WriteValueIntoState(Vector2, Void*)
    Vector2Control.EvaluateMagnitude(Void*)
    InputControl<Vector2>.valueType
    InputControl<Vector2>.valueSizeInBytes
    InputControl<Vector2>.ReadValue()
    InputControl<Vector2>.ReadValueFromPreviousFrame()
    InputControl<Vector2>.ReadDefaultValue()
    InputControl<Vector2>.ReadValueFromState(Void*)
    InputControl<Vector2>.ReadUnprocessedValue()
    InputControl<Vector2>.ReadValueFromStateAsObject(Void*)
    InputControl<Vector2>.ReadValueFromStateIntoBuffer(Void*, Void*, Int32)
    InputControl<Vector2>.WriteValueFromBufferIntoState(Void*, Int32, Void*)
    InputControl<Vector2>.WriteValueFromObjectIntoState(Object, Void*)
    InputControl<Vector2>.ReadValueFromBufferAsObject(Void*, Int32)
    InputControl<Vector2>.CompareValue(Void*, Void*)
    InputControl<Vector2>.ProcessValue(Vector2)
    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.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
    [Preserve]
    public class DeltaControl : Vector2Control
    Remarks

    Delta controls are

    Properties

    down

    A synthetic axis representing the lower half of the Y axis value, i.e. the -1 to 1 range (inverted).

    Declaration
    [Preserve]
    public AxisControl down { get; set; }
    Property Value
    Type Description
    AxisControl

    Control representing the control's lower half Y axis.

    Remarks

    The control is marked as synthetic.

    left

    A synthetic axis representing the left half of the X axis value, i.e. the -1 to 1 range (inverted).

    Declaration
    [Preserve]
    public AxisControl left { get; set; }
    Property Value
    Type Description
    AxisControl

    Control representing the control's left half X axis.

    Remarks

    The control is marked as synthetic.

    right

    A synthetic axis representing the right half of the X axis value, i.e. the 0 to 1 range.

    Declaration
    [Preserve]
    public AxisControl right { get; set; }
    Property Value
    Type Description
    AxisControl

    Control representing the control's right half X axis.

    Remarks

    The control is marked as synthetic.

    up

    A synthetic axis representing the upper half of the Y axis value, i.e. the 0 to 1 range.

    Declaration
    [Preserve]
    public AxisControl up { get; set; }
    Property Value
    Type Description
    AxisControl

    Control representing the control's upper half Y axis.

    Remarks

    The control is marked as synthetic.

    Methods

    FinishSetup()

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

    Extension Methods

    InputControlExtensions.FindInParentChain<TControl>(InputControl)
    InputControlExtensions.IsPressed(InputControl, Single)
    InputControlExtensions.IsActuated(InputControl, Single)
    InputControlExtensions.ReadValueAsObject(InputControl)
    InputControlExtensions.ReadValueIntoBuffer(InputControl, Void*, Int32)
    InputControlExtensions.ReadDefaultValueAsObject(InputControl)
    InputControlExtensions.ReadValueFromEvent<TValue>(InputControl<TValue>, InputEventPtr)
    InputControlExtensions.ReadValueFromEvent<TValue>(InputControl<TValue>, InputEventPtr, out TValue)
    InputControlExtensions.ReadValueFromEventAsObject(InputControl, InputEventPtr)
    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.ResetToDefaultStateInEvent(InputControl, InputEventPtr)
    InputControlExtensions.QueueValueChange<TValue>(InputControl<TValue>, TValue, Double)
    InputControlExtensions.FindControlsRecursive<TControl>(InputControl, IList<TControl>, Func<TControl, Boolean>)

    See Also

    scroll
    In This Article
    • Properties
      • down
      • left
      • right
      • up
    • Methods
      • FinishSetup()
    • Extension Methods
    • See Also
    Back to top
    Terms of use
    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