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                 virtual void finish();
  41
  42         protected:
  43                 void load_external_image(Graphics::Image &, const std::string &);
  44
  45         private:
  46                 void external_image(const std::string &);
  47                 void external_image_srgb(const std::string &);
  48                 void external_image_common(const std::string &);
  49                 void generate_mipmap(bool);
  50                 void image_data(const std::string &);
  51                 void mipmap_levels(unsigned);
  52         };
  53
  54         enum FormatSwizzle
  55         {
  56                 NO_SWIZZLE,
  57                 R_TO_LUMINANCE,
  58                 RG_TO_LUMINANCE_ALPHA,
  59                 RGB_TO_BGR
  60         };
  61
  62         unsigned id;
  63         GLenum target;
  64         PixelFormat format;
  65         PixelFormat storage_fmt;
  66         FormatSwizzle swizzle;
  67         bool use_srgb_format;
  68         bool auto_gen_mipmap;
  69         std::string debug_name;
  70
  71         static int swizzle_orders[];
  72         static Texture *scratch_binding;
  73
  74         Texture(GLenum, ResourceManager * = 0);
  75         Texture(const Texture &);
  76         Texture &operator=(const Texture &);
  77 public:
  78         ~Texture();
  79
  80 protected:
  81         void generate_id();
  82         void set_format(PixelFormat);
  83         void apply_swizzle();
  84         void set_parameter_i(GLenum, int) const;
  85
  86 public:
  87         PixelFormat get_format() const { return format; }
  88
  89         void generate_mipmap();
  90
  91         /// Loads a Graphics::Image from a file and uploads it to the texture.
  92         virtual void load_image(const std::string &, unsigned = 0);
  93
  94         DEPRECATED void load_image(const std::string &, bool srgb);
  95
  96         /** Uploads an image to the texture.  If storage has not been defined, it
  97         will be set to match the image.  Otherwise the image must be compatible
  98         with the defined storage.  Semantics depend on the type of texture.  */
  99         virtual void image(const Graphics::Image &, unsigned = 0) = 0;
 100
 101         DEPRECATED void image(const Graphics::Image &, bool srgb);
 102
 103         GLenum get_target() const { return target; }
 104         unsigned get_id() const { return id; }
 105
 106         virtual std::uint64_t get_data_size() const { return 0; }
 107
 108         void set_debug_name(const std::string &);
 109
 110 protected:
 111         void bind_scratch();
 112 public:
 113         static void unbind_scratch();
 114 };
 115
 116 } // namespace GL
 117 } // namespace Msp
 118
 119 #endif