Packagestarling.display
Classpublic class Stage
InheritanceStage Inheritance DisplayObjectContainer Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object

A Stage represents the root of the display tree. Only objects that are direct or indirect children of the stage will be rendered.

This class represents the Starling version of the stage. Don't confuse it with its Flash equivalent: while the latter contains objects of the type flash.display.DisplayObject, the Starling stage contains only objects of the type starling.display.DisplayObject. Those classes are not compatible, and you cannot exchange one type with the other.

A stage object is created automatically by the Starling class. Don't create a Stage instance manually.

Keyboard Events

In Starling, keyboard events are only dispatched at the stage. Add an event listener directly to the stage to be notified of keyboard events.

Resize Events

When the Flash player is resized, the stage dispatches a ResizeEvent. The event contains properties containing the updated width and height of the Flash player.

See also

starling.events.KeyboardEvent
starling.events.ResizeEvent


Public Properties
 PropertyDefined By
 Inheritedalpha : Number
The opacity of the object.
DisplayObject
 Inheritedbase : DisplayObject
[read-only] The topmost object in the display tree the object is part of.
DisplayObject
 InheritedblendMode : String
The blend mode determines how the object is blended with the objects underneath.
DisplayObject
 Inheritedbounds : Rectangle
[read-only] The bounds of the object relative to the local coordinates of the parent.
DisplayObject
  cameraPosition : Vector3D
[read-only] The global position of the camera.
Stage
  color : uint
The background color of the stage.
Stage
  fieldOfView : Number
Specifies an angle (radian, between zero and PI) for the field of view.
Stage
 Inheritedfilter : FragmentFilter
The filter that is attached to the display object.
DisplayObject
  focalLength : Number
The distance between the stage and the camera.
Stage
 InheritedhasVisibleArea : Boolean
[read-only] Indicates if an object occupies any visible area.
DisplayObject
 Inheritedheight : Number
The height of the object in pixels.
DisplayObject
 Inheritedis3D : Boolean
[read-only] Indicates if this object or any of its parents is a 'Sprite3D' object.
DisplayObject
 Inheritedname : String
The name of the display object (default: null).
DisplayObject
 InheritednumChildren : int
[read-only] The number of children of this container.
DisplayObjectContainer
 Inheritedparent : DisplayObjectContainer
[read-only] The display object container that contains this display object.
DisplayObject
 InheritedpivotX : Number
The x coordinate of the object's origin in its own coordinate space (default: 0).
DisplayObject
 InheritedpivotY : Number
The y coordinate of the object's origin in its own coordinate space (default: 0).
DisplayObject
  projectionOffset : Point
A vector that moves the camera away from its default position in the center of the stage.
Stage
 Inheritedroot : DisplayObject
[read-only] The root object the display object is connected to (i.e.
DisplayObject
 Inheritedrotation : Number
The rotation of the object in radians.
DisplayObject
 InheritedscaleX : Number
The horizontal scale factor.
DisplayObject
 InheritedscaleY : Number
The vertical scale factor.
DisplayObject
 InheritedskewX : Number
The horizontal skew angle in radians.
DisplayObject
 InheritedskewY : Number
The vertical skew angle in radians.
DisplayObject
 Inheritedstage : Stage
[read-only] The stage the display object is connected to, or null if it is not connected to the stage.
DisplayObject
  stageHeight : int
The height of the stage coordinate system.
Stage
  stageWidth : int
The width of the stage coordinate system.
Stage
 Inheritedtouchable : Boolean
Indicates if this object (and its children) will receive touch events.
DisplayObject
 InheritedtouchGroup : Boolean
If a container is a 'touchGroup', it will act as a single touchable object.
DisplayObjectContainer
 InheritedtransformationMatrix : Matrix
The transformation matrix of the object relative to its parent.
DisplayObject
 InheritedtransformationMatrix3D : Matrix3D
[read-only] The 3D transformation matrix of the object relative to its parent.
DisplayObject
 InheriteduseHandCursor : Boolean
Indicates if the mouse cursor should transform into a hand while it's over the sprite.
DisplayObject
 Inheritedvisible : Boolean
The visibility of the object.
DisplayObject
 Inheritedwidth : Number
The width of the object in pixels.
DisplayObject
 Inheritedx : Number
The x coordinate of the object relative to the local coordinates of the parent.
DisplayObject
 Inheritedy : Number
The y coordinate of the object relative to the local coordinates of the parent.
DisplayObject
Public Methods
 MethodDefined By
 Inherited
Adds a child to the container.
DisplayObjectContainer
 Inherited
Adds a child to the container at a certain index.
DisplayObjectContainer
 Inherited
addEventListener(type:String, listener:Function):void
[override] Registers an event listener at a certain object.
DisplayObject
  
advanceTime(passedTime:Number):void
Stage
 Inherited
alignPivot(hAlign:String = center, vAlign:String = center):void
Moves the pivot point to a certain position within the local coordinate system of the object.
DisplayObject
 Inherited
broadcastEvent(event:Event):void
Dispatches an event on all children (recursively).
DisplayObjectContainer
 Inherited
broadcastEventWith(type:String, data:Object = null):void
Dispatches an event with the given parameters on all children (recursively).
DisplayObjectContainer
 Inherited
contains(child:DisplayObject):Boolean
Determines if a certain object is a child of the container (recursively).
DisplayObjectContainer
 Inherited
dispatchEvent(event:Event):void
[override]
DisplayObject
 Inherited
dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void
Dispatches an event with the given parameters to all objects that have registered listeners for the given type.
EventDispatcher
 Inherited
dispose():void
[override] Disposes the resources of all children.
DisplayObjectContainer
  
drawToBitmapData(destination:BitmapData = null, transparent:Boolean = true):BitmapData
Draws the complete stage into a BitmapData object.
Stage
 Inherited
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle
[override] Returns a rectangle that completely encloses the object as it appears in another coordinate system.
DisplayObjectContainer
  
getCameraPosition(space:DisplayObject = null, result:Vector3D = null):Vector3D
Returns the position of the camera within the local coordinate system of a certain display object.
Stage
 Inherited
Returns a child object at a certain index.
DisplayObjectContainer
 Inherited
Returns a child object with a certain name (non-recursively).
DisplayObjectContainer
 Inherited
Returns the index of a child within the container, or "-1" if it is not found.
DisplayObjectContainer
 Inherited
getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix
Creates a matrix that represents the transformation from the local coordinate system to another.
DisplayObject
 Inherited
getTransformationMatrix3D(targetSpace:DisplayObject, resultMatrix:Matrix3D = null):Matrix3D
Creates a matrix that represents the transformation from the local coordinate system to another.
DisplayObject
 Inherited
globalToLocal(globalPoint:Point, resultPoint:Point = null):Point
Transforms a point from global (stage) coordinates to the local coordinate system.
DisplayObject
 Inherited
globalToLocal3D(globalPoint:Point, resultPoint:Vector3D = null):Vector3D
Transforms a point from global (stage) coordinates to the 3D local coordinate system.
DisplayObject
 Inherited
hasEventListener(type:String):Boolean
Returns if there are listeners registered for a certain event type.
EventDispatcher
  
hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject
[override] Returns the object that is found topmost beneath a point in stage coordinates, or the stage itself if nothing else is found.
Stage
 Inherited
local3DToGlobal(localPoint:Vector3D, resultPoint:Point = null):Point
Transforms a 3D point from the local coordinate system to global (stage) coordinates.
DisplayObject
 Inherited
localToGlobal(localPoint:Point, resultPoint:Point = null):Point
Transforms a point from the local coordinate system to global (stage) coordinates.
DisplayObject
 Inherited
removeChild(child:DisplayObject, dispose:Boolean = false):DisplayObject
Removes a child from the container.
DisplayObjectContainer
 Inherited
removeChildAt(index:int, dispose:Boolean = false):DisplayObject
Removes a child at a certain index.
DisplayObjectContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void
Removes a range of children from the container (endIndex included).
DisplayObjectContainer
 Inherited
removeEventListener(type:String, listener:Function):void
[override] Removes an event listener from the object.
DisplayObject
 Inherited
removeEventListeners(type:String = null):void
[override] Removes all event listeners with a certain type, or all of them if type is null.
DisplayObject
 Inherited
removeFromParent(dispose:Boolean = false):void
Removes the object from its parent, if it has one, and optionally disposes it.
DisplayObject
 Inherited
render(support:RenderSupport, parentAlpha:Number):void
[override] Renders the display object with the help of a support object.
DisplayObjectContainer
 Inherited
setChildIndex(child:DisplayObject, index:int):void
Moves a child to a certain index.
DisplayObjectContainer
 Inherited
sortChildren(compareFunction:Function):void
Sorts the children according to a given function (that works just like the sort function of the Vector class).
DisplayObjectContainer
 Inherited
Swaps the indexes of two children.
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps the indexes of two children.
DisplayObjectContainer
Events
 Event Summary Defined By
 InheritedDispatched when an object is added to a parent.DisplayObject
 InheritedDispatched when an object is connected to the stage (directly or indirectly).DisplayObject
 InheritedDispatched once every frame on every object that is connected to the stage.DisplayObject
 InheritedDispatched when a key on the keyboard is pressed.DisplayObject
 InheritedDispatched when a key on the keyboard is released.DisplayObject
 InheritedDispatched when an object is removed from its parent.DisplayObject
 InheritedDispatched when an object is removed from the stage and won't be rendered any longer.DisplayObject
  Dispatched when the Flash container is resized.Stage
 InheritedDispatched when an object is touched.DisplayObject
Property Detail
cameraPositionproperty
cameraPosition:Vector3D  [read-only]

The global position of the camera. This property can only be used to find out the current position, but not to modify it. For that, use the 'projectionOffset', 'fieldOfView' and 'focalLength' properties. If you need the camera position in a certain coordinate space, use 'getCameraPosition' instead.

CAUTION: not a copy, but the actual object!


Implementation
    public function get cameraPosition():Vector3D
colorproperty 
color:uint

The background color of the stage.


Implementation
    public function get color():uint
    public function set color(value:uint):void
fieldOfViewproperty 
fieldOfView:Number

Specifies an angle (radian, between zero and PI) for the field of view. This value determines how strong the perspective transformation and distortion apply to a Sprite3D object.

A value close to zero will look similar to an orthographic projection; a value close to PI results in a fisheye lens effect. If the field of view is set to 0 or PI, nothing is seen on the screen.

The default value is 1.0.


Implementation
    public function get fieldOfView():Number
    public function set fieldOfView(value:Number):void
focalLengthproperty 
focalLength:Number

The distance between the stage and the camera. Changing this value will update the field of view accordingly.


Implementation
    public function get focalLength():Number
    public function set focalLength(value:Number):void
projectionOffsetproperty 
projectionOffset:Point

A vector that moves the camera away from its default position in the center of the stage. Use this property to change the center of projection, i.e. the vanishing point for 3D display objects.

CAUTION: not a copy, but the actual object!


Implementation
    public function get projectionOffset():Point
    public function set projectionOffset(value:Point):void
stageHeightproperty 
stageHeight:int

The height of the stage coordinate system. Change it to scale its contents relative to the viewPort property of the Starling object.


Implementation
    public function get stageHeight():int
    public function set stageHeight(value:int):void
stageWidthproperty 
stageWidth:int

The width of the stage coordinate system. Change it to scale its contents relative to the viewPort property of the Starling object.


Implementation
    public function get stageWidth():int
    public function set stageWidth(value:int):void
Method Detail
advanceTime()method
public function advanceTime(passedTime:Number):void

Parameters

passedTime:Number

drawToBitmapData()method 
public function drawToBitmapData(destination:BitmapData = null, transparent:Boolean = true):BitmapData

Draws the complete stage into a BitmapData object.

If you encounter problems with transparency, start Starling in BASELINE profile (or higher). BASELINE_CONSTRAINED might not support transparency on all platforms.

Parameters

destination:BitmapData (default = null) — If you pass null, the object will be created for you. If you pass a BitmapData object, it should have the size of the back buffer (which is accessible via the respective properties on the Starling instance).
 
transparent:Boolean (default = true) — If enabled, empty areas will appear transparent; otherwise, they will be filled with the stage color.

Returns
BitmapData
getCameraPosition()method 
public function getCameraPosition(space:DisplayObject = null, result:Vector3D = null):Vector3D

Returns the position of the camera within the local coordinate system of a certain display object. If you do not pass a space, the method returns the global position. To change the position of the camera, you can modify the properties 'fieldOfView', 'focalDistance' and 'projectionOffset'.

Parameters

space:DisplayObject (default = null)
 
result:Vector3D (default = null)

Returns
Vector3D
hitTest()method 
override public function hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject

Returns the object that is found topmost beneath a point in stage coordinates, or the stage itself if nothing else is found.

Parameters

localPoint:Point
 
forTouch:Boolean (default = false)

Returns
DisplayObject
Event Detail
resize Event
Event Object Type: starling.events.ResizeEvent

Dispatched when the Flash container is resized.