FilterColorMatrix
A RenderNode that applies a Color Matrix filter effect to a Game Object or camera. The color matrix is a 5x4 floating-point matrix that transforms the red, green, blue, and alpha channels of every pixel in the rendered output, enabling visual effects such as grayscale, sepia tone, hue rotation, brightness, contrast, and saturation adjustments.
This node is used internally by the Phaser filter pipeline and is driven by a Phaser.Filters.ColorMatrix controller, which provides the matrix data and alpha values passed as uniforms to the fragment shader.
Constructor
new FilterColorMatrix(manager)
Parameters
| name | type | optional | description |
|---|---|---|---|
| manager | Phaser.Renderer.WebGL.RenderNodes.RenderNodeManager | No | The manager that owns this RenderNode. |
Scope: static
Extends
Source: src/renderer/webgl/renderNodes/filters/FilterColorMatrix.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 Color Matrix filter.
Uploads the 5x4 color matrix data array from the controller's Phaser.Display.ColorMatrix to the uColorMatrix uniform, and the overall alpha multiplier to the uAlpha uniform.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| controller | Phaser.Filters.ColorMatrix | No | The filter controller providing the color matrix and alpha values. |
| drawingContext | Phaser.Renderer.WebGL.DrawingContext | No | The current drawing context. |
Overrides: Phaser.Renderer.WebGL.RenderNodes.BaseFilterShader#setupUniforms
Source: src/renderer/webgl/renderNodes/filters/FilterColorMatrix.js#L39
Since: 4.0.0
Inherited Members
From Phaser.Renderer.WebGL.RenderNodes.BaseFilterShader:
From Phaser.Renderer.WebGL.RenderNodes.RenderNode: