BatchHandlerTriFlat
This render node draws triangles with vertex color in batches.
Constructor
new BatchHandlerTriFlat(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.BatchHandlerConfig | Yes | The configuration object for this handler. |
Scope: static
Extends
Source: src/renderer/webgl/renderNodes/BatchHandlerTriFlat.js#L17
Since: 4.0.0
Inherited Members
From Phaser.Renderer.WebGL.RenderNodes.BatchHandler:
- batchEntries
- bytesPerIndexPerInstance
- bytesPerInstance
- currentBatchEntry
- floatsPerInstance
- indexBuffer
- indicesPerInstance
- instanceCount
- instancesPerBatch
- maxTexturesPerBatch
- programManager
- vertexBufferLayout
- verticesPerInstance
From Phaser.Renderer.WebGL.RenderNodes.RenderNode:
Public Members
nextRenderOptions
nextRenderOptions: object
Description:
The render options currently being built.
Source: src/renderer/webgl/renderNodes/BatchHandlerTriFlat.js#L79
Since: 4.0.0
renderOptions
renderOptions: object
Description:
The current render options to which the batch is built.
These help define the shader.
Source: src/renderer/webgl/renderNodes/BatchHandlerTriFlat.js#L67
Since: 4.0.0
vertexCount
vertexCount: number
Description:
The number of vertices currently in the batch.
Source: src/renderer/webgl/renderNodes/BatchHandlerTriFlat.js#L48
Since: 4.0.0
Inherited Methods
From Phaser.Renderer.WebGL.RenderNodes.BatchHandler:
From Phaser.Renderer.WebGL.RenderNodes.RenderNode:
Public Methods
batch
<instance> batch(currentContext, indexes, vertices, colors, [lighting])
Description:
Add data to the batch.
The data is composed of vertices and indexed triangles.
Each triangle is defined by three indices into the vertices array.
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| currentContext | Phaser.Renderer.WebGL.DrawingContext | No | The current drawing context. | |
| indexes | Array.<number> | No | The index data. Each triangle is defined by three indices into the vertices array, so the length of this should be a multiple of 3. | |
| vertices | Array.<number> | No | The vertices data. Each vertex is defined by an x-coordinate and a y-coordinate. | |
| colors | Array.<number> | No | The color data. Each vertex has a color as a Uint32 value. | |
| lighting | boolean | Yes | false | Should this batch use lighting? |
Overrides: Phaser.Renderer.WebGL.RenderNodes.BatchHandler#batch
Source: src/renderer/webgl/renderNodes/BatchHandlerTriFlat.js#L289
Since: 4.0.0
run
<instance> run(drawingContext)
Description:
Draw then empty the current batch.
This method is called automatically, by either this node or the manager,
when the batch is full, or when something else needs to be rendered.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| drawingContext | Phaser.Renderer.WebGL.DrawingContext | No | The current drawing context. |
Overrides: Phaser.Renderer.WebGL.RenderNodes.BatchHandler#run
Source: src/renderer/webgl/renderNodes/BatchHandlerTriFlat.js#L227
Since: 4.0.0
setupUniforms
<instance> setupUniforms(drawingContext)
Description:
Update the uniforms for the current shader program.
This method is called automatically when the batch is run.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| drawingContext | Phaser.Renderer.WebGL.DrawingContext | No | The current drawing context. |
Source: src/renderer/webgl/renderNodes/BatchHandlerTriFlat.js#L146
Since: 4.0.0