XMVectorGetIntByIndexPtr function (directxmath.h)

Article
02/22/2024

Retrieve, into an instance of an integer referenced by pointer, the value of one of the four components of an XMVECTOR Data Type containing integer data by index.

Syntax

void XM_CALLCONV XMVectorGetIntByIndexPtr(
  [out] uint32_t  *x,
        FXMVECTOR V,
        size_t    i
) noexcept;

Parameters

[out] x

Pointer to an instance of an integer object that will receive the value of the i component of the XMVECTOR Data Type object V.

V

A XMVECTOR Data Type containing integer data.

i

The index of the component to be retrieved.

Return value

None.

Remarks

The value of i must be positive and less than or equal to three ( 0 <= i <= 3 ).

The indexes have the following correspondence with XMVECTOR Data Type vector components:

Index	Component
`0`	`x`
`1`	`y`
`2`	`z`
`3`	`w`

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)