GraphicsDevice() 

{{TYPE-ERROR}}backBufferAntialias 

True if the back buffer should use anti-aliasing.

numberboneLimit 

The maximum number of supported bones using uniform buffers.

[read only]

HTMLCanvasElementcanvas 

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

[read only]

DEVICETYPE_WEBGL1, DEVICETYPE_WEBGL2, DEVICETYPE_WEBGPUdeviceType 

The type of the device. Can be one of pc.DEVICETYPE_WEBGL1, pc.DEVICETYPE_WEBGL2 or pc.DEVICETYPE_WEBGPU.

booleanfullscreen 

Fullscreen mode.

GpuProfilergpuProfiler 

The GPU profiler.

numberheight 

Height of the back buffer in pixels.

booleaninsideRenderPass 

booleanisWebGL1 

True if the deviceType is WebGL1

[read only]

booleanisWebGL2 

True if the deviceType is WebGL2

[read only]

booleanisWebGPU 

True if the deviceType is WebGPU

[read only]

numbermaxAnisotropy 

The maximum supported texture anisotropy setting.

[read only]

numbermaxColorAttachments 

The maximum supported number of color buffers attached to a render target.

[read only]

numbermaxCubeMapSize 

The maximum supported dimension of a cube map.

[read only]

numbermaxPixelRatio 

Maximum pixel ratio.

numbermaxTextureSize 

The maximum supported dimension of a texture.

[read only]

numbermaxVolumeSize 

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

[read only]

stringprecision 

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

[read only]

numbersamples 

The number of hardware anti-aliasing samples used by the frame buffer.

[read only]

ScopeSpacescope 

The scope namespace for shader attributes and variables.

[read only]

booleansupportsInstancing 

True if hardware instancing is supported.

[read only]

booleansupportsMrt 

True if Multiple Render Targets feature is supported. This refers to the ability to render to multiple color textures with a single draw call.

[read only]

booleansupportsVolumeTextures 

True if the device supports volume textures.

[read only]

booleantextureFloatFilterable 

True if filtering can be applied when sampling float textures.

[read only]

booleantextureFloatRenderable 

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

[read only]

booleantextureHalfFloatRenderable 

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

[read only]

numberwidth 

Width of the back buffer in pixels.

destroy() 

Destroy the graphics device.

getRenderTarget() 

Queries the currently set render target on the device.

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

Returns

RenderTarget

The current render target.

postInit() 

Function that executes after the device has been created.

setBlendState(blendState) 

Sets the specified blend state.

Parameters

blendState

BlendState

New blend state.

setCullMode(cullMode) 

Controls how triangles are culled based on their face direction. The default cull mode is CULLFACE_BACK.

Parameters

cullMode

number

The cull mode to set. Can be: CULLFACE_NONE CULLFACE_BACK CULLFACE_FRONT

setDepthState(depthState) 

Sets the specified depth state.

Parameters

depthState

DepthState

New depth state.

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, null

The render target to activate.

setStencilState([stencilFront], [stencilBack]) 

Sets the specified stencil state. If both stencilFront and stencilBack are null, stencil operation is disabled.

Parameters

stencilFront	StencilParameters	The front stencil parameters. Defaults to StencilParameters.DEFAULT if not specified.
stencilBack	StencilParameters	The back stencil parameters. Defaults to StencilParameters.DEFAULT if not specified.

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.

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.

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.

const 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

const evt = obj.on('test', function (a, b) {
    console.log(a + b);
});
// some time later
evt.off();

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

EventHandle

Can be used for removing event in the future.

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

EventHandle

• can be used for removing event in the future.