Animatable class declares a common interface
for other classes that can be added to the Juggler. [...]
AnimationChain class is used to animate multiple Animatables. [...]
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. [...]
The Bitmap class represents display objects that represent bitmap images.
A fast container for Bitmap instances.
The BitmapData class lets you load or create arbitrarily sized transparent
or opaque bitmap images and manipulate them in various ways at runtime.
The BitmapDataLoadInfo creates information about the best matching image
file based on the specified image url, the pixelRatios and the current
The BitmapDataLoadOptions class contains different options to configure
how BitmapDatas are loaded from the server.
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.
A class that provides constant values for visual blend mode effects.
An event that has no specific
DisplayObject as target but rather all
DisplayObject instances, including those that are not on the display list. [...]
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.
This filter provide a simple ChromaKey solution
that can be applied on bitmap or video
Circle < T extends > num
Use the list of color values defined in
Color to have
easy access to the ARGB values of different colors.
DelayedCall class is used to delay the invocation of
a function by a given time. [...]
The base class for all objects that can be placed on the display list.
DisplayObjectChildren < T extends > DisplayObject
This class is returned by the
DisplayObjectParent.children getter. [...]
The base class for all objects that can serve as display object containers
on the display list.
DisplayObjectContainer3D class enables 3D transformations
of 2D display objects. [...]
DisplayObjectParent < T extends > DisplayObject
An abstract class implemented by containers for display objects.
An event that is dispatched when a frame is entered.
The system environment in which the application is running.
Holds basic information about an event.
The base class for all classes that dispatch events.
EventStream < T extends > Event
Provides a stream of
EventStreamProvider < T extends > Event
A factory to expose
Events as streams.
EventStreamSubscription < T extends > Event
A subscription on events from an
An event that is dispatched when the current frame is exited.
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.
A display object to play sprite sheet animations.
A FXAA (fast approximate anti-alias) filter for shapes and other display objects.
A display object to show a section of a
to the ratio property. [...]
An invisible and rectangular display object to catch input events.
A vector graphics drawing surface.
The base class for all graphics commands
The base class for all graphics fill commands
The base class for all graphics stroke commands
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 is a common base class for MouseEvent and TouchEvent. [...]
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 controls the progress of your application by
propagating the time passed between two render frames. [...]
Event that is dispatched in response to user input through a keyboard. [...]
Defines the standard key locations returned by
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. [...]
Mesh class allows free form deformations of a BitmapData instance
by using triangles to form an arbitrary shape. [...]
Use the static properties of the
Mouse class to control
the appearance of the mouse cursor.
An event that is dispatched into the event flow whenever mouse events occur.
PerspectiveProjection defines the matrix that is used to projection
3D display objects on a 2D plane like the stage or other display objects.
Point < T extends > num
Rectangle < T extends > num
The interface for all implementations of a render context.
The base class for all events fired by a render context.
An event that is dispatched when the display list is about to be updated
RenderFilter class defines the interface for filters
that can be rendered by the engine.
RenderMask class defines the interface for masks
that can be rendered by the engine.
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 class adds a 3D projection matrix to
the RenderObject class. Only display objects with 3D capabilities
will implement this class.
RenderState class is used to render objects to a give render surface
defined by the renderContext parameter. [...]
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).
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.
RenderMask that supports the WebGL scissor feature.
This class is used to create lightweight shapes.
The SimpleButton class lets you control all instances of button symbols.
The SoundLoadOptions class contains different options to configure
how audio files are loaded from the server.
A SoundSprite combines multiple audio files into a single audio file.
The Sprite class is a basic display list building block.
Sprite3D class enables 3D transformations of 2D display objects. [...]
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.
The options used by the
Stage constructor to setup the stage.
The default configurations for various StageXL features.
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. [...]
The base class for a custom texture atlas loader.
Gauge specially designed to work in combination with the Juggler. [...]
TouchEvent class lets you handle events on devices that detect user
contact with the device (such as a finger on a touch screen). [...]
Transition class provides common transition functions
used by the Tween and Translation classes. [...]
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. [...]
The abstract base class for
TweenObject2D and TweenObject3D.
TweenObject2D class defines the interface for a class
that can used with the Tween.animate method. [...]
TweenObject3D class defines the interface for a class
that can used with the Tween.animate3D method. [...]
TweenProperty class controls the value of a property while
the tween is running. This class is returned by the getters of
the TweenPropertyAccessor implementations.
The abstract base class for
TweenPropertyAccessor3D. Those accessors are returned by
the Tween.animate and Tween.animate3D getters.
TweenPropertyAccessor2D is used to access the animatable
properties of a TweenObject2D. This class is return by the
TweenPropertyAccessor3D is used to access the animatable
properties of a TweenObject3D. This class is return by the
The Video class is used to load and control videos.
The VideoLoadOptions class contains different options to configure
how videos are loaded from the server.
The VideoObject class is a display object to show and control videos.
A display object with custom 2D transformation matrix.
Exceptions / Errors
An AggregateError contains a list of errors that occur during execution.
A LoadError indicates a problem while loading a resource.