XMVectorPermute function (directxmath.h)

Permutes the components of two vectors to create a new vector.

Syntax

XMVECTOR XM_CALLCONV XMVectorPermute(
  [in] FXMVECTOR V1,
  [in] FXMVECTOR V2,
       uint32_t  PermuteX,
       uint32_t  PermuteY,
       uint32_t  PermuteZ,
       uint32_t  PermuteW
) noexcept;

Parameters

[in] V1

First vector.

[in] V2

Second vector.

PermuteX

Index form 0-7 indicating where the X component of the new vector should be copied from.

PermuteY

Index form 0-7 indicating where the Y component of the new vector should be copied from.

PermuteZ

Index form 0-7 indicating where the Z component of the new vector should be copied from.

PermuteW

Index form 0-7 indicating where the W component of the new vector should be copied from.

Return value

Returns the permuted vector that resulted from combining the source vectors.

Remarks

If all 4 indices reference only a single vector (i.e. they are all in the range 0-3 or all in the range 4-7), use XMVectorSwizzle instead for better performance.

The XM_PERMUTE_ constants are provided to use as input values for PermuteX,PermuteY,PermuteZ, and PermuteW.

For constant PermuteX/Y/Z/W parameters, it is much more efficient to use the template form of XMVectorPermute:

template<uint32_t PermuteX, uint32_t PermuteY, uint32_t PermuteZ, uint32_t PermuteW>
    XMVECTOR XMVectorPermute(FXMVECTOR V1, FXMVECTOR V2)

Example: XMVectorPermute<XM_PERMUTE_0Z, XM_PERMUTE_1X, XM_PERMUTE_0W, XM_PERMUTE_1Y>( V1, V2 );
   

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

Component-Wise Vector Functions

XMVectorSwizzle