Class Bloom

A volume component that holds settings for the Bloom effect.

Inheritance
Object
UnityEngine.Rendering.VolumeComponent
VolumeComponentWithQuality
Bloom
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]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@10.3/manual/Post-Processing-Bloom.html")]
public sealed class Bloom : VolumeComponentWithQuality, 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
UnityEngine.Rendering.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
UnityEngine.Rendering.MinFloatParameter

dirtTexture

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

Declaration
[Tooltip("Specifies a Texture to add smudges or dust to the bloom effect.")]
public TextureParameter dirtTexture
Field Value
Type Description
UnityEngine.Rendering.TextureParameter

intensity

Controls the strength of the bloom filter.

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

scatter

Controls the extent of the veiling effect.

Declaration
[Tooltip("Controls the extent of the veiling effect.")]
public ClampedFloatParameter scatter
Field Value
Type Description
UnityEngine.Rendering.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
[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
UnityEngine.Rendering.MinFloatParameter

tint

Specifies the tint of the bloom filter.

Declaration
[Tooltip("Specifies the tint of the bloom filter.")]
public ColorParameter tint
Field Value
Type Description
UnityEngine.Rendering.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
Boolean

highQualityPrefiltering

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

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

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
Boolean

true if the effect should be rendered, false otherwise.
Implements