Class Bloom | Post Processing | 2.3.0
docs.unity3d.com
    Show / Hide Table of Contents

    Class Bloom

    This class holds settings for the Bloom effect.

    Inheritance
    Object
    PostProcessEffectSettings
    Bloom
    Inherited Members
    PostProcessEffectSettings.active
    PostProcessEffectSettings.enabled
    PostProcessEffectSettings.SetAllOverridesTo(Boolean, Boolean)
    PostProcessEffectSettings.GetHash()
    Namespace: UnityEngine.Rendering.PostProcessing
    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
    public FloatParameter anamorphicRatio
    Field Value
    Type Description
    FloatParameter

    clamp

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

    Declaration
    public FloatParameter clamp
    Field Value
    Type Description
    FloatParameter

    color

    The tint of the Bloom filter.

    Declaration
    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
    public FloatParameter diffusion
    Field Value
    Type Description
    FloatParameter

    dirtIntensity

    The amount of lens dirtiness.

    Declaration
    [Min(0F)]
    [DisplayName("Intensity")]
    public FloatParameter dirtIntensity
    Field Value
    Type Description
    FloatParameter

    dirtTexture

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

    Declaration
    [DisplayName("Texture")]
    public TextureParameter dirtTexture
    Field Value
    Type Description
    TextureParameter

    fastMode

    Boost performances by lowering the effect quality.

    Declaration
    public BoolParameter fastMode
    Field Value
    Type Description
    BoolParameter

    intensity

    The strength of the bloom filter.

    Declaration
    [Min(0F)]
    public FloatParameter intensity
    Field Value
    Type Description
    FloatParameter

    softKnee

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

    Declaration
    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(0F)]
    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
    Boolean

    true if the effect is currently enabled and supported

    Overrides
    PostProcessEffectSettings.IsEnabledAndSupported(PostProcessRenderContext)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023