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 wrap(TextureWrap);
92 void wrap_r(TextureWrap);
93 void wrap_s(TextureWrap);
94 void wrap_t(TextureWrap);
104 GENERATE_MIPMAP = 32,
107 MAX_ANISOTROPY = 256,
115 RG_TO_LUMINANCE_ALPHA
121 FormatSwizzle swizzle;
122 TextureFilter min_filter;
123 TextureFilter mag_filter;
124 float max_anisotropy;
131 mutable int dirty_params;
133 static int swizzle_orders[];
135 Texture(GLenum, ResourceManager * = 0);
136 Texture(const Texture &);
137 Texture &operator=(const Texture &);
142 static DataType get_alloc_type(PixelFormat);
143 void set_internal_format(PixelFormat);
144 PixelFormat get_upload_format(PixelFormat) const;
146 void update_parameter(int) const;
147 void set_parameter_i(GLenum, int) const;
148 void set_parameter_f(GLenum, float) const;
150 void set_min_filter(TextureFilter);
151 void set_mag_filter(TextureFilter);
153 /** Sets filter for both minification and magnification. Since mipmapping
154 is not applicable to magnification, LINEAR is used instead. */
155 void set_filter(TextureFilter);
157 void set_max_anisotropy(float);
159 /** Sets the wrapping mode for all coordinates. */
160 void set_wrap(TextureWrap);
162 void set_wrap_s(TextureWrap);
163 void set_wrap_t(TextureWrap);
164 void set_wrap_r(TextureWrap);
166 static bool can_generate_mipmap();
168 /** Sets automatic mipmap generation. If enabled, mipmaps are generated
169 when a texture image is uploaded. */
170 void set_generate_mipmap(bool);
173 void auto_generate_mipmap();
176 /** Sets depth texture comparison. Has no effect on other formats. When
177 comparison is enabled, the third component of the texture coordinate is
178 compared against the texel value, and the result is returned as the texture
180 void set_compare_enabled(bool);
182 /** Sets the function to use for depth comparison. */
183 void set_compare_func(Predicate);
185 /// Loads a Graphics::Image from a file and uploads it to the texture.
186 virtual void load_image(const std::string &, bool srgb = false);
188 /** Uploads an image to the texture. If storage has not been defined, it
189 will be set to match the image. Otherwise the image must be compatible
190 with the defined storage. Semantics depend on the type of texture.
192 If srgb is true and storage is determined by this call, then an sRGB pixel
193 format will be used. */
194 virtual void image(const Graphics::Image &, bool srgb = false) = 0;
196 GLenum get_target() const { return target; }
197 unsigned get_id() const { return id; }
199 void bind() const { bind_to(0); }
200 void bind_to(unsigned) const;
202 static const Texture *current(unsigned = 0);
203 static void unbind() { unbind_from(0); }
204 static void unbind_from(unsigned);
206 virtual UInt64 get_data_size() const { return 0; }
210 bool is_mipmapped(TextureFilter);