Class Bloom

A volume component that holds settings for the Bloom effect.

Inheritance
Object
VolumeComponentWithQuality
Bloom
Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Syntax
public sealed class Bloom : VolumeComponentWithQuality, IPostProcessComponent

Fields

anamorphic

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

Declaration
public BoolParameter anamorphic
Field Value
Type Description
BoolParameter

dirtIntensity

Controls the strength of the lens dirt.

Declaration
public MinFloatParameter dirtIntensity
Field Value
Type Description
MinFloatParameter

dirtTexture

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

Declaration
public TextureParameter dirtTexture
Field Value
Type Description
TextureParameter

intensity

Controls the strength of the bloom filter.

Declaration
public ClampedFloatParameter intensity
Field Value
Type Description
ClampedFloatParameter

scatter

Controls the extent of the veiling effect.

Declaration
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
public MinFloatParameter threshold
Field Value
Type Description
MinFloatParameter

tint

Specifies the tint of the bloom filter.

Declaration
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
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