Class ViewportCameraSettings

The ViewportCameraSettings contains settings used for a ViewportCamera. Typically a ViewportCamera is used to provide an interactive camera in a UIViewportRenderer.

Hierarchy (view full)

Constructors

Properties

Accessors

Methods

Events

Constructors

Properties

Settings that control camera parameters such as the projection mode or the field-of-view.

Settings that control (post-processing) effects for the camera. The settings determine how the renderer processes the camera, which effects will be enabled, and what properties will those effects use.

Settings that control gizmo drawing.

Settings that control fundamental properties of the RSX renderer.

Accessors

  • get isGlobal(): boolean
  • Determines if the settings instance is the global settings that require saving to the UserProjectSettings.

    Returns boolean

Methods

  • Marks the settings as dirty and invokes the onDirty event handler.

    Returns void

    This method should be invoked after making a change, so subsystems such as a viewport cna be updated. If the settings are the shared editor settings, the editor settings will be marked for autosave.

Events

onDirty: Event<[ViewportCameraSettings], void>

Invoked when the settings changed.

This is an internal event. Do not subscribe directly to it, use UserProjectSettings.onSettingsChanged.