Linux Mac OSX Windows

Implemented by

 gfxIImageFrame interface

 All x, y, width, height values are in pixels.

 @author Tim Rowley <tor@cs.brown.edu>
 @author Stuart Parmenter <pavlov@netscape.com>
 @version 0.1
[scriptable, uuid(9c37930b-cadd-453c-89e1-9ed456715b9c)]
interface gfxIImageFrame : nsISupports

Attributes


        


  
  attribute
  long
  blendMethod


      

  

  
      

        
 The image data format the image was created with.
 @see gfxIFormats


        


  
  readonly attribute
  gfx_format
  format


      

  

  
      

        

        


  
  attribute
  long
  frameDisposalMethod


      

  

  
      

        
 The height of the image.


        


  
  readonly attribute
  PRInt32
  height


      

  

  
      

        

        


  
  readonly attribute
  unsigned long
  imageBytesPerRow


      

  

  
      

        
 returns the number of bytes allocated for the image


        


  
  readonly attribute
  unsigned long
  imageDataLength


      

  

  
      

        
 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.


        


  
  attribute
  boolean
  mutable


      

  

  
      

        
 returns whether the image requires the background to be painted


        


  
  readonly attribute
  boolean
  needsBackground


      

  

  
      

        
 Represents the number of milliseconds until the next frame should be displayed.
 @note -1 means that this frame should be displayed forever.


        


  
  attribute
  long
  timeout


      

  

  
      

        
 The width of the image.


        


  
  readonly attribute
  PRInt32
  width


      

  

  
      

        
 The x-offset of the image.


        


  
  readonly attribute
  PRInt32
  x


      

  

  
      

        
 The y-offset of the image.


        


  
  readonly attribute
  PRInt32
  y


      

  
    

  


  
    
Methods

    

  
      

        

        


  
  void
  getImageData([array, size_is(length)] out PRUint8 bits, out unsigned long length)


      

  

  
      

        
 Get Palette data pointer


        


  
  void
  getPaletteData([array, size_is(length)] out gfx_color palette, out unsigned long length)


      

  

  
      

        
 The rectangle this frame ocupies.
 @param rect this is really an out parameter.


        


  [noscript] 
  void
  getRect(in nsRectRef rect)


      

  

  
      

        
 Create a new a aWidth x a aHeight sized image.

 @param aX The x-offset from the origin of the gfxIImageContainer parent.
 @param aY The y-offset from the origin of the gfxIImageContainer parent.
 @param aWidth The width of the image to create.
 @param aHeight The height of the image to create.
 @param aFormat the width of the image to create.

 @note The data in a new image is uninitialized.


        


  
  void
  init(in PRInt32 aX, in PRInt32 aY, in PRInt32 aWidth, in PRInt32 aHeight, in gfx_format aFormat, in gfx_depth aDepth)


      

  

  
      

        
 Lock image pixels before addressing the data directly


        


  
  void
  lockImageData()


      

  

  
      

        
 Unlock image pixels


        


  
  void
  unlockImageData()