Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISelectiveBloomEffectDefinition

Hierarchy

Index

Properties

Properties

type

type: SELECTIVE_BLOOM

The type of this effect.

Optional properties

properties?: { blendFunction?: BlendFunction; ignoreBackground?: boolean; intensity?: number; kernelSize?: KernelSize; luminanceSmoothing?: number; luminanceThreshold?: number; mipmapBlur?: boolean }

Type declaration

  • Optional blendFunction?: BlendFunction

    The blend function of this effect. (default: BlendFunction.ADD)

  • Optional ignoreBackground?: boolean

    Enables or disables if the background is evaluated for the bloom calculation. (default: true)

  • Optional intensity?: number

    The bloom intensity. (default: 1.0)

  • Optional kernelSize?: KernelSize

    The blur kernel size. (default: KernelSize.LARGE)

  • Optional luminanceSmoothing?: number

    Controls the smoothness of the luminance threshold. Range is [0, 1]. (default: 0.025)

  • Optional luminanceThreshold?: number

    The luminance threshold. Raise this value to mask out darker elements in the scene. Range is [0, 1]. (default: 0.9)

  • Optional mipmapBlur?: boolean

    Enables or disables mipmap blur. (default: false)

Optional token

token?: string

The token of the effect, is only returned by the viewer, but ignored as an input.