Package 

Class ToneMapper

  • 
public 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
    • Fixed-aesthetic tone mapping operators
    • Debug/validation tone mapping operators
    You can create custom tone mapping operators by subclassing ToneMapper.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public class ToneMapper.Linear

      Linear tone mapping operator that returns the input color but clamped tothe 0..1 range. This operator is mostly useful for debugging.
      public class ToneMapper.ACES

      ACES tone mapping operator. This operator is an implementation of theACES Reference Rendering Transform (RRT) combined with the Output DeviceTransform (ODT) for sRGB monitors (dim surround, 100 nits).
      public class ToneMapper.ACESLegacy

      ACES tone mapping operator, modified to match the perceived brightnessof FilmicToneMapper. This operator is the same as ACESToneMapper butapplies a brightness multiplier of ~1.6 to the input color value totarget brighter viewing environments.
      public class ToneMapper.Filmic

      "Filmic" tone mapping operator. This tone mapper was designed toapproximate the aesthetics of the ACES RRT + ODT for Rec.709and historically Filament's default tone mapping operator. It existsonly for backward compatibility purposes and is not otherwise recommended.
      public class ToneMapper.Generic

      Generic tone mapping operator that gives control over the tone mappingcurve. This operator can be used to control the aesthetics of the finalimage. This operator also allows to control the dynamic range of thescene referred values.The tone mapping curve is defined by 5 parameters:

      • contrast: controls the contrast of the curve
      • midGrayIn: sets the input middle gray
      • midGrayOut: sets the output middle gray
      • hdrMax: defines the maximum input value that will be mapped tooutput white

    • Method Summary

      Modifier and Type Method Description
      long getNativeObject()

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait