Matrix.OrthoLH(Single,Single,Single,Single) Method (Microsoft.DirectX)

  • Article

Builds a left-handed orthogonal projection matrix.

Definition

Visual Basic Public Shared Function OrthoLH( _
    ByVal width As Single, _
    ByVal height As Single, _
    ByVal znearPlane As Single, _
    ByVal zfarPlane As Single _
) As Matrix
C# public static Matrix OrthoLH(
    float width,
    float height,
    float znearPlane,
    float zfarPlane
);
C++ public:
static Matrix OrthoLH(
    float width,
    float height,
    float znearPlane,
    float zfarPlane
);
JScript public static function OrthoLH(
    width : float,
    height : float,
    znearPlane : float,
    zfarPlane : float
) : Matrix;

Parameters

width System.Single
Width of the view volume.
height System.Single
Height of the view volume.
znearPlane System.Single
Minimum z-value of the view volume, which is referred to as z-near.
zfarPlane System.Single
Maximum z-value of the view volume, which is referred to as z-far.

Return Value

Microsoft.DirectX.Matrix
Pointer to a Matrix structure that is a left-handed orthogonal projection matrix.

Remarks

An orthogonal matrix is an invertible matrix for which the inverse is equal to the transpose.

All of the parameters of the OrthoLH method are distances in camera space. The parameters describe the dimensions of the view volume.

This method uses the following formula to compute the returned matrix.

2/width    0         0                                  0
0          2/height  0                                  0
0          0         1/(zfarPlane-znearPlane)           0
0          0         znearPlane/(znearPlane-zfarPlane)  1

See Also