Class HDROptions

HDR rendering options [[include:Options/HDR.md]]

Hierarchy (View Summary)

OptionLoader<IHDROptions>
- HDROptions

Implements

IHDROptions

Index

Constructors

Properties

enable mode peakNits

Methods

Constructors

constructor

new HDROptions(): HDROptions

Returns HDROptions

Inherited from OptionLoader.constructor

Properties

enable

enable: boolean = true

Whether HDR rendering is enabled

mode

mode: "standard" | "natural" | "vivid" | "cinematic" | "dynamic" | HdrMode = HdrMode.standard

The HDR rendering mode preset, e.g. HdrMode.standard or HdrMode.vivid

peakNits

peakNits: number = defaultPeakNits

The peak brightness in nits for HDR rendering

Methods

`Protected`doLoad

doLoad(data: RecursivePartial<IHDROptions>): void
Parameters
- data: RecursivePartial<IHDROptions>
Returns void
Overrides OptionLoader.doLoad
- Defined in Options/Classes/HDROptions.ts:27

load

load(data?: RecursivePartial<IHDROptions>): void
This load method is used to load data in the classes used as generic
Parameters
- Optionaldata: RecursivePartial<IHDROptions>
  the input options
Returns void
Inherited from OptionLoader.load
- Defined in Utils/OptionLoader.ts:6