| Package | starling.display |
| Class | public class Canvas |
| Inheritance | Canvas  DisplayObject EventDispatcher Object |
| Method | Defined By | ||
|---|---|---|---|
Canvas() Creates a new (empty) Canvas. | Canvas | ||
 | addEventListener(type:String, listener:Function):void [override] Registers an event listener at a certain object. | DisplayObject | |
| 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 | |
beginFill(color:uint = 0xffffff, alpha:Number = 1.0):void Specifies a simple one-color fill that subsequent calls to drawing methods
(such as drawCircle()) will use. | Canvas | ||
clear():void Removes all existing vertices. | Canvas | ||
| dispatchEvent(event:Event):void [override] | DisplayObject | |
| 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 | |
dispose():void [override] Disposes all resources of the display object. | Canvas | ||
drawCircle(x:Number, y:Number, radius:Number):void Draws a circle. | Canvas | ||
drawEllipse(x:Number, y:Number, width:Number, height:Number):void Draws an ellipse. | Canvas | ||
drawPolygon(polygon:Polygon):void Draws an arbitrary polygon. | Canvas | ||
drawRectangle(x:Number, y:Number, width:Number, height:Number):void Draws a rectangle. | Canvas | ||
endFill():void Resets the color to 'white' and alpha to '1'. | Canvas | ||
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another
coordinate system. | Canvas | ||
| getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| getTransformationMatrix3D(targetSpace:DisplayObject, resultMatrix:Matrix3D = null):Matrix3D Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
| globalToLocal3D(globalPoint:Point, resultPoint:Vector3D = null):Vector3D Transforms a point from global (stage) coordinates to the 3D local coordinate system. | DisplayObject | |
| 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 local coordinates, or nil if
the test fails. | Canvas | ||
| hitTestMask(localPoint:Point):Boolean Checks if a certain point is inside the display object's mask. | DisplayObject | |
| local3DToGlobal(localPoint:Vector3D, resultPoint:Point = null):Point Transforms a 3D point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| removeEventListener(type:String, listener:Function):void [override] Removes an event listener from the object. | DisplayObject | |
| removeEventListeners(type:String = null):void [override] Removes all event listeners with a certain type, or all of them if type is null. | DisplayObject | |
| removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
render(support:RenderSupport, parentAlpha:Number):void [override] Renders the display object with the help of a support object. | Canvas | ||
| Canvas | () | Constructor |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic function Canvas()Creates a new (empty) Canvas. Call one or more of the 'draw' methods to add content.
| beginFill | () | method |
public function beginFill(color:uint = 0xffffff, alpha:Number = 1.0):void Specifies a simple one-color fill that subsequent calls to drawing methods
(such as drawCircle()) will use.
Parameters
color:uint (default = 0xffffff) | |
alpha:Number (default = 1.0) |
| clear | () | method |
public function clear():voidRemoves all existing vertices.
| dispose | () | method |
override public function dispose():voidDisposes all resources of the display object. GPU buffers are released, event listeners are removed, filters and masks are disposed.
| drawCircle | () | method |
public function drawCircle(x:Number, y:Number, radius:Number):voidDraws a circle.
Parameters
x:Number | |
y:Number | |
radius:Number |
| drawEllipse | () | method |
public function drawEllipse(x:Number, y:Number, width:Number, height:Number):voidDraws an ellipse.
Parameters
x:Number | |
y:Number | |
width:Number | |
height:Number |
| drawPolygon | () | method |
public function drawPolygon(polygon:Polygon):voidDraws an arbitrary polygon.
Parameters
polygon:Polygon |
| drawRectangle | () | method |
public function drawRectangle(x:Number, y:Number, width:Number, height:Number):voidDraws a rectangle.
Parameters
x:Number | |
y:Number | |
width:Number | |
height:Number |
| endFill | () | method |
public function endFill():voidResets the color to 'white' and alpha to '1'.
| getBounds | () | method |
override public function getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):RectangleReturns a rectangle that completely encloses the object as it appears in another coordinate system. If you pass a 'resultRectangle', the result will be stored in this rectangle instead of creating a new object.
Parameters
targetSpace:DisplayObject | |
resultRect:Rectangle (default = null) |
Rectangle |
| hitTest | () | method |
override public function hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObjectReturns the object that is found topmost beneath a point in local coordinates, or nil if the test fails. If "forTouch" is true, untouchable and invisible objects will cause the test to fail.
Parameters
localPoint:Point | |
forTouch:Boolean (default = false) |
DisplayObject |
| render | () | method |
override public function render(support:RenderSupport, parentAlpha:Number):voidRenders the display object with the help of a support object. Never call this method directly, except from within another render method.
Parameters
support:RenderSupport — Provides utility functions for rendering.
| |
parentAlpha:Number — The accumulated alpha value from the object's parent up to the stage. |