source/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                 bool srgb;
  34
  35         public:
  36                 Loader(Texture &);
  37                 Loader(Texture &, Collection &);
  38         private:
  39                 void init();
  40
  41                 unsigned get_levels() const;
  42
  43                 void external_image(const std::string &);
  44                 void filter(TextureFilter);
  45                 void generate_mipmap(bool);
  46                 void image_data(const std::string &);
  47                 void mag_filter(TextureFilter);
  48                 void max_anisotropy(float);
  49                 void min_filter(TextureFilter);
  50                 void mipmap_levels(unsigned);
  51                 void sampler();
  52                 void wrap(TextureWrap);
  53                 void wrap_r(TextureWrap);
  54                 void wrap_s(TextureWrap);
  55                 void wrap_t(TextureWrap);
  56         };
  57
  58         enum ParameterMask
  59         {
  60                 FORMAT_SWIZZLE = 512
  61         };
  62
  63         enum FormatSwizzle
  64         {
  65                 NO_SWIZZLE,
  66                 R_TO_LUMINANCE,
  67                 RG_TO_LUMINANCE_ALPHA
  68         };
  69
  70         unsigned id;
  71         GLenum target;
  72         PixelFormat ifmt;
  73         FormatSwizzle swizzle;
  74         bool auto_gen_mipmap;
  75         Sampler default_sampler;
  76
  77         static int swizzle_orders[];
  78
  79         Texture(GLenum, ResourceManager * = 0);
  80         Texture(const Texture &);
  81         Texture &operator=(const Texture &);
  82 public:
  83         ~Texture();
  84
  85 protected:
  86         void set_internal_format(PixelFormat);
  87         PixelComponents get_upload_components(PixelComponents) const;
  88         void apply_swizzle();
  89         void set_parameter_i(GLenum, int) const;
  90
  91 public:
  92         Sampler &get_default_sampler() { return default_sampler; }
  93         const Sampler &get_default_sampler() const { return default_sampler; }
  94
  95         DEPRECATED void set_min_filter(TextureFilter);
  96         DEPRECATED void set_mag_filter(TextureFilter);
  97
  98         /** Sets filter for both minification and magnification.  Since mipmapping
  99         is not applicable to magnification, LINEAR is used instead. */
 100         DEPRECATED void set_filter(TextureFilter);
 101
 102         DEPRECATED void set_mipmap_levels(unsigned) { }
 103
 104         DEPRECATED void set_max_anisotropy(float);
 105
 106         /** Sets the wrapping mode for all coordinates. */
 107         DEPRECATED void set_wrap(TextureWrap);
 108
 109         DEPRECATED void set_wrap_s(TextureWrap);
 110         DEPRECATED void set_wrap_t(TextureWrap);
 111         DEPRECATED void set_wrap_r(TextureWrap);
 112
 113         static bool can_generate_mipmap();
 114
 115         void generate_mipmap();
 116
 117         /** Sets automatic mipmap generation.  If enabled, mipmaps are generated
 118         when a texture image is uploaded. */
 119         void set_auto_generate_mipmap(bool);
 120
 121         /// Deprecated.  Use set_auto_generate_mipmap instead.
 122         DEPRECATED void set_generate_mipmap(bool g) { set_auto_generate_mipmap(g); }
 123
 124         /** Sets depth texture comparison.  Has no effect on other formats.  When
 125         comparison is enabled, the third component of the texture coordinate is
 126         compared against the texel value, and the result is returned as the texture
 127         sample. */
 128         DEPRECATED void set_compare_enabled(bool);
 129
 130         /** Sets the function to use for depth comparison. */
 131         DEPRECATED void set_compare_func(Predicate);
 132
 133         /// Loads a Graphics::Image from a file and uploads it to the texture.
 134         virtual void load_image(const std::string &, bool srgb = false);
 135
 136         virtual void load_image(const std::string &, unsigned, bool srgb = false);
 137
 138         /** Uploads an image to the texture.  If storage has not been defined, it
 139         will be set to match the image.  Otherwise the image must be compatible
 140         with the defined storage.  Semantics depend on the type of texture.
 141
 142         If srgb is true and storage is determined by this call, then an sRGB pixel
 143         format will be used. */
 144         virtual void image(const Graphics::Image &, bool srgb = false);
 145
 146         virtual void image(const Graphics::Image &, unsigned, bool srgb = false) = 0;
 147
 148         GLenum get_target() const { return target; }
 149         unsigned get_id() const { return id; }
 150
 151         void bind() const { bind_to(0); }
 152         void bind_to(unsigned) const;
 153
 154         static const Texture *current(unsigned = 0);
 155         static void unbind() { unbind_from(0); }
 156         static void unbind_from(unsigned);
 157
 158         virtual UInt64 get_data_size() const { return 0; }
 159 };
 160
 161 } // namespace GL
 162 } // namespace Msp
 163
 164 #endif