clamp - constrain a value to lie between two further values
Contents
Copyright
Copyright © 2011-2014 Khronos Group
[FIXME: source] 11/18/2024 CLAMP(3G)
Declaration
genTypeclamp(genTypex,genTypeminVal,genTypemaxVal);genTypeclamp(genTypex,floatminVal,floatmaxVal);genDTypeclamp(genDTypex,genDTypeminVal,genDTypemaxVal);genDTypeclamp(genDTypex,doubleminVal,doublemaxVal);genITypeclamp(genITypex,genITypeminVal,genITypemaxVal);genITypeclamp(genITypex,intminVal,intmaxVal);genUTypeclamp(genUTypex,genUTypeminVal,genUTypemaxVal);genUTypeclamp(genUTypex,uintminVal,uintmaxVal);
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).
Name
clamp - constrain a value to lie between two further values
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.
See Also
min(), max()
Version Support
┌────────────┬───────────────────────────────────────────────────────────────────────────────────┐
│ │ OpenGLShadingLanguageVersion │
├────────────┼──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┤
│ Function │ 1.10 │ 1.20 │ 1.30 │ 1.40 │ 1.50 │ 3.30 │ 4.00 │ 4.10 │ 4.20 │ 4.30 │ 4.40 │ 4.50 │
│ Name │ │ │ │ │ │ │ │ │ │ │ │ │
├────────────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
│ clamp │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │
│ (genType) │ │ │ │ │ │ │ │ │ │ │ │ │
├────────────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
│ clamp │ - │ - │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │
│ (genIType) │ │ │ │ │ │ │ │ │ │ │ │ │
├────────────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
│ clamp │ - │ - │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │
│ (genUType) │ │ │ │ │ │ │ │ │ │ │ │ │
├────────────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
│ clamp │ - │ - │ - │ - │ - │ - │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │
│ (genDType) │ │ │ │ │ │ │ │ │ │ │ │ │
└────────────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┘
