XMMatrixOrthographicOffCenterLH function (directxmath.h)

Article
07/12/2022

Builds a custom orthogonal projection matrix for a left-handed coordinate system.

Syntax

XMMATRIX XM_CALLCONV XMMatrixOrthographicOffCenterLH(
  [in] float ViewLeft,
  [in] float ViewRight,
  [in] float ViewBottom,
  [in] float ViewTop,
  [in] float NearZ,
  [in] float FarZ
) noexcept;

Parameters

[in] ViewLeft

Minimum x-value of the view volume.

[in] ViewRight

Maximum x-value of the view volume.

[in] ViewBottom

Minimum y-value of the view volume.

[in] ViewTop

Maximum y-value of the view volume.

[in] NearZ

Distance to the near clipping plane.

[in] FarZ

Distance to the far clipping plane.

Return value

Returns the custom orthogonal projection matrix.

Remarks

For typical usage, NearZ is less than FarZ. However, if you flip these values so FarZ is less than NearZ, the result is an inverted z buffer (also known as a "reverse z buffer") which can provide increased floating-point precision.

NearZ and FarZ cannot be the same value and must be greater than 0.

All the parameters of XMMatrixOrthographicOffCenterLH are distances in camera space.

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

Share via