PixiDisplay Class
PixiDisplay is a display plugin for the CloudKid Framework that uses the Pixi library for rendering.
Constructor
PixiDisplay
-
id
-
options
Parameters:
-
id
StringThe id of the canvas element on the page to draw to.
-
options
ObjectThe setup data for the Pixi stage.
-
[forceContext=null]
String optionalIf a specific renderer should be used instead of WebGL falling back to Canvas. Use "webgl" or "canvas2d" to specify a renderer.
-
[clearView=false]
Boolean optionalIf the stage should wipe the canvas between renders.
-
[backgroundColor=0x000000]
Uint optionalThe background color of the stage (if it is not transparent).
-
[transparent=false]
Boolean optionalIf the stage should be transparent.
-
[preMultAlpha=false]
Boolean optionalIf the WebGL renderer should draw with all images as pre-multiplied alpha. In most cases, you probably do not want to set this option to true.
-
Item Index
Methods
destroy
()
Destroys the display. This method is called by the Application and should not be called directly, use Application.removeDisplay(id). The stage recursively removes all display objects here.
render
-
elapsed
Updates the stage and draws it. This is only called by the Application. This method does nothing if paused is true or visible is false.
Parameters:
-
elapsed
Int
resize
-
width
-
height
Resizes the canvas and the renderer. This is only called by the Application.
Parameters:
-
width
IntThe width that the display should be
-
height
IntThe height that the display should be
Properties
The Pixi renderer.
The rendering library's stage element, the root display object
canvas
DOMElement
public
the canvas managed by this display
height
Int
public
Convenience method for getting the height of the canvas element would be the same thing as canvas.height
paused
Boolean
public
If rendering is paused on this display only. Pausing all displays can be done using Application.paused setter.
visible
Boolean
public
If the display is visible, using "display: none" css on the canvas. Invisible displays won't render.
width
Int
public
Convenience method for getting the width of the canvas element would be the same thing as canvas.width