XMVectorGetByIndex function (directxmath.h)

Article
07/12/2022

Retrieve the value of one of the four components of an XMVECTOR Data Type containing floating-point data by index.

Syntax

float XM_CALLCONV XMVectorGetByIndex(
  FXMVECTOR V,
  size_t    i
) noexcept;

Parameters

V

A XMVECTOR Data Type containing integer data.

i

The index of the component to be retrieved.

Return value

The floating-point value of the selected component.

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)