XMVector3InBounds function (directxmath.h)

Article
02/22/2024

Tests whether the components of a 3D vector are within set bounds.

Syntax

bool XM_CALLCONV XMVector3InBounds(
  [in] FXMVECTOR V,
  [in] FXMVECTOR Bounds
) noexcept;

Parameters

[in] V

3D vector to test.

[in] Bounds

3D vector that determines the bounds.

Return value

Returns true if both the x, y, and z-components of V are within the set bounds, and false otherwise.

Remarks

The following pseudocode demonstrates the operation of the function:

return (V.x <= Bounds.x && V.x >= -Bounds.x) &&
       (V.y <= Bounds.y && V.y >= -Bounds.y) &&
       (V.z <= Bounds.z && V.z >= -Bounds.z);

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)