docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class Bloom

    This class holds settings for the Bloom effect.

    Inheritance
    object
    Object
    ScriptableObject
    PostProcessEffectSettings
    Bloom
    Inherited Members
    PostProcessEffectSettings.active
    PostProcessEffectSettings.enabled
    PostProcessEffectSettings.SetAllOverridesTo(bool, bool)
    PostProcessEffectSettings.GetHash()
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(string)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectOfType<T>()
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: UnityEngine.Rendering.PostProcessing
    Assembly: Unity.Postprocessing.Runtime.dll
    Syntax
    [Serializable]
    public sealed class Bloom : PostProcessEffectSettings

    Fields

    anamorphicRatio

    Distorts the bloom to give an anamorphic look. Negative values distort vertically, positive values distort horizontally.

    Declaration
    [Range(-1, 1)]
    [Tooltip("Distorts the bloom to give an anamorphic look. Negative values distort vertically, positive values distort horizontally.")]
    public FloatParameter anamorphicRatio
    Field Value
    Type Description
    FloatParameter

    clamp

    Clamps pixels to control the bloom amount. This value is expressed in gamma-space.

    Declaration
    [Tooltip("Clamps pixels to control the bloom amount. Value is in gamma-space.")]
    public FloatParameter clamp
    Field Value
    Type Description
    FloatParameter

    color

    The tint of the Bloom filter.

    Declaration
    [ColorUsage(false, true)]
    [Tooltip("Global tint of the bloom filter.")]
    public ColorParameter color
    Field Value
    Type Description
    ColorParameter

    diffusion

    Changes extent of veiling effects in a screen resolution-independent fashion. For maximum quality stick to integer values. Because this value changes the internal iteration count, animating it isn't recommended as it may introduce small hiccups in the perceived radius.

    Declaration
    [Range(1, 10)]
    [Tooltip("Changes the extent of veiling effects. For maximum quality, use integer values. Because this value changes the internal iteration count, You should not animating it as it may introduce issues with the perceived radius.")]
    public FloatParameter diffusion
    Field Value
    Type Description
    FloatParameter

    dirtIntensity

    The amount of lens dirtiness.

    Declaration
    [Min(0)]
    [Tooltip("The intensity of the lens dirtiness.")]
    [DisplayName("Intensity")]
    public FloatParameter dirtIntensity
    Field Value
    Type Description
    FloatParameter

    dirtTexture

    The dirtiness texture to add smudges or dust to the lens.

    Declaration
    [Tooltip("The lens dirt texture used to add smudges or dust to the bloom effect.")]
    [DisplayName("Texture")]
    public TextureParameter dirtTexture
    Field Value
    Type Description
    TextureParameter

    fastMode

    Boost performances by lowering the effect quality.

    Declaration
    [FormerlySerializedAs("mobileOptimized")]
    [Tooltip("Boost performance by lowering the effect quality. This settings is meant to be used on mobile and other low-end platforms but can also provide a nice performance boost on desktops and consoles.")]
    public BoolParameter fastMode
    Field Value
    Type Description
    BoolParameter

    intensity

    The strength of the bloom filter.

    Declaration
    [Min(0)]
    [Tooltip("Strength of the bloom filter. Values higher than 1 will make bloom contribute more energy to the final render.")]
    public FloatParameter intensity
    Field Value
    Type Description
    FloatParameter

    softKnee

    Makes transition between under/over-threshold gradual (0 = hard threshold, 1 = soft threshold).

    Declaration
    [Range(0, 1)]
    [Tooltip("Makes transitions between under/over-threshold gradual. 0 for a hard threshold, 1 for a soft threshold).")]
    public FloatParameter softKnee
    Field Value
    Type Description
    FloatParameter

    threshold

    Filters out pixels under this level of brightness. This value is expressed in gamma-space.

    Declaration
    [Min(0)]
    [Tooltip("Filters out pixels under this level of brightness. Value is in gamma-space.")]
    public FloatParameter threshold
    Field Value
    Type Description
    FloatParameter

    Methods

    IsEnabledAndSupported(PostProcessRenderContext)

    Returns true if the effect is currently enabled and supported.

    Declaration
    public override bool IsEnabledAndSupported(PostProcessRenderContext context)
    Parameters
    Type Name Description
    PostProcessRenderContext context

    The current post-processing render context

    Returns
    Type Description
    bool

    true if the effect is currently enabled and supported

    Overrides
    PostProcessEffectSettings.IsEnabledAndSupported(PostProcessRenderContext)
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)