D3DXPlaneDotCoord function

Note

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

Computes the dot product of a plane and a 3D vector. The w parameter of the vector is assumed to be 1.

Syntax

FLOAT D3DXPlaneDotCoord(
  _In_ const D3DXPLANE   *pP,
  _In_ const D3DXVECTOR3 *pV
);

Parameters

pP [in]

Type: const D3DXPLANE*

Pointer to a source D3DXPLANE structure.

pV [in]

Type: const D3DXVECTOR3*

Pointer to a source D3DXVECTOR3 structure.

Return value

Type: FLOAT

The dot product of the plane and 3D vector.

Remarks

Given a plane (a, b, c, d) and a 3D vector (x, y, z) the return value of this function is a*x + b*y + c*z + d*1. The D3DXPlaneDotCoord function is useful for determining the plane's relationship with a coordinate in 3D space.

Requirements

Requirement Value
Header
D3dx9math.h
Library
D3dx9.lib

See also

Math Functions

D3DXPlaneDot

D3DXPlaneDotNormal