XMPlaneTransformStream function (directxmath.h)

Article
02/22/2024

Transforms a stream of planes by a given matrix.

Syntax

XMFLOAT4 *XM_CALLCONV XMPlaneTransformStream(
  [out] XMFLOAT4       *pOutputStream,
  [in]  size_t         OutputStride,
  [in]  const XMFLOAT4 *pInputStream,
  [in]  size_t         InputStride,
  [in]  size_t         PlaneCount,
        FXMMATRIX      ITM
) noexcept;

Parameters

[out] pOutputStream

Address of the first XMFLOAT4 in the destination stream. The components of each XMFLOAT4 are the plane coefficients (A, B, C, D) for the plane equation Ax+By+Cz+D=0.

[in] OutputStride

Stride, in bytes, between planes in the destination stream.

[in] pInputStream

Address of the first XMFLOAT4 in the stream to be transformed. The components of each XMFLOAT4 are the plane coefficients (A, B, C, D) for the plane equation Ax+By+Cz+D=0.

[in] InputStride

Stride, in bytes, between planes in the input stream.

[in] PlaneCount

Number of planes to transform.

ITM

Return value

Returns the address of the first XMFLOAT4 in the destination stream. The components of each XMFLOAT4 are the plane coefficients (A, B, C, D) for the plane equation Ax+By+Cz+D=0.

Remarks

Platform Requirements

Microsoft Visual Studio 2010 or Microsoft Visual Studio 2012 with the Windows SDK for Windows 8. Supported for Win32 desktop apps, Windows Store apps, and Windows Phone 8 apps.

Requirements

Requirement	Value
Target Platform	Windows
Header	directxmath.h