phaser - v4.0.0-rc.4
    Preparing search index...

    Class Bokeh

    The Bokeh Filter Controller.

    This filter controller manages the bokeh effect for a Camera.

    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 Camera via the FilterList component:

    const camera = this.cameras.main;

    camera.filters.internal.addBokeh();
    camera.filters.external.addBokeh();

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    active allowBaseDraw amount blurX blurY camera contrast currentPadding ignoreDestroy isTiltShift paddingOverride radius renderNode strength

    Methods

    destroy getPadding setActive setPaddingOverride

    Constructors

    • Parameters

      • camera: Cameras.Scene2D.Camera

        The Camera that owns this filter.

      • 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 filter, without removing and adding it from the Game Object.

    allowBaseDraw: boolean

    If true, this filter will be permitted to draw to the base texture. This can be unwanted if, for example, the filter doesn't actually draw anything.

    This is an internal flag used by the renderer. You should not modify this value directly.

    amount: number

    The amount, or strength, of the bokeh effect.

    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.

    camera: Cameras.Scene2D.Camera

    A reference to the Camera that owns this filter.

    contrast: number

    The color contrast, or brightness, of the bokeh effect.

    currentPadding: Geom.Rectangle

    The padding currently being used by this filter. This is set and used during rendering using getPadding. It is necessary for filters being used in an external list. You should not modify this value directly.

    ignoreDestroy: boolean

    Whether this filter controller will be destroyed when the FilterList that owns it is destroyed. If you enable this, you must ensure that you clean up the filter controller at an appropriate time. This allows you to reuse a controller for multiple objects; this is not recommended unless you know what you're doing. It tends to work best with external filters.

    isTiltShift: boolean

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

    paddingOverride: Geom.Rectangle

    Padding override. This is on by default. If this is set, the filter will use this padding instead of calculating it. Prefer using setPaddingOverride instead of modifying this directly.

    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.

    renderNode: string

    The ID of the RenderNode that this filter uses.

    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.

    Methods

    • Returns the padding required for this filter, and sets currentPadding to the result. Most filters don't need extra padding, but some might sample beyond the texture size, such as a blur.

      The bounds are encoded as a Rectangle. To enlarge the bounds, the top and left values should be negative, and the bottom and right values should be positive.

      Returns Geom.Rectangle

    • Sets the active state of this filter.

      A disabled filter will not be used.

      Parameters

      • value: boolean

        true to enable this filter, or false to disable it.

      Returns this

    • Sets the padding override. If this is set, the filter will use this padding instead of calculating them. it Call setPaddingOverride(null) to clear the override. Call setPaddingOverride() to set the padding to 0.

      Parameters

      • Optionalleft: number

        The top padding. Default 0.

      • Optionaltop: number

        The top padding. Default 0.

      • Optionalright: number

        The right padding. Default 0.

      • Optionalbottom: number

        The bottom padding. Default 0.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods