XMPlaneDot

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

Syntax

XMVECTOR XMPlaneDot(
         XMVECTOR P,
         XMVECTOR V
)  

Parameters

P
Type: XMVECTOR 

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

V
Type: XMVECTOR 

4D vector to use in the dot product.

Return value

Type: XMVECTOR 

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.

Requirements

Header: Declared in directxmath.h.