Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
system |
string |
The name of the system this renderer is for. |
||||||||||||||||||||||||||||||||||||||||||||
options |
object |
optional
The optional renderer parameters.
|
Extends
Members
-
The background color as a number.
-
The background color as an [R, G, B] array.
-
The background color as a string.
-
_lastObjectRendered PIXI.DisplayObject protected
-
The last root object that the renderer tried to render.
-
_tempDisplayObjectParent PIXI.DisplayObject protected
-
This temporary display object used as the parent of the currently being rendered item.
-
Whether CSS dimensions of canvas view should be resized to screen dimensions automatically.
-
The background color to fill if not transparent
-
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.
-
Same as view.height, actual number of pixels in the canvas by vertical.
- Default Value:
- 600
-
The supplied constructor options.
-
Collection of plugins.
-
The value of the preserveDrawingBuffer flag affects whether or not the contents of the stencil buffer is retained after rendering.
-
The resolution / device pixel ratio of the renderer.
- Default Value:
- 1
-
screen PIXI.Rectangle
-
Measurements of the screen. (0, 0, screenWidth, screenHeight).
Its safe to use as filterArea or hitArea for the whole stage.
-
Whether the render view is transparent.
-
The type of the renderer.
- Default Value:
- PIXI.RENDERER_TYPE.UNKNOWN
- See:
-
The canvas element that everything is drawn to.
-
Same as view.width, actual number of pixels in the canvas by horizontal.
- Default Value:
- 800
Methods
-
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.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 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.RenderTexture A texture of the graphics object. -
Initialize the plugins.
Name Type Description staticMap
object The dictionary of statically saved plugins.
-
Resizes the screen and canvas to the specified width and height. Canvas dimensions are multiplied by resolution.
Name Type Description screenWidth
number The new width of the screen.
screenHeight
number The new height of the screen.