XMVector3ComponentsFromNormal function (directxmath.h)

Article
02/22/2024

Using a reference normal vector, splits a 3D vector into components that are parallel and perpendicular to the normal.

Syntax

void XM_CALLCONV XMVector3ComponentsFromNormal(
  [out] XMVECTOR  *pParallel,
  [out] XMVECTOR  *pPerpendicular,
  [in]  FXMVECTOR V,
  [in]  FXMVECTOR Normal
) noexcept;

Parameters

[out] pParallel

Address of the component of V that is parallel to Normal.

[out] pPerpendicular

Address of the component of V that is perpendicular to Normal.

[in] V

3D vector to break into components.

[in] Normal

3D reference normal vector.

Return value

None.

Remarks

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)