CanvasLayer

Canvas Layer - cached off screen rendering system

  • Contains an offscreen canvas that can be rendered to
  • WebGL rendering is optional, call useWebGL to enable

Constructor

new CanvasLayer(positionopt, sizeopt, angleopt, renderOrderopt, canvasSizeopt)

Create a canvas layer object

Parameters:
NameTypeAttributesDefaultDescription
positionVector2<optional>

World space position of the layer

sizeVector2<optional>

World space size of the layer

anglenumber<optional>
0

Angle the layer is rotated by

renderOrdernumber<optional>
0

Objects sorted by renderOrder

canvasSizeVector2<optional>

Default size of canvas, can be changed later

Source
Example
const canvasLayer = new CanvasLayer(vec2(), vec2(200,100));

Extends

Members

additiveColor

Properties
TypeDescription
Color

Additive color to apply when rendered

Overrides
Source

angle

Properties
TypeDescription
number

Angle to rotate the object

Overrides
Source

angleDamping

Properties
NameTypeAttributesDefaultDescription
angleDampingnumber<optional>
objectDefaultAngleDamping

How much to slow down rotation each frame (0-1)

Overrides
Source

angleVelocity

Properties
TypeDescription
number

Angular velocity of the object

Overrides
Source

canvas

Properties
TypeDescription
HTMLCanvasElement

The canvas used by this layer

Source

children

Properties
TypeDescription
Array.<EngineObject>

List of children of this object

Overrides
Source

clampSpeed

Properties
TypeDescription
boolean

Limit object speed along x and y axis

Overrides
Source

collideRaycast

Properties
TypeDescription
boolean

Object collides with raycasts

Overrides
Source

collideSolidObjects

Properties
TypeDescription
boolean

Object collides with solid objects

Overrides
Source

collideTiles

Properties
TypeDescription
boolean

Object collides with the tile collision

Overrides
Source

color

Properties
TypeDescription
Color

Color to apply when rendered

Overrides
Source

context

Properties
TypeDescription
OffscreenCanvasRenderingContext2D

The 2D canvas context used by this layer

Source

damping

Properties
NameTypeAttributesDefaultDescription
dampingnumber<optional>
objectDefaultDamping

How much to slow down velocity each frame (0-1)

Overrides
Source

drawSize

Properties
TypeDescription
Vector2

Size of object used for drawing, uses size if not set

Overrides
Source

friction

Properties
NameTypeAttributesDefaultDescription
frictionnumber<optional>
objectDefaultFriction

How much friction to apply when sliding (0-1)

Overrides
Source

glTexture

Properties
TypeDescription
WebGLTexture

Texture if using WebGL for this layer, call useWebGL to enable

Source

gravityScale

Properties
TypeDescription
number

How much to scale gravity by for this object

Overrides
Source

groundObject

Properties
TypeDescription
EngineObject

Object we are standing on, if any

Overrides
Source

isSolid

Properties
TypeDescription
boolean

Object collides with and blocks other objects

Overrides
Source

localAngle

Properties
TypeDescription
number

Local angle if child

Overrides
Source

localPos

Properties
TypeDescription
Vector2

Local position if child

Overrides
Source

mass

Properties
NameTypeAttributesDefaultDescription
massnumber<optional>
objectDefaultMass

How heavy the object is, static if 0

Overrides
Source

mirror

Properties
TypeDescription
boolean

Should it flip along y axis when rendered

Overrides
Source

parent

Properties
TypeDescription
EngineObject

Parent of object if in local space

Overrides
Source

pos

Properties
TypeDescription
Vector2

World space position of the object

Overrides
Source

renderOrder

Properties
TypeDescription
number

Objects are sorted by render order

Overrides
Source

restitution

Properties
NameTypeAttributesDefaultDescription
restitutionnumber<optional>
objectDefaultRestitution

How bouncy the object is when colliding (0-1)

Overrides
Source

size

Properties
TypeDescription
Vector2

World space width and height of the object

Overrides
Source

spawnTime

Properties
TypeDescription
number

Track when object was created

Overrides
Source

tileInfo

Properties
TypeDescription
TileInfo

Tile info to render object (undefined is untextured)

Overrides
Source

velocity

Properties
TypeDescription
Vector2

Velocity of the object

Overrides
Source

Methods

addChild(child, localPosopt, localAngleopt)

Attaches a child to this with a given local transform

Parameters:
NameTypeAttributesDefaultDescription
childEngineObject
localPosVector2<optional>
(0,0)
localAnglenumber<optional>
0
Overrides
Source

applyAcceleration(acceleration)

Apply acceleration to this object (adjust velocity, not affected by mass)

Parameters:
NameTypeDescription
accelerationVector2
Overrides
Source

applyAngularAcceleration(acceleration)

Apply angular acceleration to this object

Parameters:
NameTypeDescription
accelerationnumber
Overrides
Source

applyForce(force)

Apply force to this object (adjust velocity, affected by mass)

Parameters:
NameTypeDescription
forceVector2
Overrides
Source

collideWithObject(object) → {boolean}

Called to check if a object collision should be resolved

Parameters:
NameTypeDescription
objectEngineObject

the object to test against

Overrides
Source
Returns:
  • true if the collision should be resolved
Type: 
boolean

collideWithTile(tileData, pos) → {boolean}

Called to check if a tile collision should be resolved

Parameters:
NameTypeDescription
tileDatanumber

the value of the tile at the position

posVector2

tile where the collision occurred

Overrides
Source
Returns:
  • true if the collision should be resolved
Type: 
boolean

destroy()

Destroy this canvas layer

Overrides
Source

drawCanvas2D(pos, size, angle, mirror, drawFunction)

Draw onto the layer canvas in world space (bypass WebGL)

Parameters:
NameTypeDescription
posVector2
sizeVector2
anglenumber
mirrorboolean
drawFunctionfunction
Source

drawRect(pos, sizeopt, coloropt, angleopt)

Draw a rectangle onto the layer canvas in world space

Parameters:
NameTypeAttributesDefaultDescription
posVector2
sizeVector2<optional>
(1,1)
colorColor<optional>
(1,1,1,1)
anglenumber<optional>
0
Source

drawTile(pos, sizeopt, tileInfoopt, coloropt, angleopt, mirroropt)

Draw a tile onto the layer canvas in world space

Parameters:
NameTypeAttributesDefaultDescription
posVector2
sizeVector2<optional>
(1,1)
tileInfoTileInfo<optional>
colorColor<optional>
(1,1,1,1)
anglenumber<optional>
0
mirrorboolean<optional>
false
Source

getAliveTime() → {number}

How long since the object was created

Overrides
Source
Returns:
Type: 
number

getMirrorSign() → {number}

Get the direction of the mirror

Overrides
Source
Returns:

-1 if this.mirror is true, or 1 if not mirrored

Type: 
number

localToWorld(pos)

Convert from local space to world space

Parameters:
NameTypeDescription
posVector2

local space point

Overrides
Source

localToWorldVector(vec)

Convert from local space to world space for a vector (rotation only)

Parameters:
NameTypeDescription
vecVector2

local space vector

Overrides
Source

removeChild(child)

Removes a child from this one

Parameters:
NameTypeDescription
childEngineObject
Overrides
Source

render()

Render the object, draws a tile by default, automatically called each frame, sorted by renderOrder

Overrides
Source

renderDebugInfo()

Render debug info for this object

Overrides
Source

setCollision(collideSolidObjectsopt, isSolidopt, collideTilesopt, collideRaycastopt)

Set how this object collides

Parameters:
NameTypeAttributesDefaultDescription
collideSolidObjectsboolean<optional>
true

Does it collide with solid objects?

isSolidboolean<optional>
true

Does it collide with and block other objects? (expensive in large numbers)

collideTilesboolean<optional>
true

Does it collide with the tile collision?

collideRaycastboolean<optional>
true

Does it collide with raycasts?

Overrides
Source

toString() → {string}

Returns string containing info about this object for debugging

Overrides
Source
Returns:
Type: 
string

update()

Update the object physics, called automatically by engine once each frame

Overrides
Source

updateTransforms()

Update the object transform, called automatically by engine even when paused

Overrides
Source

useWebGL(enableopt)

Create or update the WebGL texture for this layer

Parameters:
NameTypeAttributesDefaultDescription
enableboolean<optional>
true

enable WebGL rendering and update the texture

Source

worldToLocal(pos)

Convert from world space to local space

Parameters:
NameTypeDescription
posVector2

world space point

Overrides
Source

worldToLocalVector(vec)

Convert from world space to local space for a vector (rotation only)

Parameters:
NameTypeDescription
vecVector2

world space vector

Overrides
Source