Blast-Radius Aware AI Code Review for Business-Critical Systems
LiveReview LiveReview Explore LiveReview

clamp - constrain a value to lie between two further values

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                                            │
       ├────────────┼──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┤
       │ Function1.101.201.301.401.503.304.004.104.204.304.404.50 │
       │ Name       │      │      │      │      │      │      │      │      │      │      │      │      │
       ├────────────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
       │ clamp      │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │
       │ (genType)  │      │      │      │      │      │      │      │      │      │      │      │      │
       ├────────────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
       │ clamp      │  -   │  -   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │
       │ (genIType) │      │      │      │      │      │      │      │      │      │      │      │      │
       ├────────────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
       │ clamp      │  -   │  -   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │
       │ (genUType) │      │      │      │      │      │      │      │      │      │      │      │      │
       ├────────────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
       │ clamp      │  -   │  -   │  -   │  -   │  -   │  -   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │  ✔   │
       │ (genDType) │      │      │      │      │      │      │      │      │      │      │      │      │
       └────────────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┘

See Also