Edit

clamp

  • Article

Clamps the specified value to the specified minimum and maximum range.

ret clamp(x, min, max)

Parameters

Item Description
x
 [in] A value to clamp.
min
 [in] The specified minimum range.
max
 [in] The specified maximum range.

Return Value

The clamped value for the x parameter.

Remarks

For values of -INF or INF, clamp will behave as expected. However for values of NaN, the results are undefined.

Type Description

Name Template Type Component Type Size
x scalar, vector, or matrix float, int any
min same as input x float, int same dimension(s) as input x
max same as input x float, int same dimension(s) as input x
ret same as input x float, int same dimension(s) as input x

Minimum Shader Model

This function is supported in the following shader models.

Shader Model Supported
Shader Model 2 (DirectX HLSL) and higher shader models yes
Shader Model 1 (DirectX HLSL) vs_1_1 and ps_1_4

See also

Intrinsic Functions (DirectX HLSL)