&#58195; API Reference

The blend equation. Can be:

Note that MIN and MAX modes require either EXT_blend_minmax or WebGL2 to work (check device.extBlendMinmax).

setBlendEquationSeparate(blendEquation, blendAlphaEquation) 

Configures the blending equation. The default blend equation is pc.BLENDEQUATION_ADD.

Parameters

blendEquation

The blend equation. Can be:

Note that MIN and MAX modes require either EXT_blend_minmax or WebGL2 to work (check device.extBlendMinmax).

blendAlphaEquation

A separate blend equation for the alpha channel. Accepts same values as blendEquation.

setBlendFunction(blendSrc, blendDst) 

Configures blending operations. Both source and destination blend modes can take the following values:

Parameters

blendSrc	number	The source blend function.
blendDst	number	The destination blend function.

setBlendFunctionSeparate(blendSrc, blendDst, blendSrcAlpha, blendDstAlpha) 

Configures blending operations. Both source and destination blend modes can take the following values:

Parameters

blendSrc	number	The source blend function.
blendDst	number	The destination blend function.
blendSrcAlpha	number	The separate source blend function for the alpha channel.
blendDstAlpha	number	The separate destination blend function for the alpha channel.

setBlending(blending) 

Enables or disables blending.

Parameters

blending

True to enable blending and false to disable it.

setColorWrite(writeRed, writeGreen, writeBlue, writeAlpha) 

Enables or disables writes to the color buffer. Once this state is set, it persists until it is changed. By default, color writes are enabled for all color channels.

// Just write alpha into the frame buffer
device.setColorWrite(false, false, false, true);

Parameters

writeRed	boolean	True to enable writing of the red channel and false otherwise.
writeGreen	boolean	True to enable writing of the green channel and false otherwise.
writeBlue	boolean	True to enable writing of the blue channel and false otherwise.
writeAlpha	boolean	True to enable writing of the alpha channel and false otherwise.

setCullMode(cullMode) 

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

Parameters

cullMode

The cull mode to set. Can be:

setDepthFunc(func) 

Configures the depth test.

Parameters

func

A function to compare a new depth value with an existing z-buffer value and decide if to write a pixel. Can be:

pc.FUNC_NEVER: don't draw
pc.FUNC_LESS: draw if new depth < depth buffer
pc.FUNC_EQUAL: draw if new depth == depth buffer
pc.FUNC_LESSEQUAL: draw if new depth <= depth buffer
pc.FUNC_GREATER: draw if new depth > depth buffer
pc.FUNC_NOTEQUAL: draw if new depth != depth buffer
pc.FUNC_GREATEREQUAL: draw if new depth >= depth buffer
pc.FUNC_ALWAYS: always draw

setDepthTest(depthTest) 

Enables or disables depth testing of fragments. Once this state is set, it persists until it is changed. By default, depth testing is enabled.

device.setDepthTest(true);

Parameters

depthTest

True to enable depth testing and false otherwise.

setDepthWrite(writeDepth) 

Enables or disables writes to the depth buffer. Once this state is set, it persists until it is changed. By default, depth writes are enabled.

device.setDepthWrite(true);

Parameters

writeDepth

True to enable depth writing and false otherwise.

setIndexBuffer(indexBuffer) 

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

Parameters

indexBuffer

pc.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

pc.RenderTarget

The render target to activate.

setScissor(x, y, w, h) 

Set the active scissor rectangle on the specified device.

Parameters

x	number	The pixel space x-coordinate of the bottom left corner of the scissor rectangle.
y	number	The pixel space y-coordinate of the bottom left corner of the scissor rectangle.
w	number	The width of the scissor rectangle in pixels.
h	number	The height of the scissor rectangle in pixels.

setShader(shader) 

Sets the active shader to be used during subsequent draw calls.

Parameters

shader

pc.Shader

The shader to set to assign to the device.

Returns

boolean

True if the shader was successfully set, false otherwise.

setStencilFunc(func, ref, mask) 

Configures stencil test for both front and back faces.

Parameters

func

A comparison function that decides if the pixel should be written, based on the current stencil buffer value, reference value, and mask value. Can be:

pc.FUNC_NEVER: never pass
pc.FUNC_LESS: pass if (ref & mask) < (stencil & mask)
pc.FUNC_EQUAL: pass if (ref & mask) == (stencil & mask)
pc.FUNC_LESSEQUAL: pass if (ref & mask) <= (stencil & mask)
pc.FUNC_GREATER: pass if (ref & mask) > (stencil & mask)
pc.FUNC_NOTEQUAL: pass if (ref & mask) != (stencil & mask)
pc.FUNC_GREATEREQUAL: pass if (ref & mask) >= (stencil & mask)
pc.FUNC_ALWAYS: always pass

ref

Reference value used in comparison.

mask

Mask applied to stencil buffer value and reference value before comparison.

setStencilFuncBack(func, ref, mask) 

Configures stencil test for back faces.

Parameters

func

A comparison function that decides if the pixel should be written, based on the current stencil buffer value, reference value, and mask value. Can be:

pc.FUNC_NEVER: never pass
pc.FUNC_LESS: pass if (ref & mask) < (stencil & mask)
pc.FUNC_EQUAL: pass if (ref & mask) == (stencil & mask)
pc.FUNC_LESSEQUAL: pass if (ref & mask) <= (stencil & mask)
pc.FUNC_GREATER: pass if (ref & mask) > (stencil & mask)
pc.FUNC_NOTEQUAL: pass if (ref & mask) != (stencil & mask)
pc.FUNC_GREATEREQUAL: pass if (ref & mask) >= (stencil & mask)
pc.FUNC_ALWAYS: always pass

ref

Reference value used in comparison.

mask

Mask applied to stencil buffer value and reference value before comparison.

setStencilFuncFront(func, ref, mask) 

Configures stencil test for front faces.

Parameters

func

A comparison function that decides if the pixel should be written, based on the current stencil buffer value, reference value, and mask value. Can be:

pc.FUNC_NEVER: never pass
pc.FUNC_LESS: pass if (ref & mask) < (stencil & mask)
pc.FUNC_EQUAL: pass if (ref & mask) == (stencil & mask)
pc.FUNC_LESSEQUAL: pass if (ref & mask) <= (stencil & mask)
pc.FUNC_GREATER: pass if (ref & mask) > (stencil & mask)
pc.FUNC_NOTEQUAL: pass if (ref & mask) != (stencil & mask)
pc.FUNC_GREATEREQUAL: pass if (ref & mask) >= (stencil & mask)
pc.FUNC_ALWAYS: always pass

ref

Reference value used in comparison.

mask

Mask applied to stencil buffer value and reference value before comparison.

setStencilOperation(fail, zfail, zpass, writeMask) 

Configures how stencil buffer values should be modified based on the result of depth/stencil tests. Works for both front and back faces.

Parameters

fail	number	Action to take if stencil test is failed.
zfail	number	Action to take if depth test is failed.
zpass	number	Action to take if both depth and stencil test are passed All arguments can be: pc.STENCILOP_KEEP: don't change the stencil buffer value pc.STENCILOP_ZERO: set value to zero pc.STENCILOP_REPLACE: replace value with the reference value (see pc.GraphicsDevice#setStencilFunc) pc.STENCILOP_INCREMENT: increment the value pc.STENCILOP_INCREMENTWRAP: increment the value, but wrap it to zero when it's larger than a maximum representable value pc.STENCILOP_DECREMENT: decrement the value pc.STENCILOP_DECREMENTWRAP: decrement the value, but wrap it to a maximum representable value, if the current value is 0 pc.STENCILOP_INVERT: invert the value bitwise
writeMask	number	A bit mask applied to the reference value, when written.

setStencilOperationBack(fail, zfail, zpass, writeMask) 

Configures how stencil buffer values should be modified based on the result of depth/stencil tests. Works for back faces.

Parameters

fail	number	Action to take if stencil test is failed.
zfail	number	Action to take if depth test is failed.
zpass	number	Action to take if both depth and stencil test are passed All arguments can be: pc.STENCILOP_KEEP: don't change the stencil buffer value pc.STENCILOP_ZERO: set value to zero pc.STENCILOP_REPLACE: replace value with the reference value (see pc.GraphicsDevice#setStencilFunc) pc.STENCILOP_INCREMENT: increment the value pc.STENCILOP_INCREMENTWRAP: increment the value, but wrap it to zero when it's larger than a maximum representable value pc.STENCILOP_DECREMENT: decrement the value pc.STENCILOP_DECREMENTWRAP: decrement the value, but wrap it to a maximum representable value, if the current value is 0 pc.STENCILOP_INVERT: invert the value bitwise
writeMask	number	A bit mask applied to the reference value, when written.

setStencilOperationFront(fail, zfail, zpass, writeMask) 

Configures how stencil buffer values should be modified based on the result of depth/stencil tests. Works for front faces.

Parameters

fail	number	Action to take if stencil test is failed.
zfail	number	Action to take if depth test is failed.
zpass	number	Action to take if both depth and stencil test are passed All arguments can be: pc.STENCILOP_KEEP: don't change the stencil buffer value pc.STENCILOP_ZERO: set value to zero pc.STENCILOP_REPLACE: replace value with the reference value (see pc.GraphicsDevice#setStencilFunc) pc.STENCILOP_INCREMENT: increment the value pc.STENCILOP_INCREMENTWRAP: increment the value, but wrap it to zero when it's larger than a maximum representable value pc.STENCILOP_DECREMENT: decrement the value pc.STENCILOP_DECREMENTWRAP: decrement the value, but wrap it to a maximum representable value, if the current value is 0 pc.STENCILOP_INVERT: invert the value bitwise
writeMask	number	A bit mask applied to the reference value, when written.

setStencilTest(enable) 

Enables or disables stencil test.

Parameters

enable

True to enable stencil test and false to disable it.

setVertexBuffer(vertexBuffer, stream, [vbOffset]) 

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

Parameters

vertexBuffer	pc.VertexBuffer	The vertex buffer to assign to the device.
stream	number	The stream index for the vertex buffer, indexed from 0 upwards.
vbOffset	number	The byte offset into the vertex buffer data. Defaults to 0.

setViewport(x, y, w, h) 

Set the active rectangle for rendering on the specified device.

Parameters

x	number	The pixel space x-coordinate of the bottom left corner of the viewport.
y	number	The pixel space y-coordinate of the bottom left corner of the viewport.
w	number	The width of the viewport in pixels.
h	number	The height of the viewport in pixels.

updateBegin() 

Marks the beginning of a block of rendering. Internally, this function binds the render target currently set on the device. This function should be matched with a call to pc.GraphicsDevice#updateEnd. Calls to pc.GraphicsDevice#updateBegin and pc.GraphicsDevice#updateEnd must not be nested.

updateEnd() 

Marks the end of a block of rendering. This function should be called after a matching call to pc.GraphicsDevice#updateBegin. Calls to pc.GraphicsDevice#updateBegin and pc.GraphicsDevice#updateEnd must not be nested.

Events

resizecanvas 

The 'resizecanvas' event is 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	object	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

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 hander functions, called 'test' with scope this

Parameters

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

Returns

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	pc.callbacks.HandleEvent	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

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	pc.callbacks.HandleEvent	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