GraphicsDevice

Extends: EventHandler

The graphics device manages the underlying graphics context. It is responsible for submitting render state changes and graphics primitives to the hardware. A graphics device is tied to a specific canvas HTML element. It is valid to have more than one canvas element per page and create a new graphics device against each.

Summary

Properties

boneLimit	The maximum number of supported bones using uniform buffers.
canvas	The canvas DOM element that provides the underlying WebGL context used by the graphics device.
fullscreen	Fullscreen mode.
height	Height of the back buffer in pixels.
insideRenderPass
maxAnisotropy	The maximum supported texture anisotropy setting.
maxCubeMapSize	The maximum supported dimension of a cube map.
maxPixelRatio	Maximum pixel ratio.
maxTextureSize	The maximum supported dimension of a texture.
maxVolumeSize	The maximum supported dimension of a 3D texture (any axis).
precision	The highest shader precision supported by this graphics device.
scope	The scope namespace for shader attributes and variables.
shaders
supportsInstancing	True if hardware instancing is supported.
targets
textureFloatRenderable	True if 32-bit floating-point textures can be used as a frame buffer.
textureHalfFloatRenderable	True if 16-bit floating-point textures can be used as a frame buffer.
textures
width	Width of the back buffer in pixels.

Methods

destroy	Destroy the graphics device.
getRenderTarget	Queries the currently set render target on the device.
setIndexBuffer	Sets the current index buffer on the graphics device.
setRenderTarget	Sets the specified render target on the device.
setVertexBuffer	Sets the current vertex buffer on the graphics device.

Events

resizecanvas

Fired when the canvas is resized.

Inherited

Methods

fire	Fire an event, all additional arguments are passed on to the event listener.
hasEvent	Test if there are any handlers bound to an event name.
off	Detach an event handler from an event.
on	Attach an event handler to an event.
once	Attach an event handler to an event.

Details

Constructor

GraphicsDevice() 

Properties

numberboneLimit 

The maximum number of supported bones using uniform buffers.

HTMLCanvasElementcanvas 

The canvas DOM element that provides the underlying WebGL context used by the graphics device.

booleanfullscreen 

Fullscreen mode.

numberheight 

Height of the back buffer in pixels.

booleaninsideRenderPass 

numbermaxAnisotropy 

The maximum supported texture anisotropy setting.

numbermaxCubeMapSize 

The maximum supported dimension of a cube map.

numbermaxPixelRatio 

Maximum pixel ratio.

numbermaxTextureSize 

The maximum supported dimension of a texture.

numbermaxVolumeSize 

The maximum supported dimension of a 3D texture (any axis).

stringprecision 

The highest shader precision supported by this graphics device. Can be 'hiphp', 'mediump' or 'lowp'.

ScopeSpacescope 

The scope namespace for shader attributes and variables.

Shader[]shaders 

booleansupportsInstancing 

True if hardware instancing is supported.

RenderTarget[]targets 

booleantextureFloatRenderable 

True if 32-bit floating-point textures can be used as a frame buffer.

booleantextureHalfFloatRenderable 

True if 16-bit floating-point textures can be used as a frame buffer.

Texture[]textures 

numberwidth 

Width of the back buffer in pixels.

Methods

destroy() 

Destroy the graphics device.

getRenderTarget() 

Queries the currently set render target on the device.

// Get the current render target
var renderTarget = device.getRenderTarget();

Returns

RenderTarget

The current render target.

setIndexBuffer(indexBuffer) 

Sets the current index buffer on the graphics device. On subsequent calls to GraphicsDevice#draw, the specified index buffer will be used to provide index data for any indexed primitives.

Parameters

indexBuffer

IndexBuffer

The index buffer to assign to the device.

setRenderTarget(renderTarget) 

Sets the specified render target on the device. If null is passed as a parameter, the back buffer becomes the current target for all rendering operations.

// Set a render target to receive all rendering output
device.setRenderTarget(renderTarget);

// Set the back buffer to receive all rendering output
device.setRenderTarget(null);

Parameters

renderTarget

RenderTarget

The render target to activate.

setVertexBuffer(vertexBuffer) 

Sets the current vertex buffer on the graphics device. On subsequent calls to GraphicsDevice#draw, the specified vertex buffer(s) will be used to provide vertex data for any primitives.

Parameters

vertexBuffer

VertexBuffer

The vertex buffer to assign to the device.

Events

resizecanvas 

Fired when the canvas is resized.

Parameters

width	number	The new width of the canvas in pixels.
height	number	The new height of the canvas in pixels.

Inherited

Methods

fire(name, [arg1], [arg2], [arg3], [arg4], [arg5], [arg6], [arg7], [arg8]) 

Fire an event, all additional arguments are passed on to the event listener.

obj.fire('test', 'This is the message');

Parameters

name	string	Name of event to fire.
arg1	*	First argument that is passed to the event handler.
arg2	*	Second argument that is passed to the event handler.
arg3	*	Third argument that is passed to the event handler.
arg4	*	Fourth argument that is passed to the event handler.
arg5	*	Fifth argument that is passed to the event handler.
arg6	*	Sixth argument that is passed to the event handler.
arg7	*	Seventh argument that is passed to the event handler.
arg8	*	Eighth argument that is passed to the event handler.

Returns

EventHandler

Self for chaining.

hasEvent(name) 

Test if there are any handlers bound to an event name.

obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false

Parameters

name

string

The name of the event to test.

Returns

boolean

True if the object has handlers bound to the specified event name.

off([name], [callback], [scope]) 

Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

var handler = function () {
};
obj.on('test', handler);

obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this

Parameters

name	string	Name of the event to unbind.
callback	HandleEventCallback	Function to be unbound.
scope	object	Scope that was used as the this when the event is fired.

Returns

EventHandler

Self for chaining.

on(name, callback, [scope]) 

Attach an event handler to an event.

obj.on('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console

Parameters

name	string	Name of the event to bind the callback to.
callback	HandleEventCallback	Function that is called when event is fired. Note the callback is limited to 8 arguments.
scope	object	Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandler

Self for chaining.

once(name, callback, [scope]) 

Attach an event handler to an event. This handler will be removed after being fired once.

obj.once('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
obj.fire('test', 1, 2); // not going to get handled

Parameters

name	string	Name of the event to bind the callback to.
callback	HandleEventCallback	Function that is called when event is fired. Note the callback is limited to 8 arguments.
scope	object	Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandler

Self for chaining.