clamp

From OpenGL Reference
Jump to navigation Jump to search

Constrain a value to lie between two further values.

Declaration[edit]

genType clamp( genType x, genType minVal, genType maxVal );
genType clamp( genType x, float minVal, float maxVal );
genDType clamp( genDType x, genDType minVal, genDType maxVal );
genDType clamp( genDType x, double minVal, double 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[edit]

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[edit]

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


Version Support[edit]

clamp (genType) 1.1+
clamp (genIType) 1.3+
clamp (genUType) 1.3+
clamp (genDType) 4.0+

See Also[edit]

 min , max 


Copyright[edit]

Copyright© 2011-2014 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. http://opencontent.org/openpub/.