openfl.display

The Application class is a Lime Application instance that uses OpenFL Window by default when a new window is created.

The Bitmap class represents display objects that represent bitmap images. These can be images that you load with the openfl.Assets or openfl.display.Loader classes, or they can be images that you create with the Bitmap() constructor.

The BitmapData class lets you work with the data (pixels) of a Bitmap object. You can use the methods of the BitmapData class to create arbitrarily sized transparent or opaque bitmap images and manipulate them in various ways at runtime. You can also access the BitmapData for a bitmap image that you load with the openfl.Assets or openfl.display.Loader classes.

BETA**

BETA**

BETA**

The DisplayObject class is the base class for all objects that can be placed on the display list. The display list manages all objects displayed in openfl. Use the DisplayObjectContainer class to arrange the display objects in the display list. DisplayObjectContainer objects can have child display objects, while other display objects, such as Shape and TextField objects, are "leaf" nodes that have only parents and siblings, no children.

The DisplayObjectContainer class is the base class for all objects that can serve as display object containers on the display list. The display list manages all objects displayed in the Flash runtimes. Use the DisplayObjectContainer class to arrange the display objects in the display list. Each DisplayObjectContainer object has its own child list for organizing the z-order of the objects. The z-order is the front-to-back order that determines which object is drawn in front, which is behind, and so on.

The FPS class provides an easy-to-use monitor to display the current frame rate of an OpenFL project

The FrameLabel object contains properties that specify a frame number and the corresponding label name. The Scene class includes a labels property, which is an array of FrameLabel objects for the scene.

The Graphics class contains a set of methods that you can use to create a vector shape. Display objects that support drawing include Sprite and Shape objects. Each of these classes includes a graphics property that is a Graphics object. The following are among those helper functions provided for ease of use: drawRect(), drawRoundRect(), drawCircle(), and drawEllipse().

Defines a bitmap fill. The bitmap can be smoothed, repeated or tiled to fill the area; or manipulated using a transformation matrix. Use a GraphicsBitmapFill object with the Graphics.drawGraphicsData() method. Drawing a GraphicsBitmapFill object is the equivalent of calling the Graphics.beginBitmapFill() method.

Indicates the end of a graphics fill. Use a GraphicsEndFill object with the Graphics.drawGraphicsData() method.

Defines a gradient fill. Use a GraphicsGradientFill object with the Graphics.drawGraphicsData() method. Drawing a GraphicsGradientFill object is the equivalent of calling the Graphics.beginGradientFill() method.

A collection of drawing commands and the coordinate parameters for those commands.

Defines a set of quadrilaterals. This is similar to using GraphicsPath drawRect repeatedly, but each rectangle can use a transform value to rotate, scale or skew the result.

Defines a shader fill. Use a GraphicsShaderFill object with the Graphics.drawGraphicsData() method. Drawing a GraphicsShaderFill object is the equivalent of calling the Graphics.beginShaderFill() method.

Defines a solid fill.

Defines a line style or stroke.

Defines an ordered set of triangles that can be rendered using either (u,v) fill coordinates or a normal fill. Each triangle in the path is represented by three sets of (x, y) coordinates, each of which is one point of the triangle. The triangle vertices do not contain z coordinates and do not necessarily represent 3D faces. However a triangle path can be used to support the rendering of 3D geometry in a 2D space.

ITileContainer is an interface implemented by compatible tile container objects, including the Tilemap and TileContainer classes.

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.

The JPEGEncoderOptions class defines a compression algorithm for the openfl.display.BitmapData.encode() method.

The Loader class is used to load SWF files or image (JPG, PNG, or GIF) files. Use the load() method to initiate loading. The loaded display object is added as a child of the Loader object.

The LoaderInfo class provides information about a loaded SWF file or a loaded image file(JPEG, GIF, or PNG). LoaderInfo objects are available for any display object. The information provided includes load progress, the URLs of the loader and loaded content, the number of bytes total for the media, and the nominal height and width of the media.

The MovieClip class inherits from the following classes: Sprite, DisplayObjectContainer, InteractiveObject, DisplayObject, and EventDispatcher.

BETA**

The PNGEncoderOptions class defines a compression algorithm for the openfl.display.BitmapData.encode() method.

The Preloader class is a Lime Preloader instance that uses an OpenFL display object to display loading progress.

// TODO: Document GLSL Shaders A Shader instance represents a Pixel Bender shader kernel in ActionScript. To use a shader in your application, you create a Shader instance for it. You then use that Shader instance in the appropriate way according to the effect you want to create. For example, to use the shader as a filter, you assign the Shader instance to the shader property of a ShaderFilter object. A shader defines a function that executes on all the pixels in an image, one pixel at a time. The result of each call to the function is the output color at that pixel coordinate in the image. A shader can specify one or more input images, which are images whose content can be used in determining the output of the function. A shader can also specify one or more parameters, which are input values that can be used in calculating the function output. In a single shader execution, the input and parameter values are constant. The only thing that varies is the coordinate of the pixel whose color is the function result. Shader function calls for multiple output pixel coordinates execute in parallel to improve shader execution performance.

// TODO: Document GLSL Shaders A ShaderInput instance represents a single input image for a shader kernel. A kernel can be defined to accept zero, one, or more source images that are used in the kernel execution. A ShaderInput instance provides a mechanism for specifying the input image that is used when the shader executes. To specify a value for the input, create a BitmapData, ByteArray, or Vector. instance containing the image data and assign it to the input property. The ShaderInput instance representing a Shader instance's input image is accessed as a property of the Shader instance's data property. The ShaderInput property has the same name as the input's name in the shader code. For example, if a shader defines an input named src, the ShaderInput instance representing the src input is available as the src property, as this example shows:

TODO: Document GLSL Shaders

This class is used to create lightweight shapes using the ActionScript drawing application program interface(API). The Shape class includes a graphics property, which lets you access methods from the Graphics class.

The SimpleButton class lets you control all instances of button symbols in a SWF file.

The Sprite class is a basic display list building block: a display list node that can display graphics and can also contain children.

The Stage class represents the main drawing area.

The Stage class represents the main drawing area. For SWF content running in the browser (in Flash^{஼/sup> Player), the Stage represents the entire area where Flash content is shown. For content running in AIR on desktop operating systems, each NativeWindow object has a corresponding Stage object.}

The Tile class is the base class for all objects that can be contained in a ITileContainer object. Use the Tilemap or TileContainer class to arrange the tile objects in the tile list. Tilemap or TileContainer objects can contain tile' objects, while other the Tile class is a "leaf" node that have only parents and siblings, no children.

The TileContainer type is a special kind of Tile that can hold other tiles within it.

The Tilemap class represents a "quad batch", or series of objects that are rendered from the same bitmap. The Tilemap class is designed to encourage the use of a single Tileset reference for best performance, but it is possible to use unique Tileset references for each Tile or TileContainer within a Tilemap.

The Tileset class lets you specify logical rectangles within a larger BitmapData object, to be rendered using a Tilemap instance.

The Window class is a Lime Window instance that automatically initializes an OpenFL stage for the current window.