Class BloomEffect

constructor

• new BloomEffect(initial?: Partial<BloomParams>): BloomEffect

  Parameters

  • initial: Partial<BloomParams> = {}

  Returns BloomEffect

params

dispose

• dispose(): void

  Returns void

init

• init(ctx: EffectContext): void

  Parameters

  • ctx: EffectContext

  Returns void

outputRect

• outputRect(dims: EffectDims): readonly [number, number, number, number]

  The rect this stage draws into, as [x, y, w, h].

  Coordinates are in physical pixels, relative to the element, with
  the origin at the bottom-left.

  Omit this method (or return undefined) when the effect does not
  change the size of the content, such as a grayscale or invert
  filter. The stage then draws into the same rect as its input.

  Some common rects to return:

  • dims.contentRect — just the element, with no extra space.
  • The element plus px extra pixels on every side, for effects
    like blur, glow, or drop shadow:
    [-px, -px, elementPixel[0] + 2 * px, elementPixel[1] + 2 * px].
  • dims.canvasRect — the whole canvas, including the
    scrollPadding area around the viewport.

  Each stage picks its own rect. If one stage returns 100×100 and
  the next returns 50×50, those are the sizes used; rects do not
  grow as the chain runs.

  Parameters

  • dims: EffectDims

  Returns readonly [number, number, number, number]

render

• render(ctx: EffectContext): void

  Render phase. Omit to make this effect transparent in the chain.

  Parameters

  • ctx: EffectContext

  Returns void

setParams

• setParams(partial: Partial<BloomParams>): void

  Parameters

  • partial: Partial<BloomParams>

  Returns void