Class: CanvasRenderer

Extends

• SINT.SystemRenderer

Members

autoResize boolean inherited overrides

Whether css dimensions of canvas view should be resized to screen dimensions automatically

backgroundColor number inherited overrides

The background color to fill if not transparent

blendModes object.<string, mixed> inherited overrides

Tracks the blend modes useful for this renderer.

clearBeforeRender boolean inherited overrides

This sets if the CanvasRenderer will clear the canvas or not before the new render pass. If the scene is NOT transparent SINTJS will use a canvas sized fillRect operation every frame to set the canvas background color. If the scene is transparent SINTJS will use clearRect to clear the canvas every frame. Disable this by setting this to false. For example if your game has a canvas filling background image you often don't need this set.

context CanvasRenderingContext2D

The currently active canvas 2d context (could change with renderTextures)

height number readonly inherited overrides

Same as view.height, actual number of pixels in the canvas by vertical

Default Value:

• 600

maskManager SINT.CanvasMaskManager

Instance of a CanvasMaskManager, handles masking when using the canvas renderer.

options Object readonly inherited overrides

The supplied constructor options.

plugins object readonly

Collection of installed plugins. These are included by default in SINT, but can be excluded by creating a custom build. Consult the README for more information about creating custom builds and excluding plugins.

Properties:

Name	Type	Description
accessibility	SINT.accessibility.AccessibilityManager	Support tabbing interactive elements.
extract	SINT.extract.CanvasExtract	Extract image data from renderer.
interaction	SINT.interaction.InteractionManager	Handles mouse, touch and pointer events.
prepare	SINT.prepare.CanvasPrepare	Pre-render display objects.

preserveDrawingBuffer boolean inherited overrides

The value of the preserveDrawingBuffer flag affects whether or not the contents of the stencil buffer is retained after rendering.

refresh boolean

Boolean flag controlling canvas refresh.

resolution number inherited overrides

The resolution / device pixel ratio of the renderer

Default Value:

• 1

rootContext CanvasRenderingContext2D

The root canvas 2d context that everything is drawn with.

roundPixels boolean inherited overrides

If true SINTJS will Math.floor() x/y values when rendering, stopping pixel interpolation. Handy for crisp pixel art and speed on legacy devices.

screen SINT.Rectangle inherited overrides

Measurements of the screen. (0, 0, screenWidth, screenHeight)

Its safe to use as filterArea or hitArea for whole stage

smoothProperty string

The canvas property used to set the canvas smoothing property.

transparent boolean inherited overrides

Whether the render view is transparent

type number inherited overrides

The type of the renderer.

Default Value:

• SINT.RENDERER_TYPE.UNKNOWN

See:

• SINT.RENDERER_TYPE

view HTMLCanvasElement inherited overrides

The canvas element that everything is drawn to

width number readonly inherited overrides

Same as view.width, actual number of pixels in the canvas by horizontal

Default Value:

• 800

Methods

clear (clearColor)

Clear the canvas of renderer.

Name	Type	Description
clearColor	string	optional Clear the canvas with this color, except the canvas is transparent.

destroy (removeView) overrides

Removes everything from the renderer and optionally removes the Canvas DOM element.

Name	Type	Default	Description
removeView	boolean	false	optional Removes the Canvas element from the DOM.

generateTexture (displayObject, scaleMode, resolution, region)SINT.Texture inherited overrides

Useful function that returns a texture of the display object that can then be used to create sprites This can be quite useful if your displayObject is complicated and needs to be reused multiple times.

Name	Type	Description
displayObject	SINT.DisplayObject	The displayObject the object will be generated from
scaleMode	number	Should be one of the scaleMode consts
resolution	number	The resolution / device pixel ratio of the texture being generated
region	SINT.Rectangle	optional The region of the displayObject, that shall be rendered, if no region is specified, defaults to the local bounds of the displayObject.

Returns:

Type	Description
SINT.Texture	a texture of the graphics object

invalidateBlendMode ()

Checks if blend mode has changed.

registerPlugin (pluginName, ctor)

Adds a plugin to the renderer.

Name	Type	Description
pluginName	string	The name of the plugin.
ctor	function	The constructor function or class for the plugin.

render (displayObject, renderTexture, clear, transform, skipUpdateTransform)

Renders the object to this canvas view

Name	Type	Default	Description
displayObject	SINT.DisplayObject		The object to be rendered
renderTexture	SINT.RenderTexture		optional A render texture to be rendered to. If unset, it will render to the root context.
clear	boolean	false	optional Whether to clear the canvas before drawing
transform	SINT.Matrix		optional A transformation to be applied
skipUpdateTransform	boolean	false	optional Whether to skip the update transform

resize (screenWidth, screenHeight) overrides

Resizes the canvas view to the specified width and height.

Name	Type	Description
screenWidth	number	the new width of the screen
screenHeight	number	the new height of the screen

setBlendMode (blendMode)

Sets the blend mode of the renderer.

Name	Type	Description
blendMode	number	See SINT.BLEND_MODES for valid values.