DrawableImage

Scaleform::Render::ImageBase
    Scaleform::Render::Image
    Scaleform::Render::FenceResource
        Scaleform::Render::DrawableImage

Declaration

class DrawableImage : public Image, public ListNode<DrawableImage>, public FenceResource;

Description

DrawableImage is an image virtualization object that combines software pixel data access with hardware rendering. DrawableImage object is used primarily to implement Flash BitmapData interface, but can also be useful when Advance thread access to rendered content is needed.

One of key features of DrawableImage is that is allows rendering of a render tree on a separate thread, while feeding this data back to advance thread for processing. Since such communication can involve significant

stalling, several important use cases are optimized:

a) Draw() to DrawableImage one or few files, using it as a render source only for other tree rendering. This should queue up render thread processing with no stalls and read-back communication necessary.

b) Modify image with either draw() or software to initialize content, then do multiple HitTest / pixel access operations that are fast.

Both of these cases are likely to be heavily used in Flash games. In general, DrawableImage tries to minimize render thread stalls through command queuing and minimizing render thread transitions. Due to high overhead of thread communication, DrawableImage commands that don't return a value may be queued up for delayed group processing.

Enumerations

Enumeration	Description
ChannelBits
DrawableImageStateFlags	The state of the DrawableImage.
OperationType	Comparison operators for comparing the pixel value with the threshold value.

Methods

Method	Description
Dispose	Disposes a drawable image so that it can no longer be reused.
~DrawableImage	DrawableImage destructor.
ApplyFilter	Generates a filtered image from a source.
CalcFilterRect	Determines what rectangle ApplyFilter would affect.
ColorTransform	Performs a color transform operation on the image.
Compare	Compares two DrawableImages.
CopyChannel	Transfers data from one channel of another drawable object into a channel of the current drawable image
CopyPixels	Provides a fast routine to perform pixel manipulation between images with no stretching, rotation, or color effects.
Decode	Decodes image into the destination ImageData, potentially converting data a scan-line at a time.
Draw	Draws the render tree.
DrawableImage	DrawableImage constructor.
FillRect	Fills a rectangular area of pixels with a specified color.
FloodFill	Performs a flood fill operation on an image starting at an (x, y) coordinate and filling with a certain color.
GetAsImage	Returns the current object as a Render::Image pointer.
GetColorBoundsRect	Calculates rectangular bounds that fully encloses all pixels of the specified color or all pixels that doesn't include the specified color.
GetContext	Returns the DrawableImageContext (Movie-level object) for this DrawableImage.
GetFormat	Returns the format (ImageFormat) of this image.
GetImageType	Returns the image type (ImageType) for this image. By default, returns Type_DrawableImage.
GetMipmapCount	Obtains the number of mipmaps of the texture in the image.
GetPixel	Gets pixel value without alpha.
GetPixel32	Gets pixel value with alpha.
GetPixels	Gets the pixels.
GetRenderTarget	Returns the render target.
GetSize	Obtains the logical dimensions of the images.
GetUse	Returns the capability flag set for the image. See ImageUse.
Histogram	Computes populations counts of each channels color values.
HitTest	Performs hit testing between two images or rectangles.
IsTransparent	Checks if the image is transparent or whether the BitmapData object was created with the 'transparent' flag.
Merge	Merge merges source image into destination image with per-channel blending.
Noise	Fills an image with pixels representing random noise.
PaletteMap	Performs a paletteMap operation on the image. Remaps the color channel values in an image that has up to four arrays of color palette data, one for each channel.
PerlinNoise	Generates a Perlin noise image.
PixelDissolve	Performs a pixel dissolve either from a source image to a destination image or by using the same image.
Scroll	Scrolls an image by a certain (x, y) pixel amount.
GetTexture	Obtains the texture pointer from the data, intended for use with a given renderer.
SetPixel	Sets the pixel value without alpha.
SetPixel32	Sets the pixel value with alpha.
SetPixels	Fills in the destination rectangle with pixels.
Threshold	Tests pixel values in an image against a specified threshold and sets pixels that pass the test to new color values.
TextureLost	Called to indicate texture contents are lost and releases the texture references held by the images.
MapImageSource
Release	Releases texture with proper notification.

File

Render_DrawableImage.h