new PIXI.CanvasRenderer (options) overrides
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
options |
object |
<optional> |
The optional renderer parameters |
|
options.width |
number |
<optional> |
800 |
the width of the screen |
options.height |
number |
<optional> |
600 |
the height of the screen |
options.view |
HTMLCanvasElement |
<optional> |
the canvas to use as a view, optional |
|
options.transparent |
boolean |
<optional> |
false |
If the render view is transparent, default false |
options.autoDensity |
boolean |
<optional> |
false |
Resizes renderer view in CSS pixels to allow for resolutions other than 1 |
options.antialias |
boolean |
<optional> |
false |
sets antialias |
options.resolution |
number |
<optional> |
1 |
The resolution / device pixel ratio of the renderer. The resolution of the renderer retina would be 2. |
options.preserveDrawingBuffer |
boolean |
<optional> |
false |
enables drawing buffer preservation, enable this if you need to call toDataUrl on the webgl context. |
options.clearBeforeRender |
boolean |
<optional> |
true |
This sets if the renderer will clear the canvas or not before the new render pass. |
options.backgroundColor |
number |
<optional> |
0x000000 |
The background color of the rendered area (shown if not transparent). |
Extends
Members
Tracks the blend modes useful for this renderer.
The currently active canvas 2d context (could change with renderTextures)
maskManager PIXI.CanvasMaskManager
Instance of a CanvasMaskManager, handles masking when using the canvas renderer.
Boolean flag controlling canvas refresh.
The root canvas 2d context that everything is drawn with.
The canvas property used to set the canvas smoothing property.
plugins object overrides
Collection of installed plugins. These are included by default in PIXI, 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 |
PIXI.AccessibilityManager |
Support tabbing interactive elements. |
extract |
PIXI.CanvasExtract |
Extract image data from renderer. |
interaction |
PIXI.InteractionManager |
Handles mouse, touch and pointer events. |
prepare |
PIXI.CanvasPrepare |
Pre-render display objects. |
Methods
- See:
-
- PIXI.CanvasRenderer#plugins
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. |
Clear the canvas of renderer.
| Name | Type | Attributes | Description |
|---|---|---|---|
clearColor |
string |
<optional> |
Clear the canvas with this color, except the canvas is transparent. |
destroy (removeView) void overrides
Removes everything from the renderer and optionally removes the Canvas DOM element.
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
removeView |
boolean |
<optional> |
false |
Removes the Canvas element from the DOM. |
Checks if blend mode has changed.
Renders the object to this canvas view
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
displayObject |
PIXI.DisplayObject |
The object to be rendered |
||
renderTexture |
PIXI.RenderTexture |
<optional> |
A render texture to be rendered to. If unset, it will render to the root context. |
|
clear |
boolean |
<optional> |
this.clearBeforeRender |
Whether to clear the canvas before drawing |
transform |
PIXI.Matrix |
<optional> |
A transformation to be applied |
|
skipUpdateTransform |
boolean |
<optional> |
false |
Whether to skip the update transform |
resize (screenWidth, screenHeight) void 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 |
Sets the blend mode of the renderer.
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
blendMode |
number |
See PIXI.BLEND_MODES for valid values. |
||
readyForOuterBlend |
boolean |
<optional> |
false |
Some blendModes are dangerous, they affect outer space of sprite.
Pass |
sets matrix of context called only from render() methods takes care about resolution
| Name | Type | Attributes | Description |
|---|---|---|---|
transform |
PIXI.Matrix |
world matrix of current element |
|
roundPixels |
boolean |
<optional> |
whether to round (tx,ty) coords |
localResolution |
number |
<optional> |
If specified, used instead of |
Events
Fired after rendering finishes.
Fired before rendering starts.
Inherited Properties
From class PIXI.AbstractRenderer
autoDensity boolean inherited
Whether CSS dimensions of canvas view should be resized to screen dimensions automatically.
backgroundColor number inherited
The background color to fill if not transparent
clearBeforeRender boolean inherited
This sets if the CanvasRenderer will clear the canvas or not before the new render pass. If the scene is NOT transparent PixiJS will use a canvas sized fillRect operation every frame to set the canvas background color. If the scene is transparent PixiJS 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.
height number inherited
Same as view.height, actual number of pixels in the canvas by vertical.
- Default Value:
- 600
options Object inherited
The supplied constructor options.
preserveDrawingBuffer boolean inherited
The value of the preserveDrawingBuffer flag affects whether or not the contents of the stencil buffer is retained after rendering.
resolution number inherited
The resolution / device pixel ratio of the renderer.
- Default Value:
- 1
screen PIXI.Rectangle inherited
Measurements of the screen. (0, 0, screenWidth, screenHeight).
Its safe to use as filterArea or hitArea for the whole stage.
transparent boolean inherited
Whether the render view is transparent.
type number inherited
The type of the renderer.
- Default Value:
- PIXI.RENDERER_TYPE.UNKNOWN
- See:
view HTMLCanvasElement inherited
The canvas element that everything is drawn to.
width number inherited
Same as view.width, actual number of pixels in the canvas by horizontal.
- Default Value:
- 800
_backgroundColor number protected inherited
The background color as a number.
_backgroundColorRgba
Array
The background color as an [R, G, B] array.
_backgroundColorString string protected inherited
The background color as a string.
_lastObjectRendered PIXI.DisplayObject protected inherited
The last root object that the renderer tried to render.
Inherited Methods
From class PIXI.AbstractRenderer
generateTexture (displayObject, scaleMode, resolution, region) PIXI.RenderTexture inherited
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 | Attributes | Description |
|---|---|---|---|
displayObject |
PIXI.DisplayObject |
The displayObject the object will be generated from. |
|
scaleMode |
PIXI.SCALE_MODES |
<optional> |
The scale mode of the texture. |
resolution |
number |
<optional> |
The resolution / device pixel ratio of the texture being generated. |
region |
PIXI.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 |
|---|---|
| PIXI.RenderTexture | A texture of the graphics object. |
initPlugins (staticMap) void protected inherited
Initialize the plugins.
| Name | Type | Description |
|---|---|---|
staticMap |
object |
The dictionary of statically saved plugins. |