Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
optional
The optional renderer parameters
|
Extends
Members
-
autoResize 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
-
blendModes object.<string, mixed> inherited
-
Tracks the blend modes useful for this renderer.
-
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.
-
The currently active canvas 2d context (could change with renderTextures)
-
extract PIXI.extract.CanvasExtract
-
Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture
-
height number readonly inherited
-
Same as view.height, actual number of pixels in the canvas by vertical
- Default Value:
- 600
-
maskManager PIXI.CanvasMaskManager
-
Instance of a CanvasMaskManager, handles masking when using the canvas renderer.
-
options Object readonly inherited
-
The supplied constructor options.
-
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.accessibility.AccessibilityManager Support tabbing interactive elements.
extract
PIXI.extract.CanvasExtract Extract image data from renderer.
interaction
PIXI.interaction.InteractionManager Handles mouse, touch and pointer events.
prepare
PIXI.prepare.CanvasPrepare Pre-render display objects.
-
preserveDrawingBuffer boolean inherited
-
The value of the preserveDrawingBuffer flag affects whether or not the contents of the stencil buffer is retained after rendering.
-
Boolean flag controlling canvas refresh.
-
The resolution / device pixel ratio of the renderer
- Default Value:
- 1
-
The root canvas 2d context that everything is drawn with.
-
roundPixels boolean inherited
-
If true PixiJS will Math.floor() x/y values when rendering, stopping pixel interpolation. Handy for crisp pixel art and speed on legacy devices.
-
screen PIXI.Rectangle inherited
-
Measurements of the screen. (0, 0, screenWidth, screenHeight)
Its safe to use as filterArea or hitArea for whole stage
-
The canvas property used to set the canvas smoothing property.
-
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 readonly inherited
-
Same as view.width, actual number of pixels in the canvas by horizontal
- Default Value:
- 800
Methods
-
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)PIXI.Texture 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 Description displayObject
PIXI.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
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.Texture a texture of the graphics object -
Checks if blend mode has changed.
-
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.
-
Renders the object to this canvas view
Name Type 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 false optional Whether to clear the canvas before drawing
transform
PIXI.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
-
Sets the blend mode of the renderer.
Name Type Description blendMode
number See PIXI.BLEND_MODES for valid values.