new PIXI.CanvasRenderer (options) overrides
| Name | Type | Attributes | Description |
|---|---|---|---|
options |
PIXI.IRendererOptions |
<optional> |
See PIXI.settings.RENDER_OPTIONS for defaults. |
Extends
Implements
Members
_plugin PIXI.PluginSystem readonly
plugin system instance
_view PIXI.ViewSystem readonly
View system instance
Whether CSS dimensions of canvas view should be resized to screen dimensions automatically.
background PIXI.BackgroundSystem readonly
background system instance
The background color alpha. Setting this to 0 will make the canvas transparent.
backgroundColor PIXI.ColorSource Deprecated : since 7.0.0
The background color to fill if not transparent
Tracks the blend modes useful for this renderer.
canvasContext PIXI.CanvasContextSystem readonly
Canvas context system instance
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.
context PIXI.ICanvasRenderingContext2D Deprecated : since 7.0.0 Use `renderer.canvasContext.activeContext instead
The currently active canvas 2d context (could change with renderTextures)
Same as view.height, actual number of pixels in the canvas by vertical.
- Default Value:
- 600
lastObjectRendered PIXI.IRenderableObject
the last object rendered by the renderer. Useful for other plugins like interaction managers
mask PIXI.CanvasMaskSystem readonly
canvas mask system instance
maskManager PIXI.CanvasMaskSystem Deprecated : since 7.0.0 use `renderer.canvasContext.mask`
system that manages canvas masks
objectRenderer PIXI.CanvasObjectRendererSystem readonly
renderer system instance
options PIXI.IRendererOptions readonly
Options passed to the constructor.
Collection of plugins
old abstract function not used by canvas renderer
Boolean flag controlling canvas refresh.
When logging Pixi to the console, this is the name we will show
- Default Value:
- "Canvas"
Flag if we are rendering to the screen vs renderTexture
The resolution / device pixel ratio of the renderer.
rootContext PIXI.ICanvasRenderingContext2D Deprecated : since 7.0.0 Use `renderer.canvasContext.rootContext instead
The root canvas 2d context that everything is drawn with.
screen PIXI.Rectangle
Measurements of the screen. (0, 0, screenWidth, screenHeight). Its safe to use as filterArea or hitArea for the whole stage.
The canvas property used to set the canvas smoothing property.
startup PIXI.StartupSystem readonly
Startup system instance
textureGenerator PIXI.GenerateTextureSystem readonly
textureGenerator system instance
The type of the renderer. will be PIXI.RENDERER_TYPE.CANVAS
- See:
old abstract function not used by canvas renderer
view PIXI.ICanvas
The canvas element that everything is drawn to.
Same as view.width, actual number of pixels in the canvas by horizontal.
- Default Value:
- 800
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. |
Methods
Clear the canvas of renderer.
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. |
generateTexture (displayObject, options) PIXI.RenderTexture
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.IRenderableObject |
The displayObject the object will be generated from. |
|
options |
IGenerateTextureOptions |
<optional> |
Generate texture options. |
options.region |
PIXI.Rectangle |
The region of the displayObject, that shall be rendered, if no region is specified, defaults to the local bounds of the displayObject. |
|
options.resolution |
number |
<optional> |
If not given, the renderer's resolution is used. |
options.multisample |
PIXI.MSAA_QUALITY |
<optional> |
If not given, the renderer's multisample is used. |
Returns:
| Type | Description |
|---|---|
| PIXI.RenderTexture | A texture of the graphics object. |
Checks if blend mode has changed.
Renders the object to its WebGL view.
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
displayObject |
PIXI.DisplayObject |
The object to be rendered. |
||
options |
IRendererRenderOptions |
<optional> |
Object to use for render options. |
|
options.renderTexture |
PIXI.RenderTexture |
<optional> |
The render texture to render to. |
|
options.clear |
boolean |
<optional> |
true |
Should the canvas be cleared before the new render. |
options.transform |
PIXI.Matrix |
<optional> |
A transform to apply to the render texture before rendering. |
|
options.skipUpdateTransform |
boolean |
<optional> |
false |
Should we skip the update transform pass? |
Resizes the canvas view to the specified width and height.
| Name | Type | Description |
|---|---|---|
desiredScreenWidth |
number |
the desired width of the screen |
desiredScreenHeight |
number |
the desired 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.SystemManager
runners { [key: string]: PIXI.Runner } readonly inherited overrides
a collection of runners defined by the user
Inherited Methods
From class PIXI.SystemManager
Create a bunch of runners based of a collection of ids
| Name | Type | Description |
|---|---|---|
runnerIds |
string[] |
the runner ids to add |
Add a new system to the renderer.
| Name | Type | Description |
|---|---|---|
ClassRef |
ISystemConstructor<R> |
Class reference |
name |
string |
Property name for system, if not specified
will use a static |
Returns:
| Type | Description |
|---|---|
| this | Return instance of renderer |
A function that will run a runner and call the runners function but pass in different options to each system based on there name.
E.g. If you have two systems added called systemA and systemB you could call do the following:
system.emitWithCustomOptions(init, {
systemA: {...optionsForA},
systemB: {...optionsForB},
});
init would be called on system A passing optionsForA and on system B passing optionsForB.
| Name | Type | Description |
|---|---|---|
runner |
PIXI.Runner |
the runner to target |
options |
Record<string, unknown> |
key value options for each system |
Set up a system with a collection of SystemClasses and runners. Systems are attached dynamically to this class when added.
| Name | Type | Description |
|---|---|---|
config |
ISystemConfig<R> |
the config for the system manager |