XMVector2TransformNormalStream function (directxmath.h)

Article
07/12/2022

Transforms a stream of 2D normal vectors by a given matrix.

Syntax

XMFLOAT2 *XM_CALLCONV XMVector2TransformNormalStream(
  [out] XMFLOAT2       *pOutputStream,
  [in]  size_t         OutputStride,
  [in]  const XMFLOAT2 *pInputStream,
  [in]  size_t         InputStride,
  [in]  size_t         VectorCount,
  [in]  FXMMATRIX      M
) noexcept;

Parameters

[out] pOutputStream

Address of the first XMFLOAT2 in the destination stream.

[in] OutputStride

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

[in] pInputStream

Address of the first XMFLOAT2 in the stream to be transformed.

[in] InputStride

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

[in] VectorCount

Number of vectors to transform.

[in] M

Transformation matrix.

Return value

Returns the address of the first XMFLOAT2 in the destination stream.

Remarks

Each vector in the input stream must be normalized.

XMVector2TransformNormalStream uses row 0 and 1 of the input transformation matrix for rotation and scaling. Rows 2 and 3 are ignored.

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 (include DirectXMath.h)