Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


saturate

Returns the result of clamping the float value x into the interval [0, 1].
Read time 2 minutesLast updated 4 days ago

Definition

saturate(float)

Returns the result of clamping the float value x into the interval [0, 1].
public static float saturate(float x)

Parameters

Input value.

Returns

Type

Description

floatThe 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].
public static float2 saturate(float2 x)

Parameters

Input value.

Returns

Type

Description

float2The 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].
public static float3 saturate(float3 x)

Parameters

Input value.

Returns

Type

Description

float3The 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].
public static float4 saturate(float4 x)

Parameters

Input value.

Returns

Type

Description

float4The 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].
public static double saturate(double x)

Parameters

Input value.

Returns

Type

Description

doubleThe 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].
public static double2 saturate(double2 x)

Parameters

Input value.

Returns

Type

Description

double2The 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].
public static double3 saturate(double3 x)

Parameters

Input value.

Returns

Type

Description

double3The 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].
public static double4 saturate(double4 x)

Parameters

Input value.

Returns

Type

Description

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