Typedefs

EventListener(T event) → void

A handler function that is used to listen to events.

TransitionFunction(num ratio) → num

The TransitionFunction is the function signature for transitions used in the Tween and Translation classes. The function takes the ratio between 0.0 and 1.0 and returns the actual progress of the transition.

Enums

CapsStyle

EventPhase

Provides constant values for the eventPhase property of the Event class.

HorizontalAlign

InputEventMode

JointStyle

PathEncoding

RenderEngine

The implementation kind of the render context.

SimpleButtonState

SoundEngine

StageAlign

The StageAlign defines how the content of the Stage is aligned inside of the Canvas. The setting controls where the origin (point 0,0) of the Stage will be placed on the Canvas.

StageRenderMode

The StageRenderMode defines how often the Stage is rendered by the RenderLoop where the Stage is attached to.

StageScaleMode

The StageScaleMode defines how the Stage is scaled inside of the Canvas.

VerticalAlign

Classes

AlphaMaskFilter

Animatable

This abstract Animatable class declares a common interface for other classes that can be added to the Juggler.

AnimationChain

The AnimationChain class is used to animate multiple Animatables.

AnimationGroup

The AnimationGroup class is used to animate multiple Animatables. Those Animatables are animated in parallel and the onComplete callback is called when all Animatables have completed.

AudioElementMixer

AudioElementSound

AudioElementSoundChannel

Bitmap

The Bitmap class represents display objects that represent bitmap images.

BitmapContainer

A fast container for Bitmap instances.

BitmapData

The BitmapData class lets you load or create arbitrarily sized transparent or opaque bitmap images and manipulate them in various ways at runtime.

BitmapDataChannel

BitmapDataLoadOptions

The BitmapDataLoadOptions class contains different options to configure how BitmapDatas are loaded from the server.

BitmapDataUpdateBatch

The BitmapDataUpdateBatch class provides all the BitmapData update methods, but does not automatically update the underlying WebGL texture. This improves the performance for multiple updates to the BitmapData. Once all updates are done, call the update method to update the underlying WebGL texture.

BitmapDrawable

BitmapFilter

BlendMode

A class that provides constant values for visual blend mode effects.

BlurFilter

BroadcastEvent

An event that has no specific DisplayObject as target but rather all DisplayObject instances, including those that are not on the display list.

CanvasShadowWrapper

This class is a replacement for the deprecated shadow property of the DisplayObject class. Please consider to use the DropShadowFilter class which is the recommended technique to render shadows in WebGL.

ChromaKeyFilter

This filter provide a simple ChromaKey solution that can be applied on bitmap or video

Circle

Color

Use the list of color values defined in Color to have easy access to the ARGB values of different colors.

ColorMatrixFilter

ColorTransform

DelayedCall

The DelayedCall class is used to delay the invocation of a function by a given time.

DisplacementMapFilter

DisplayObject

The base class for all objects that can be placed on the display list.

DisplayObjectChildren

This class is returned by the DisplayObjectParent.children getter.

DisplayObjectContainer

The base class for all objects that can serve as display object containers on the display list.

DisplayObjectContainer3D

The abstract DisplayObjectContainer3D class enables 3D transformations of 2D display objects.

DisplayObjectParent

An abstract class implemented by containers for display objects.

DropShadowFilter

EnterFrameEvent

An event that is dispatched when a new frame is entered.

Environment

The system environment in which the application is running.

Event

Holds basic information about an event.

EventDispatcher

The base class for all classes that dispatch events.

EventStream

Provides a stream of Events.

EventStreamProvider

A factory to expose Events as streams.

EventStreamSubscription

A subscription on events from an EventStream.

ExitFrameEvent

An event that is dispatched when the current frame is exited.

FlattenFilter

The FlattenFilter does not change the visual appearance of the BitmapData or DisplayObject where it is applied to. This filter can be used to merge the children of a DisplayObjectContainer to a flat texture. This is useful for DisplayObjects with certain blend modes or alpha values.

FlipBook

A display object to play sprite sheet animations.

FxaaFilter

A FXAA (fast approximate anti-alias) filter for shapes and other display objects.

Gauge

A display object to show a section of a BitmapData according to the ratio property.

GlassPlate

An invisible and rectangular display object to catch input events.

GlowFilter

Graphics

A vector graphics drawing surface.

GraphicsCommand

The base class for all graphics commands

GraphicsCommandArc

GraphicsCommandArcElliptical

GraphicsCommandArcTo

GraphicsCommandBeginPath

GraphicsCommandBezierCurveTo

GraphicsCommandCircle

GraphicsCommandClosePath

GraphicsCommandDecode

GraphicsCommandDecodeEaselJS

GraphicsCommandDecodeSVG

GraphicsCommandEllipse

GraphicsCommandFill

The base class for all graphics fill commands

GraphicsCommandFillColor

GraphicsCommandFillGradient

GraphicsCommandFillPattern

GraphicsCommandLineTo

GraphicsCommandMoveTo

GraphicsCommandQuadraticCurveTo

GraphicsCommandRect

GraphicsCommandRectRound

GraphicsCommandStroke

The base class for all graphics stroke commands

GraphicsCommandStrokeColor

GraphicsCommandStrokeGradient

GraphicsCommandStrokePattern

GraphicsContext

GraphicsContextRenderMask

GraphicsGradient

GraphicsGradientColorStop

GraphicsPattern

HtmlObject

The HtmlObject adds a regular HTML element to the display list. You can set all the well known DisplayObject properties like x, y, scaleX, scaleY, rotation or alpha which will be applied to the HTML element. Because the HtmlObject is still rendered by the browser it will appear on top of the Stage and can't be overlayed by regular DisplayObjects.

InputEvent

The InputEvent is a common base class for MouseEvent and TouchEvent.

InteractiveObject

The InteractiveObject class is the abstract base class for all display objects with which the user can interact, using the mouse, keyboard, or other user input device.

Juggler

The Juggler controls the progress of your application by propagating the time passed between two render frames.

KeyboardEvent

An Event that is dispatched in response to user input through a keyboard.

KeyLocation

Defines the standard key locations returned by KeyboardEvent.getKeyLocation.

Mask

A Mask describes a geometric shape to show only a portion of a DisplayObject. Pixels inside of the shape are visible and pixels outside of the shape are invisible.

Matrix

Matrix3D

Mesh

The Mesh class allows free form deformations of a BitmapData instance by using triangles to form an arbitrary shape.

MockSound

MockSoundChannel

Mouse

Use the static properties of the Mouse class to control the appearance of the mouse cursor.

MouseCursor

MouseCursorData

MouseEvent

An event that is dispatched into the event flow whenever mouse events occur.

NormalMapFilter

PerspectiveProjection

The PerspectiveProjection defines the matrix that is used to projection 3D display objects on a 2D plane like the stage or other display objects.

Point

Polygon

Rectangle

RenderBufferIndex

RenderBufferVertex

RenderContext

The interface for all implementations of a render context.

RenderContextCanvas

RenderContextEvent

The base class for all events fired by a render context.

RenderContextWebGL

RenderEvent

An event that is dispatched when the display list is about to be updated and rendered.

RenderFilter

The abstract RenderFilter class defines the interface for filters that can be rendered by the engine.

RenderFrameBuffer

RenderLoop

RenderLoopBase

RenderMask

The abstract RenderMask class defines the interface for masks that can be rendered by the engine.

RenderObject

The abstract RenderObject class defines the interface for a class that can be rendered with the RenderState.renderObject method. All display objects do implement this interface and therefore they can be rendered by the engine.

RenderObject3D

The abstract RenderObject3D class adds a 3D projection matrix to the RenderObject class. Only display objects with 3D capabilities will implement this class.

RenderProgram

RenderProgramSimple

RenderProgramTinted

RenderProgramTriangle

RenderState

The RenderState class is used to render objects to a give render surface defined by the renderContext parameter.

RenderStatistics

RenderStencilBuffer

RenderTexture

RenderTextureFiltering

The RenderTextureFiltering defines the method that is used to determine the texture color for a texture mapped pixel, using the colors of nearby texels (pixels of the texture).

RenderTextureQuad

ResourceManager

ResourceManagerResource

Scale9Bitmap

The Scale9Bitmap display object divides it's BitmapData into a 3x3 grid defined by the grid rectangle. The corners of the grid are rendered in it's orignal form. The fields between the corners are scaled to get the size defined by the width and height properties.

Shape

This class is used to create lightweight shapes.

SimpleButton

The SimpleButton class lets you control all instances of button symbols.

Sound

SoundChannel

SoundLoadOptions

The SoundLoadOptions class contains different options to configure how audio files are loaded from the server.

SoundMixer

SoundSprite

A SoundSprite combines multiple audio files into a single audio file.

SoundSpriteSegment

SoundTransform

Sprite

The Sprite class is a basic display list building block.

Sprite3D

The Sprite3D class enables 3D transformations of 2D display objects.

SpriteSheet

Stage

The Stage is the drawing area where all display objects are rendered to. Place a Canvas element to your HTML and use the Stage to wrap all the rendering functions to this Canvas element.

StageOptions

The options used by the Stage constructor to setup the stage.

StageXL

The default configurations for various StageXL features.

TextEvent

An object dispatches a TextEvent object when a user enters text in a text field or clicks a hyperlink in an HTML-enabled text field.

TextField

TextFieldAutoSize

TextFieldType

TextFormat

TextFormatAlign

TextLineMetrics

TextureAtlas

TextureAtlasFormat

TextureAtlasFrame

TextureAtlasLoader

The base class for a custom texture atlas loader.

TimeGauge

A Gauge specially designed to work in combination with the Juggler.

TintFilter

TouchEvent

The TouchEvent class lets you handle events on devices that detect user contact with the device (such as a finger on a touch screen).

Transition

The Transition class provides common transition functions used by the Tween and Translation classes.

Translation

The Translation class animates a value by continuously calling the onUpdate function.

Tween

Use the Tween class to animate the properties of a display object like x, y, scaleX, scaleY, alpha, rotation etc. The animation starts with the current value of the property and ends at a given target or delta value.

TweenObject

The abstract base class for TweenObject2D and TweenObject3D.

TweenObject2D

The TweenObject2D class defines the interface for a class that can used with the Tween.animate method.

TweenObject3D

The TweenObject3D class defines the interface for a class that can used with the Tween.animate3D method.

TweenProperty

The TweenProperty class controls the value of a property while the tween is running. This class is returned by the getters of the TweenPropertyAccessor implementations.

TweenPropertyAccessor

The abstract base class for TweenPropertyAccessor2D and TweenPropertyAccessor3D. Those accessors are returned by the Tween.animate and Tween.animate3D getters.

TweenPropertyAccessor2D

The TweenPropertyAccessor2D is used to access the animatable properties of a TweenObject2D. This class is return by the Tween.animate getter.

TweenPropertyAccessor3D

The TweenPropertyAccessor3D is used to access the animatable properties of a TweenObject3D. This class is return by the Tween.animate3D getter.

Vector

Video

The Video class is used to load and control videos.

VideoLoadOptions

The VideoLoadOptions class contains different options to configure how videos are loaded from the server.

VideoObject

The VideoObject class is a display object to show and control videos.

Warp

A display object with custom 2D transformation matrix.

WebAudioApiMixer

WebAudioApiSound

WebAudioApiSoundChannel

Exceptions / Errors

AggregateError

An AggregateError contains a list of errors that occur during execution.

LoadError

A LoadError indicates a problem while loading a resource.