Class: ForgeRenderLayer
Defined in: rendering/render-layers/forge-render-layer.ts:7
The ForgeRenderLayer class represents a rendering layer with its own canvas and WebGL context.
Extends
Constructors
Constructor
new ForgeRenderLayer(
name,canvas,clearStrategy,sortEntities):ForgeRenderLayer
Defined in: rendering/render-layers/forge-render-layer.ts:25
Constructs a new instance of the ForgeRenderLayer class.
Parameters
name
string
The name of the render layer.
canvas
HTMLCanvasElement
The canvas element associated with the render layer.
clearStrategy
CLEAR_STRATEGY_KEYS = CLEAR_STRATEGY.blank
The strategy for clearing the render layer (default: CLEAR_STRATEGY.blank).
sortEntities
boolean = false
Whether to sort entities by their y position before rendering (default: false).
Returns
ForgeRenderLayer
Throws
An error if the WebGL2 context is not found.
Overrides
Properties
canvas
canvas:
HTMLCanvasElement
Defined in: rendering/render-layers/render-layer.ts:11
The canvas element associated with the render layer.
Inherited from
center
center:
Vector2
Defined in: rendering/render-layers/render-layer.ts:14
The center of the canvas.
Inherited from
clearStrategy
clearStrategy:
CLEAR_STRATEGY_KEYS
Defined in: rendering/render-layers/forge-render-layer.ts:12
The strategy for clearing the render layer.
context
context:
WebGL2RenderingContext
Defined in: rendering/render-layers/forge-render-layer.ts:9
The WebGL2 rendering context for the canvas.
name
name:
string
Defined in: rendering/render-layers/render-layer.ts:8
The name of the render layer.
Inherited from
sortEntities
sortEntities:
boolean
Defined in: rendering/render-layers/forge-render-layer.ts:15
Whether to sort entities by their y position before rendering.
Methods
resize()
resize(
width,height):void
Defined in: rendering/render-layers/forge-render-layer.ts:46
Resizes the canvas to the specified width and height, and updates the center.
Parameters
width
number
The new width of the canvas.
height
number
The new height of the canvas.
Returns
void