docs.unity3d.com
    Show / Hide Table of Contents

    Class AxisDeadzoneProcessor

    Clamps values to the range given by min and max and re-normalizes the resulting value to [0..1].

    Inheritance
    Object
    InputProcessor
    InputProcessor<Single>
    AxisDeadzoneProcessor
    Inherited Members
    InputProcessor<Single>.ProcessAsObject(Object, InputControl)
    InputProcessor<Single>.Process(Void*, Int32, InputControl)
    Namespace: UnityEngine.InputSystem.Processors
    Syntax
    public class AxisDeadzoneProcessor : InputProcessor<float>
    Remarks

    This processor is registered (see RegisterProcessor<T>(String)) under the name "AxisDeadzone".

    It acts like a combination of ClampProcessor and NormalizeProcessor.

    // Bind to right trigger on gamepad such that the value is clamped and normalized between // 0.3 and 0.7. new InputAction(binding: "<Gamepad>/rightTrigger", processors: "axisDeadzone(min=0.3,max=0.7)");

    Fields

    max

    Upper bound (inclusive) beyond which input values get clamped. Corresponds to 1 in the normalized range.

    Declaration
    public float max
    Field Value
    Type Description
    Single
    Remarks

    If this is equal to 0 (the default), defaultDeadzoneMax is used instead.

    min

    Lower bound (inclusive) below which input values get clamped. Corresponds to 0 in the normalized range.

    Declaration
    public float min
    Field Value
    Type Description
    Single
    Remarks

    If this is equal to 0 (the default), defaultDeadzoneMin is used instead.

    Methods

    Process(Single, InputControl)

    Normalize value according to min and max.

    Declaration
    public override float Process(float value, InputControl control = null)
    Parameters
    Type Name Description
    Single value

    Input value.

    InputControl control

    Ignored.

    Returns
    Type Description
    Single

    Normalized value.

    Overrides
    UnityEngine.InputSystem.InputProcessor<System.Single>.Process(System.Single, UnityEngine.InputSystem.InputControl)

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    String
    Overrides
    Object.ToString()

    See Also

    StickDeadzoneProcessor
    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