Creates a BitmapImage2D object with a specified width and height. If you
specify a value for the fillColor parameter, every pixel in
the bitmap is set to that color.
By default, the bitmap is created as transparent, unless you pass
the value false for the transparent parameter. After you
create an opaque bitmap, you cannot change it to a transparent bitmap.
Every pixel in an opaque bitmap uses only 24 bits of color channel
information. If you define the bitmap as transparent, every pixel uses 32
bits of color channel information, including an alpha transparency
channel.
Specifies whether the bitmap image supports per-pixel
transparency. The default value is true
(transparent). To create a fully transparent bitmap,
set the value of the transparent
parameter to true and the value of the
fillColor parameter to 0x00000000(or to
0). Setting the transparent property to
false can result in minor improvements
in rendering performance.
A 32-bit ARGB color value that you use to fill the bitmap image area. The default value is 0xFFFFFFFF(solid white).
adapter is used to provide MovieClip to scripts taken from different platforms setter typically managed by factory. getter defaults to AwayJS class
A unique id for the asset, used to identify assets in an associative array
The original name used for this asset in the resource (e.g. file) in which
it was found. This may not be the same as name, which may
have changed due to of a name conflict.
The size of the cube bitmap in pixels.
The size of the cube bitmap in pixels.
Defines whether the bitmap image supports per-pixel transparency. You can
set this value only when you construct a BitmapImage2D object by passing in
true for the transparent parameter of the
constructor. Then, after you create a BitmapImage2D object, you can check
whether it supports per-pixel transparency by determining if the value of
the transparent property is true.
Defines whether the bitmap image supports per-pixel transparency. You can
set this value only when you construct a BitmapImage2D object by passing in
true for the transparent parameter of the
constructor. Then, after you create a BitmapImage2D object, you can check
whether it supports per-pixel transparency by determining if the value of
the transparent property is true.
Add an event listener
Returns a new BitmapImage2D object that is a clone of the original instance with an exact copy of the contained bitmap.
A new BitmapImage2D object that is identical to the original.
Adjusts the color values in a specified area of a bitmap image by using a
ColorTransform object. If the rectangle matches the
boundaries of the bitmap image, this method transforms the color values of
the entire image.
A Rectangle object that defines the area of the image in which the ColorTransform object is applied.
A ColorTransform object that describes the color transformation values to apply.
Transfers data from one channel of another BitmapImage2D object or the current BitmapImage2D object into a channel of the current BitmapImage2D object. All of the data in the other channels in the destination BitmapImage2D object are preserved.
The source channel value and destination channel value can be one of following values:
BitmapImage2DChannel.REDBitmapImage2DChannel.GREENBitmapImage2DChannel.BLUEBitmapImage2DChannel.ALPHAThe source Rectangle object. To copy only channel data from a smaller area within the bitmap, specify a source rectangle that is smaller than the overall size of the BitmapImage2D object.
The destination Point object that represents the upper-left corner of the rectangular area where the new channel data is placed. To copy only channel data from one area to a different area in the destination image, specify a point other than (0,0).
The source channel. Use a value from the
BitmapImage2DChannel class
(BitmapImage2DChannel.RED,
BitmapImage2DChannel.BLUE,
BitmapImage2DChannel.GREEN,
BitmapImage2DChannel.ALPHA).
The destination channel. Use a value from the
BitmapImage2DChannel class
(BitmapImage2DChannel.RED,
BitmapImage2DChannel.BLUE,
BitmapImage2DChannel.GREEN,
BitmapImage2DChannel.ALPHA).
Provides a fast routine to perform pixel manipulation between images with no stretching, rotation, or color effects. This method copies a rectangular area of a source image to a rectangular area of the same size at the destination point of the destination BitmapImage2D object.
If you include the alphaBitmap and alphaPoint
parameters, you can use a secondary image as an alpha source for the
source image. If the source image has alpha data, both sets of alpha data
are used to composite pixels from the source image to the destination
image. The alphaPoint parameter is the point in the alpha
image that corresponds to the upper-left corner of the source rectangle.
Any pixels outside the intersection of the source image and alpha image
are not copied to the destination image.
The mergeAlpha property controls whether or not the alpha
channel is used when a transparent image is copied onto another
transparent image. To copy pixels with the alpha channel data, set the
mergeAlpha property to true. By default, the
mergeAlpha property is false.
A rectangle that defines the area of the source image to use as input.
The destination point that represents the upper-left corner of the rectangular area where the new pixels are placed.
Dispatch an event
Frees memory that is used to store the BitmapImage2D object.
When the dispose() method is called on an image, the width
and height of the image are set to 0. All subsequent calls to methods or
properties of this BitmapImage2D instance fail, and an exception is thrown.
BitmapImage2D.dispose() releases the memory occupied by the
actual bitmap data, immediately(a bitmap can consume up to 64 MB of
memory). After using BitmapImage2D.dispose(), the BitmapImage2D
object is no longer usable and an exception may be thrown if
you call functions on the BitmapImage2D object. However,
BitmapImage2D.dispose() does not garbage collect the BitmapImage2D
object(approximately 128 bytes); the memory occupied by the actual
BitmapImage2D object is released at the time the BitmapImage2D object is
collected by the garbage collector.
Draws the source display object onto the bitmap image, using
the NME software renderer. You can specify matrix,
colorTransform, blendMode, and a destination
clipRect parameter to control how the rendering performs.
Optionally, you can specify whether the bitmap should be smoothed when
scaled(this works only if the source object is a BitmapImage2D object).
The source display object does not use any of its applied
transformations for this call. It is treated as it exists in the library
or file, with no matrix transform, no color transform, and no blend mode.
To draw a display object(such as a movie clip) by using its own transform
properties, you can copy its transform property object to the
transform property of the Bitmap object that uses the
BitmapImage2D object.
The display object or BitmapImage2D object to draw to the BitmapImage2D object.(The DisplayObject and BitmapImage2D classes implement the IBitmapDrawable interface.)
A Matrix object used to scale, rotate, or translate
the coordinates of the bitmap. If you do not want to
apply a matrix transformation to the image, set this
parameter to an identity matrix, created with the
default new Matrix() constructor, or
pass a null value.
A ColorTransform object that you use to adjust the
color values of the bitmap. If no object is
supplied, the bitmap image's colors are not
transformed. If you must pass this parameter but you
do not want to transform the image, set this
parameter to a ColorTransform object created with
the default new ColorTransform()
constructor.
A string value, from the flash.display.BlendMode class, specifying the blend mode to be applied to the resulting bitmap.
A Rectangle object that defines the area of the source object to draw. If you do not supply this value, no clipping occurs and the entire source object is drawn.
A Boolean value that determines whether a BitmapImage2D
object is smoothed when scaled or rotated, due to a
scaling or rotation in the matrix
parameter. The smoothing parameter only
applies if the source parameter is a
BitmapImage2D object. With smoothing set
to false, the rotated or scaled
BitmapImage2D image can appear pixelated or jagged. For
example, the following two images use the same
BitmapImage2D object for the source
parameter, but the smoothing parameter
is set to true on the left and
false on the right:
<p>Drawing a bitmap with <code>smoothing</code> set
to <code>true</code> takes longer than doing so with
<code>smoothing</code> set to
<code>false</code>.</p>
Fills a rectangular area of pixels with a specified ARGB color.
The rectangular area to fill.
The ARGB color value that fills the area. ARGB colors are often specified in hexadecimal format; for example, 0xFF336699.
Returns an integer that represents an RGB pixel value from a BitmapImage2D
object at a specific point(x, y). The
getPixel() method returns an unmultiplied pixel value. No
alpha information is returned.
All pixels in a BitmapImage2D object are stored as premultiplied color values. A premultiplied image pixel has the red, green, and blue color channel values already multiplied by the alpha data. For example, if the alpha value is 0, the values for the RGB channels are also 0, independent of their unmultiplied values. This loss of data can cause some problems when you perform operations. All BitmapImage2D methods take and return unmultiplied values. The internal pixel representation is converted from premultiplied to unmultiplied before it is returned as a value. During a set operation, the pixel value is premultiplied before the raw image pixel is set.
The x position of the pixel.
The y position of the pixel.
A number that represents an RGB pixel value. If the(x, y) coordinates are outside the bounds of the image, the method returns 0.
Returns an ARGB color value that contains alpha channel data and RGB data.
This method is similar to the getPixel() method, which
returns an RGB color without alpha channel data.
All pixels in a BitmapImage2D object are stored as premultiplied color values. A premultiplied image pixel has the red, green, and blue color channel values already multiplied by the alpha data. For example, if the alpha value is 0, the values for the RGB channels are also 0, independent of their unmultiplied values. This loss of data can cause some problems when you perform operations. All BitmapImage2D methods take and return unmultiplied values. The internal pixel representation is converted from premultiplied to unmultiplied before it is returned as a value. During a set operation, the pixel value is premultiplied before the raw image pixel is set.
The x position of the pixel.
The y position of the pixel.
A number representing an ARGB pixel value. If the(x, y) coordinates are outside the bounds of the image, 0 is returned.
check if an object has an event listener assigned to it
Locks an image so that any objects that reference the BitmapImage2D object,
such as Bitmap objects, are not updated when this BitmapImage2D object
changes. To improve performance, use this method along with the
unlock() method before and after numerous calls to the
setPixel() or setPixel32() method.
Remove an event listener
Converts an Array into a rectangular region of pixel data. For each pixel, an Array element is read and written into the BitmapImage2D pixel. The data in the Array is expected to be 32-bit ARGB pixel values.
Specifies the rectangular region of the BitmapImage2D object.
An Array that consists of 32-bit unmultiplied pixel values to be used in the rectangular region.
Sets a single pixel of a BitmapImage2D object. The current alpha channel value of the image pixel is preserved during this operation. The value of the RGB color parameter is treated as an unmultiplied color value.
Note: To increase performance, when you use the
setPixel() or setPixel32() method repeatedly,
call the lock() method before you call the
setPixel() or setPixel32() method, and then call
the unlock() method when you have made all pixel changes.
This process prevents objects that reference this BitmapImage2D instance from
updating until you finish making the pixel changes.
The x position of the pixel whose value changes.
The y position of the pixel whose value changes.
The resulting RGB color for the pixel.
Sets the color and alpha transparency values of a single pixel of a
BitmapImage2D object. This method is similar to the setPixel()
method; the main difference is that the setPixel32() method
takes an ARGB color value that contains alpha channel information.
All pixels in a BitmapImage2D object are stored as premultiplied color values. A premultiplied image pixel has the red, green, and blue color channel values already multiplied by the alpha data. For example, if the alpha value is 0, the values for the RGB channels are also 0, independent of their unmultiplied values. This loss of data can cause some problems when you perform operations. All BitmapImage2D methods take and return unmultiplied values. The internal pixel representation is converted from premultiplied to unmultiplied before it is returned as a value. During a set operation, the pixel value is premultiplied before the raw image pixel is set.
Note: To increase performance, when you use the
setPixel() or setPixel32() method repeatedly,
call the lock() method before you call the
setPixel() or setPixel32() method, and then call
the unlock() method when you have made all pixel changes.
This process prevents objects that reference this BitmapImage2D instance from
updating until you finish making the pixel changes.
The x position of the pixel whose value changes.
The y position of the pixel whose value changes.
The resulting ARGB color for the pixel. If the bitmap is opaque(not transparent), the alpha transparency portion of this color value is ignored.
Converts a byte array into a rectangular region of pixel data. For each
pixel, the ByteArray.readUnsignedInt() method is called and
the return value is written into the pixel. If the byte array ends before
the full rectangle is written, the function returns. The data in the byte
array is expected to be 32-bit ARGB pixel values. No seeking is performed
on the byte array before or after the pixels are read.
Specifies the rectangular region of the BitmapImage2D object.
A ByteArray object that consists of 32-bit unmultiplied pixel values to be used in the rectangular region.
Unlocks an image so that any objects that reference the BitmapImage2D object,
such as Bitmap objects, are updated when this BitmapImage2D object changes.
To improve performance, use this method along with the lock()
method before and after numerous calls to the setPixel() or
setPixel32() method.
Generated using TypeDoc
The BitmapImage2D export class lets you work with the data(pixels) of a Bitmap object. You can use the methods of the BitmapImage2D export class to create arbitrarily sized transparent or opaque bitmap images and manipulate them in various ways at runtime. You can also access the BitmapImage2D for a bitmap image that you load with the
flash.Assetsorflash.display.Loaderclasses.This export class lets you separate bitmap rendering operations from the internal display updating routines of flash. By manipulating a BitmapImage2D object directly, you can create complex images without incurring the per-frame overhead of constantly redrawing the content from vector data.
The methods of the BitmapImage2D export class support effects that are not available through the filters available to non-bitmap display objects.
A BitmapImage2D object contains an array of pixel data. This data can represent either a fully opaque bitmap or a transparent bitmap that contains alpha channel data. Either type of BitmapImage2D object is stored as a buffer of 32-bit integers. Each 32-bit integer determines the properties of a single pixel in the bitmap.
Each 32-bit integer is a combination of four 8-bit channel values(from 0 to 255) that describe the alpha transparency and the red, green, and blue (ARGB) values of the pixel.(For ARGB values, the most significant byte represents the alpha channel value, followed by red, green, and blue.)
The four channels(alpha, red, green, and blue) are represented as numbers when you use them with the
BitmapImage2D.copyChannel()method or theDisplacementMapFilter.componentXandDisplacementMapFilter.componentYproperties, and these numbers are represented by the following constants in the BitmapImage2DChannel class:BitmapImage2DChannel.ALPHABitmapImage2DChannel.REDBitmapImage2DChannel.GREENBitmapImage2DChannel.BLUEYou can attach BitmapImage2D objects to a Bitmap object by using the
bitmapDataproperty of the Bitmap object.You can use a BitmapImage2D object to fill a Graphics object by using the
Graphics.beginBitmapFill()method.You can also use a BitmapImage2D object to perform batch tile rendering using the
flash.display.Tilesheetclass.In Flash Player 10, the maximum size for a BitmapImage2D object is 8,191 pixels in width or height, and the total number of pixels cannot exceed 16,777,215 pixels.(So, if a BitmapImage2D object is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation is 2,880 pixels in height and 2,880 in width.