CrystalSpace

Public API Reference

igraphic/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 
00043 
00044 #define CS_IMGFMT_MASK (0x0000ffff)
00046 #define CS_IMGFMT_NONE (0x00000000)
00047 
00051 #define CS_IMGFMT_TRUECOLOR (0x00000001)
00053 #define CS_IMGFMT_PALETTED8 (0x00000002)
00055 #define CS_IMGFMT_ANY (CS_IMGFMT_MASK)
00057 #define CS_IMGFMT_ALPHA (0x00010000)
00058 
00062 #define CS_IMGFMT_INVALID (0x80000000)
00063 
00066 enum csImageType
00067 {
00069   csimg2D = 0,
00073   csimg3D,
00079   csimgCube
00080 };
00081 
00096 struct iImage : public virtual iBase
00097 {
00098   SCF_INTERFACE (iImage, 4, 0, 0);
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 
00136   virtual void GetKeyColor (int &r, int &g, int &b) const = 0;
00137 
00143   virtual uint HasMipmaps () const = 0;
00149   virtual csRef<iImage> GetMipmap (uint num) = 0;
00150   
00158   virtual const char* GetRawFormat() const = 0;
00162   virtual csRef<iDataBuffer> GetRawData() const = 0;
00166   virtual csImageType  GetImageType() const = 0;
00171   virtual uint HasSubImages() const = 0;
00178   virtual csRef<iImage> GetSubImage (uint num) = 0;
00179 };
00180 
00183 #endif // __CS_IGRAPHIC_IMAGE_H__
00184 

Generated for Crystal Space 1.2.1 by doxygen 1.5.3