filament/io.github.erkko68.filament/ColorGrading/Builder

Builder

Builder for creating ColorGrading instances.

Configure color grading settings such as exposure, contrast, saturation, and tone mapping, then call build() to create the ColorGrading object.

Constructors

constructor()

Functions

fun build(engine: Engine): ColorGrading

Creates the ColorGrading object.

fun channelMixer(outRed: FloatArray, outGreen: FloatArray, outBlue: FloatArray): ColorGrading.Builder

Sets the channel mixer to adjust individual color channels.

fun contrast(contrast: Float): ColorGrading.Builder

Sets the contrast adjustment.

fun curves(shadowGamma: FloatArray, midPoint: FloatArray, highlightScale: FloatArray): ColorGrading.Builder

Sets curve adjustments for shadows, midtones, and highlights.

fun customLut(data: FloatArray, dimension: Int): ColorGrading.Builder

Specifies a custom 3D color grading LUT to map the final sRGB color, applied after post-processing in LDR (sRGB space).

fun dimensions(dim: Int): ColorGrading.Builder

Sets the dimensions of the color grading LUT (3D cube side length).

fun exposure(exposure: Float): ColorGrading.Builder

Adjusts the exposure of the image in exposure value (EV) stops.

fun fastMath(fastMath: Boolean): ColorGrading.Builder

Enables or disables fast math approximations.

fun format(format: ColorGrading.LutFormat): ColorGrading.Builder

Sets the format of the color grading LUT.

fun gamutMapping(gamutMapping: Boolean): ColorGrading.Builder

Enables or disables gamut mapping.

luminanceScaling

fun luminanceScaling(luminanceScaling: Boolean): ColorGrading.Builder

Enables or disables luminance scaling.

nightAdaptation

fun nightAdaptation(adaptation: Float): ColorGrading.Builder

Controls the amount of night adaptation to replicate low-light vision.

outputColorSpace

fun outputColorSpace(colorSpace: ColorSpace): ColorGrading.Builder

Sets the color space the graded color is converted to (default: Rec709-sRGB-D65). Only Rec709-sRGB-D65 and Rec709-Linear-D65 are supported, and only the transfer function is taken into account.

fun quality(qualityLevel: ColorGrading.QualityLevel): ColorGrading.Builder

Sets the quality level of the color grading LUT.

fun saturation(saturation: Float): ColorGrading.Builder

Sets the saturation adjustment.

shadowsMidtonesHighlights

fun shadowsMidtonesHighlights(shadows: FloatArray, midtones: FloatArray, highlights: FloatArray, ranges: FloatArray): ColorGrading.Builder

Sets shadows, midtones, and highlights adjustments.

slopeOffsetPower

fun slopeOffsetPower(slope: FloatArray, offset: FloatArray, power: FloatArray): ColorGrading.Builder

Sets slope, offset, and power adjustments (ASC CDL).

fun toneMapper(toneMapper: ToneMapper): ColorGrading.Builder

Sets the tone mapper to use for tone mapping.

fun vibrance(vibrance: Float): ColorGrading.Builder

Sets the vibrance adjustment (selective saturation).

fun whiteBalance(temperature: Float, tint: Float): ColorGrading.Builder

Adjusts the white balance of the image to remove color casts or for artistic purposes.