abstractnew PIXI.SystemRenderer(system, width, height, options)
Name | Type | Default | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
system |
string |
The name of the system this renderer is for. |
|||||||||||||||||||||||||||||||||||||
width |
number | 800 |
optional
the width of the canvas view |
||||||||||||||||||||||||||||||||||||
height |
number | 600 |
optional
the height of the canvas view |
||||||||||||||||||||||||||||||||||||
options |
object |
optional
The optional renderer parameters
|
Extends
- EventEmitter
Members
-
autoResizeboolean
-
Whether the render view should be resized automatically
-
backgroundColornumber
-
The background color to fill if not transparent
-
blendModesobject.<string, mixed>
-
Tracks the blend modes useful for this renderer.
-
clearBeforeRenderboolean
-
This sets if the CanvasRenderer will clear the canvas or not before the new render pass.
If the scene is NOT transparent Pixi will use a canvas sized fillRect operation every
frame to set the canvas background color. If the scene is transparent Pixi 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. -
heightnumber
-
The height of the canvas view
- Default Value:
- 600
-
preserveDrawingBufferboolean
-
The value of the preserveDrawingBuffer flag affects whether or not the contents of
the stencil buffer is retained after rendering. -
resolutionnumber
-
The resolution / device pixel ratio of the renderer
- Default Value:
- 1
-
roundPixelsboolean
-
If true Pixi will Math.floor() x/y values when rendering, stopping pixel interpolation.
Handy for crisp pixel art and speed on legacy devices. -
transparentboolean
-
Whether the render view is transparent
-
typenumber
-
The type of the renderer.
- Default Value:
- PIXI.RENDERER_TYPE.UNKNOWN
- See:
-
viewHTMLCanvasElement
-
The canvas element that everything is drawn to
-
widthnumber
-
The width of the canvas view
- Default Value:
- 800
Methods
-
destroy(removeView)
-
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){PIXI.Texture}
-
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
Returns:
Type Description PIXI.Texture a texture of the graphics object -
resize(width, height)
-
Resizes the canvas view to the specified width and height
Name Type Description width
number the new width of the canvas view
height
number the new height of the canvas view