JSDoc: Class: Engine

Constructor

new Engine(canvas)

Create the engine controlling a canvas

Parameters:

Name	Type	Description
`canvas`	object	DOM element containing the canvas

Source:

engine.js, line 11

Members

canvas

Get the current drawing canvas

Source:

engine.js, line 406

ctx

Get the current drawing context

Source:

engine.js, line 398

deltaTime

Get the current framerate as milliseconds per frame (mspf)

Source:

engine.js, line 438

deltaTimeAverage

Get the average framerate as milliseconds per frame (mspf)

Source:

engine.js, line 446

frameCount

Get the count of frames since the start

Source:

engine.js, line 414

frameRate

Get the current framerate as frames per second (fps)

Source:

engine.js, line 422

frameRateAverage

Get the average framerate as frames per second (fps)

Source:

engine.js, line 430

height

Get the drawing area height

Source:

engine.js, line 462

is_recording

Get the current recording state

Source:

engine.js, line 470

(readonly) mousePosition

Get the current mouse position

Source:

engine.js, line 479

(readonly) prevMousePosition

Get the previous mouse position

Source:

engine.js, line 488

width

Get the drawing area width

Source:

engine.js, line 454

Methods

background(color)

Set the background color for the canvas

Parameters:

Name	Type	Description
`color`	string \| number	Color can be a CSS< RGB, RGBA, HEX, HEAX, HSL, HSLA string, a Color object, or a monochrome value (number)

Source:

engine.js, line 350

click(x, y)

Public callback for mouse click and touchscreen tap

Parameters:

Name	Type	Description
`x`	number	coordinate of the click/tap location
`y`	number	coordinate of the click/tap location

Source:

engine.js, line 295

clickHandler(e)

Handler for mouse click/touchscreen tap

Parameters:

Name	Type	Description
`e`	MouseEvent	event

Source:

engine.js, line 223

draw(dt)

Main sketch function, will be run continuously unless noLoop() is called

Parameters:

Name	Type	Description
`dt`	number	Delta time in milliseconds since last frame

Source:

engine.js, line 392

keyDown(key, code)

Public callback for key down

Parameters:

Name	Type	Description
`key`	string	pressed key
`code`	number	code of the pressed key

Source:

engine.js, line 337

keyDownHandler(e)

Handler for key pressed event

Parameters:

Name	Type	Description
`e`	KeyboardEvent	event

Source:

engine.js, line 270

keyPress(key, code)

Public callback for key press

Parameters:

Name	Type	Description
`key`	string	pressed key
`code`	string	code of the pressed key

Source:

engine.js, line 330

keyPressHandler(e)

Handler for key press event

Parameters:

Name	Type	Description
`e`	KeyboardEvent	event

Source:

engine.js, line 286

keyUp(key, code)

Public callback for key up

Parameters:

Name	Type	Description
`key`	string	pressed key
`code`	number	code of the pressed key

Source:

engine.js, line 344

keyUpHandler(e)

Handler for key up event

Parameters:

Name	Type	Description
`e`	KeyboardEvent	event

Source:

engine.js, line 278

loop()

Starts looping the script

Source:

engine.js, line 101

mouseDown(x, y)

Public callback for mouse and touchscreen pressed

Parameters:

Name	Type	Description
`x`	number	coordinate of the click/tap location
`y`	number	coordinate of the click/tap location

Source:

engine.js, line 302

mouseDownHandler(e)

Handler for mouse down

Parameters:

Name	Type	Description
`e`	MouseEvent	event

Source:

engine.js, line 232

mouseDragged(x, y)

Public callback for mouse and touchscreen drag

Parameters:

Name	Type	Description
`x`	number	coordinate of the click/tap location
`y`	number	coordinate of the click/tap location

Source:

engine.js, line 309

mouseMoveHandler(e)

Handler for moved mouse

Parameters:

Name	Type	Description
`e`	MouseEvent	event

Source:

engine.js, line 252

mouseMoved(x, y)

Public callback for mouse and touchscreen moved

Parameters:

Name	Type	Description
`x`	number	coordinate of the click/tap location
`y`	number	coordinate of the click/tap location

Source:

engine.js, line 323

mouseUp(x, y)

Public callback for mouse and touchscreen up

Parameters:

Name	Type	Description
`x`	number	coordinate of the click/tap location
`y`	number	coordinate of the click/tap location

Source:

engine.js, line 316

mouseUpHandler(e)

Handler for mouse up

Parameters:

Name	Type	Description
`e`	MouseEvent	event

Source:

engine.js, line 242

noLoop()

Stops looping the script

Source:

engine.js, line 108

preload()

Function ran once, before the sketch is actually loaded

Source:

engine.js, line 381

saveFrame(titleopt)

Save current frame

Parameters:

Name	Type	Attributes	Default	Description
`title`	string	<optional>	null	The image filename (optional).

Source:

engine.js, line 163

saveRecording(filename)

Save the recording as a series of frames in a zip file

Parameters:

Name	Type	Default	Description
`filename`	string	frames.zip	of the file to download

Source:

engine.js, line 144

scaleFromCenter(x, y)

Scale the canvas by a factor from the center. If only one parameter is passed, the canvas will be scaled uniformly.

Parameters:

Name	Type	Default	Description
`x`	number		scaling factor in the x direction
`y`	number	null	scaling factor in the y direction

Source:

engine.js, line 370

setup()

Function ran once

Source:

engine.js, line 386

startRecording()

Start recording frames

Source:

engine.js, line 126

stop()

Completely stop the engine. Note that this step is final and there's no way to programatically restart it after this call.

Source:

engine.js, line 116

stopRecording()

Stop recording frames

Source:

engine.js, line 136