Class Bloom

Constructors

constructor

Methods

createBloomExpression destroy3DAPIResources

Constructors

constructor

Methods

createBloomExpression

  • createBloomExpression(params): {
        bloomExpression: Expression;
        bloomedRenderTarget: RenderTargetTexture;
    }

  • Creates a complete bloom effect expression with all required render passes.

    The bloom effect consists of three main stages:

    1. Detect high luminance areas in the input texture
    2. Apply multiple levels of Gaussian blur to create a glow effect
    3. Synthesize the original texture with the blurred high luminance areas

    Parameters

    • params: {
          parameters: {
              gaussianBlurLevelHighLuminance?: number;
              gaussianKernelSize?: number;
              gaussianVariance?: number;
              luminanceCriterion?: number;
              synthesizeCoefficient?: [number, number, number, number, number, number];
          };
          textureToBloom: AbstractTexture;
      }

      Configuration object for the bloom effect

      • parameters: {
            gaussianBlurLevelHighLuminance?: number;
            gaussianKernelSize?: number;
            gaussianVariance?: number;
            luminanceCriterion?: number;
            synthesizeCoefficient?: [number, number, number, number, number, number];
        }

        Bloom effect parameters

        • OptionalgaussianBlurLevelHighLuminance?: number
        • OptionalgaussianKernelSize?: number
        • OptionalgaussianVariance?: number
        • OptionalluminanceCriterion?: number
        • OptionalsynthesizeCoefficient?: [number, number, number, number, number, number]
      • textureToBloom: AbstractTexture

        The source texture to apply bloom effect to

    Returns {
        bloomExpression: Expression;
        bloomedRenderTarget: RenderTargetTexture;
    }

    Object containing the bloom expression and the final render target texture

destroy3DAPIResources

  • destroy3DAPIResources(): void

  • Destroys all 3D API resources used by this Bloom instance.

    This method cleans up all cached framebuffers and their associated GPU resources. It should be called when the Bloom instance is no longer needed to prevent memory leaks and properly release graphics resources.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods