RSX Code Reference
    Preparing search index...

    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 Summary)

    Index
    constructor
    camera effects gizmos renderer
    isGlobal
    assign markAsDirty
    onDirty
    camera: CameraSettings

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

    effects: EffectSettings

    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.

    gizmos: GizmoDrawSettings

    Settings that control gizmo drawing.

    renderer: RendererSettings

    Settings that control fundamental properties of the RSX renderer.

    • get isGlobal(): boolean

      Determines if the settings instance is the global settings that require saving to the UserProjectSettings.

      Returns boolean

    • Copies all properties defined by the prototype of other to this instance.

      Parameters

      • other: Readonly<T>

      Returns void

    • 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.

    onDirty: Event<[ViewportCameraSettings], void>

    Invoked when the settings changed.

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

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods
    Events