SubmitterQuad
The SubmitterQuad RenderNode submits data for rendering a single Image-like GameObject.
It uses a BatchHandler to render the image as part of a batch.
This node receives the drawing context, game object, and parent matrix.
It also receives the texturer, tinter, and transformer nodes
from the node that invoked it.
This allows the behavior to be configured by setting the appropriate nodes
on the GameObject for individual tweaks, or on the invoking Renderer node
for global changes.
Constructor
new SubmitterQuad(manager, [config])
Parameters
| name | type | optional | description |
|---|---|---|---|
| manager | Phaser.Renderer.WebGL.RenderNodes.RenderNodeManager | No | The manager that owns this RenderNode. |
| config | Phaser.Types.Renderer.WebGL.RenderNodes.SubmitterQuadConfig | Yes | The configuration object for this RenderNode. |
Scope: static
Extends
Source: src/renderer/webgl/renderNodes/submitter/SubmitterQuad.js#L14
Since: 4.0.0
Inherited Members
From Phaser.Renderer.WebGL.RenderNodes.RenderNode:
Public Members
batchHandler
batchHandler: string
Description:
The key of the RenderNode used to render data.
Source: src/renderer/webgl/renderNodes/submitter/SubmitterQuad.js#L43
Since: 4.0.0
defaultConfig
defaultConfig: Phaser.Types.Renderer.WebGL.RenderNodes.SubmitterQuadConfig
Description:
The default configuration for this RenderNode.
Source: src/renderer/webgl/renderNodes/submitter/SubmitterQuad.js#L85
Inherited Methods
From Phaser.Renderer.WebGL.RenderNodes.RenderNode:
Public Methods
run
<instance> run(drawingContext, gameObject, parentMatrix, element, texturerNode, transformerNode, [tinterNode], [normalMap], [normalMapRotation])
Description:
Submit data for rendering.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| drawingContext | Phaser.Renderer.WebGL.DrawingContext | No | The current drawing context. |
| gameObject | Phaser.GameObjects.GameObject | No | The GameObject being rendered. |
| parentMatrix | Phaser.GameObjects.Components.TransformMatrix | No | The parent matrix of the GameObject. |
| element | object | No | The specific element within the game object. This is used for objects that consist of multiple quads. |
| texturerNode | Phaser.Renderer.WebGL.RenderNodes.RenderNode | No | The texturer node used to texture the GameObject. You may pass a TexturerImage node or an object containing equivalent data without a run method. |
| transformerNode | Phaser.Renderer.WebGL.RenderNodes.RenderNode | Object | No | The transformer node used to transform the GameObject. You may pass a transformer node or an object with a quad property. |
| tinterNode | Phaser.Renderer.WebGL.RenderNodes.RenderNode, Omit.<Phaser.Renderer.WebGL.RenderNodes.RenderNode, 'run'> | Yes | The tinter node used to tint the GameObject. You may pass a tinter node or an object containing equivalent data without a run method. If omitted, Image-style tinting will be used. |
| normalMap | Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper | Yes | The normal map texture to use for lighting. If omitted, the normal map texture of the GameObject will be used, or the default normal map texture of the renderer. |
| normalMapRotation | number | Yes | The rotation of the normal map texture. If omitted, the rotation of the GameObject will be used. |
Overrides: Phaser.Renderer.WebGL.RenderNodes.RenderNode#run
Source: src/renderer/webgl/renderNodes/submitter/SubmitterQuad.js#L97
Since: 4.0.0