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         static DataType get_alloc_type(PixelFormat);
  87         void set_internal_format(PixelFormat);
  88         PixelFormat get_upload_format(PixelFormat) const;
  89         void apply_swizzle();
  90         void set_parameter_i(GLenum, int) const;
  91
  92 public:
  93         Sampler &get_default_sampler() { return default_sampler; }
  94         const Sampler &get_default_sampler() const { return default_sampler; }
  95
  96         DEPRECATED void set_min_filter(TextureFilter);
  97         DEPRECATED void set_mag_filter(TextureFilter);
  98
  99         /** Sets filter for both minification and magnification.  Since mipmapping
 100         is not applicable to magnification, LINEAR is used instead. */
 101         DEPRECATED void set_filter(TextureFilter);
 102
 103         DEPRECATED void set_mipmap_levels(unsigned) { }
 104
 105         DEPRECATED void set_max_anisotropy(float);
 106
 107         /** Sets the wrapping mode for all coordinates. */
 108         DEPRECATED void set_wrap(TextureWrap);
 109
 110         DEPRECATED void set_wrap_s(TextureWrap);
 111         DEPRECATED void set_wrap_t(TextureWrap);
 112         DEPRECATED void set_wrap_r(TextureWrap);
 113
 114         static bool can_generate_mipmap();
 115
 116         void generate_mipmap();
 117
 118         /** Sets automatic mipmap generation.  If enabled, mipmaps are generated
 119         when a texture image is uploaded. */
 120         void set_auto_generate_mipmap(bool);
 121
 122         /// Deprecated.  Use set_auto_generate_mipmap instead.
 123         DEPRECATED void set_generate_mipmap(bool g) { set_auto_generate_mipmap(g); }
 124
 125         /** Sets depth texture comparison.  Has no effect on other formats.  When
 126         comparison is enabled, the third component of the texture coordinate is
 127         compared against the texel value, and the result is returned as the texture
 128         sample. */
 129         DEPRECATED void set_compare_enabled(bool);
 130
 131         /** Sets the function to use for depth comparison. */
 132         DEPRECATED void set_compare_func(Predicate);
 133
 134         /// Loads a Graphics::Image from a file and uploads it to the texture.
 135         virtual void load_image(const std::string &, bool srgb = false);
 136
 137         virtual void load_image(const std::string &, unsigned, bool srgb = false);
 138
 139         /** Uploads an image to the texture.  If storage has not been defined, it
 140         will be set to match the image.  Otherwise the image must be compatible
 141         with the defined storage.  Semantics depend on the type of texture.
 142
 143         If srgb is true and storage is determined by this call, then an sRGB pixel
 144         format will be used. */
 145         virtual void image(const Graphics::Image &, bool srgb = false);
 146
 147         virtual void image(const Graphics::Image &, unsigned, bool srgb = false) = 0;
 148
 149         GLenum get_target() const { return target; }
 150         unsigned get_id() const { return id; }
 151
 152         void bind() const { bind_to(0); }
 153         void bind_to(unsigned) const;
 154
 155         static const Texture *current(unsigned = 0);
 156         static void unbind() { unbind_from(0); }
 157         static void unbind_from(unsigned);
 158
 159         virtual UInt64 get_data_size() const { return 0; }
 160 };
 161
 162 } // namespace GL
 163 } // namespace Msp
 164
 165 #endif