Class Tonemapping

A volume component that holds settings for the Tonemapping effect.

Inheritance
object
Object
ScriptableObject
VolumeComponent
Tonemapping
Implements
Inherited Members
VolumeComponent.active
VolumeComponent.displayName
VolumeComponent.parameters
VolumeComponent.GetHashCode()
VolumeComponent.AnyPropertiesIsOverridden()
VolumeComponent.Release()
VolumeComponent.GetSourceTerm()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate(Object, Scene)
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, IApplyRevertPropertyContextMenuItemProvider, IPostProcessComponent

Fields

acesPreset

Specifies the preset to be used for HDR displays.

Declaration
[Tooltip("Specifies the ACES preset to be used for HDR displays.")]
public HDRACESPresetParameter acesPreset
Field Value
Type Description
HDRACESPresetParameter

detectBrightnessLimits

Whether to use the minimum and maximum brightness values detected from the output device. It might be worth considering calibrating this values manually if the results are not the desired ones.

Declaration
[Tooltip("Whether to use the minimum and maximum brightness values detected from the output device. It might be worth considering calibrating this values manually if the results are not the desired ones.")]
public BoolParameter detectBrightnessLimits
Field Value
Type Description
BoolParameter

detectPaperWhite

Whether to use values detected from the output device as paperwhite. This value will often not lead to equivalent images between SDR and HDR. It is suggested to manually set this value.

Declaration
[Tooltip("Whether to use values detected from the output device as paperwhite. This value will often not lead to equivalent images between SDR and HDR. It is suggested to manually set this value.")]
public BoolParameter detectPaperWhite
Field Value
Type Description
BoolParameter

fallbackMode

Specifies the fallback tonemapping algorithm to use when outputting to an HDR device, when the main mode is not supported.

Declaration
[Tooltip("Specifies the fallback tonemapping algorithm to use when outputting to an HDR device, when the main mode is not supported.")]
public FallbackHDRTonemapParameter fallbackMode
Field Value
Type Description
FallbackHDRTonemapParameter
See Also

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

hueShiftAmount

How much hue we want to preserve. Values closer to 0 try to preserve hue, while as values get closer to 1 hue shifts are reintroduced.

Declaration
[Tooltip("How much hue we want to preserve. Values closer to 0 try to preserve hue, while as values get closer to 1 hue shifts are reintroduced.")]
public ClampedFloatParameter hueShiftAmount
Field Value
Type Description
ClampedFloatParameter

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

maxNits

The maximum brightness (in nits) of the screen. Note that this is assumed to be defined by the preset when ACES Tonemap is used.

Declaration
[Tooltip("The maximum brightness (in nits) of the screen. Note that this is assumed to be defined by the preset when ACES Tonemap is used.")]
public ClampedFloatParameter maxNits
Field Value
Type Description
ClampedFloatParameter

minNits

The minimum brightness (in nits) of the screen. Note that this is assumed to be 0.005f with ACES Tonemap.

Declaration
[Tooltip("The minimum brightness (in nits) of the screen. Note that this is assumed to be 0.005 with ACES Tonemap.")]
public ClampedFloatParameter minNits
Field Value
Type Description
ClampedFloatParameter

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

neutralHDRRangeReductionMode

Specifies the range reduction mode used when HDR output is enabled and Neutral tonemapping is enabled.

Declaration
[Tooltip("Specifies the range reduction mode used when HDR output is enabled and Neutral tonemapping is enabled.")]
public NeutralRangeReductionModeParameter neutralHDRRangeReductionMode
Field Value
Type Description
NeutralRangeReductionModeParameter

paperWhite

The paper white value. It controls how bright a paper white surface should be, it also determines the maximum brightness of UI. The scene is also scaled relative to this value. Value in nits.

Declaration
[Tooltip("It controls how bright a paper white surface should be, it also determines the maximum brightness of UI. The scene is also scaled relative to this value. Value in nits.")]
public ClampedFloatParameter paperWhite
Field Value
Type Description
ClampedFloatParameter

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

useFullACES

Whether to use full ACES tonemap instead of an approximation.

Declaration
[Tooltip("Whether to use full ACES tonemap instead of an approximation. When outputting to an HDR display, full ACES is always used regardless of this checkbox.")]
public BoolParameter useFullACES
Field Value
Type Description
BoolParameter

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