Skip to main content
Version: Phaser v4.0.0

FilterBokeh

This RenderNode renders the Bokeh filter effect, which simulates the lens blur and depth-of-field appearance found in photography and film. It supports both a standard circular bokeh blur and a tilt-shift mode, which blurs only the top and bottom regions of the image to create the illusion of a shallow focal plane. The effect is controlled via the associated filter controller. See Phaser.Filters.Bokeh.

Constructor

new FilterBokeh(manager)

Parameters

nametypeoptionaldescription
managerPhaser.Renderer.WebGL.RenderNodes.RenderNodeManagerNoThe manager that owns this RenderNode.

Scope: static

Extends

Phaser.Renderer.WebGL.RenderNodes.BaseFilterShader

Source: src/renderer/webgl/renderNodes/filters/FilterBokeh.js#L12
Since: 4.0.0

Inherited Methods

From Phaser.Renderer.WebGL.RenderNodes.BaseFilterShader:

From Phaser.Renderer.WebGL.RenderNodes.RenderNode:


Public Methods

setupUniforms

<instance> setupUniforms(controller, drawingContext)

Description:

Sets the WebGL shader uniforms required by the Bokeh fragment shader, sourcing values from the filter controller and the current drawing context. This method is called automatically each time the filter is rendered.

Parameters:

nametypeoptionaldescription
controllerPhaser.Filters.BokehNoThe Bokeh filter controller supplying the effect parameters.
drawingContextPhaser.Renderer.WebGL.DrawingContextNoThe current drawing context, used to supply the render resolution.

Overrides: Phaser.Renderer.WebGL.RenderNodes.BaseFilterShader#setupUniforms

Source: src/renderer/webgl/renderNodes/filters/FilterBokeh.js#L37
Since: 4.0.0


Inherited Members

From Phaser.Renderer.WebGL.RenderNodes.BaseFilterShader:

From Phaser.Renderer.WebGL.RenderNodes.RenderNode: