D3DXPlaneIntersectLine function (D3dx9math.h)

Note

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

Finds the intersection between a plane and a line.

Syntax

D3DXVECTOR3* D3DXPlaneIntersectLine(
  _Inout_       D3DXVECTOR3 *pOut,
  _In_    const D3DXPLANE   *pP,
  _In_    const D3DXVECTOR3 *pV1,
  _In_    const D3DXVECTOR3 *pV2
);

Parameters

pOut [in, out]

Type: D3DXVECTOR3*

Pointer to a D3DXVECTOR3 structure, identifying the intersection between the specified plane and line.

pP [in]

Type: const D3DXPLANE*

Pointer to the source D3DXPLANE structure.

pV1 [in]

Type: const D3DXVECTOR3*

Pointer to a source D3DXVECTOR3 structure, defining a line starting point.

pV2 [in]

Type: const D3DXVECTOR3*

Pointer to a source D3DXVECTOR3 structure, defining a line ending point.

Return value

Type: D3DXVECTOR3*

Pointer to a D3DXVECTOR3 structure that is the intersection between the specified plane and line.

Remarks

If the line is parallel to the plane, NULL is returned.

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

Requirements

Requirement	Value
Header	D3dx9math.h
Library	D3dx9.lib

See also

Math Functions