Skip to main content
Version: Phaser v4.0.0-rc.6

ShaderQuad

A RenderNode that renders a quad using a shader program.

This is used for custom rendering effects and post-processing.

Constructor

new ShaderQuad(manager, config)

Parameters

nametypeoptionaldescription
managerPhaser.Renderer.WebGL.RenderNodes.RenderNodeManagerNoThe manager that owns this RenderNode.
configPhaser.Types.GameObjects.Shader.ShaderQuadConfigNoThe configuration object for this RenderNode.

Scope: static

Extends

Phaser.Renderer.WebGL.RenderNodes.RenderNode

Source: src/renderer/webgl/renderNodes/ShaderQuad.js#L15
Since: 4.0.0

Inherited Members

From Phaser.Renderer.WebGL.RenderNodes.RenderNode:


Public Members

_texturerProxy

_texturerProxy: object

Description:

An object which acts as a proxy for textures in the transformer.

Source: src/renderer/webgl/renderNodes/ShaderQuad.js#L122
Since: 4.0.0


indexBuffer

indexBuffer: Phaser.Renderer.WebGL.Wrappers.WebGLBufferWrapper

Description:

The index buffer defining vertex order.

Source: src/renderer/webgl/renderNodes/ShaderQuad.js#L53
Since: 4.0.0


programManager

programManager: Phaser.Renderer.WebGL.ProgramManager

Description:

The program manager used to create and manage shader programs.

This contains shader variants.

Source: src/renderer/webgl/renderNodes/ShaderQuad.js#L78
Since: 4.0.0


renderer

renderer: Phaser.Renderer.WebGL.WebGLRenderer

Description:

The WebGLRenderer in use.

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


setUniform

setUniform: function

Description:

The uniform callback used to set uniforms on the shader program.

Source: src/renderer/webgl/renderNodes/ShaderQuad.js#L104
Since: 4.0.0


transformerNode

transformerNode: Phaser.Renderer.WebGL.RenderNodes.TransformerImage

Description:

The transformer node used to transform the quad for rendering.

Source: src/renderer/webgl/renderNodes/ShaderQuad.js#L113
Since: 4.0.0


vertexBufferLayout

vertexBufferLayout: Phaser.Renderer.WebGL.Wrappers.WebGLVertexBufferLayoutWrapper

Description:

The vertex buffer layout for this RenderNode.

This consists of 4 bytes, 0-3, forming corners of a quad instance.

Source: src/renderer/webgl/renderNodes/ShaderQuad.js#L62
Since: 4.0.0


Inherited Methods

From Phaser.Renderer.WebGL.RenderNodes.RenderNode:


Public Methods

updateShaderConfig

<instance> updateShaderConfig(drawingContext, gameObject, renderNode)

Description:

Updates the shader configuration for the current render pass.

This is called before the shader is rendered.

This method is a hook for custom shader configurations.

You should override it if you need to adjust shader additions

after initialization.

Parameters:

nametypeoptionaldescription
drawingContextPhaser.Renderer.WebGL.DrawingContextNoThe current drawing context.
gameObjectPhaser.GameObjects.GameObjectNoThe GameObject being rendered.
renderNodePhaser.Renderer.WebGL.RenderNodes.ShaderQuadNoThe RenderNode being rendered.

Source: src/renderer/webgl/renderNodes/ShaderQuad.js#L344
Since: 4.0.0