CrystalSpace

Public API Reference

Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

image.h

Go to the documentation of this file.
00001 /*
00002     Copyright (C) 1998 by Jorrit Tyberghein
00003 
00004     This library is free software; you can redistribute it and/or
00005     modify it under the terms of the GNU Library General Public
00006     License as published by the Free Software Foundation; either
00007     version 2 of the License, or (at your option) any later version.
00008 
00009     This library is distributed in the hope that it will be useful,
00010     but WITHOUT ANY WARRANTY; without even the implied warranty of
00011     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00012     Library General Public License for more details.
00013 
00014     You should have received a copy of the GNU Library General Public
00015     License along with this library; if not, write to the Free
00016     Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
00017 */
00018 
00019 #ifndef __CS_IGRAPHIC_IMAGE_H__
00020 #define __CS_IGRAPHIC_IMAGE_H__
00021 
00031 #include "csutil/scf.h"
00032 
00033 struct iDataBuffer;
00034 struct csRGBpixel;
00035 
00036 /*
00037  * We can request csImageLoader to load an image in several formats.
00038  * The format we should use depends on what we want to do with the image;
00039  * usually if we're going to use the image as a texture, the format we
00040  * should use is determined by querying the 3D rasterizer for the preferred
00041  * image format.
00042  */
00043 enum
00044 {
00046   CS_IMGFMT_MASK = 0x0000ffff,
00048   CS_IMGFMT_NONE = 0x00000000,
00050   CS_IMGFMT_TRUECOLOR = 0x00000001,
00052   CS_IMGFMT_PALETTED8 = 0x00000002,
00054   CS_IMGFMT_ANY = CS_IMGFMT_MASK,
00056   CS_IMGFMT_ALPHA = 0x00010000,
00061   CS_IMGFMT_INVALID = 0x80000000
00062 };
00063 
00065 enum csImageType
00066 {
00068   csimg2D = 0,
00072   csimg3D,
00078   csimgCube
00079 };
00080 
00081 SCF_VERSION (iImage, 2, 0, 1);
00082 
00098 struct iImage : public iBase
00099 {
00107   virtual const void *GetImageData () = 0;
00109   virtual int GetWidth() const = 0;
00111   virtual int GetHeight() const = 0;
00113   virtual int GetDepth() const = 0;
00114 
00116   virtual void SetName (const char *iName) = 0;
00118   virtual const char *GetName () const = 0;
00119 
00121   virtual int GetFormat () const = 0;
00123   virtual const csRGBpixel* GetPalette () = 0;
00130   virtual const uint8* GetAlpha () = 0;
00131 
00133   virtual bool HasKeyColor () const = 0;
00134 
00139   CS_DEPRECATED_METHOD virtual bool HasKeycolor () const = 0;
00140 
00142   virtual void GetKeyColor (int &r, int &g, int &b) const = 0;
00143 
00148   CS_DEPRECATED_METHOD virtual void GetKeycolor (int &r, int &g, int &b) const = 0;
00149 
00155   virtual uint HasMipmaps () const = 0;
00161   virtual csRef<iImage> GetMipmap (uint num) = 0;
00162   
00167   virtual const char* GetRawFormat() const = 0;
00171   virtual csRef<iDataBuffer> GetRawData() const = 0;
00175   virtual csImageType  GetImageType() const = 0;
00180   virtual uint HasSubImages() const = 0;
00187   virtual csRef<iImage> GetSubImage (uint num) = 0;
00188 };
00189 
00192 #endif // __CS_IGRAPHIC_IMAGE_H__
00193 

Generated for Crystal Space by doxygen 1.4.4