docs.unity3d.com
Search Results for

    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<float>
    AxisDeadzoneProcessor
    Inherited Members
    InputProcessor<float>.ProcessAsObject(object, InputControl)
    InputProcessor<float>.Process(void*, int, InputControl)
    InputProcessor.cachingPolicy
    Namespace: UnityEngine.InputSystem.Processors
    Assembly: Unity.InputSystem.dll
    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
    float
    Remarks

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

    See Also
    StickDeadzoneProcessor

    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
    float
    Remarks

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

    See Also
    StickDeadzoneProcessor

    Methods

    Process(float, InputControl)

    Normalize value according to min and max.

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

    Input value.

    InputControl control

    Ignored.

    Returns
    Type Description
    float

    Normalized value.

    Overrides
    InputProcessor<float>.Process(float, InputControl)
    See Also
    StickDeadzoneProcessor

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    string
    Overrides
    object.ToString()
    See Also
    StickDeadzoneProcessor

    See Also

    StickDeadzoneProcessor

    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Fields
      • max
      • min
    • Methods
      • Process(float, InputControl)
      • ToString()
    • See Also
    Back to top
    Copyright © 2024 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)