D3DXPlaneDot function

Note

The D3DX utility library is deprecated. We recommend that you use DirectXMath instead.

Computes the dot product of a plane and a 4D vector.

Syntax

FLOAT D3DXPlaneDot(
  _In_ const D3DXPLANE   *pP,
  _In_ const D3DXVECTOR4 *pV
);

Parameters

pP [in]

Type: const D3DXPLANE*

Pointer to a source D3DXPLANE structure.

pV [in]

Type: const D3DXVECTOR4*

Pointer to a D3DXVECTOR4 structure.

Return value

Type: FLOAT

The dot product of the plane and 4D vector.

Remarks

Given a plane (a, b, c, d) and a 4D vector (x, y, z, w) the return value of this function is a*x + b*y + c*z + d*w. The D3DXPlaneDot function is useful for determining the plane's relationship with a homogeneous coordinate. For example, this function could 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

Requirement	Value
Header	D3dx9math.h
Library	D3dx9.lib

See also

Math Functions

D3DXPlaneDotCoord

D3DXPlaneDotNormal