Class ImageViewerDisplaySettings

A struct to define the settings of the displayed image.

Hierarchy (view full)

Constructors

Properties

checkerboardBackground: boolean

Whether the image viewer should display a checkerboard background behind the main image.

face: number

The current face being displayed. Only relevant if texture is cubemap.

Settings flags for the Image Viewer

linearFiltering: boolean

Whether the image viewer should use linear filtering.

mipLevel: number

The current Mip Map being displayed.

The size of the aperture of the pixel inspector. Zero if disabled.

selectedChannel: number

A UI handle for the current selected color channel to be displayed.

textureSettings: TextureRenderSettings

The current selected color channel to be displayed.

The tiling options of the Image Viewer.

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

Invoked when the settings changed.

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