Class DiagnosticViewSettings

Class that notifies its parent ManagedSettigns or ManagedSubSettings object when one of its members changes.

Index

Constructors

Accessors

blendMode isAnyEnabled isEnabled mode opacity pixelInspection views

Methods

markAsDirty modify

Constructors

`Protected`constructor

new DiagnosticViewSettings(
isInternalConstructor?: boolean,
): DiagnosticViewSettings
Parameters
- OptionalisInternalConstructor: boolean
Returns DiagnosticViewSettings

Overrides FrameworkObject.constructor

Accessors

blendMode

get blendMode(): EnumValue<DiagnosticViewBlend>

If the mode is set to Overlay, this controls how the overlayed texture would blend with the final output.

Returns EnumValue<DiagnosticViewBlend>
set blendMode(value: EnumValue<DiagnosticViewBlend>): void
Parameters
- value: EnumValue<DiagnosticViewBlend>
Returns void

isAnyEnabled

get isAnyEnabled(): boolean

Whether or not any of the Diagnostics Views is enabled and valid.

Returns boolean
set isAnyEnabled(value: boolean): void
Parameters
- value: boolean
Returns void

isEnabled

get isEnabled(): boolean

Whether or not this Render Settings should capture all the available Diagnostics Views.

Returns boolean
set isEnabled(value: boolean): void
Parameters
- value: boolean
Returns void

mode

get mode(): EnumValue<DiagnosticViewMode>

Controls the mode of the views. Can be either an overlay or multiple views.

Returns EnumValue<DiagnosticViewMode>
set mode(value: EnumValue<DiagnosticViewMode>): void
Parameters
- value: EnumValue<DiagnosticViewMode>
Returns void

opacity

get opacity(): number

If the mode is set to Overlay, then this controls the opacity of the overlayed texture.

Returns number
set opacity(value: number): void
Parameters
- value: number
Returns void

pixelInspection

get pixelInspection(): DiagnosticPixelInspectionSettings

Settings to the pixel inspection.

Returns DiagnosticPixelInspectionSettings
set pixelInspection(value: DiagnosticPixelInspectionSettings): void
Parameters
- value: DiagnosticPixelInspectionSettings
Returns void

views

get views(): Iterable<DiagnosticView>

A vector of all the possible views.

Returns Iterable<DiagnosticView>
set views(value: Iterable<DiagnosticView> | readonly DiagnosticView[]): void
Parameters
- value: Iterable<DiagnosticView> | readonly DiagnosticView[]
Returns void

Methods

markAsDirty

markAsDirty(dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>): void
Marks the object as dirty.
Parameters
- dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>
  Flags specifying what kind of member was changed.
Returns void

modify

modify(action: () => void): void
Allows modifying this object multiple times in a row in a scope, without marking the object dirty immediately. Dirty flags are accumulated and the object is marked dirty at the end.
Parameters
- action: () => void
  The scope where the object is modified.
Returns void