source/texture2d.h

   1 /* $Id$
   2
   3 This file is part of libmspgl
   4 Copyright © 2007  Mikko Rasa, Mikkosoft Productions
   5 Distributed under the LGPL
   6 */
   7
   8 #ifndef MSP_GL_TEXTURE2D_H_
   9 #define MSP_GL_TEXTURE2D_H_
  10
  11 #include <string>
  12 #include <msp/gbase/image.h>
  13 #include "pixelformat.h"
  14 #include "texture.h"
  15
  16 namespace Msp {
  17 namespace GL {
  18
  19 /**
  20 Two-dimensional texture class.  This is the most common type of texture.
  21 */
  22 class Texture2D: public Texture
  23 {
  24 public:
  25         class Loader: public Texture::Loader
  26         {
  27         public:
  28                 Loader(Texture2D &);
  29         private:
  30                 void image_data(const std::string &);
  31                 void raw_data(const std::string &);
  32                 void storage(PixelFormat, unsigned, unsigned, unsigned);
  33         };
  34
  35 private:
  36         PixelFormat ifmt;
  37         sizei width;
  38         sizei height;
  39         int border;
  40
  41 public:
  42         Texture2D();
  43
  44         /**
  45         Defines the texture storage.  This function may only be successfully called
  46         once.
  47         */
  48         void storage(PixelFormat fmt, sizei wd, sizei ht, int brd);
  49
  50         /**
  51         Uploads an image to the texture.  storage() must have been called prior to
  52         this, and the image must have dimensions conforming to the specified
  53         storage.
  54         */
  55         void image(int level, PixelFormat fmt, DataType type, const void *data);
  56
  57         /**
  58         Uploads a sub-image into the texture.  Unlike full image upload, there are
  59         no constraints on the size of the sub-image.
  60         */
  61         void sub_image(int level, int x, int y, sizei wd, sizei ht, PixelFormat fmt, DataType type, const void *data);
  62
  63         /**
  64         Loads an image from a file and uploads it to the texture.  If storage() has
  65         not been called, the storage format will be set to match the loaded image.
  66         */
  67         void load_image(const std::string &fn);
  68
  69         sizei get_width() const  { return width; }
  70         sizei get_height() const { return height; }
  71
  72 private:
  73         void image(const Graphics::Image &);
  74 };
  75
  76 } // namespace GL
  77 } // namespace Msp
  78
  79 #endif