XMComparisonAnyTrue

Tests the comparison value to determine if any of the compared components are true.

Syntax

bool XMComparisonAnyTrue(
         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 XMVector4EqualR. The names of the recording functions end with an “R”.

Return value

Type: bool 

Returns true if any of the compared components are true.

Remarks

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

uint32_t comparisonValue = XMVector4EqualR( V1, V2 );
if( XMComparisonAnyTrue( comparisonValue ) )
{
	DoStuff();
}  

The DoStuff function will be called only if any of the four components of V1 and V2 are equal (any compared components are true).

Requirements

Header: Declared in directxmath.h.