source/core/texture.h

   1 #ifndef MSP_GL_TEXTURE_H_
   2 #define MSP_GL_TEXTURE_H_
   3
   4 #include <msp/core/attributes.h>
   5 #include <msp/datafile/objectloader.h>
   6 #include <msp/graphics/image.h>
   7 #include "datatype.h"
   8 #include "gl.h"
   9 #include "pixelformat.h"
  10 #include "predicate.h"
  11 #include "sampler.h"
  12 #include "resource.h"
  13
  14 namespace Msp {
  15 namespace GL {
  16
  17 /**
  18 Base class for textures.  This class only defines operations common for all
  19 texture types and is not instantiable.  For specifying images for textures,
  20 see one of the dimensioned texture classes.
  21
  22 A texture can consinst of a stack of images, called a mipmap.  The dimensions
  23 of each mipmap level are half that of the previous level.  The mipmap stack
  24 can be used for texture minification; see the Sampler class for details.
  25 */
  26 class Texture: public Resource
  27 {
  28 protected:
  29         class Loader: public DataFile::CollectionObjectLoader<Texture>
  30         {
  31         protected:
  32                 unsigned levels;
  33
  34         public:
  35                 Loader(Texture &);
  36                 Loader(Texture &, Collection &);
  37         private:
  38                 void init();
  39
  40         protected:
  41                 void load_external_image(Graphics::Image &, const std::string &);
  42
  43         private:
  44                 void external_image(const std::string &);
  45                 void external_image_srgb(const std::string &);
  46                 void external_image_common(const std::string &);
  47                 void generate_mipmap(bool);
  48                 void image_data(const std::string &);
  49                 void mipmap_levels(unsigned);
  50         };
  51
  52         enum ParameterMask
  53         {
  54                 FORMAT_SWIZZLE = 512
  55         };
  56
  57         enum FormatSwizzle
  58         {
  59                 NO_SWIZZLE,
  60                 R_TO_LUMINANCE,
  61                 RG_TO_LUMINANCE_ALPHA,
  62                 RGB_TO_BGR
  63         };
  64
  65         unsigned id;
  66         GLenum target;
  67         PixelFormat format;
  68         PixelFormat storage_fmt;
  69         FormatSwizzle swizzle;
  70         bool use_srgb_format;
  71         bool auto_gen_mipmap;
  72         std::string debug_name;
  73
  74         static int swizzle_orders[];
  75
  76         Texture(GLenum, ResourceManager * = 0);
  77         Texture(const Texture &);
  78         Texture &operator=(const Texture &);
  79 public:
  80         ~Texture();
  81
  82 protected:
  83         void generate_id();
  84         void set_format(PixelFormat);
  85         void apply_swizzle();
  86         void set_parameter_i(GLenum, int) const;
  87
  88 public:
  89         static bool can_generate_mipmap();
  90
  91         void generate_mipmap();
  92 protected:
  93         void generate_mipmap_();
  94
  95 public:
  96         /** Sets automatic mipmap generation.  If enabled, mipmaps are generated
  97         when a texture image is uploaded. */
  98         void set_auto_generate_mipmap(bool);
  99
 100         /// Deprecated.  Use set_auto_generate_mipmap instead.
 101         DEPRECATED void set_generate_mipmap(bool g) { set_auto_generate_mipmap(g); }
 102
 103         /// Loads a Graphics::Image from a file and uploads it to the texture.
 104         virtual void load_image(const std::string &, unsigned = 0);
 105
 106         DEPRECATED void load_image(const std::string &, bool srgb);
 107
 108         /** Uploads an image to the texture.  If storage has not been defined, it
 109         will be set to match the image.  Otherwise the image must be compatible
 110         with the defined storage.  Semantics depend on the type of texture.  */
 111         virtual void image(const Graphics::Image &, unsigned = 0) = 0;
 112
 113         DEPRECATED void image(const Graphics::Image &, bool srgb);
 114
 115         GLenum get_target() const { return target; }
 116         unsigned get_id() const { return id; }
 117
 118         virtual UInt64 get_data_size() const { return 0; }
 119
 120         void set_debug_name(const std::string &);
 121 };
 122
 123 } // namespace GL
 124 } // namespace Msp
 125
 126 #endif