phaser - v3.90.0
    Preparing search index...

    The Bokeh FX Controller.

    This FX controller manages the bokeh effect for a Game Object.

    Bokeh refers to a visual effect that mimics the photographic technique of creating a shallow depth of field. This effect is used to emphasize the game's main subject or action, by blurring the background or foreground elements, resulting in a more immersive and visually appealing experience. It is achieved through rendering techniques that simulate the out-of-focus areas, giving a sense of depth and realism to the game's graphics.

    This effect can also be used to generate a Tilt Shift effect, which is a technique used to create a miniature effect by blurring everything except a small area of the image. This effect is achieved by blurring the top and bottom elements, while keeping the center area in focus.

    A Bokeh effect is added to a Game Object via the FX component:

    const sprite = this.add.sprite();

    sprite.preFX.addBokeh();
    sprite.postFX.addBokeh();

    Hierarchy (View Summary)

    Index

    Constructors

    • Parameters

      • gameObject: GameObject

        A reference to the Game Object that has this fx.

      • Optionalradius: number

        The radius of the bokeh effect. Default 0.5.

      • Optionalamount: number

        The amount of the bokeh effect. Default 1.

      • Optionalcontrast: number

        The color contrast of the bokeh effect. Default 0.2.

      • OptionalisTiltShift: boolean

        Is this a bokeh or Tile Shift effect? Default false.

      • OptionalblurX: number

        If Tilt Shift, the amount of horizontal blur. Default 1.

      • OptionalblurY: number

        If Tilt Shift, the amount of vertical blur. Default 1.

      • Optionalstrength: number

        If Tilt Shift, the strength of the blur. Default 1.

      Returns Bokeh

    Properties

    active: boolean

    Toggle this boolean to enable or disable this effect, without removing and adding it from the Game Object.

    Only works for Pre FX.

    Post FX are always active.

    amount: number

    The amount, or strength, of the bokeh effect. Defaults to 1.

    blurX: number

    If a Tilt Shift effect this controls the amount of horizontal blur.

    Setting this value on a non-Tilt Shift effect will have no effect.

    blurY: number

    If a Tilt Shift effect this controls the amount of vertical blur.

    Setting this value on a non-Tilt Shift effect will have no effect.

    contrast: number

    The color contrast, or brightness, of the bokeh effect. Defaults to 0.2.

    gameObject: GameObject

    A reference to the Game Object that owns this effect.

    isTiltShift: boolean

    Is this a Tilt Shift effect or a standard bokeh effect?

    radius: number

    The radius of the bokeh effect.

    This is a float value, where a radius of 0 will result in no effect being applied, and a radius of 1 will result in a strong bokeh. However, you can exceed this value for even stronger effects.

    strength: number

    If a Tilt Shift effect this controls the strength of the blur.

    Setting this value on a non-Tilt Shift effect will have no effect.

    type: number

    The FX_CONST type of this effect.

    Methods

    • Destroys this FX Controller.

      Returns void

    • Sets the active state of this FX Controller.

      A disabled FX Controller will not be updated.

      Parameters

      • value: boolean

        true to enable this FX Controller, or false to disable it.

      Returns this