Back to FabImage Library website

You are here: Start » Function Reference » All Functions » 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: fil
Module: FoundationLite

Returns a value as close as possible to inValue, but in the specified range.

Syntax

void fil::ClampInteger
(
	const int inValue,
	const int inMinimum,
	const int inMaximum,
	int& outClampedValue
)

Parameters

Name Type Default Description
Input value
 inValue const int
Input value
 inMinimum const int
Input value
 inMaximum const int
Output value
 outClampedValue int&

Errors

List of possible exceptions:

Error type Description
DomainError Invalid range (inMinimum > inMaximum) given in ClampInteger.