XMVectorInBoundsR function (directxmath.h)

Article
07/12/2022

Tests whether the components of a given vector are within certain bounds and sets a comparison value that can be examined using functions such as XMComparisonAllTrue.

Syntax

XMVECTOR XM_CALLCONV XMVectorInBoundsR(
  [out] uint32_t  *pCR,
  [in]  FXMVECTOR V,
  [in]  FXMVECTOR Bounds
) noexcept;

Parameters

[out] pCR

Pointer to a uint32_t comparison value that can be examined using functions such as XMComparisonAllInBounds. The XMComparisonXXXX functions may be used to further test the number of components that passed the comparison.

[in] V

Vector to test.

[in] Bounds

Vector that determines the bounds.

Return value

Returns a vector containing the results of each component test.

Remarks

The following pseudocode demonstrates the comparison operation of the function:

XMVECTOR Control;

Control.x = (V.x <= Bounds.x && V.x >= -Bounds.x) ? 0xFFFFFFFF : 0;
Control.y = (V.y <= Bounds.y && V.y >= -Bounds.y) ? 0xFFFFFFFF : 0;
Control.z = (V.z <= Bounds.z && V.z >= -Bounds.z) ? 0xFFFFFFFF : 0;
Control.w = (V.w <= Bounds.w && V.w >= -Bounds.w) ? 0xFFFFFFFF : 0;

return Control;

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 (include DirectXMath.h)

Share via