Packageorg.flintparticles.renderers
Classpublic class FullStageBitmapRenderer
InheritanceFullStageBitmapRenderer Inheritance BitmapRenderer Inheritance flash.display.Sprite
SubclassesFullStagePixelRenderer

The FullStageBitmapRenderer is a custom BitmapRenderer whose canvas exactly covers the stage. This canvas sizing is only reliable when the display region for the swf is exactly the same size as the swf itself, so that no scaling occurs.

It is more efficient to use a BitmapRenderer with an appropriately defined canvas. This class exists to allow the continued use of functionality that existed in the BitmapRenderer in early versions of Flint.

This renderer uses properties of the stage object. It throws an exception if it is not in the same security sandbox as the Stage owner (the main SWF file). To avoid this, the Stage owner can grant permission to the domain containing this renderer by calling the Security.allowDomain() method or the Security.allowInsecureDomain() method.


Public Properties
 PropertyDefined by
  canvas : Rectangle
[write-only] Throws an error.
FullStageBitmapRenderer
  x : Number
[write-only] Override's the default x property of the display object to add additional functionality for managing the bitmap display.
FullStageBitmapRenderer
  y : Number
[write-only] Override's the default y property of the display object to add additional functionality for managing the bitmap display.
FullStageBitmapRenderer
Protected Properties
 PropertyDefined by
 InheritedZERO_POINT : Point
[static]
BitmapRenderer
Public Methods
 MethodDefined by
  
FullStageBitmapRenderer(smoothing:Boolean = false)
The constructor creates a FullStageBitmapRenderer.
FullStageBitmapRenderer
 Inherited
addFilter(filter:BitmapFilter, postRender:Boolean = false):void
The addFilter method adds a BitmapFilter to the renderer.
BitmapRenderer
 Inherited
addParticle(particle:Particle):void
The addParticle method is called when a particle is added to the emitter that this renderer is assigned to.
BitmapRenderer
 Inherited
clearPaletteMap():void
Clears any palette map that has been set for the renderer.
BitmapRenderer
 Inherited
dispose():void
When the renderer is no longer required, this method must be called by the user to free up memory used by the renderer.
BitmapRenderer
 Inherited
removeFilter(filter:BitmapFilter):void
Removes a BitmapFilter object from the Renderer.
BitmapRenderer
 Inherited
removeParticle(particle:Particle):void
The removeParticle method is called when a particle is removed from the emitter that this renderer is assigned to.
BitmapRenderer
  
renderParticles(particles:Array):void
The renderParticles method is called every frame so the renderer can draw the particles that are in the emitter that this renderer is assigned to.
FullStageBitmapRenderer
 Inherited
setPaletteMap(red:Array = null, green:Array = null, blue:Array = null, alpha:Array = null):void
Sets a palette map for the renderer.
BitmapRenderer
Protected Methods
 MethodDefined by
 Inherited
createBitmap():void
Create the Bitmap and BitmapData objects
BitmapRenderer
 Inherited
drawParticle(particle:Particle):void
Used internally here and in derived classes to alter the manner of the particle rendering.
BitmapRenderer
Property detail
canvasproperty
canvas:Rectangle  [write-only]

Throws an error. You cannot set the canvas of a FullStageBitmapRenderer.

Implementation
    public function set canvas(value:Rectangle):void
xproperty 
x:Number  [write-only]

Override's the default x property of the display object to add additional functionality for managing the bitmap display.

Implementation
    public function set x(value:Number):void
yproperty 
y:Number  [write-only]

Override's the default y property of the display object to add additional functionality for managing the bitmap display.

Implementation
    public function set y(value:Number):void
Constructor detail
FullStageBitmapRenderer()constructor
public function FullStageBitmapRenderer(smoothing:Boolean = false)

The constructor creates a FullStageBitmapRenderer. After creation it should be added to the display list of a DisplayObjectContainer to place it on the stage and should be applied to an Emitter using the Emitter's renderer property.

Parameters
smoothing:Boolean (default = false)
Method detail
renderParticles()method
public override function renderParticles(particles:Array):void

The renderParticles method is called every frame so the renderer can draw the particles that are in the emitter that this renderer is assigned to.

Parameters
particles:Array — The particles to draw.