XMComparisonAnyOutOfBounds function (directxmath.h)

Article
02/22/2024

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

Syntax

bool XMComparisonAnyOutOfBounds(
  [in] uint32_t CR
) noexcept;

Parameters

[in] CR

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

Return value

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.

Platform Requirements

Microsoft Visual Studio 2010 or Microsoft Visual Studio 2012 with the Windows SDK for Windows 8. Supported for Win32 desktop apps, Windows Store apps, and Windows Phone 8 apps.

Requirements

Requirement	Value
Target Platform	Windows
Header	directxmath.h