1 #ifndef MSP_GL_TEXTURE_H_
2 #define MSP_GL_TEXTURE_H_
4 #include <msp/core/attributes.h>
5 #include <msp/datafile/objectloader.h>
6 #include <msp/graphics/image.h>
9 #include "pixelformat.h"
10 #include "predicate.h"
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.
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.
26 class Texture: public Resource
29 class Loader: public DataFile::CollectionObjectLoader<Texture>
37 Loader(Texture &, Collection &);
41 unsigned get_levels() const;
43 void load_external_image(Graphics::Image &, const std::string &);
46 void external_image(const std::string &);
47 void filter(TextureFilter);
48 void generate_mipmap(bool);
49 void image_data(const std::string &);
50 void mag_filter(TextureFilter);
51 void max_anisotropy(float);
52 void min_filter(TextureFilter);
53 void mipmap_levels(unsigned);
55 void wrap(TextureWrap);
56 void wrap_r(TextureWrap);
57 void wrap_s(TextureWrap);
58 void wrap_t(TextureWrap);
70 RG_TO_LUMINANCE_ALPHA,
77 PixelFormat storage_fmt;
78 FormatSwizzle swizzle;
80 Sampler default_sampler;
82 static int swizzle_orders[];
84 Texture(GLenum, ResourceManager * = 0);
85 Texture(const Texture &);
86 Texture &operator=(const Texture &);
91 void set_format(PixelFormat);
93 void set_parameter_i(GLenum, int) const;
96 Sampler &get_default_sampler() { return default_sampler; }
97 const Sampler &get_default_sampler() const { return default_sampler; }
99 DEPRECATED void set_min_filter(TextureFilter);
100 DEPRECATED void set_mag_filter(TextureFilter);
102 /** Sets filter for both minification and magnification. Since mipmapping
103 is not applicable to magnification, LINEAR is used instead. */
104 DEPRECATED void set_filter(TextureFilter);
106 DEPRECATED void set_mipmap_levels(unsigned) { }
108 DEPRECATED void set_max_anisotropy(float);
110 /** Sets the wrapping mode for all coordinates. */
111 DEPRECATED void set_wrap(TextureWrap);
113 DEPRECATED void set_wrap_s(TextureWrap);
114 DEPRECATED void set_wrap_t(TextureWrap);
115 DEPRECATED void set_wrap_r(TextureWrap);
117 static bool can_generate_mipmap();
119 void generate_mipmap();
121 /** Sets automatic mipmap generation. If enabled, mipmaps are generated
122 when a texture image is uploaded. */
123 void set_auto_generate_mipmap(bool);
125 /// Deprecated. Use set_auto_generate_mipmap instead.
126 DEPRECATED void set_generate_mipmap(bool g) { set_auto_generate_mipmap(g); }
128 /** Sets depth texture comparison. Has no effect on other formats. When
129 comparison is enabled, the third component of the texture coordinate is
130 compared against the texel value, and the result is returned as the texture
132 DEPRECATED void set_compare_enabled(bool);
134 /** Sets the function to use for depth comparison. */
135 DEPRECATED void set_compare_func(Predicate);
137 /// Loads a Graphics::Image from a file and uploads it to the texture.
138 virtual void load_image(const std::string &, bool srgb = false);
140 virtual void load_image(const std::string &, unsigned, bool srgb = false);
142 /** Uploads an image to the texture. If storage has not been defined, it
143 will be set to match the image. Otherwise the image must be compatible
144 with the defined storage. Semantics depend on the type of texture.
146 If srgb is true and storage is determined by this call, then an sRGB pixel
147 format will be used. */
148 virtual void image(const Graphics::Image &, bool srgb = false);
150 virtual void image(const Graphics::Image &, unsigned, bool srgb = false) = 0;
152 GLenum get_target() const { return target; }
153 unsigned get_id() const { return id; }
155 void bind() const { bind_to(0); }
156 void bind_to(unsigned) const;
158 static const Texture *current(unsigned = 0);
159 static void unbind() { unbind_from(0); }
160 static void unbind_from(unsigned);
162 virtual UInt64 get_data_size() const { return 0; }