saturate

Description

Clamp value to [0,1] range.

Signature

T saturate<T>(T x)
    where T : __BuiltinFloatingPointType;

vector<T, N> saturate<T, N:int>(vector<T, N> x)
    where T : __BuiltinFloatingPointType;

matrix<T, N, M> saturate<T, N:int, M:int>(matrix<T, N, M> x)
    where T : __BuiltinFloatingPointType;

Generic Parameters

T: __BuiltinFloatingPointType

N : int

M : int

Parameters

x : T

The value to clamp.

x : vector<T, N>

The value to clamp.

x : matrix<T, N, M>

The value to clamp.

Return value

The clamped value.

Availability and Requirements

Defined for the following targets:

hlsl

Available in all stages.

glsl

Available in all stages.

cpp

Available in all stages.

cuda

Available in all stages.

metal

Available in all stages.

wgsl

Available in all stages.

spirv

Available in all stages.