clamp

Clamp x to range given by min, max

gentype clamp ( gentype x,
  gentype minval,
  gentype maxval)
gentype clamp ( gentype x,
  float minval,
  float maxval)

gentype clamp (gentype x, double minval, double maxval) // if double extension enabled
gentype clamp (gentype x, half minval, half maxval) // if half extension enabled

Description

Returns min(fmax(x, minval), maxval).

Results are undefined if minval > maxval.

Notes

Built-in common functions operate component-wise and the description is per-component and are implemented using the round to nearest even rounding mode. We use the generic type name gentype to indicate that the function can take float, float2, float3, float4, float8, or float16 as the type for the arguments.

The built-in common functions are implemented using the round to nearest even rounding mode.

If extended with cl_khr_fp64, generic type name gentype may indicate double and double{2|3|4|8|16} as arguments and return values. If extended with cl_khr_fp16, generic type name gentype may indicate half and half{2|3|4|8|16} as arguments and return values.

Specification

OpenCL Specification

Also see

Common Functions

Copyright © 2007-2010 The Khronos Group Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and/or associated documentation files (the "Materials"), to deal in the Materials without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Materials, and to permit persons to whom the Materials are furnished to do so, subject to the condition that this copyright notice and permission notice shall be included in all copies or substantial portions of the Materials.