User Manual

Camera

The Camera component enables an entity to render a scene from a certain viewpoint.

The Camera component can be enabled or disabled using the toggle in the top right of the component panel. If enabled, the camera will render the scene every frame.

Camera component

Properties

PropertyDescription
Clear BuffersControls how the camera's render target is cleared before rendering each frame. The camera maintains two types of buffer: the color buffer which stores the visible image and a depth buffer that stores information about the distance of a rendered pixel in relation to the position of the camera. The buffers can be cleared independently:
  • Color: If selected, the camera will explicitly clear its render target to the chosen clear color before rendering the scene.
  • Depth: If selected, the camera will explicitly clear the depth buffer of its render target before rendering the scene.
Clear ColorThe color used to clear the camera's render target. This property is only displayed if 'Clear Color Buffer' is selected.
ProjectionThe projection type of the camera. Options are:
  • Perspective
  • Orthographic
Frustum CullingIf selected, the camera will only render mesh instances whose axis-aligned bounding boxes intersect with the camera's view frustum. Otherwise, the entire scene will be rendered regardless of visibility.
Field of ViewThe angle between top and bottom clip planes of a perspective camera. This property is only displayed if 'Projection' is set to 'Perspective'.
Ortho HeightThe distance in world units between the top and bottom clip planes of an orthographic camera. This property is only displayed if 'Projection' is set to 'Orthographic'.
Near ClipThe distance in camera space from the camera's eye point to the near clip plane.
Far ClipThe distance in camera space from the camera's eye point to the far clip plane.
PriorityA number that defines the order in which camera views are rendered by the engine. Smaller numbers are rendered first.
ViewportA rectangle that specifies the viewport onto the camera's attached render target. This allows you to implement features like split-screen or picture-in-picture. It is defined by normalised coordinates (0 to 1) in the following format:
  • x: The lower left x coordinate
  • y: The lower left y coordinate
  • w: The width of the rectangle
  • h: The height of the rectangle

Scripting Interface

You can control a Camera component's properties using a script component. The Camera component's scripting interface is here.