Back to Filament

ToneMapper

docs/android/dokka/filament-android/com.google.android.filament/-tone-mapper/index.md

1.75.03.0 KB
Original Source

//filament-android/com.google.android.filament/ToneMapper

ToneMapper

open class ToneMapper

Interface for tone mapping operators. A tone mapping operator, or tone mapper, is responsible for compressing the dynamic range of the rendered scene to a dynamic range suitable for display. In Filament, tone mapping is a color grading step. ToneMapper instances are created and passed to the ColorGrading::Builder to produce a 3D LUT that will be used during post-processing to prepare the final color buffer for display. Filament provides several default tone mapping operators that fall into three categories:

  • Configurable tone mapping operators
    • GenericToneMapper
    • AgXToneMapper
  • Fixed-aesthetic tone mapping operators
    • ACESToneMapper
    • ACESLegacyToneMapper
    • FilmicToneMapper
    • PBRNeutralToneMapper
    • GT7ToneMapper
  • Debug/validation tone mapping operators
    • LinearToneMapper
    • DisplayRangeToneMapper

Inheritors

Linear
ACES
ACESLegacy
Filmic
PBRNeutralToneMapper
GT7ToneMapper
Agx
Generic

Types

NameSummary
ACES[main]
open class ACES : ToneMapper
ACES tone mapping operator.
ACESLegacy[main]
open class ACESLegacy : ToneMapper
ACES tone mapping operator, modified to match the perceived brightness of FilmicToneMapper.
Agx[main]
open class Agx : ToneMapper
AgX tone mapping operator.
Filmic[main]
open class Filmic : ToneMapper
"Filmic" tone mapping operator.
Generic[main]
open class Generic : ToneMapper
Generic tone mapping operator that gives control over the tone mapping curve.
GT7ToneMapper[main]
open class GT7ToneMapper : ToneMapper
Gran Turismo 7 tone mapping operator.
Linear[main]
open class Linear : ToneMapper
Linear tone mapping operator that returns the input color but clamped to the 0..1 range.
PBRNeutralToneMapper[main]
open class PBRNeutralToneMapper : ToneMapper
Khronos PBR Neutral tone mapping operator.

Functions

NameSummary
getNativeObject[main]
open fun getNativeObject(): Long