1 #ifndef MSP_GL_TEXTURE_H_
2 #define MSP_GL_TEXTURE_H_
4 #include <msp/datafile/objectloader.h>
5 #include <msp/graphics/image.h>
8 #include "pixelformat.h"
20 /// Bilinear filtering
23 /// Mipmapping without filtering
24 NEAREST_MIPMAP_NEAREST = GL_NEAREST_MIPMAP_NEAREST,
26 /// Linear filtering between two mipmap levels
27 NEAREST_MIPMAP_LINEAR = GL_NEAREST_MIPMAP_LINEAR,
29 /// Bilinear filtering on the closest mipmap level
30 LINEAR_MIPMAP_NEAREST = GL_LINEAR_MIPMAP_NEAREST,
32 /// Trilinear filtering between two mipmap levels
33 LINEAR_MIPMAP_LINEAR = GL_LINEAR_MIPMAP_LINEAR
39 /// Tile the texture infinitely
42 /// Extend the texels at the edge of the texture to infinity
43 CLAMP_TO_EDGE = GL_CLAMP_TO_EDGE,
45 /// Tile the texture, with every other repetition mirrored
46 MIRRORED_REPEAT = GL_MIRRORED_REPEAT
51 Base class for textures. This class only defines operations common for all
52 texture types and is not instantiable. For specifying images for textures, see
53 one of the dimensioned texture classes.
55 A texture is generally rendered at a size that's either smaller or larger than
56 its native size, so that the texture coordinates do not exactly correspond to
57 the texels of the texture. The kind of filtering used, if any, is determined
58 by the minification and magnification filter parameters. The default is LINEAR
59 for magnification and NEAREST_MIPMAP_LINEAR for minification.
61 When a mipmapped filter is in use, the texture consists of a stack of mipmap
62 images. Level 0 is the base image. Each level above 0 has half the size of
63 the previous level, rounded down and clamped to 1. The level with size 1 in
64 all dimensions is the last mipmap level. All levels must be allocated for the
67 If texture coordinates fall outside of the principal range of the texture,
68 wrapping is applied. The default for all directions is REPEAT.
70 class Texture: public Resource
73 class Loader: public DataFile::CollectionObjectLoader<Texture>
80 Loader(Texture &, Collection &);
84 void external_image(const std::string &);
85 void filter(TextureFilter);
86 void generate_mipmap(bool);
87 void image_data(const std::string &);
88 void mag_filter(TextureFilter);
89 void max_anisotropy(float);
90 void min_filter(TextureFilter);
91 void mipmap_levels(unsigned);
92 void wrap(TextureWrap);
93 void wrap_r(TextureWrap);
94 void wrap_s(TextureWrap);
95 void wrap_t(TextureWrap);
107 MAX_ANISOTROPY = 256,
108 FORMAT_SWIZZLE = 512,
116 RG_TO_LUMINANCE_ALPHA
122 FormatSwizzle swizzle;
123 TextureFilter min_filter;
124 TextureFilter mag_filter;
125 unsigned mipmap_levels;
126 float max_anisotropy;
130 bool auto_gen_mipmap;
133 mutable int dirty_params;
135 static int swizzle_orders[];
137 Texture(GLenum, ResourceManager * = 0);
138 Texture(const Texture &);
139 Texture &operator=(const Texture &);
144 static DataType get_alloc_type(PixelFormat);
145 void set_internal_format(PixelFormat);
146 PixelFormat get_upload_format(PixelFormat) const;
148 void update_parameter(int) const;
149 void set_parameter_i(GLenum, int) const;
150 void set_parameter_f(GLenum, float) const;
152 void set_min_filter(TextureFilter);
153 void set_mag_filter(TextureFilter);
155 /** Sets filter for both minification and magnification. Since mipmapping
156 is not applicable to magnification, LINEAR is used instead. */
157 void set_filter(TextureFilter);
159 void set_mipmap_levels(unsigned);
161 void set_max_anisotropy(float);
163 /** Sets the wrapping mode for all coordinates. */
164 void set_wrap(TextureWrap);
166 void set_wrap_s(TextureWrap);
167 void set_wrap_t(TextureWrap);
168 void set_wrap_r(TextureWrap);
170 static bool can_generate_mipmap();
172 void generate_mipmap();
174 /** Sets automatic mipmap generation. If enabled, mipmaps are generated
175 when a texture image is uploaded. */
176 void set_auto_generate_mipmap(bool);
178 /// Deprecated. Use set_auto_generate_mipmap instead.
179 void set_generate_mipmap(bool g) { set_auto_generate_mipmap(g); }
181 /** Sets depth texture comparison. Has no effect on other formats. When
182 comparison is enabled, the third component of the texture coordinate is
183 compared against the texel value, and the result is returned as the texture
185 void set_compare_enabled(bool);
187 /** Sets the function to use for depth comparison. */
188 void set_compare_func(Predicate);
190 /// Loads a Graphics::Image from a file and uploads it to the texture.
191 virtual void load_image(const std::string &, bool srgb = false);
193 /** Uploads an image to the texture. If storage has not been defined, it
194 will be set to match the image. Otherwise the image must be compatible
195 with the defined storage. Semantics depend on the type of texture.
197 If srgb is true and storage is determined by this call, then an sRGB pixel
198 format will be used. */
199 virtual void image(const Graphics::Image &, bool srgb = false) = 0;
201 GLenum get_target() const { return target; }
202 unsigned get_id() const { return id; }
204 void bind() const { bind_to(0); }
205 void bind_to(unsigned) const;
207 static const Texture *current(unsigned = 0);
208 static void unbind() { unbind_from(0); }
209 static void unbind_from(unsigned);
211 virtual UInt64 get_data_size() const { return 0; }
215 bool is_mipmapped(TextureFilter);