You’re reading the docs for Phaser v4.0.0. The latest is Phaser v4.1.0.

FilterBlocky

Phaser.Renderer.WebGL.RenderNodes.FilterBlocky

This RenderNode renders the Blocky filter effect, which pixelates the rendered output by dividing it into rectangular blocks of a configurable size. Each block is filled with a uniform color sampled from the source texture, producing a retro, low-resolution appearance. The block dimensions and positional offset are driven by the associated Phaser.Filters.Blocky controller. See Phaser.Filters.Blocky.

Constructor

new FilterBlocky(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/FilterBlocky.js#L12
Since: 4.0.0

Inherited Methods

From Phaser.Renderer.WebGL.RenderNodes.BaseFilterShader:

From Phaser.Renderer.WebGL.RenderNodes.RenderNode:


Public Methods

setupUniforms

instancesetupUniforms(controller, drawingContext)

Description:

Sets the WebGL shader uniforms required by the Blocky filter.

Passes the current render target dimensions as resolution, and a combined uSizeAndOffset vector containing the clamped block width, block height, and the x/y positional offset. The block size values are clamped to a minimum of 1 to prevent division-by-zero in the shader.

Parameters:

nametypeoptionaldescription
controllerPhaser.Filters.BlockyNoThe filter controller providing block size and offset values.
drawingContextPhaser.Renderer.WebGL.DrawingContextNoThe current drawing context, used to read the render target dimensions.

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

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


Inherited Members

From Phaser.Renderer.WebGL.RenderNodes.BaseFilterShader:

From Phaser.Renderer.WebGL.RenderNodes.RenderNode: