TilemapMesh

Specialized Mesh visual used to render multiple tiles in a tilemap layer.

TilemapMesh extends the basic Mesh to add tilemap-specific properties and implements object pooling for efficient memory management. Each quad represents a single visible tile within a TilemapLayer and is automatically managed by the layer's rendering system.

Features #

• Object Pooling: Reuses instances to minimize garbage collection
• Tile Mesh Properties: Stores tile index, position, and tile data
• Automatic Management: Created and recycled automatically by TilemapLayer

Internal Usage #

This class is primarily used internally by TilemapLayer. Direct instantiation is not recommended - use the static get() method to obtain pooled instances.

// Internal usage by TilemapLayer
var mesh = TilemapMesh.get();
mesh.layerIndex = layerIndex;
mesh.textureIndex = textureIndex;
// ... configure visual properties

// When done, recycle back to pool:
mesh.recycle();

Static Members #

Gets a TilemapMesh instance from the object pool. If the pool is empty, creates a new instance. The returned quad will be active and ready for use.

Instance Members #

The sub-layer index in the rendered layer. Set to -1 when the mesh is not in use.

The index of texture being used.

Returns this TilemapMesh to the object pool for reuse. Automatically removes the quad from its parent, resets all properties, and marks it as inactive. This method should be called when the mesh is no longer needed to free memory and reduce garbage collection.

Private Members #

Static object pool for recycling TilemapMesh instances. Initialized on first use to reduce memory allocation.

Metadata #