XMVectorGetByIndexPtr function (directxmath.h)

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

Syntax

void XM_CALLCONV XMVectorGetByIndexPtr(
  [out] float     *f,
        FXMVECTOR V,
        size_t    i
) noexcept;

Parameters

[out] f

Pointer to an instance of a floating-point object that will receive the value of the i component of the XMVECTOR Data Type object V.

V

A XMVECTOR Data Type containing floating-point 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)

See also

DirectXMath Library Vector Accessor Functions

XMVectorGetByIndex

XMVectorSetByIndexPtr