API Docs for: 1.0.0
Show:

Stage Class

Extends DisplayObjectContainer
Defined in: src/pixi/Stage.js:5
Module: PIXI

A Stage represents the root of the display tree. Everything connected to the stage is rendered

Constructor

Stage

(
  • backgroundColor
  • interactive
)

Defined in src/pixi/Stage.js:5

Parameters:

  • backgroundColor Number

    the background color of the stage

  • interactive Boolean

    enable / disable interaction (default is false)

Methods

addChild

(
  • DisplayObject
)

Inherited from DisplayObjectContainer: src/pixi/DisplayObjectContainer.js:29

Adds a child to the container.

Parameters:

addChildAt

(
  • DisplayObject
  • index
)

Inherited from DisplayObjectContainer: src/pixi/DisplayObjectContainer.js:51

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

Parameters:

click

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/DisplayObject.js:91

A callback that is used when the users clicks on the displayObject with their mouse

Parameters:

getChildAt

(
  • index
)

Inherited from DisplayObjectContainer: src/pixi/DisplayObjectContainer.js:137

Returns the Child at the specified index

Parameters:

  • index Number

getMousePosition

() Point

Defined in src/pixi/Stage.js:71

This will return the point containing global coords of the mouse.

Returns:

Point: The point containing the coords of the global InteractionData position.

mousedown

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/DisplayObject.js:97

A callback that is used when the user clicks the mouse down over the sprite

Parameters:

mouseout

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/DisplayObject.js:123

A callback that is used when the users mouse leaves the displayObject

Parameters:

mouseover

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/DisplayObject.js:117

A callback that is used when the users mouse rolls over the displayObject

Parameters:

mouseup

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/DisplayObject.js:103

A callback that is used when the user releases the mouse that was over the displayObject for this callback to be fired the mouse must have been pressed down over the displayObject

Parameters:

mouseupoutside

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/DisplayObject.js:110

A callback that is used when the user releases the mouse that was over the displayObject but is no longer over the displayObject for this callback to be fired, The touch must have started over the displayObject

Parameters:

removeChild

(
  • DisplayObject
)

Inherited from DisplayObjectContainer: src/pixi/DisplayObjectContainer.js:155

Removes a child from the container.

Parameters:

setBackgroundColor

(
  • backgroundColor
)

Defined in src/pixi/Stage.js:60

Parameters:

  • backgroundColor Number

setInteractive

(
  • interactive
)

Inherited from DisplayObject: src/pixi/DisplayObject.js:164

Indicates if the sprite will have touch and mouse interactivity. It is false by default

Parameters:

  • interactive Boolean

swapChildren

(
  • DisplayObject
  • DisplayObject2
)

Inherited from DisplayObjectContainer: src/pixi/DisplayObjectContainer.js:97

Swaps the depth of 2 displayObjects

Parameters:

tap

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/DisplayObject.js:134

A callback that is used when the users taps on the sprite with their finger basically a touch version of click

Parameters:

touchend

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/DisplayObject.js:147

A callback that is used when the user releases a touch over the displayObject

Parameters:

touchendoutside

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/DisplayObject.js:153

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:

touchstart

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/DisplayObject.js:141

A callback that is used when the user touch's over the displayObject

Parameters:

updateTransform

()

Defined in src/pixi/Stage.js:37

Properties

alpha

Number

Inherited from DisplayObject: src/pixi/DisplayObject.js:33

The opacity of the object.

children

Array

Inherited from DisplayObjectContainer: src/pixi/DisplayObjectContainer.js:16

[read-only] The of children of this container.

hitArea

Rectangle

Inherited from DisplayObject: src/pixi/DisplayObject.js:62

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)

parent

DisplayObjectContainer

Inherited from DisplayObject: src/pixi/DisplayObject.js:48

[read-only] The display object container that contains this display object.

position

Point

Inherited from DisplayObject: src/pixi/DisplayObject.js:12

The coordinate of the object relative to the local coordinates of the parent.

rotation

Number

Inherited from DisplayObject: src/pixi/DisplayObject.js:26

The rotation of the object in radians.

scale

Point

Inherited from DisplayObject: src/pixi/DisplayObject.js:19

The scale factor of the object.

stage

Stage

Inherited from DisplayObject: src/pixi/DisplayObject.js:55

[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.

visible

Boolean

Inherited from DisplayObject: src/pixi/DisplayObject.js:40

The visibility of the object.