Main

Tily. Main

Members

Fields & Properties
Methods
main.js:54

new Main(canvas, optionsopt)

The main Tily object. Initialises a canvas element and starts drawing tiles.

Parameters
Name Type Attributes Description
canvas HTMLElement

The canvas element in which to draw tiles.
options TilyOptions <optional>

An optional object containing options for configuring this Tily instance.

Members

main.js:98

activeBuffer :Tily.BufferBase

The buffer currently being rendered.

main.js:106

(nullable) bufferTransition :Tily.BufferTransition

The currently running buffer transition or null if there is no currently running transition.

Default Value:
  • null
main.js:74

canvas :HTMLElement

The canvas element in which to draw tiles.

main.js:80

context :CanvasRenderingContext2D

The context on which to draw tiles.

main.js:125

frameCount :number

The number of frames rendered in the last second.

main.js:137

frameRate :number

The number of frames rendered per second.

main.js:131

frameTime :number

The number of milliseconds elapsed since the last framerate update.

main.js:92

height :number

The viewport height.

main.js:119

lastFrameTime :number

The unix epoch time of the last rendered frame.

main.js:113

loop :number

A request id returned from window.requestAnimationFrame that uniquely identifies the entry in the callback list for the main render loop.

main.js:68

options :TilyOptions

Options for configuring this Tily instance.

main.js:247

size :Size

The size of this Tily element measured in pixels.

main.js:86

width :number

The viewport width.

Methods

main.js:230

activateBuffer(buffer, optionsopt) → {Promise}

Activate a new buffer with an optional fade transition from the current buffer.

Parameters
Name Type Attributes Description
buffer Tily.Buffer

The new buffer to activate.
options TransitionOptions <optional>

An optional options object.
Returns

A promise instance for setting a transition finished callback.

Type
Promise
main.js:178

draw(elapsedTime)

Render the Tily instance onto the canvas.

Parameters
Name Type Description
elapsedTime number

The time elapsed in seconds since the last draw call.