Matrix.CreatePerspectiveFieldOfView Method (Single, Single, Single, Single)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Builds a perspective projection matrix based on a field of view and returns by value.

Namespace:  Microsoft.Xna.Framework
Assembly:  Microsoft.Xna.Framework.Math (in Microsoft.Xna.Framework.Math.dll)

Syntax

'Declaration
Public Shared Function CreatePerspectiveFieldOfView ( _
    fieldOfView As Single, _
    aspectRatio As Single, _
    nearPlaneDistance As Single, _
    farPlaneDistance As Single _
) As Matrix
public static Matrix CreatePerspectiveFieldOfView(
    float fieldOfView,
    float aspectRatio,
    float nearPlaneDistance,
    float farPlaneDistance
)

Parameters

  • fieldOfView
    Type: System.Single
    Field of view in the y direction, in radians.
  • aspectRatio
    Type: System.Single
    Aspect ratio, defined as view space width divided by height.
  • nearPlaneDistance
    Type: System.Single
    Distance to the near view plane.
  • farPlaneDistance
    Type: System.Single
    Distance to the far view plane.

Return Value

Type: Microsoft.Xna.Framework.Matrix
The perspective projection matrix.

Exceptions

Exception Condition
ArgumentOutOfRangeException

One of the following conditions is true:

  • fieldOfView is not between 0 and pi (180 degrees). Note that fieldOfView should be specified in radians.

  • nearPlaneDistance or farPlaneDistance is a negative value. Specify a positive value for nearPlaneDistance or farPlaneDistance.

  • nearPlaneDistance is larger than farPlaneDistance. nearPlaneDistance must be smaller than farPlaneDistance.

Remarks

Projection space refers to the space after applying projection transformation from view space. After the projection transformation, visible content has x- and y-coordinates ranging from −1 to 1, and a z-coordinate ranging from 0 to 1.

To obtain the viewable area (in world space) of a scene, create a BoundingFrustum and pass the combined view and projection matrix to the constructor.

Version Information

Silverlight

Supported in: 5

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.