App.API

Class: App

App

new App(canvas) → {App}

Base class for all Foam applications.

Parameters:

Name	Type	Argument	Description
canvas	HTMLCanvasElement	<optional>	Target canvas

Source:

• app/App.js , lineno 30

Returns:

Type

App

Members

<protected> _gl :CanvasRenderingContext2D

Reference to WebGLRenderingContext

Type:

• CanvasRenderingContext2D

Source:

• app/App.js , lineno 113

<protected> _glDraw :glDraw

Reference to glDraw.

Type:

• glDraw

Source:

• app/App.js , lineno 120

<protected> _glTrans :glTrans

Reference to glTrans

Type:

• glTrans

Source:

• app/App.js , lineno 128

Methods

<static> getInstance() → {App}

Get an instance of the current program.

Source:

• app/App.js , lineno 300

Returns:

Type

App

<static> new(resource, obj)

Factory method. Inititates a program.

Parameters:

Name	Type	Description
resource	Object | Array.<Object>	The resource / resource-bundle {path, type} to be loaded
obj	Object	A program object {setup,update}

Source:

• app/App.js , lineno 583

<static> newOnLoad(obj)

Factory method. Inititates a program. Called on window load.

Parameters:

Name	Type	Description
obj	Object	A program object {setup,update}

Source:

• app/App.js , lineno 538

<static> newOnLoadWithResource(resource, obj, callbackError, {Function), strict)

Factory method. Initiates a program providing loaded resources. Called on window load.

Parameters:

Name	Type	Argument	Default	Description
resource	Object | Array.<Object>			The resource / resource-bundle {path, type} to be loaded
obj	Object			A program object {setup,update}
callbackError	function	<optional>		Callback if an error occured
{Function)				[callbackProcess] - Callback on load
strict	bool	<optional>	true	Abort if at least one resource could not be loaded

Source:

• app/App.js , lineno 568

<static> newOnResource(resource, obj, callbackError, {Function), strict)

Factory method. Initiates a program providing loaded resources.

Parameters:

Name	Type	Argument	Default	Description
resource	Object | Array.<Object>			The resource / resource-bundle {path, type} to be loaded
obj	Object			A program object {setup,update}
callbackError	function	<optional>		Callback if an error occured
{Function)				[callbackProcess] - Callback on load
strict	bool	<optional>	true	Abort if at least one resource could not be loaded

Source:

• app/App.js , lineno 553

getFPS() → {Number}

Return the current target framerate

Source:

• app/App.js , lineno 451

Returns:

Type

Number

getFramesElapsed() → {Number}

Return the number of frames elapsed since the program started.

Source:

• app/App.js , lineno 460

Returns:

Type

Number

getSecondsElapsed() → {Number}

Return the number of seconds elapsed since the program started.

Source:

• app/App.js , lineno 469

Returns:

Type

Number

getTime() → {Number}

Return the current time.

Source:

• app/App.js , lineno 478

Returns:

Type

Number

getTimeDelta() → {Number}

Return the time the between now and the last update call.

Source:

• app/App.js , lineno 496

Returns:

Type

Number

getTimeStart() → {Number}

Return the time at program start.

Source:

• app/App.js , lineno 487

Returns:

Type

Number

getWindowAspectRatio() → {number}

Return the current window aspect ratio.

Source:

• app/App.js , lineno 412

Returns:

Type

number

getWindowBounds(rect) → {Rect}

Return the current window's bounds.

Parameters:

Name	Type	Description
rect	Rect	Out rect

Source:

• app/App.js , lineno 375

Returns:

Type

Rect

getWindowHeight() → {Number}

Return the window´s current height.

Source:

• app/App.js , lineno 403

Returns:

Type

Number

getWindowScale() → {number}

Return the current window scale.

Source:

• app/App.js , lineno 421

Returns:

Type

number

getWindowSize(v) → {Vec2}

Return the window´s current size.

Parameters:

Name	Type	Argument	Description
v	Vec2	<optional>	Out size

Source:

• app/App.js , lineno 385

Returns:

Type

Vec2

getWindowWidth() → {Number}

Return the window´s current width.

Source:

• app/App.js , lineno 394

Returns:

Type

Number

loop(loop)

Set if the program should continously call update.

Parameters:

Name	Type	Description
loop	Boolean

Source:

• app/App.js , lineno 505

<abstract> onWebGLContextNotAvailable()

Callback if webgl is not available.

Source:

• app/App.js , lineno 324

onWindowResize()

Callback on window resize.

Source:

• app/App.js , lineno 429

setFPS(fps)

Set the target framerate.

Parameters:

Name	Type	Description
fps	Number	The framerate

Source:

• app/App.js , lineno 441

<abstract> setup()

Setup

Source:

• app/App.js , lineno 308

setWindowSize(width, height, scale)

Set the window size.

Parameters:

Name	Type	Argument	Description
width	Number		The width
height	Number		The height
scale	Number	<optional>	The ratio of pixels per window pixel (default: 1:1)

Source:

• app/App.js , lineno 339

<abstract> update()

Update

Source:

• app/App.js , lineno 316

Generated with wicked.