Stage Class
A Stage represents the root of the display tree. Everything connected to the stage is rendered
Constructor
Stage
-
backgroundColor
Parameters:
-
backgroundColorNumberthe background color of the stage, you have to pass this in is in hex format like: 0xFFFFFF for white
Creating a stage is a mandatory process when you use Pixi, which is as simple as this : var stage = new PIXI.Stage(0xFFFFFF); where the parameter given is the background colour of the stage, in hex you will use this stage instance to add your sprites to it and therefore to the renderer Here is how to add a sprite to the stage : stage.addChild(sprite);
Item Index
Methods
- _renderCanvas
- _renderWebGL
- addChild
- addChildAt
- click
- generateTexture
- getBounds
- getChildAt
- getChildIndex
- getLocalBounds
- getMousePosition
- mousedown
- mouseout
- mouseover
- mouseup
- mouseupoutside
- removeChild
- removeChildAt
- removeChildren
- removeStageReference
- rightclick
- rightdown
- rightup
- rightupoutside
- setBackgroundColor
- setChildIndex
- setInteractionDelegate
- setInteractive deprecated
- setStageReference
- swapChildren
- tap
- toGlobal
- touchend
- touchendoutside
- touchstart
Properties
Methods
_renderCanvas
-
renderSession
Renders the object using the Canvas renderer
Parameters:
-
renderSessionRenderSession
_renderWebGL
-
renderSession
Renders the object using the WebGL renderer
Parameters:
-
renderSessionRenderSession
addChild
-
child
Adds a child to the container.
Parameters:
-
childDisplayObjectThe DisplayObject to add to the container
addChildAt
-
child -
index
Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown
Parameters:
-
childDisplayObjectThe child to add
-
indexNumberThe index to place the child in
click
-
interactionData
A callback that is used when the users clicks on the displayObject with their mouse's left button
Parameters:
-
interactionDataInteractionData
generateTexture
-
resolution -
scaleMode
Useful function that returns a texture of the displayObject object that can then be used to create sprites This can be quite useful if your displayObject is static / complicated and needs to be reused multiple times.
Parameters:
-
resolutionNumberThe resolution of the texture being generated
-
scaleModeNumberShould be one of the PIXI.scaleMode consts
Returns:
a texture of the graphics object
getBounds
()
Rectangle
Retrieves the bounds of the displayObjectContainer as a rectangle object
Returns:
the rectangular bounding area
getChildAt
-
index
Returns the child at the specified index
Parameters:
-
indexNumberThe index to get the child from
getChildIndex
-
child
Returns the index position of a child DisplayObject instance
Parameters:
-
childDisplayObjectThe DisplayObject instance to identify
Returns:
The index position of the child display object to identify
getLocalBounds
()
Rectangle
Retrieves the local bounds of the displayObject as a rectangle object
Returns:
the rectangular bounding area
getMousePosition
()
Point
This will return the point containing global coords of the mouse.
Returns:
The point containing the coords of the global InteractionData position.
mousedown
-
interactionData
A callback that is used when the user clicks the mouse's left button down over the sprite
Parameters:
-
interactionDataInteractionData
mouseout
-
interactionData
A callback that is used when the users mouse leaves the displayObject
Parameters:
-
interactionDataInteractionData
mouseover
-
interactionData
A callback that is used when the users mouse rolls over the displayObject
Parameters:
-
interactionDataInteractionData
mouseup
-
interactionData
A callback that is used when the user releases the mouse's left button that was over the displayObject for this callback to be fired, the mouse's left button must have been pressed down over the displayObject
Parameters:
-
interactionDataInteractionData
mouseupoutside
-
interactionData
A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject for this callback to be fired, the mouse's left button must have been pressed down over the displayObject
Parameters:
-
interactionDataInteractionData
removeChild
-
child
Removes a child from the container.
Parameters:
-
childDisplayObjectThe DisplayObject to remove
removeChildAt
-
index
Removes a child from the specified index position in the child list of the container.
Parameters:
-
indexNumberThe index to get the child from
removeChildren
-
beginIndex -
endIndex
Removes all child instances from the child list of the container.
Parameters:
-
beginIndexNumberThe beginning position. Predefined value is 0.
-
endIndexNumberThe ending position. Predefined value is children's array length.
removeStageReference
()
removes the current stage reference of the container
rightclick
-
interactionData
A callback that is used when the users clicks on the displayObject with their mouse's right button
Parameters:
-
interactionDataInteractionData
rightdown
-
interactionData
A callback that is used when the user clicks the mouse's right button down over the sprite
Parameters:
-
interactionDataInteractionData
rightup
-
interactionData
A callback that is used when the user releases the mouse's right button that was over the displayObject for this callback to be fired the mouse's right button must have been pressed down over the displayObject
Parameters:
-
interactionDataInteractionData
rightupoutside
-
interactionData
A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject for this callback to be fired, the mouse's right button must have been pressed down over the displayObject
Parameters:
-
interactionDataInteractionData
setBackgroundColor
-
backgroundColor
Sets the background color for the stage
Parameters:
-
backgroundColorNumberthe color of the background, easiest way to pass this in is in hex format like: 0xFFFFFF for white
setChildIndex
-
child -
index
Changes the position of an existing child in the display object container
Parameters:
-
childDisplayObjectThe child DisplayObject instance for which you want to change the index number
-
indexNumberThe resulting index number for the child display object
setInteractionDelegate
-
domElement
Sets another DOM element which can receive mouse/touch interactions instead of the default Canvas element. This is useful for when you have other DOM elements on top of the Canvas element.
Parameters:
-
domElementDOMElementThis new domElement which will receive mouse/touch events
setInteractive
-
interactive
[Deprecated] Indicates if the sprite will have touch and mouse interactivity. It is false by default Instead of using this function you can now simply set the interactive property to true or false
Parameters:
-
interactiveBoolean
setStageReference
-
stage
Sets the container's stage reference, the stage this object is connected to
Parameters:
-
stageStagethe stage that the container will have as its current stage reference
swapChildren
-
child -
child2
[NYI] Swaps the depth of 2 displayObjects
Parameters:
-
childDisplayObject -
child2DisplayObject
tap
-
interactionData
A callback that is used when the users taps on the sprite with their finger basically a touch version of click
Parameters:
-
interactionDataInteractionData
toGlobal
-
position
Calculates the global position of the display object
Parameters:
-
positionPointThe world origin to calculate from
Returns:
A point object representing the position of this object
touchend
-
interactionData
A callback that is used when the user releases a touch over the displayObject
Parameters:
-
interactionDataInteractionData
touchendoutside
-
interactionData
A callback that is used when the user releases the touch that was over the displayObject for this callback to be fired, The touch must have started over the sprite
Parameters:
-
interactionDataInteractionData
touchstart
-
interactionData
A callback that is used when the user touches over the displayObject
Parameters:
-
interactionDataInteractionData
Properties
_interactive
Boolean
private
[read-only] Whether or not the object is interactive, do not toggle directly! use the interactive property
alpha
Number
The opacity of the object.
cacheAsBitmap
Boolean
Set weather or not a the display objects is cached as a bitmap. This basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects To remove filters simply set this property to 'null'
children
Array[read-only] The array of children of this container.
color
Array<>
private
[NYI] Unknown
defaultCursor
String
This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true
dirty
Boolean
private
Whether the stage is dirty and needs to have interactions updated
dynamic
Boolean
private
[NYI] Holds whether or not this object is dynamic, for rendering optimization
filterArea
Rectangle
The area the filter is applied to like the hitArea this is used as more of an optimisation rather than figuring out the dimensions of the displayObject each frame you can set this rectangle
filters
Array An array of filters
Sets the filters for the displayObject.
- IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer. To remove filters simply set this property to 'null'
height
Number
The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set
hitArea
Rectangle | Circle | Ellipse | Polygon
This is the defined area that will pick up mouse / touch events. It is null by default. Setting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)
interactionManager
InteractionManager
The interaction manage for this stage, manages all interactive activity on the stage
interactive
Boolean
Whether or not the stage is interactive
mask
Graphics
Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping. To remove a mask, set this property to null.
parent
DisplayObjectContainer
[read-only] The display object container that contains this display object.
renderable
Boolean
Can this object be rendered
rotation
Number
The rotation of the object in radians.
stage
Stage
[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.
visible
Boolean
The visibility of the object.
width
Number
The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set
worldAlpha
Number
[read-only] The multiplied alpha of the displayObject
worldTransform
Mat3
private
[read-only] Current transform of the object based on world (parent) factors
worldVisible
Boolean
[read-only] Indicates if the sprite is globaly visible.
x
Number
The position of the displayObject on the x axis relative to the local coordinates of the parent.
y
Number
The position of the displayObject on the y axis relative to the local coordinates of the parent.