Class DiagnosticViewSettings

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

Hierarchy

FrameworkObject
- DiagnosticViewSettings

Index

Constructors

Accessors

blendMode isAnyEnabled isEnabled mode opacity pixelInspection views

Methods

markAsDirty modify

Constructors

`Protected`constructor

new DiagnosticViewSettings(isInternalConstructor?): DiagnosticViewSettings
Parameters
- OptionalisInternalConstructor: boolean
Returns DiagnosticViewSettings
Overrides FrameworkObject.constructor

Accessors

blendMode

get blendMode(): EnumValue<DiagnosticViewBlend, number>
If the mode is set to Overlay, this controls how the overlayed texture would blend with the final output.

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

isAnyEnabled

get isAnyEnabled(): boolean
Whether or not any of the Diagnostics Views is enabled and valid.

Returns boolean
set isAnyEnabled(value): 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): void
Parameters
- value: boolean
Returns void

mode

get mode(): EnumValue<DiagnosticViewMode, number>
Controls the mode of the views. Can be either an overlay or multiple views.

Returns EnumValue<DiagnosticViewMode, number>
set mode(value): void
Parameters
- value: EnumValue<DiagnosticViewMode, number>
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): void
Parameters
- value: number
Returns void

pixelInspection

get pixelInspection(): DiagnosticPixelInspectionSettings
Settings to the pixel inspection.

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

views

get views(): Iterable<DiagnosticView>
A vector of all the possible views.

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

Methods

markAsDirty

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

modify

modify(action): 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.
  - - (): void
    - Returns void
Returns void