Class Tonemapping

A volume component that holds settings for the Tonemapping effect.

Inheritance

Object

UnityEngine.Rendering.VolumeComponent

Tonemapping

Inherited Members

UnityEngine.Rendering.VolumeComponent.active

UnityEngine.Rendering.VolumeComponent.OnEnable()

UnityEngine.Rendering.VolumeComponent.OnDisable()

UnityEngine.Rendering.VolumeComponent.Override(UnityEngine.Rendering.VolumeComponent, System.Single)

UnityEngine.Rendering.VolumeComponent.SetAllOverridesTo(System.Boolean)

UnityEngine.Rendering.VolumeComponent.GetHashCode()

UnityEngine.Rendering.VolumeComponent.OnDestroy()

UnityEngine.Rendering.VolumeComponent.Release()

UnityEngine.Rendering.VolumeComponent.displayName

UnityEngine.Rendering.VolumeComponent.parameters

Namespace: UnityEngine.Rendering.HighDefinition

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
UnityEngine.Rendering.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
UnityEngine.Rendering.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 TextureParameter lutTexture

Field Value

Type	Description
UnityEngine.Rendering.TextureParameter

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

TonemappingMode

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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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.