lib/video/surface.h

   1 //  $Id$
   2 //
   3 //  SuperTux
   4 //  Copyright (C) 2004 Tobias Glaesser <tobi.web@gmx.de>
   5 //
   6 //  This program is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU General Public License
   8 //  as published by the Free Software Foundation; either version 2
   9 //  of the License, or (at your option) any later version.
  10 //
  11 //  This program is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 //  GNU General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU General Public License
  17 //  along with this program; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  19 //  02111-1307, USA.
  20
  21 #ifndef SUPERTUX_TEXTURE_H
  22 #define SUPERTUX_TEXTURE_H
  23
  24 #include <string>
  25 #include <list>
  26
  27 #ifndef NOOPENGL
  28 #include "SDL_opengl.h"
  29 #endif
  30
  31 #include "SDL.h"
  32
  33 #include "../math/vector.h"
  34 #include "../video/screen.h"
  35
  36 namespace SuperTux
  37   {
  38
  39   void apply_filter_to_surface(SDL_Surface *surface, int filter, int value);
  40   SDL_Surface* sdl_surface_from_sdl_surface(SDL_Surface* sdl_surf, bool use_alpha);
  41   SDL_Surface* sdl_surface_from_nothing();
  42
  43   class SurfaceImpl;
  44   class SurfaceSDL;
  45   class SurfaceOpenGL;
  46   class DrawingContext;
  47
  48   /// bitset for drawing effects
  49   enum {
  50     /** Don't apply anything */
  51     NONE_EFFECT       = 0x0000,
  52     /** Draw the Surface upside down */
  53     VERTICAL_FLIP     = 0x0001,
  54     /** Draw the Surface from left to down */
  55     HORIZONTAL_FLIP   = 0x0002,
  56     /** Draw the Surface with alpha equal to 128 */
  57     SEMI_TRANSPARENT  = 0x0004
  58   };
  59
  60   /// types of filters
  61   enum {
  62     MASK_FILTER
  63   };
  64
  65   /** This class holds all the data necessary to construct a surface */
  66   class SurfaceData
  67     {
  68     public:
  69       enum ConstructorType { LOAD, LOAD_PART, SURFACE, GRADIENT };
  70       ConstructorType type;
  71       SDL_Surface* surface;
  72       std::string file;
  73       bool use_alpha;
  74       int x;
  75       int y;
  76       int w;
  77       int h;
  78       Color top_gradient;
  79       Color bottom_gradient;
  80
  81       SurfaceData(SDL_Surface* surf, bool use_alpha_);
  82       SurfaceData(const std::string& file_, bool use_alpha_);
  83       SurfaceData(const std::string& file_, int x_, int y_, int w_, int h_, bool use_alpha_);
  84       SurfaceData(Color top_gradient_, Color bottom_gradient_, int w_, int h_);
  85       ~SurfaceData();
  86
  87       SurfaceSDL* create_SurfaceSDL();
  88       SurfaceOpenGL* create_SurfaceOpenGL();
  89       SurfaceImpl* create();
  90     };
  91
  92
  93   /// Surface
  94   /** Container class that holds a surface, necessary so that we can
  95       switch Surface implementations (OpenGL, SDL) on the fly */
  96   class Surface
  97     {
  98     public:
  99       SurfaceData data;
 100       SurfaceImpl* impl;
 101       int w;
 102       int h;
 103
 104       typedef std::list<Surface*> Surfaces;
 105       static Surfaces surfaces;
 106     public:
 107       static void reload_all();
 108       static void debug_check();
 109
 110       Surface(SDL_Surface* surf, bool use_alpha);
 111       Surface(const std::string& file, bool use_alpha);
 112       Surface(const std::string& file, int x, int y, int w, int h, bool use_alpha);
 113       Surface(Color top_gradient, Color bottom_gradient, int w_, int h_);
 114       ~Surface();
 115
 116       /** Reload the surface, which is necesarry in case of a mode swich */
 117       void reload();
 118
 119       void resize(int widht, int height);
 120
 121       void apply_mask(Color color);
 122     };
 123
 124   /** Surface implementation, all implementation have to inherit from
 125       this class */
 126   class SurfaceImpl
 127     {
 128     protected:
 129       SDL_Surface* sdl_surface;
 130
 131     public:
 132       int w;
 133       int h;
 134
 135     public:
 136       SurfaceImpl();
 137       virtual ~SurfaceImpl();
 138
 139       /** Return 0 on success, -2 if surface needs to be reloaded */
 140       virtual int draw(float x, float y, Uint8 alpha, Uint32 effect = NONE_EFFECT) = 0;
 141       virtual int draw_part(float sx, float sy, float x, float y, float w, float h,  Uint8 alpha, Uint32 effect = NONE_EFFECT) = 0;
 142       virtual int draw_stretched(float x, float y, int w, int h, Uint8 alpha, Uint32 effect = NONE_EFFECT) = 0;
 143
 144
 145       int resize(int w_, int h_);
 146
 147       SDL_Surface* get_sdl_surface() const; // @evil@ try to avoid this function
 148
 149       virtual void apply_mask(Color color) = 0;
 150     };
 151
 152   class SurfaceSDL : public SurfaceImpl
 153     {
 154     public:
 155       SurfaceSDL(SDL_Surface* surf, bool use_alpha);
 156       SurfaceSDL(const std::string& file, bool use_alpha);
 157       SurfaceSDL(const std::string& file, int x, int y, int w, int h, bool use_alpha);
 158       SurfaceSDL(Color top_gradient, Color bottom_gradient, int w, int h);
 159       virtual ~SurfaceSDL();
 160
 161       int draw(float x, float y, Uint8 alpha, Uint32 effect = NONE_EFFECT);
 162       int draw_part(float sx, float sy, float x, float y, float w, float h,  Uint8 alpha, Uint32 effect = NONE_EFFECT);
 163       int draw_stretched(float x, float y, int w, int h, Uint8 alpha, Uint32 effect = NONE_EFFECT);
 164
 165       void apply_mask(Color color);
 166     };
 167
 168 #ifndef NOOPENGL
 169   class SurfaceOpenGL : public SurfaceImpl
 170     {
 171     public:
 172       GLuint gl_texture;
 173
 174     public:
 175       SurfaceOpenGL(SDL_Surface* surf, bool use_alpha);
 176       SurfaceOpenGL(const std::string& file, bool use_alpha);
 177       SurfaceOpenGL(const std::string& file, int x, int y, int w, int h, bool use_alpha);
 178       SurfaceOpenGL(Color top_gradient, Color bottom_gradient, int w, int h);
 179
 180       virtual ~SurfaceOpenGL();
 181
 182       int draw(float x, float y, Uint8 alpha, Uint32 effect = NONE_EFFECT);
 183       int draw_part(float sx, float sy, float x, float y, float w, float h,  Uint8 alpha, Uint32 effect = NONE_EFFECT);
 184       int draw_stretched(float x, float y, int w, int h, Uint8 alpha, Uint32 effect = NONE_EFFECT);
 185
 186       void apply_mask(Color color);
 187
 188     private:
 189       void create_gl(SDL_Surface * surf, GLuint * tex);
 190     };
 191 #endif
 192
 193 } //namespace SuperTux
 194
 195 #endif /*SUPERTUX_TEXTURE_H*/
 196
 197 /* Local Variables: */
 198 /* mode: c++ */
 199 /* End: */