Function directx_math::XMPlaneDotNormal[][src]

pub fn XMPlaneDotNormal(P: FXMVECTOR, V: FXMVECTOR) -> XMVECTOR

Calculates the dot product between the normal vector of a plane and a 3D vector.

Parameters

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

V 3D vector to use in the dot product. The w component of V is always treated as if is 0.0.

Return value

Returns the dot product between the normal vector of the plane and V replicated into each of the four components of the returned XMVECTOR.

Remarks

This function is useful for calculating the angle between the normal vector of the plane, and another normal vector. The following pseudocode demonstrates the operation of the function.

XMVECTOR vectorOut;

vectorOut.x = P.x * V.x + P.y * V.y + P.z * V.z;
vectorOut.y = P.x * V.x + P.y * V.y + P.z * V.z;
vectorOut.z = P.x * V.x + P.y * V.y + P.z * V.z;
vectorOut.w = P.x * V.x + P.y * V.y + P.z * V.z;

return vectorOut;

Reference

https://docs.microsoft.com/en-us/windows/win32/api/directxmath/nf-directxmath-XMPlaneDotNormal