Class Tonemapping

A volume component that holds settings for the Tonemapping effect.

Inheritance

Object

Tonemapping

Namespace: UnityEngine.Rendering.HighDefinition

Syntax

public sealed class Tonemapping : VolumeComponent, IPostProcessComponent

Fields

gamma

Sets a gamma correction value that HDRP applies to the whole curve. This parameter is only used when Custom is set.

Declaration

public MinFloatParameter gamma

Field Value

Type	Description
MinFloatParameter

lutContribution

How much of the lookup texture will contribute to the color grading effect. This parameter is only used when External is set.

Declaration

public ClampedFloatParameter lutContribution

Field Value

Type	Description
ClampedFloatParameter

lutTexture

A custom 3D texture lookup table to apply. This parameter is only used when External is set.

Declaration

public TextureParameter lutTexture

Field Value

Type	Description
TextureParameter

mode

Specifies the tonemapping algorithm to use for the color grading process.

Declaration

public TonemappingModeParameter mode

Field Value

Type	Description
TonemappingModeParameter

See Also

TonemappingMode

shoulderAngle

Controls how much overshoot to add to the shoulder. This parameter is only used when Custom is set.

Declaration

public ClampedFloatParameter shoulderAngle

Field Value

Type	Description
ClampedFloatParameter

shoulderLength

Sets how many F-stops (EV) to add to the dynamic range of the curve. This parameter is only used when Custom is set.

Declaration

public MinFloatParameter shoulderLength

Field Value

Type	Description
MinFloatParameter

shoulderStrength

Controls the transition between the midsection and the shoulder of the curve. A value of 0 results in no transition and a value of 1 results in a very hard transition. This parameter is only used when Custom is set.

Declaration

public ClampedFloatParameter shoulderStrength

Field Value

Type	Description
ClampedFloatParameter

toeLength

Controls how much of the dynamic range is in the toe. Higher values result in longer toes and therefore contain more of the dynamic range. This parameter is only used when Custom is set.

Declaration

public ClampedFloatParameter toeLength

Field Value

Type	Description
ClampedFloatParameter

toeStrength

Controls the transition between the toe and the mid section of the curve. A value of 0 results in no transition and a value of 1 results in a very hard transition. This parameter is only used when Custom is set.

Declaration

public ClampedFloatParameter toeStrength

Field Value

Type	Description
ClampedFloatParameter

Methods

IsActive()

Tells if the effect needs to be rendered or not.

Declaration

public bool IsActive()

Returns

Type	Description
Boolean	true if the effect should be rendered, false otherwise.

Implements

IPostProcessComponent.IsActive()

ValidateLUT()

Validates the format and size of the LUT texture set in lutTexture.

Declaration

public bool ValidateLUT()

Returns

Type	Description
Boolean	true if the LUT is valid, false otherwise.