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>
36 Loader(Texture &, Collection &);
40 unsigned get_levels() const;
42 void load_external_image(Graphics::Image &, const std::string &);
45 void external_image(const std::string &);
46 void external_image_srgb(const std::string &);
47 void external_image_common(const std::string &);
48 void filter(TextureFilter);
49 void generate_mipmap(bool);
50 void image_data(const std::string &);
51 void mag_filter(TextureFilter);
52 void max_anisotropy(float);
53 void min_filter(TextureFilter);
54 void mipmap_levels(unsigned);
56 void wrap(TextureWrap);
57 void wrap_r(TextureWrap);
58 void wrap_s(TextureWrap);
59 void wrap_t(TextureWrap);
71 RG_TO_LUMINANCE_ALPHA,
78 PixelFormat storage_fmt;
79 FormatSwizzle swizzle;
82 Sampler default_sampler;
84 static int swizzle_orders[];
86 Texture(GLenum, ResourceManager * = 0);
87 Texture(const Texture &);
88 Texture &operator=(const Texture &);
94 void set_format(PixelFormat);
96 void set_parameter_i(GLenum, int) const;
99 Sampler &get_default_sampler() { return default_sampler; }
100 const Sampler &get_default_sampler() const { return default_sampler; }
102 DEPRECATED void set_min_filter(TextureFilter);
103 DEPRECATED void set_mag_filter(TextureFilter);
105 /** Sets filter for both minification and magnification. Since mipmapping
106 is not applicable to magnification, LINEAR is used instead. */
107 DEPRECATED void set_filter(TextureFilter);
109 DEPRECATED void set_mipmap_levels(unsigned) { }
111 DEPRECATED void set_max_anisotropy(float);
113 /** Sets the wrapping mode for all coordinates. */
114 DEPRECATED void set_wrap(TextureWrap);
116 DEPRECATED void set_wrap_s(TextureWrap);
117 DEPRECATED void set_wrap_t(TextureWrap);
118 DEPRECATED void set_wrap_r(TextureWrap);
120 static bool can_generate_mipmap();
122 void generate_mipmap();
124 /** Sets automatic mipmap generation. If enabled, mipmaps are generated
125 when a texture image is uploaded. */
126 void set_auto_generate_mipmap(bool);
128 /// Deprecated. Use set_auto_generate_mipmap instead.
129 DEPRECATED void set_generate_mipmap(bool g) { set_auto_generate_mipmap(g); }
131 /** Sets depth texture comparison. Has no effect on other formats. When
132 comparison is enabled, the third component of the texture coordinate is
133 compared against the texel value, and the result is returned as the texture
135 DEPRECATED void set_compare_enabled(bool);
137 /** Sets the function to use for depth comparison. */
138 DEPRECATED void set_compare_func(Predicate);
140 /// Loads a Graphics::Image from a file and uploads it to the texture.
141 virtual void load_image(const std::string &, unsigned = 0);
143 DEPRECATED void load_image(const std::string &, bool srgb);
145 /** Uploads an image to the texture. If storage has not been defined, it
146 will be set to match the image. Otherwise the image must be compatible
147 with the defined storage. Semantics depend on the type of texture. */
148 virtual void image(const Graphics::Image &, unsigned = 0) = 0;
150 DEPRECATED void image(const Graphics::Image &, bool srgb);
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; }