GFx

GFx

Scaleform 4.6 Reference Documentation describes the classes and APIs provided by the Autodesk® Scaleform SDK, which is a high-performance User Interface middleware solution for the entertainment industry. Scaleform allows developers to use the Adobe® Flash Studio to rapidly create interactive animated 3D UIs, rendering them as either HUD overlays or as textured 3D surfaces within the game engine. 

The reference documentation is divided into four sections based on the core GFx functionality they represent; also included is the inheritance diagram which shows the class hierarchy in Scaleform.

  • GFxPlayer contains the main playback engine classes such as Loader used to load SWF/GFX files, MovieDef representing the loaded file data, and Movie representing an independent instance of the movie during playback. A range of configuration classes used to enable international language translation, control rendering quality, configure font system, text system, IME, custom I/O and multi-threaded loading are also described here.
  • Renderer section describes the rendering system used in Scaleform, including classes such as HAL, RenderTarget, Viewport, and Texture. You will find documentation here particularly useful when implementing your own renderer.
  • SoundRenderer section describes the sound rendering system used in Scaleform, for playing sound and includes classes such as SoundRenderer, SoundSample, and SoundChannel.
  • Kernel section contains the fundamental classes that Scaleform is built on. Some key classes described here include Ptr and RefCountBase used for reference counting, File interface overridable for custom data source support.
  • The inheritance diagram shows the class hierarchy of Scaleform.
Topics
Topic 
Description 
Core playback engine used in the Scaleform SDK. 
Rendering system used in Scaleform. 
Core sound rendering subsystem for Scaleform SDK. 
Core libraries used by Scaleform. 
Utility library for all applications in Scaleform. 
Main 
Frequently used classes in Scaleform GFx. 
Additional helper classes in Scaleform GFx. 
Global Class Hierarchy.