XMPlaneDot function (directxmath.h)

Article
07/12/2022

Calculates the dot product between an input plane and a 4D vector.

Syntax

XMVECTOR XM_CALLCONV XMPlaneDot(
  [in] FXMVECTOR P,
  [in] FXMVECTOR V
) noexcept;

Parameters

[in] P

XMVECTOR describing the plane coefficients (A, B, C, D) for the plane equation Ax+By+Cz+D=0.

[in] V

4D vector to use in the dot product.

Return value

Returns the dot product of P and V replicated into each of the four components of the returned XMVECTOR.

Remarks

The XMPlaneDot function is useful for determining the plane's relationship with a homogeneous coordinate. For example, this function can be used to determine if a particular coordinate is on a particular plane, or on which side of a particular plane a particular coordinate lies.

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