gfxIImageFrame
IID: | f6d00ee7-defc-4101-b2dc-e72cf4c37c3c |
Inherits From: | nsISupports |
GfxIImageFrame interface
All x, y, width, height values are in pixels.
This interface is implemented by the following components:
Properties
readonly PRUint32 alphaBytesPerRow
readonly PRUint32 alphaDataLength
Returns the number of bytes allocated for the alpha mask
gfx_color backgroundColor
readonly gfx_format format
The image data format the image was created with.
PRInt32 frameDisposalMethod
readonly PRInt32 height
The height of the image.
readonly PRUint32 imageBytesPerRow
readonly PRUint32 imageDataLength
Returns the number of bytes allocated for the image
PRBool mutable
TRUE by default. When set to FALSE, you will no longer be able to make any modifications to the data of the image. Any attempts will fail.
readonly PRBool needsBackground
Returns whether the image requires the background to be painted
PRInt32 timeout
Represents the number of milliseconds until the next frame should be displayed.
readonly PRInt32 width
The width of the image.
readonly PRInt32 x
The x-offset of the image.
readonly PRInt32 y
The y-offset of the image.
Methods
void drawTo ( gfxIImageFrame* dst , PRInt32 DX , PRInt32 DY , PRInt32 DWidth , PRInt32 DHeight )
void getAlphaData ( out arrayof PRUint8 bits , out PRUint32 length )
void getImageData ( out arrayof PRUint8 bits , out PRUint32 length )
[noscript] void getRect ( nsRectRef rect )
void init ( PRInt32 aX , PRInt32 aY , PRInt32 width , PRInt32 height , gfx_format format , gfx_depth depth )
void lockAlphaData ( )
void lockImageData ( )
void setAlphaData ( arrayof PRUint8 data , PRUint32 length , PRInt32 offset )
void setImageData ( arrayof PRUint8 data , PRUint32 length , PRInt32 offset )
void unlockAlphaData ( )
void unlockImageData ( )
void drawTo ( gfxIImageFrame* dst , PRInt32 DX , PRInt32 DY , PRInt32 DWidth , PRInt32 DHeight )
Blit this frame into another frame. Used for GIF animation compositing
- Arguments:
- dst
- DX
- DY
- DWidth
- DHeight
void getRect ( nsRectRef rect )
The rectangle this frame ocupies.
- Arguments:
- rect: this is really an out parameter.
void init ( PRInt32 aX , PRInt32 aY , PRInt32 width , PRInt32 height , gfx_format format , gfx_depth depth )
Create a new \a width x \a height sized image.
- Arguments:
- aX: The x-offset from the origin of the gfxIImageContainer parent.
- aY: The y-offset from the origin of the gfxIImageContainer parent.
- width: The width of the image to create.
- height: The height of the image to create.
- format: the width of the image to create.
- depth
void setAlphaData ( arrayof PRUint8 data , PRUint32 length , PRInt32 offset )
Sets \a length bytes of \a data in this object.
- Arguments:
- data
- length
- offset
void setImageData ( arrayof PRUint8 data , PRUint32 length , PRInt32 offset )
Sets \a length bytes of \a data in this object.
- Arguments:
- data
- length
- offset: The offset from the first pixel in bytes. To set data beginning with the first (top left) pixel in the image, \a offset should be 0; to set data beginning with, for example, the sixth pixel in the first row of a RGBA32 image, the offset should be 20.
Reference documentation is generated from Mozilla's source.