Name

clamp — constrain a value to lie between two further values

Declaration

genType clamp(genType x,
 genType minVal,
 genType maxVal);
 
genType clamp(genType x,
 float minVal,
 float maxVal);
 
genIType clamp(genIType x,
 genIType minVal,
 genIType maxVal);
 
genIType clamp(genIType x,
 int minVal,
 int maxVal);
 
genUType clamp(genUType x,
 genUType minVal,
 genUType maxVal);
 
genUType clamp(genUType x,
 uint minVal,
 uint maxVal);
 

Parameters

x

Specify the value to constrain.

minVal

Specify the lower end of the range into which to constrain x.

maxVal

Specify the upper end of the range into which to constrain x.

Description

clamp returns the value of x constrained to the range minVal to maxVal. The returned value is computed as min(max(x, minVal), maxVal). The result is undefined if minVal ≥ maxVal.

Version Support

OpenGL ES Shading Language Version
Function Name 1.00 3.00
clamp (genType)✔✔
clamp (genIType)-✔
clamp (genUType)-✔

See Also

min, max

Copyright

Copyright © 2011-2013 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999.