HAL

HAL
Scaleform::Render::HAL
Declaration
class HAL : public RefCountBase<HAL, StatRender_Mem>, public Context::RenderNotify;
Description

HAL is a "hardware abstraction layer" interface used for rendering Movie instances. HAL tracks an optional command queue that allows its associated systems to post commands for the render thread.

Enumerations
Enumeration 
Description 
Contains flags that are checked for during most API calls to ensure that state is valid for the operation. 
Flags available to the Push/PopRenderTarget method (defaults to none). 
Specifies the type of rasterization to perform. Not all of these are available on all platforms. See IsRasterModeSupported
Methods
Method 
Description 
Applies the specified blend mode to the device, allowing for alpha blending. 
Adds an external notification object that will be informed about HAL events. 
Begins rendering frame, which is a caching unit. 
Begins scene rendering, initializing various render states needed externally. 
Clears a rectangle (in screen coordinates) to the given color. 
Creates a user render target. 
Creates a temporary RenderTarget, (which may be evicted with subsequent render target allocations). 
Draw 
Draw draws a draw primitive (DP) where every mesh element is transformed by the specified matrix. 
Draw 
Renders a a display tree starting with TreeRoot
Renders a display tree starting with TreeRoot
Draw 
Draws a single RenderQueue item. 
Draws a range of complex meshes. 
Draws a range of pre-cached and pre-processed primitives. 
Retrieves the capabilities of this HAL to perform the DICommand wrt the GPU (See DICommand::RenderCaps). 
Performs a DrawableImage compare operation on the GPU (see BitmapData.compare). 
Performs a copy of DrawableImage results to back to a render surface. 
Performs a DrawableImage colorTransform operation on the GPU (see BitmapData.colorTransform). 
Performs a DrawableImage merge operation on the GPU (see BitmapData.merge). 
Performs a DrawableImage paletteMap operation on the GPU (see BitmapData.paletteMap). 
Performs a DrawableImage copyChannel operation on the GPU (see BitmapData.copyChannel). 
Performs a DrawableImage copyPixels operation on the GPU (see BitmapData.copyPixels). 
Ends rendering of a display unit. 
Ends rendering of a frame. 
Ends rendering of a submit mask and enables its use. 
Completes scene rendering. 
Performs all queued rendering. 
Forces update of render tree, in order to apply changes in TreeNodes. 
Returns the video mode configuration flags. 
GetContextNotify retrieves the context rendering interface for receiving notifications on renderer/frame changes. 
Returns the current display pass. 
Returns the render events set on the HAL. 
Returns the glyph cache which holds the cached textures and fonts. 
Returns the glyph cache parameters. 
Obtains the graphics device class for deferred render contexts to record API calls into a buffer. 
Obtains the HALState of the renderer. 
Returns the maximum number of batches, based on the number of available uniforms, and the number required per-batch (on shader-platforms). 
Returns a reference to the MeshCache which maintains the hardware Vertex and Index buffers containing cached shape meshes. 
Returns the various matrix states set in the renderer. 
Returns the matrix pool used for storing matrices and Cxforms by the renderer. 
Returns the derived matrix state objects. 
Returns the memory manager that handles allocation of video memory, if directly allocatable. 
Returns the mesh cache params. 
Returns the mesh generator. 
Returns the mesh key manager used for creating and managing mesh key objects. 
Returns the render profile view mode. 
Returns the primitive fill manager that contains the list of primitive fills. 
Obtains the cache interface used by the rendering queue. 
Returns the RenderSync object, used for synchronizing the CPU and GPU. 
Returns the thread Id of the render thread. 
Returns the render queue processor for processing and rendering the items. 
Returns the render buffer interface. 
Returns the render statistics, such as rendering triangle information/draw primitives. 
Returns the stroke generator. 
Returns the texture manager used for creating textures and managing them. 
Obtains the tolerance values set for tessellations while rendering. 
Obtains the viewport that is used for rendering. 
Returns the viewport scale. 
HAL 
Render HAL constructor. 
Returns true if render HAL has been initialized through a call to InitHAL. 
Checks if the prepass step is required. 
Returns whether this platform supports the given raster mode. 
Obtains formats that renderer will use for single, batched and instanced rendering of the specified source format. 
Retrieves a blend mode that will be used for rendering. 
Pops a filter draw sequence off the filter stack. This will actually perform filter rendering. 
Disables the use of a submit mask, all content is fully rendered from this point onwards. 
Restore previous 3D projection matrix. 
Restores the previous render target. 
Retrieves the data attached in Action Script (MovieClip.rendererString and MovieClip.rendererFloat). 
Restore previous 3D View matrix. 
Pushes a filter draw sequence on the filter stack. Any content rendered after this, and before PopFilters will have filters applied to it. 
Begins rendering of a submit mask that will be used to cull other rendered contents. 
Pushes a 3D projection matrix onto the stack when rendering. Generally used for 3D perspective. 
Passes the data attached in Action Script (MovieClip.rendererString and MovieClip.rendererFloat). 
Prepares a cacheable primitive. 
Passes a blend mode to the renderer that will be used for rendering. Default mode is Normal. 
Pushes a 3D view matrix onto the stack when rendering. Generally used along with 3D perspective. 
Deal with the situation in which the rendering context is lost. 
Removes the external notification object that informs HAL about the video mode changes. 
Deal with the situation in which the rendering context is lost. 
Informs the HAL that a display pass is beginning. 
Sets the glyph cache parameters. 
Sets the mesh cache parameters. 
Sets which eye to use when drawing a 3D stereo image. 
Sets the stereo parameters that are to be initialized in the renderer for stereo 3D support. 
Sets the raster mode to be applied to the next scene. 
Applies the primary output render target. 
Sets the stereo state that are to be initialized in the renderer for stereo 3D support. 
Applies the tolerance values for the tessellations required for rendering. 
Begins rendering of a display unit that potentially has its own viewport. 
Returns whether the profiler can render any of the filters contained in the FilterPrimitive
 
Shuts down rendering, releasing resources allocated in InitHAL. 
Submit queued commands for deferred contexts. 
Begins rendering to the specified target. 
Sets the HAL config flags. 
Sets the user matrix. 
Structures
Structure 
Description 
Holds stats as recorded by the HAL during rendering. 
File

Render_HAL.h