Class Tonemapping

A volume component that holds settings for the Tonemapping effect.

Inheritance
object
Object
ScriptableObject
VolumeComponent
Tonemapping
Implements
Inherited Members
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.Rendering.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
[Serializable]
[VolumeComponentMenuForRenderPipeline("Post-processing/Tonemapping", new Type[] { typeof(HDRenderPipeline) })]
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
[Tooltip("Sets a gamma correction value that HDRP applies to the whole curve.")]
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
[Tooltip("How much of the lookup texture will contribute to the color grading effect.")]
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
[Tooltip("A custom 3D texture lookup table to apply.")]
public Texture3DParameter lutTexture
Field Value
Type Description
Texture3DParameter

mode

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

Declaration
[Tooltip("Specifies the tonemapping algorithm to use for the color grading process.")]
public TonemappingModeParameter mode
Field Value
Type Description
TonemappingModeParameter
See Also

shoulderAngle

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

Declaration
[Tooltip("Controls how much overshoot to add to the shoulder.")]
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
[Tooltip("Sets how many F-stops (EV) to add to the dynamic range of the curve.")]
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
[Tooltip("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.")]
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
[Tooltip("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.")]
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
[Tooltip("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.")]
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
bool

true if the effect should be rendered, false otherwise.

ValidateLUT()

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

Declaration
public bool ValidateLUT()
Returns
Type Description
bool

true if the LUT is valid, false otherwise.

Implements