FilterGlow
A RenderNode that applies a glow effect around the edges of a Game Object using a WebGL fragment shader. The glow radiates outward from the visible pixels of the source texture, with configurable distance, quality, color, and inner and outer strength. An optional knockout mode renders only the glow itself, hiding the original image beneath it.
This node is used internally by the Phaser.Filters.Glow filter controller. The glow distance and quality are compiled into the shader as preprocessor defines, so changing them causes a shader recompile. Other properties are passed as uniforms and can be updated each frame without recompilation.
See Phaser.Filters.Glow.
Constructor
new FilterGlow(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/FilterGlow.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 glow fragment shader. This includes the render target resolution, the glow color, the outer and inner glow strength, the scale factor, and the knockout flag that controls whether the original image is hidden beneath the glow.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| controller | Phaser.Filters.Glow | No | The Glow filter controller providing the uniform values. |
| drawingContext | Phaser.Renderer.WebGL.DrawingContext | No | The current drawing context, used to read the render target dimensions. |
Overrides: Phaser.Renderer.WebGL.RenderNodes.BaseFilterShader#setupUniforms
Source: src/renderer/webgl/renderNodes/filters/FilterGlow.js#L86
Since: 4.0.0
updateShaderConfig
<instance> updateShaderConfig(controller, drawingContext)
Description:
Updates the shader program's preprocessor defines for glow distance and quality based on the current controller values. Because these parameters are baked into the shader at compile time, changing them replaces the relevant shader additions and triggers a program recompile.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| controller | Phaser.Filters.Glow | No | The Glow filter controller providing the distance and quality values. |
| drawingContext | Phaser.Renderer.WebGL.DrawingContext | No | The current drawing context. |
Overrides: Phaser.Renderer.WebGL.RenderNodes.BaseFilterShader#updateShaderConfig
Source: src/renderer/webgl/renderNodes/filters/FilterGlow.js#L60
Since: 4.0.0
Inherited Members
From Phaser.Renderer.WebGL.RenderNodes.BaseFilterShader:
From Phaser.Renderer.WebGL.RenderNodes.RenderNode: