Loader

Scaleform::GFx::FileTypeConstants
    Scaleform::GFx::StateBag
        Scaleform::GFx::Loader

Declaration

class Loader : public StateBag;

Description

Loader class is used to load SWF files from the file system; it is usually the first GFx class created by the application. Before loading actually takes place, the loader can be configured to use custom logging streams, as well callbacks for opening files and creating images. By providing their own implementation of File and registering a FileOpenCallback function, developers can actually bypass the default file system interface and provide SWF data from a custom source.

The most commonly used function of Loader is CreateMovie. This function is used to actually load the SWF files, returning MovieDef pointer, which can be used to create playback instances.

Enumerations

Enumeration	Description
LoadConstants	Describes flags that control what data components of the SWF file are loaded and how the library is used.

Methods

Method	Description
CreateMovie	Loads an SWF file into a movie definition object.
CancelLoading	Cancels the loading of SWF files into a movie definition object.
GetResourceLib	Obtains ResourceLib object maintained by the loader.
GetMovieInfo	Obtains information about SWF file and checks for its availability.
Loader	Default loader initializers which create a number of optional libraries that can be excluded from build if set to 0 instead.
Loader	Creates a Loader object, optionally initializing it with a file open callback and verbosity flags.
SetResourceLib	Sets the ResourceLib for the loader.
UnpinAll	Unpins all movie resources held in the library.

Operators

Operator	Description
=

Structures

Structure	Description
LoaderConfig	A structure wrapping different loader parameters together into one, including default loading states and optional link-dependent states.

File

GFx_Loader.h