The manager that owns this RenderNode.
The configuration object for this handler.
The entries in the batch. Each entry represents a "sub-batch" of quads which use the same pool of textures. This allows the renderer to continue to buffer quads into the same batch without needing to upload the vertex buffer. When the batch flushes, there will be one vertex buffer upload, and one draw call per batch entry.
The number of bytes per index per instance. This is used to advance the index buffer, and accounts for the size of a Uint16Array element.
The number of bytes per instance, used to determine how much of the vertex buffer to upload.
The current batch entry being filled with textures.
The default configuration object for this handler.
This is merged with the config object passed in the constructor.
The number of floats per instance, used to determine how much of the vertex buffer to update.
The index buffer defining vertex order.
The number of indices per instance. This is usually 6 for a quad. Each index corresponds to a vertex in the vertex buffer.
The number of instances currently in the batch.
The number of instances per batch, used to determine the size of the vertex buffer, and the number of instances to render.
This is usually limited by the maximum number of vertices that can be
distinguished with a 16-bit UNSIGNED_INT index buffer,
which is 65536. This is set in the game render config as batchSize.
The manager that owns this RenderNode.
The maximum number of textures per batch entry. This is usually set to the maximum number of texture units available, but it might be smaller for some uses.
The name of the RenderNode.
The render options currently being built.
The program manager used to create and manage shader programs. This contains shader variants.
The current render options to which the batch is built. These help define the shader.
The layout, data, and vertex buffer used to store the vertex data.
The default layout is for a quad with position, texture coordinate, texture ID, tint effect, and tint color on each vertex.
The number of vertices per instance.
This is usually 4 for a quad.
Each vertex corresponds to an index in the element buffer.
Add a quad to the batch.
For compatibility with TRIANGLE_STRIP rendering, the vertices are added in the order:
The current drawing context.
The texture to render.
The x coordinate of the top-left corner.
The y coordinate of the top-left corner.
The x coordinate of the bottom-left corner.
The y coordinate of the bottom-left corner.
The x coordinate of the top-right corner.
The y coordinate of the top-right corner.
The x coordinate of the bottom-right corner.
The y coordinate of the bottom-right corner.
The left u coordinate (0-1).
The top v coordinate (0-1).
The width of the texture (0-1).
The height of the texture (0-1).
Whether to tint the fill color.
The top-left tint color.
The bottom-left tint color.
The top-right tint color.
The bottom-right tint color.
Optional render features.
Additional arguments for subclasses.
Add a strip to the batch.
This method would usually be named batch, but the call signature
is different from the other batch handlers.
The current drawing context.
The Game Object being rendered.
The current transform matrix.
The texture to render.
The vertices of the strip.
The UV coordinates of the strip.
The color values of the strip.
The alpha values of the strip.
The overall alpha value of the strip.
Whether to tint the fill color.
Optional render features. Strip rendering should always set multiTexturing to false. It can use smoothPixelArt. Other options are ignored.
OptionaldebugCallback: FunctionThe debug callback, called with an array consisting of alternating x,y values of the transformed vertices.
Process textures for batching.
This method is called automatically by the batch method.
It returns a piece of data used for various texture tasks,
depending on the render options.
The texture datum may be used for texture ID or normal map rotation.
The texture to render.
The current render options.
Finalize the texture count for the current sub-batch. This is called automatically when the render is run. It requests a shader program with the necessary number of textures, if that is less than the maximum allowed. This reduces the number of textures the GPU must handle, which can improve performance.
The total number of textures in the batch.
By default this is an empty method hook that you can override and use in your own custom render nodes.
This method is called at the start of the run method.
Don't forget to call it in your custom method.
The context currently in use.
By default this is an empty method hook that you can override and use in your own custom render nodes.
This method is called at the end of the run method.
Don't forget to call it in your custom method.
The context currently in use.
Push the current batch entry to the batch entry list, and create a new batch entry for future use.
Set new dimensions for the renderer. This should be overridden by subclasses.
This is called automatically when the renderer is resized.
The new width of the renderer.
The new height of the renderer.
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.
The current drawing context.
Set whether the node should report debug information.
It wraps the run method with additional debug information.
Whether to report debug information.
Update the texture uniforms for the current shader program.
This method is called automatically when the batch is run.
The textures to render.
Update the uniforms for the current shader program.
This method is called automatically when the batch is run.
The current drawing context.
Update the render options for the current shader program.
The new render options.
Update the shader configuration based on render options. This is called automatically when the render options change.
Update the number of draw calls per batch. This rebuilds the shader program with the new draw call count. The minimum number of draw calls is 1, and the maximum is the number of texture units defined in the renderer. Rebuilding the shader may be expensive, so use this sparingly.
If this runs during a batch, and the new count is less than the number of textures in the current batch entry, the batch will be flushed before the shader program is rebuilt, so none of the textures are skipped.
This is usually called automatically by a listener
for the Phaser.Renderer.Events.SET_PARALLEL_TEXTURE_UNITS event,
triggered by the RenderNodeManager.
Optionalcount: numberThe new number of draw calls per batch. If undefined, the maximum number of texture units is used.
This RenderNode renders textured triangle strips, such as for the Rope Game Object. It uses batches to accelerate drawing.
If a strip is submitted with too many vertices (usually >32,768), it will throw an error.
Note that you should call
batchStripinstead ofbatchto add strips.