Class CanvasRenderMode

The canvas rendering modes.

System.Object
CanvasRenderMode
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
public sealed class CanvasRenderMode : Enum

Fields

CameraSpace

The camera space rendering mode that places Canvas in a given distance in front of a specified Camera. The UI elements are rendered by this camera, which means that the Camera settings affect the appearance of the UI. If the Camera is set to Perspective, the UI elements will be rendered with perspective, and the amount of perspective distortion can be controlled by the Camera Field of View. If the screen is resized, changes resolution, or the camera frustum changes, the Canvas will automatically change size to match as well.

Declaration
public const CanvasRenderMode CameraSpace
Field Value
CanvasRenderMode

ScreenSpace

The screen space rendering mode that places UI elements on the screen rendered on top of the scene. If the screen is resized or changes resolution, the Canvas will automatically change size to match this.

Declaration
public const CanvasRenderMode ScreenSpace
Field Value
CanvasRenderMode

value__

Declaration
public int value__
Field Value
System.Int32

WorldSpace

The world space rendering mode that places Canvas as any other object in the scene. The size of the Canvas can be set manually using its Transform, and UI elements will render in front of or behind other objects in the scene based on 3D placement. This is useful for UIs that are meant to be a part of the world. This is also known as a 'diegetic interface'.

Declaration
public const CanvasRenderMode WorldSpace
Field Value
CanvasRenderMode

WorldSpaceFaceCamera

The world space rendering mode that places Canvas as any other object in the scene and orients it to face the camera. The size of the Canvas can be set manually using its Transform, and UI elements will render in front of or behind other objects in the scene based on 3D placement. This is useful for UIs that are meant to be a part of the world. This is also known as a 'diegetic interface'.

Declaration
public const CanvasRenderMode WorldSpaceFaceCamera
Field Value
CanvasRenderMode

Extension Methods