XMVector2TransformCoordStream function (directxmath.h)

Article
02/22/2024

Transforms a stream of 2D vectors by a given matrix, projecting the resulting vectors such that their w coordinates are equal to 1.0.

Syntax

XMFLOAT2 *XM_CALLCONV XMVector2TransformCoordStream(
  [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

XMVector2TransformCoordStream performs transformations by using the input matrix row 0 and row 1 for rotation and scaling, and row 3 for translation (effectively assuming row 2 is 0). The w component of the input vector is assumed to be 1.0. The z component of the returned vector should be ignored and its w component will have a value of 1.0.

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)

Share via