CanvasLayer System

src/graphics/canvas-layer.js#L3-L11

An object for creating the canvas layer system.

Mostly contains private methods to draw entities on a canvas element.

Properties

._canvas
.context

Methods

.attach()
.detach()
.dirty()
._drawAll()
._drawDirtyCells()

.attach()

src/graphics/canvas-layer.js#L41-L51

public .attach(ent)

ent: The entity to add

Sets the entity's draw context to this layer

.detach()

src/graphics/canvas-layer.js#L58-L68

public .detach(ent)

ent: The entity to detach

Removes an entity to the list of Canvas objects to draw

.dirty()

src/graphics/canvas-layer.js#L26-L36

public .dirty(ent)

ent: The entity to add

Add an entity to the list of Canvas objects that need redrawing

._canvas

src/graphics/canvas-layer.js#L86-L93

The canvas element associated with the canvas layer.

.context

src/graphics/canvas-layer.js#L77-L83

This will return the 2D context associated with the canvas layer's canvas element.

._drawAll()

src/graphics/canvas-layer.js#L243-L260

public ._drawAll([Object rect])

rect: a rectangular region {_x: x_val, _y: y_val, _w: w_val, _h: h_val}

If rect is omitted, redraw within the viewport
If rect is provided, redraw within the rect.
Triggered by the "RenderScene" event
This method is invoked if the number of rects is over 60% of the total number of objects.
Clear the whole viewport, and redraw entities overlapping it by default.

See Also

Canvas.draw

._drawDirtyCells()

src/graphics/canvas-layer.js#L183-L201

public ._drawDirtyCells([Object rect])

rect: a rectangular region {_x: x_val, _y: y_val, _w: w_val, _h: h_val}

If rect is omitted, redraw within the viewport
If rect is provided, redraw within the rect.
Triggered by the "RenderScene" event
This method is invoked if the number of rects is under 60% of the total number of objects and the total number of objects is greater than 16.
Clear the dirty spatial grid cells, and redraw entities overlapping the dirty spatial grid cells.

See Also

Canvas.draw