API Docs for: 0.1.0
Show:

zerk.game.engine.dom Class

Defined in: src/zerk/class/game/engine/dom.js:1
Module: zerk

DOM interface

Methods

_createCanvas

(
  • id
  • width
  • height
  • visible
)
DOMElement protected

Defined in src/zerk/class/game/engine/dom.js:317

Creates a canvas DOM element

Parameters:

  • id String

    DOM id

  • width Integer

    Canvas width

  • height Integer

    Canvas height

  • visible Boolean

    Canvas visibility

Returns:

DOMElement: Canvas DOM element

_getElementPosition

(
  • element
)
Object protected

Defined in src/zerk/class/game/engine/dom.js:271

Returns the position of given DOM element

Parameters:

  • element DOMElement

    DOM element

Returns:

Object: Offset

cancelEvent

(
  • event
)
Boolean

Defined in src/zerk/class/game/engine/dom.js:249

Cancel DOM event

Parameters:

  • event DOMEvent

    DOM event

Returns:

Boolean: Returns false

getBody

() DOMElement

Defined in src/zerk/class/game/engine/dom.js:159

Returns the body DOM element

Returns:

DOMElement:

getCanvasBodyBuffer

() DOMElement

Defined in src/zerk/class/game/engine/dom.js:89

Returns the body buffer canvas DOM element

Returns:

DOMElement: Body buffer canvas DOM element

getCanvasFixtureBuffer

() DOMElement

Defined in src/zerk/class/game/engine/dom.js:101

Returns the fixture buffer canvas DOM element

Returns:

DOMElement: Fixture buffer canvas DOM element

getCanvasGame

() DOMElement

Defined in src/zerk/class/game/engine/dom.js:77

Returns the game canvas DOM element

Returns:

DOMElement: Game canvas DOM element

getCanvasGamePosition

() Object

Defined in src/zerk/class/game/engine/dom.js:135

Returns the position of the game canvas DOM element

Returns:

Object: Offset

getCanvasPhysicsDebug

() DOMElement

Defined in src/zerk/class/game/engine/dom.js:113

Returns the physics debug canvas DOM element

Returns:

DOMElement: Physics debug canvas DOM element

getDocument

() DOMDocument

Defined in src/zerk/class/game/engine/dom.js:147

Returns the DOM document

Returns:

DOMDocument: DOM document

init

()

Defined in src/zerk/class/game/engine/dom.js:49

Class constructor

registerEvent

(
  • element
  • eventName
  • callback
)

Defined in src/zerk/class/game/engine/dom.js:171

Registers a callback function to a DOM element event

Parameters:

  • element DOMElement

    DOM element

  • eventName String

    Event name

  • callback Function

    Callback function

unregisterEvent

(
  • element
  • eventName
  • callback
)

Defined in src/zerk/class/game/engine/dom.js:210

Unregisters a callback function from a DOM element event

Parameters:

  • element DOMElement

    DOM element

  • eventName String

    Event name

  • callback Function

    Callback function

Properties

__canvasFixtureBuffer

DOMElement protected

Defined in src/zerk/class/game/engine/dom.js:31

Fixture buffer canvas DOM element

__canvasPhysicsDebug

DOMElement protected

Defined in src/zerk/class/game/engine/dom.js:40

Physics debug canvas DOM element

_canvasBodyBuffer

DOMElement protected

Defined in src/zerk/class/game/engine/dom.js:22

Body buffer canvas DOM element

_canvasGame

DOMElement protected

Defined in src/zerk/class/game/engine/dom.js:13

Game canvas DOM element