src/video/texture.hpp

   1 //  SuperTux
   2 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   3 //
   4 //  This program is free software: you can redistribute it and/or modify
   5 //  it under the terms of the GNU General Public License as published by
   6 //  the Free Software Foundation, either version 3 of the License, or
   7 //  (at your option) any later version.
   8 //
   9 //  This program is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 //  GNU General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU General Public License
  15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #ifndef HEADER_SUPERTUX_VIDEO_TEXTURE_HPP
  18 #define HEADER_SUPERTUX_VIDEO_TEXTURE_HPP
  19
  20 #include <config.h>
  21
  22 #include <assert.h>
  23 #include <string>
  24
  25 #include "supertux/globals.hpp"
  26 #include "video/texture_manager.hpp"
  27
  28 /// bitset for drawing effects
  29 enum {
  30   /** Don't apply anything */
  31   NO_EFFECT = 0,
  32   /** Draw the Surface upside down */
  33   VERTICAL_FLIP = (1<<1),
  34   /** Draw the Surface from left to down */
  35   HORIZONTAL_FLIP = (1<<2),
  36   NUM_EFFECTS
  37 };
  38
  39 typedef unsigned int DrawingEffect;
  40
  41 /**
  42  * This class is a wrapper around a texture handle. It stores the texture width
  43  * and height and provides convenience functions for uploading SDL_Surfaces
  44  * into the texture
  45  */
  46 class Texture
  47 {
  48 private:
  49   friend class TextureManager;
  50   /* The name under which this texture is cached by the texture manager,
  51    * or the empty string if not. */
  52   std::string cache_filename;
  53
  54 public:
  55   Texture() : cache_filename() {}
  56   virtual ~Texture()
  57   {
  58     if (TextureManager::current() && cache_filename != "")
  59       /* The cache entry is now useless: its weak pointer to us has been
  60        * cleared.  Remove the entry altogether to save memory. */
  61       TextureManager::current()->reap_cache_entry(cache_filename);
  62   }
  63
  64   virtual unsigned int get_texture_width() const = 0;
  65   virtual unsigned int get_texture_height() const = 0;
  66   virtual unsigned int get_image_width() const = 0;
  67   virtual unsigned int get_image_height() const = 0;
  68
  69 private:
  70   Texture(const Texture&);
  71   Texture& operator=(const Texture&);
  72 };
  73
  74 #endif
  75
  76 /* EOF */