Back to index

lightning-sunbird  0.9+nobinonly
nsIImage.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsIImage_h___
00039 #define nsIImage_h___
00040 
00041 #include "nsISupports.h"
00042 #include "nsIRenderingContext.h"
00043 #include "nsRect.h"
00044 
00045 class nsIDeviceContext;
00046 
00047 struct nsColorMap
00048 {
00049   //I lifted this from the image lib. The difference is that
00050   //this uses nscolor instead of NI_RGB. Multiple color pollution
00051   //is a bad thing. MMP
00052   PRInt32 NumColors;  // Number of colors in the colormap.
00053                       // A negative value can be used to denote a
00054                       // possibly non-unique set.
00055   //nscolor *Map;       // Colormap colors.
00056   PRUint8 *Index;     // NULL, if map is in index order, otherwise
00057                       // specifies the indices of the map entries. */
00058 };
00059 
00060 typedef enum {
00061     nsMaskRequirements_kNoMask,
00062     nsMaskRequirements_kNeeds1Bit,
00063     nsMaskRequirements_kNeeds8Bit
00064 } nsMaskRequirements;
00065 
00066 
00067 #define  nsImageUpdateFlags_kColorMapChanged 0x1
00068 #define  nsImageUpdateFlags_kBitsChanged     0x2
00069 
00070 // The following platforms store image data rows bottom-up.
00071 #if defined(XP_WIN) || defined(XP_OS2) || defined(XP_MACOSX)
00072 #define MOZ_PLATFORM_IMAGES_BOTTOM_TO_TOP
00073 #endif
00074 
00075 // IID for the nsIImage interface
00076 #define NS_IIMAGE_IID          \
00077   { 0xce91c93f, 0x532d, 0x470d, \
00078       { 0xbf, 0xa3, 0xc9, 0x6e, 0x56, 0x01, 0x52, 0xa4 } }
00079 
00080 // Interface to Images
00081 class nsIImage : public nsISupports
00082 {
00083 
00084 public:
00085   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IIMAGE_IID)
00086 
00087   
00094   virtual nsresult Init(PRInt32 aWidth, PRInt32 aHeight, PRInt32 aDepth, nsMaskRequirements aMaskRequirements) = 0;
00095 
00101   virtual PRInt32 GetBytesPix() = 0;
00102 
00108   virtual PRBool GetIsRowOrderTopToBottom() = 0;
00109 
00115   virtual PRInt32 GetWidth() = 0;
00116 
00122   virtual PRInt32 GetHeight() = 0;
00123 
00129   virtual PRUint8 * GetBits() = 0;
00130 
00136   virtual PRInt32 GetLineStride() = 0;
00137 
00144   virtual PRBool GetHasAlphaMask() = 0;
00145 
00151   virtual PRUint8 * GetAlphaBits() = 0;
00152 
00158   virtual PRInt32 GetAlphaLineStride() = 0;
00159 
00166   virtual void ImageUpdated(nsIDeviceContext *aContext, PRUint8 aFlags, nsIntRect *aUpdateRect) = 0;
00167   
00173   virtual PRBool GetIsImageComplete() = 0;
00174 
00181   virtual nsresult Optimize(nsIDeviceContext* aContext) = 0;
00182 
00188   virtual nsColorMap * GetColorMap() = 0;
00189 
00200   NS_IMETHOD Draw(nsIRenderingContext &aContext, nsIDrawingSurface* aSurface, PRInt32 aX, PRInt32 aY, PRInt32 aWidth, PRInt32 aHeight) = 0;
00201 
00216   NS_IMETHOD Draw(nsIRenderingContext &aContext, nsIDrawingSurface* aSurface,
00217                   PRInt32 aSX, PRInt32 aSY, PRInt32 aSWidth, PRInt32 aSHeight,
00218                   PRInt32 aDX, PRInt32 aDY, PRInt32 aDWidth, PRInt32 aDHeight) = 0;
00219 
00220 
00221   NS_IMETHOD DrawTile(nsIRenderingContext &aContext,
00222                       nsIDrawingSurface* aSurface,
00223                       PRInt32 aSXOffset, PRInt32 aSYOffset,
00224                       PRInt32 aPadX, PRInt32 aPadY,
00225                       const nsRect &aTileRect) = 0;
00226 
00237   NS_IMETHOD DrawToImage(nsIImage* aDstImage, PRInt32 aDX, PRInt32 aDY, PRInt32 aDWidth, PRInt32 aDHeight) = 0;
00238 
00244   virtual PRInt8 GetAlphaDepth() = 0;
00245 
00251   virtual void* GetBitInfo() = 0;
00252 
00253 
00266   NS_IMETHOD LockImagePixels(PRBool aMaskPixels) = 0;
00267   
00279   NS_IMETHOD UnlockImagePixels(PRBool aMaskPixels) = 0;
00280 };
00281 
00282 #endif