Struct CameraSettings.Frustum
Defines the projection matrix of the camera.
Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
[Serializable]
public struct CameraSettings.Frustum
Fields
MinFarClipPlane
The far clip plane value will be at least above nearClipPlane + MinFarClipPlane
Declaration
public const float MinFarClipPlane = 0.0001
Field Value
Type | Description |
---|---|
float |
MinNearClipPlane
The near clip plane value will be above this value.
Declaration
public const float MinNearClipPlane = 1E-05
Field Value
Type | Description |
---|---|
float |
aspect
Aspect ratio of the frustum (width/height).
Declaration
public float aspect
Field Value
Type | Description |
---|---|
float |
default
Default value.
Declaration
[Obsolete("Since 2019.3, use Frustum.NewDefault() instead.")]
public static readonly CameraSettings.Frustum @default
Field Value
Type | Description |
---|---|
CameraSettings.Frustum |
farClipPlaneRaw
Far clip plane distance.
Value that will be stored for the far clip plane distance. IF you need the effective far clip plane distance, use farClipPlane.
Declaration
[FormerlySerializedAs("farClipPlane")]
public float farClipPlaneRaw
Field Value
Type | Description |
---|---|
float |
fieldOfView
Field of view for perspective matrix (for y axis, in degree).
Declaration
[Range(1, 179)]
public float fieldOfView
Field Value
Type | Description |
---|---|
float |
mode
Which mode will be used for the projection matrix.
Declaration
public CameraSettings.Frustum.Mode mode
Field Value
Type | Description |
---|---|
CameraSettings.Frustum.Mode |
nearClipPlaneRaw
Near clip plane distance.
Value that will be stored for the near clip plane distance. IF you need the effective near clip plane distance, use nearClipPlane.
Declaration
[FormerlySerializedAs("nearClipPlane")]
public float nearClipPlaneRaw
Field Value
Type | Description |
---|---|
float |
projectionMatrix
Projection matrix used for UseProjectionMatrixField mode.
Declaration
public Matrix4x4 projectionMatrix
Field Value
Type | Description |
---|---|
Matrix4x4 |
Properties
farClipPlane
Effective far clip plane distance.
Use this value to compute the projection matrix.
This value is valid to compute a projection matrix. If you need the raw stored value, see farClipPlaneRaw instead.
Declaration
public float farClipPlane { get; }
Property Value
Type | Description |
---|---|
float |
nearClipPlane
Effective near clip plane distance.
Use this value to compute the projection matrix.
This value is valid to compute a projection matrix. If you need the raw stored value, see nearClipPlaneRaw instead.
Declaration
public float nearClipPlane { get; }
Property Value
Type | Description |
---|---|
float |
Methods
ComputeProjectionMatrix()
Compute the projection matrix based on the mode and settings provided.
Declaration
public Matrix4x4 ComputeProjectionMatrix()
Returns
Type | Description |
---|---|
Matrix4x4 | The projection matrix. |
GetUsedProjectionMatrix()
Get the projection matrix used depending on the projection mode.
Declaration
public Matrix4x4 GetUsedProjectionMatrix()
Returns
Type | Description |
---|---|
Matrix4x4 | The projection matrix |
NewDefault()
Default value.
Declaration
public static CameraSettings.Frustum NewDefault()
Returns
Type | Description |
---|---|
CameraSettings.Frustum | The default value. |