Class Bloom

A volume component that holds settings for the Bloom effect.

Inheritance
object
Object
ScriptableObject
VolumeComponent
VolumeComponentWithQuality
Bloom
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/Bloom", new Type[] { typeof(HDRenderPipeline) })]
public sealed class Bloom : VolumeComponentWithQuality, IApplyRevertPropertyContextMenuItemProvider, IPostProcessComponent

Fields

anamorphic

When enabled, bloom stretches horizontally depending on the current physical Camera's Anamorphism property value.

Declaration
[Tooltip("When enabled, bloom stretches horizontally depending on the current physical Camera's Anamorphism property value.")]
public BoolParameter anamorphic
Field Value
Type Description
BoolParameter

dirtIntensity

Controls the strength of the lens dirt.

Declaration
[Tooltip("Controls the strength of the lens dirt.")]
public MinFloatParameter dirtIntensity
Field Value
Type Description
MinFloatParameter

dirtTexture

Specifies a Texture to add smudges or dust to the bloom effect.

Declaration
[Header("Lens Dirt")]
[Tooltip("Specifies a Texture to add smudges or dust to the bloom effect.")]
public Texture2DParameter dirtTexture
Field Value
Type Description
Texture2DParameter

intensity

Controls the strength of the bloom filter.

Declaration
[Tooltip("Controls the strength of the bloom filter.")]
public ClampedFloatParameter intensity
Field Value
Type Description
ClampedFloatParameter

scatter

Controls the extent of the veiling effect.

Declaration
[Tooltip("Set the radius of the bloom effect")]
public ClampedFloatParameter scatter
Field Value
Type Description
ClampedFloatParameter

threshold

Set the level of brightness to filter out pixels under this level. This value is expressed in gamma-space. A value above 0 will disregard energy conservation rules.

Declaration
[Header("Bloom")]
[Tooltip("Set the level of brightness to filter out pixels under this level. This value is expressed in gamma-space. A value above 0 will disregard energy conservation rules.")]
public MinFloatParameter threshold
Field Value
Type Description
MinFloatParameter

tint

Specifies the tint of the bloom filter.

Declaration
[Tooltip("Use the color picker to select a color for the Bloom effect to tint to.")]
public ColorParameter tint
Field Value
Type Description
ColorParameter

Properties

highQualityFiltering

When enabled, bloom uses bicubic sampling instead of bilinear sampling for the upsampling passes.

Declaration
public bool highQualityFiltering { get; set; }
Property Value
Type Description
bool

highQualityPrefiltering

When enabled, bloom uses multiple bilinear samples for the prefiltering pass.

Declaration
public bool highQualityPrefiltering { get; set; }
Property Value
Type Description
bool

resolution

Specifies the resolution at which HDRP processes the effect.

Declaration
public BloomResolution resolution { get; set; }
Property Value
Type Description
BloomResolution
See Also

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.

Implements