XMStoreFloat3 function (directxmath.h)

Stores an XMVECTOR in an XMFLOAT3.

Syntax

void XM_CALLCONV XMStoreFloat3(
  [out] XMFLOAT3  *pDestination,
  [in]  FXMVECTOR V
) noexcept;

Parameters

[out] pDestination

Address at which to store the data.

[in] V

Vector containing the data to store.

Return value

None.

Remarks

This function takes a vector and writes the three most significant components out to three single-precision floating-point values at the given address. The most significant component is written to the first four bytes of the address, the next most significant component is written to the next four bytes, and the third most significant component is written to the final four bytes.

The following pseudocode demonstrates the operation of the function.

pDestination->x = V.x; // 4 bytes to address pDestination
pDestination->y = V.y; // 4 bytes to address (uint8_t*)pDestination + 4
pDestination->z = V.z; // 4 bytes to address (uint8_t*)pDestination + 8

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

See also

DirectXMath Library Vector Store Functions