docs.unity3d.com
    Show / Hide Table of Contents

    Method saturate

    saturate(Single)

    Returns the result of clamping the float value x into the interval [0, 1].

    Declaration
    public static float saturate(float x)
    Parameters
    Type Name Description
    Single x

    Input value.

    Returns
    Type Description
    Single

    The clamping of the input into the interval [0, 1].

    saturate(float2)

    Returns the result of a componentwise clamping of the float2 vector x into the interval [0, 1].

    Declaration
    public static float2 saturate(float2 x)
    Parameters
    Type Name Description
    float2 x

    Input value.

    Returns
    Type Description
    float2

    The componentwise clamping of the input into the interval [0, 1].

    saturate(float3)

    Returns the result of a componentwise clamping of the float3 vector x into the interval [0, 1].

    Declaration
    public static float3 saturate(float3 x)
    Parameters
    Type Name Description
    float3 x

    Input value.

    Returns
    Type Description
    float3

    The componentwise clamping of the input into the interval [0, 1].

    saturate(float4)

    Returns the result of a componentwise clamping of the float4 vector x into the interval [0, 1].

    Declaration
    public static float4 saturate(float4 x)
    Parameters
    Type Name Description
    float4 x

    Input value.

    Returns
    Type Description
    float4

    The componentwise clamping of the input into the interval [0, 1].

    saturate(Double)

    Returns the result of clamping the double value x into the interval [0, 1].

    Declaration
    public static double saturate(double x)
    Parameters
    Type Name Description
    Double x

    Input value.

    Returns
    Type Description
    Double

    The clamping of the input into the interval [0, 1].

    saturate(double2)

    Returns the result of a componentwise clamping of the double2 vector x into the interval [0, 1].

    Declaration
    public static double2 saturate(double2 x)
    Parameters
    Type Name Description
    double2 x

    Input value.

    Returns
    Type Description
    double2

    The componentwise clamping of the input into the interval [0, 1].

    saturate(double3)

    Returns the result of a componentwise clamping of the double3 vector x into the interval [0, 1].

    Declaration
    public static double3 saturate(double3 x)
    Parameters
    Type Name Description
    double3 x

    Input value.

    Returns
    Type Description
    double3

    The componentwise clamping of the input into the interval [0, 1].

    saturate(double4)

    Returns the result of a componentwise clamping of the double4 vector x into the interval [0, 1].

    Declaration
    public static double4 saturate(double4 x)
    Parameters
    Type Name Description
    double4 x

    Input value.

    Returns
    Type Description
    double4

    The componentwise clamping of the input into the interval [0, 1].

    In This Article
    • saturate(Single)
    • saturate(float2)
    • saturate(float3)
    • saturate(float4)
    • saturate(Double)
    • saturate(double2)
    • saturate(double3)
    • saturate(double4)
    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