victus

description

this page documents methods and properties which are not described on their own pages.

methods

setup (obj : object)
initializes the canvas that victus will use.
obj takes the following keys:

• id : string - the ID of the canvas.
• w : number - the width to apply to the canvas.
• h : number - the height to apply to the canvas.
• color? : string (default: "#fff") - the background color to use.

this should typically be used with the DOMContentLoaded event:

document.addEventListener('DOMContentLoaded', victus.setup({
  id: 'canvas',
  w: 300,
  h: 300
}));

clear ( )
clears the canvas.

x ( )
returns the canvas context, provided setup ( ) has been used.
this allows custom drawing routines to be created.

on release, it was intended that you assign this function (and therefore the canvas context) to a variable named ctx; however, due to an oversight, using setup ( ) will have the same effect, allowing that variable to be used even faster.