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

SubmitterTilemapGPULayer

The SubmitterTilemapGPULayer RenderNode handles rendering of

TilemapGPULayer objects.

It is a Stand Alone Render, meaning that it does not batch.

Constructor

new SubmitterTilemapGPULayer(manager, [config])

Parameters

nametypeoptionaldescription
managerPhaser.Renderer.WebGL.RenderNodes.RenderNodeManagerNoThe manager that owns this RenderNode.
configPhaser.Types.Renderer.WebGL.RenderNodes.BatchHandlerConfigYesThe configuration object for this handler.

Scope: static

Extends

Phaser.Renderer.WebGL.RenderNodes.RenderNode

Source: src/renderer/webgl/renderNodes/submitter/SubmitterTilemapGPULayer.js#L23
Since: 4.0.0

Inherited Members

From Phaser.Renderer.WebGL.RenderNodes.RenderNode:


Public Members

config

config: object

Description:

The completed configuration object for this RenderNode.

This is defined by the default configuration and the user-defined configuration object.

Source: src/renderer/webgl/renderNodes/submitter/SubmitterTilemapGPULayer.js#L51
Since: 4.0.0


defaultConfig

defaultConfig: Phaser.Types.Renderer.WebGL.RenderNodes.BatchHandlerConfig

Description:

Default configuration of this RenderNode.

Source: src/renderer/webgl/renderNodes/submitter/SubmitterTilemapGPULayer.js#L163
Since: 4.0.0


indexBuffer

indexBuffer: Phaser.Renderer.WebGL.Wrappers.WebGLBufferWrapper

Description:

The index buffer defining vertex order.

Source: src/renderer/webgl/renderNodes/submitter/SubmitterTilemapGPULayer.js#L61
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/submitter/SubmitterTilemapGPULayer.js#L86
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/submitter/SubmitterTilemapGPULayer.js#L70
Since: 4.0.0


Inherited Methods

From Phaser.Renderer.WebGL.RenderNodes.RenderNode:


Public Methods

_completeConfig

<instance> _completeConfig(config)

Description:

Fill out the configuration object with default values where needed.

Parameters:

nametypeoptionaldescription
configobjectNoThe configuration object to complete.

Source: src/renderer/webgl/renderNodes/submitter/SubmitterTilemapGPULayer.js#L201
Since: 4.0.0


run

<instance> run(drawingContext, tilemapLayer, [parentMatrix])

Description:

Render a TilemapGPULayer object.

Parameters:

nametypeoptionaldescription
drawingContextPhaser.Renderer.WebGL.DrawingContextNoThe current drawing context.
tilemapLayerPhaser.Tilemaps.TilemapGPULayerNoThe TilemapGPULayer being rendered.
parentMatrixPhaser.GameObjects.Components.TransformMatrixYesThe parent matrix describing the game object's context.

Overrides: Phaser.Renderer.WebGL.RenderNodes.RenderNode#run

Source: src/renderer/webgl/renderNodes/submitter/SubmitterTilemapGPULayer.js#L427
Since: 4.0.0


setupUniforms

<instance> setupUniforms(drawingContext, tilemapLayer)

Description:

Set up uniforms for rendering.

Parameters:

nametypeoptionaldescription
drawingContextPhaser.Renderer.WebGL.DrawingContextNoThe current drawing context.
tilemapLayerPhaser.Tilemaps.TilemapGPULayerNoThe TilemapGPULayer being rendered.

Source: src/renderer/webgl/renderNodes/submitter/SubmitterTilemapGPULayer.js#L249
Since: 4.0.0


updateRenderOptions

<instance> updateRenderOptions(gameObject)

Description:

Update render options for a TilemapGPULayer object.

This may use a different shader program.

This is called before rendering the object.

Parameters:

nametypeoptionaldescription
gameObjectPhaser.Tilemaps.TilemapGPULayerNoThe TilemapGPULayer being rendered.

Source: src/renderer/webgl/renderNodes/submitter/SubmitterTilemapGPULayer.js#L338
Since: 4.0.0