Class Tonemap

Readonlyview

applied

• get applied(): boolean

  Gets if Tonemap settings are currently applied.

  This is true when the component enabled state is in the component enabled state. When false, the tonemap pass runs as an identity copy.

  Returns boolean

enabled

• get enabled(): boolean

  Returns boolean

• set enabled(value: boolean): void

  Parameters

  • value: boolean

  Returns void

exposure

• get exposure(): number

  Linear multiplier applied before tonemapping. Default 0.5.

  Returns number
• set exposure(value: number): void

  Parameters

  • value: number

  Returns void

mode

• get mode(): TonemapMode

  Tonemap curve. Default "aces".

  Returns TonemapMode
• set mode(value: TonemapMode): void

  Parameters

  • value: TonemapMode

  Returns void

renderScale

• get renderScale(): number

  Supersampling factor (1.0 = off, 2.0 = 4× fragment work). Default 1.0.

  Returns number
• set renderScale(value: number): void

  Parameters

  • value: number

  Returns void

sRGBEncode

• get sRGBEncode(): boolean

  Whether to gamma-encode the final colour. Default true.

  Returns boolean
• set sRGBEncode(value: boolean): void

  Parameters

  • value: boolean

  Returns void

fromParams

• fromParams(params: TonemapParams): SDKResult<any>

  Configures this Tonemap.

  Parameters

  • params: TonemapParams

  Returns SDKResult<any>

toParams

• toParams(): SDKResult<TonemapParams>

  Gets this Tonemap as JSON.

  Returns SDKResult<TonemapParams>