Struct RenderView

Rendering view description that defines how to render the objects (camera placement, rendering properties, etc.).

System.ValueType.Equals(System.Object)
System.ValueType.GetHashCode()
System.ValueType.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
[Tooltip("Rendering view description that defines how to render the objects (camera placement, rendering properties, etc.).")]
public struct RenderView

Fields

CullingFrustum

The view frustum used for culling (can be different than Frustum in some cases e.g. cascaded shadow map rendering).

Declaration
[Tooltip("The view frustum used for culling (can be different than Frustum in some cases e.g. cascaded shadow map rendering).")]
public BoundingFrustum CullingFrustum
Field Value
BoundingFrustum

Direction

The direction of the view.

Declaration
[Tooltip("The direction of the view.")]
public Vector3 Direction
Field Value
Vector3

Far

The far plane.

Declaration
[Tooltip("The far plane.")]
public float Far
Field Value
System.Single

Flags

The view flags.

Declaration
[Tooltip("The view flags.")]
public ViewFlags Flags
Field Value
ViewFlags

Frustum

The view frustum.

Declaration
[Tooltip("The view frustum.")]
public BoundingFrustum Frustum
Field Value
BoundingFrustum

IP

The inverted projection matrix.

Declaration
[Tooltip("The inverted projection matrix.")]
public Matrix IP
Field Value
Matrix

IsOfflinePass

Flag used by static, offline rendering passes (eg. reflections rendering, lightmap rendering etc.)

Declaration
[Tooltip("Flag used by static, offline rendering passes (eg. reflections rendering, lightmap rendering etc.)")]
public bool IsOfflinePass
Field Value
System.Boolean

IV

The inverted view matrix.

Declaration
[Tooltip("The inverted view matrix.")]
public Matrix IV
Field Value
Matrix

IVP

The inverted projection view matrix.

Declaration
[Tooltip("The inverted projection view matrix.")]
public Matrix IVP
Field Value
Matrix

MaxShadowsQuality

Maximum allowed shadows quality for this view

Declaration
[Tooltip("Maximum allowed shadows quality for this view")]
public Quality MaxShadowsQuality
Field Value
Quality

Mode

The view mode.

Declaration
[Tooltip("The view mode.")]
public ViewMode Mode
Field Value
ViewMode

ModelLODBias

The model LOD bias. Default is 0. Applied to all the objects in the render view.

Declaration
[Tooltip("The model LOD bias. Default is 0. Applied to all the objects in the render view.")]
public int ModelLODBias
Field Value
System.Int32

ModelLODDistanceFactor

The model LOD distance scale factor. Default is 1. Applied to all the objects in the render view. Higher values increase LODs quality.

Declaration
[Tooltip("The model LOD distance scale factor. Default is 1. Applied to all the objects in the render view. Higher values increase LODs quality.")]
public float ModelLODDistanceFactor
Field Value
System.Single

ModelLODDistanceFactorSqrt

Square of ModelLODDistanceFactor. Cached by rendering backend.

Declaration
[Tooltip("Square of <see cref=\"ModelLODDistanceFactor\"/>. Cached by rendering backend.")]
public float ModelLODDistanceFactorSqrt
Field Value
System.Single

Near

The near plane.

Declaration
[Tooltip("The near plane.")]
public float Near
Field Value
System.Single

NonJitteredProjection

The projection matrix with no camera offset (no jittering). For many temporal image effects, the camera that is currently rendering needs to be slightly offset from the default projection (that is, the camera is ‘jittered’). If you use motion vectors and camera jittering together, use this property to keep the motion vectors stable between frames.

Declaration
[Tooltip("The projection matrix with no camera offset (no jittering). For many temporal image effects, the camera that is currently rendering needs to be slightly offset from the default projection (that is, the camera is ‘jittered’). If you use motion vectors and camera jittering together, use this property to keep the motion vectors stable between frames.")]
public Matrix NonJitteredProjection
Field Value
Matrix

Pass

The draw passes mask for the current view rendering.

Declaration
[Tooltip("The draw passes mask for the current view rendering.")]
public DrawPass Pass
Field Value
DrawPass

Position

The position of the view.

Declaration
[Tooltip("The position of the view.")]
public Vector3 Position
Field Value
Vector3

PrevProjection

The previous frame projection matrix.

Declaration
[Tooltip("The previous frame projection matrix.")]
public Matrix PrevProjection
Field Value
Matrix

PrevView

The previous frame view matrix.

Declaration
[Tooltip("The previous frame view matrix.")]
public Matrix PrevView
Field Value
Matrix

PrevViewProjection

The previous frame view * projection matrix.

Declaration
[Tooltip("The previous frame view * projection matrix.")]
public Matrix PrevViewProjection
Field Value
Matrix

Projection

The projection matrix.

Declaration
[Tooltip("The projection matrix.")]
public Matrix Projection
Field Value
Matrix

RenderLayersMask

The rendering mask for layers. Used to exclude objects from rendering.

Declaration
[Tooltip("The rendering mask for layers. Used to exclude objects from rendering.")]
public LayersMask RenderLayersMask
Field Value
LayersMask

ScreenSize

The screen size packed (x - width, y - height, zw - inv width, w - inv height). Cached before rendering.

Declaration
[Tooltip("The screen size packed (x - width, y - height, zw - inv width, w - inv height). Cached before rendering.")]
public Vector4 ScreenSize
Field Value
Vector4

ShadowModelLODBias

The model LOD bias. Default is 0. Applied to all the objects in the shadow maps render views. Can be used to improve shadows rendering performance or increase quality.

Declaration
[Tooltip("The model LOD bias. Default is 0. Applied to all the objects in the shadow maps render views. Can be used to improve shadows rendering performance or increase quality.")]
public int ShadowModelLODBias
Field Value
System.Int32

ShadowModelLODDistanceFactor

The model LOD distance scale factor. Default is 1. Applied to all the objects in the shadow maps render views. Higher values increase LODs quality. Can be used to improve shadows rendering performance or increase quality.

Declaration
[Tooltip("The model LOD distance scale factor. Default is 1. Applied to all the objects in the shadow maps render views. Higher values increase LODs quality. Can be used to improve shadows rendering performance or increase quality.")]
public float ShadowModelLODDistanceFactor
Field Value
System.Single

StaticFlagsMask

The static flags mask used to hide objects that don't have a given static flags. Eg. use StaticFlags::Lightmap to render only objects that can use lightmap.

Declaration
[Tooltip("The static flags mask used to hide objects that don't have a given static flags. Eg. use StaticFlags::Lightmap to render only objects that can use lightmap.")]
public StaticFlags StaticFlagsMask
Field Value
StaticFlags

TaaFrameIndex

The Temporal Anti-Aliasing jitter frame index.

Declaration
[Tooltip("The Temporal Anti-Aliasing jitter frame index.")]
public int TaaFrameIndex
Field Value
System.Int32

TemporalAAJitter

The temporal AA jitter packed (xy - this frame jitter, zw - previous frame jitter). Cached before rendering. Zero if TAA is disabled. The value added to projection matrix (in clip space).

Declaration
[Tooltip("The temporal AA jitter packed (xy - this frame jitter, zw - previous frame jitter). Cached before rendering. Zero if TAA is disabled. The value added to projection matrix (in clip space).")]
public Vector4 TemporalAAJitter
Field Value
Vector4

View

The view matrix.

Declaration
[Tooltip("The view matrix.")]
public Matrix View
Field Value
Matrix

ViewInfo

The view information vector with packed components to reconstruct linear depth and view position from the hardware depth buffer. Cached before rendering.

Declaration
[Tooltip("The view information vector with packed components to reconstruct linear depth and view position from the hardware depth buffer. Cached before rendering.")]
public Vector4 ViewInfo
Field Value
Vector4

Methods

CopyFrom(Camera)

Copies render view data from the camera.

Declaration
public void CopyFrom(Camera camera)
Parameters
Camera camera

The camera.

CopyFrom(Camera, ref Viewport)

Copies render view data from the camera.

Declaration
public void CopyFrom(Camera camera, ref Viewport customViewport)
Parameters
Camera camera

The camera.
Viewport customViewport

The custom viewport to use for view/projeection matrices override.

Init()

Initializes this view with default options.

Declaration
public void Init()

SetProjector(Single, Single, Vector3, Vector3, Vector3, Single)

Set up view for projector rendering.

Declaration
public void SetProjector(float nearPlane, float farPlane, Vector3 position, Vector3 direction, Vector3 up, float angle)
Parameters
System.Single nearPlane

Near plane
System.Single farPlane

Far plane
Vector3 position

Camera's position
Vector3 direction

Camera's direction vector
Vector3 up

Camera's up vector
System.Single angle

Camera's FOV angle (in degrees)

SetUp(ref Matrix, ref Matrix)

Initializes render view data.

Declaration
public void SetUp(ref Matrix view, ref Matrix projection)
Parameters
Matrix view

The view.
Matrix projection

The projection.

UpdateCachedData()

Updates the cached data for the view (inverse matrices, etc.).

Declaration
public void UpdateCachedData()

Extension Methods