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

texture.h

Go to the documentation of this file.
00001 /*
00002     Copyright (C) 1998, 2000 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_IENGINE_TEXTURE_H__
00020 #define __CS_IENGINE_TEXTURE_H__
00021 
00028 #include "csutil/scf.h"
00029 
00030 struct iImage;
00031 struct iObject;
00032 struct iTextureHandle;
00033 struct iTextureManager;
00034 struct iTextureWrapper;
00035 
00036 SCF_VERSION (iTextureCallback, 0, 0, 1);
00037 
00041 struct iTextureCallback : public iBase
00042 {
00044   virtual void UseTexture (iTextureWrapper* wrap) = 0;
00045 };
00046 
00047 SCF_VERSION (iTextureWrapper, 0, 1, 1);
00048 
00076 struct iTextureWrapper : public iBase
00077 {
00079   virtual iObject *QueryObject() = 0;
00080 
00082   virtual iTextureWrapper *Clone () const = 0;
00083 
00088   virtual void SetImageFile (iImage *Image) = 0;
00090   virtual iImage* GetImageFile () = 0;
00091 
00097   virtual void SetTextureHandle (iTextureHandle *tex) = 0;
00099   virtual iTextureHandle* GetTextureHandle () = 0;
00100 
00102   virtual void SetKeyColor (int red, int green, int blue) = 0;
00104   virtual void GetKeyColor (int &red, int &green, int &blue) const = 0;
00105 
00107   virtual void SetFlags (int flags) = 0;
00109   virtual int GetFlags () const = 0;
00110 
00112   virtual void Register (iTextureManager *txtmng) = 0;
00113 
00119   virtual void SetUseCallback (iTextureCallback* callback) = 0;
00120 
00125   virtual iTextureCallback* GetUseCallback () const = 0;
00126 
00132   virtual void Visit () = 0;
00133 
00137   virtual bool IsVisitRequired () const = 0;
00138 
00142   virtual void SetKeepImage (bool k) = 0;
00143 
00149   virtual bool KeepImage () const = 0;
00150 
00155   virtual void SetTextureClass (const char* className) = 0;
00160   virtual const char* GetTextureClass () = 0;
00161 };
00162 
00163 
00164 SCF_VERSION (iTextureList, 0, 0, 1);
00165 
00174 struct iTextureList : public iBase
00175 {
00177   virtual iTextureWrapper *NewTexture (iImage *image) = 0;
00178 
00183   virtual iTextureWrapper *NewTexture (iTextureHandle *ith) = 0;
00184 
00186   virtual int GetCount () const = 0;
00187 
00189   virtual iTextureWrapper *Get (int n) const = 0;
00190 
00192   virtual int Add (iTextureWrapper *obj) = 0;
00193 
00195   virtual bool Remove (iTextureWrapper *obj) = 0;
00196 
00198   virtual bool Remove (int n) = 0;
00199 
00201   virtual void RemoveAll () = 0;
00202 
00204   virtual int Find (iTextureWrapper *obj) const = 0;
00205 
00207   virtual iTextureWrapper *FindByName (const char *Name) const = 0;
00208 };
00209 
00212 #endif // __CS_IENGINE_TEXTURE_H__

Generated for Crystal Space by doxygen 1.4.4