XMComparisonAnyOutOfBounds

Tests the comparison value to determine if any of the compared components are outside the set bounds.

Syntax

bool XMComparisonAnyOutOfBounds(
         uint32_t CR
)  

Parameters

CR
Type: uint32_t 

Comparison value to test. The comparison value is typically retrieved using a recording version of an DirectXMath function such as XMVectorInBoundsR. The names of the recording functions end with an “R”.

Return value

Type: bool 

Returns true if any of the compared components are outside the set bounds.

Remarks

The following code snippet highlights how this function might be used:

uint32_t comparisonValue = XMVectorInBoundsR( V, Bounds );
if( XMComparisonAnyOutOfBounds( comparisonValue ) )
{
	DoStuff();
}  

The DoStuff function will be called only if at least one of the four components of V are outside the volume determined by Bounds and -Bounds.

Requirements

Header: Declared in directxmath.h.