Back to Adaptive Vision Library Lite website
You are here: Start » Integer » ClampInteger
ClampInteger
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: | avl |
Clamps a value to a given range.
Syntax
void avl::ClampInteger ( const int inValue, const int inMinimum, const int inMaximum, int& outClampedValue )
Parameters
| Name | Type | Default | Description | |
|---|---|---|---|---|
![]() |
inValue | const int | ||
![]() |
inMinimum | const int | ||
![]() |
inMaximum | const int | ||
![]() |
outClampedValue | int& |
Errors
List of possible exceptions:
| Error type | Description |
|---|---|
| DomainError | Invalid range (inMinimum > inMaximum) given in ClampInteger. |


