D3DXPlaneFromPointNormal function (D3DX10Math.h)

Note

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

Constructs a plane from a point and a normal.

Syntax

D3DXPLANE* D3DXPlaneFromPointNormal(
  _Inout_       D3DXPLANE   *pOut,
  _In_    const D3DXVECTOR3 *pPoint,
  _In_    const D3DXVECTOR3 *pNormal
);

Parameters

pOut [in, out]

Type: D3DXPLANE*

Pointer to the D3DXPLANE that is the result of the operation.

pPoint [in]

Type: const D3DXVECTOR3*

Pointer to a D3DXVECTOR3, defining the point used to construct the plane.

pNormal [in]

Type: const D3DXVECTOR3*

Pointer to a D3DXVECTOR3 structure, defining the normal used to construct the plane.

Return value

Type: D3DXPLANE*

Pointer to the D3DXPLANE structure constructed from the point and the normal.

Remarks

The return value for this function is the same value returned in the pOut parameter. In this way, the D3DXPlaneFromPointNormal function can be used as a parameter for another function.

Requirements

Requirement Value
Header
D3DX10Math.h
Library
D3DX10.lib

See also

Math Functions