ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flash.display 

GraphicsBitmapFill  - AS3

Packageflash.display
Classpublic final class GraphicsBitmapFill
InheritanceGraphicsBitmapFill Inheritance Object
Implements IGraphicsFill, IGraphicsData

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Defines a bitmap fill. The bitmap can be smoothed, repeated or tiled to fill the area; or manipulated using a transformation matrix.

Use a GraphicsBitmapFill object with the Graphics.drawGraphicsData() method. Drawing a GraphicsBitmapFill object is the equivalent of calling the Graphics.beginBitmapFill() method.

Related API Elements



Public Properties
 PropertyDefined By
  bitmapData : BitmapData
A transparent or opaque bitmap image.
GraphicsBitmapFill
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  matrix : Matrix
A matrix object (of the flash.geom.Matrix class) that defines transformations on the bitmap.
GraphicsBitmapFill
  repeat : Boolean
Specifies whether to repeat the bitmap image in a tiled pattern.
GraphicsBitmapFill
  smooth : Boolean
Specifies whether to apply a smoothing algorithm to the bitmap image.
GraphicsBitmapFill
Public Methods
 MethodDefined By
  
GraphicsBitmapFill(bitmapData:BitmapData = null, matrix:Matrix = null, repeat:Boolean = true, smooth:Boolean = false)
Creates a new GraphicsBitmapFill object.
GraphicsBitmapFill
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

bitmapData

property
public var bitmapData:BitmapData

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

A transparent or opaque bitmap image.

Related API Elements

matrix

property 
public var matrix:Matrix

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

A matrix object (of the flash.geom.Matrix class) that defines transformations on the bitmap. For example, the following matrix rotates a bitmap by 45 degrees (pi/4 radians):

     matrix = new flash.geom.Matrix(); 
     matrix.rotate(Math.PI / 4);
     

Related API Elements

repeat

property 
public var repeat:Boolean

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Specifies whether to repeat the bitmap image in a tiled pattern.

If true, the bitmap image repeats in a tiled pattern. If false, the bitmap image does not repeat, and the outermost pixels along the edges of the bitmap are used for any fill area that extends beyond the bounds of the bitmap.

For example, consider the following bitmap (a 20 x 20-pixel checkerboard pattern):

20 by 20 pixel checkerboard

When repeat is set to true (as in the following example), the bitmap fill repeats the bitmap:

60 by 60 pixel checkerboard

When repeat is set to false, the bitmap fill uses the edge pixels for the fill area outside the bitmap:

60 by 60 pixel image with no repeating

smooth

property 
public var smooth:Boolean

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Specifies whether to apply a smoothing algorithm to the bitmap image.

If false, upscaled bitmap images are rendered by using a nearest-neighbor algorithm and look pixelated. If true, upscaled bitmap images are rendered by using a bilinear algorithm. Rendering by using the nearest neighbor algorithm is usually faster.

Constructor Detail

GraphicsBitmapFill

()Constructor
public function GraphicsBitmapFill(bitmapData:BitmapData = null, matrix:Matrix = null, repeat:Boolean = true, smooth:Boolean = false)

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Creates a new GraphicsBitmapFill object.

Parameters
bitmapData:BitmapData (default = null) — A transparent or opaque bitmap image that contains the bits to display.
 
matrix:Matrix (default = null) — A matrix object (of the flash.geom.Matrix class), which you use to define transformations on the bitmap.
 
repeat:Boolean (default = true) — If true, the bitmap image repeats in a tiled pattern. If false, the bitmap image does not repeat, and the edges of the bitmap are used for any fill area that extends beyond the bitmap.
 
smooth:Boolean (default = false) — If false, upscaled bitmap images are rendered using a nearest-neighbor algorithm and appear pixelated. If true, upscaled bitmap images are rendered using a bilinear algorithm. Rendering that uses the nearest-neighbor algorithm is usually faster.

Related API Elements