Back to FabImage Library websiteYou are here:
Start »
Function Reference »
All Functions »
Real »
ClampReal
This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.
| Header: |
STD.h
|
| Namespace: |
fil |
| Module: |
FoundationLite |
Returns a value as close as possible to inValue, but in the specified range.
Syntax
void fil::ClampReal
(
const float inValue,
const float inMinimum,
const float inMaximum,
float& outClampedValue
)
Parameters
|
Name |
Type |
Default |
Description |
 |
inValue |
const float |
|
|
|
inMinimum |
const float |
|
|
|
inMaximum |
const float |
|
|
 |
outClampedValue |
float& |
|
|
Errors
List of possible exceptions:
| Error type |
Description |
| DomainError |
Invalid range (inMinimum > inMaximum) given in ClampReal. |
