gfxIImageFrame
| IID: | 9c37930b-cadd-453c-89e1-9ed456715b9c |
| Inherits From: | nsISupports |
GfxIImageFrame interface
All x, y, width, height values are in pixels.
This interface is implemented by the following components:
Properties
PRInt32 blendMethod
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 getImageData ( out arrayof PRUint8 bits , out PRUint32 length )
void getPaletteData ( out gfx_color palette , 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 lockImageData ( )
void unlockImageData ( )
void getPaletteData ( out gfx_color palette , out PRUint32 length )
Get Palette data pointer
- Arguments:
- palette
- length
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
References
This interface is the type of the following properties:
This interface is passed as an argument to the following methods:
imgIContainer.appendFrame, imgIContainer.removeFrame, imgIContainerObserver.frameChanged, imgIDecoderObserver.onDataAvailable, imgIDecoderObserver.onStartFrame, imgIDecoderObserver.onStopFrame
This interface is returned from the following methods:
Reference documentation is generated from Mozilla's source.