1 #ifndef MSP_GL_TEXTURECUBE_H_
2 #define MSP_GL_TEXTURECUBE_H_
4 #include <msp/graphics/image.h>
5 #include "texturecube_backend.h"
22 Cube map texture, consisting of six square faces. All of the faces must be of
23 the same size. A cube map texture is addressed by three-dimensional texture
24 coordinates, with a principal range of [-1, 1]. The face is first selected
25 according to the largest coordinate, and the remaining two coordinates are used
26 to sample the face image. The images are oriented so that the cross product of
27 the s and t axes will point into the cube.
29 All faces of a cube map texture must be allocated for it to be usable.
31 Requires OpenGL version 1.3.
33 class TextureCube: public TextureCubeBackend
35 friend TextureCubeBackend;
38 class Loader: public Msp::DataFile::DerivedObjectLoader<TextureCube, Texture::Loader>
41 Loader(TextureCube &);
42 Loader(TextureCube &, Collection &);
46 void external_image(TextureCubeFace, const std::string &);
47 void image_data(TextureCubeFace, const std::string &);
48 void raw_data(TextureCubeFace, const std::string &);
49 void storage(PixelFormat, unsigned);
50 void storage_levels(PixelFormat, unsigned, unsigned);
57 static const Vector3 directions[6];
58 static const unsigned orientations[12];
61 /** Defines storage structure for the texture. If lv is zero, the number
62 of mipmap levels is automatically determined from storage dimensions.
64 Must be called before an image can be uploaded. Once storage is defined,
65 it can't be changed. */
66 void storage(PixelFormat fmt, unsigned size, unsigned lv = 0);
68 /** Updates the contents of a face. Storage must be defined beforehand.
69 The image data must have dimensions and format matching the defined
71 void image(TextureCubeFace face, unsigned level, const void *data);
73 /** Updates a rectangular region of a face. Storage must be defined
74 beforehand. The image data must be in a format mathing the defined storage
75 and the update region must be fully inside the face. */
76 void sub_image(TextureCubeFace face, unsigned level, int x, int y, unsigned w, unsigned h, const void *data);
78 void image(TextureCubeFace, const Graphics::Image &);
80 virtual void image(const Graphics::Image &, unsigned = 0);
83 unsigned get_size() const { return size; }
85 unsigned get_n_levels() const;
86 unsigned get_level_size(unsigned) const;
89 /** Returns a vector pointing out of the face. */
90 static const Vector3 &get_face_direction(TextureCubeFace);
92 /** Returns a vector in the direction of the s axis of the face. */
93 static const Vector3 &get_s_direction(TextureCubeFace);
95 /** Returns a vector in the direction of the t axis of the face. */
96 static const Vector3 &get_t_direction(TextureCubeFace);
98 /** Returns a vector pointing to the center a texel. */
99 Vector3 get_texel_direction(TextureCubeFace, unsigned, unsigned);
101 virtual AsyncLoader *load(IO::Seekable &, const Resources * = 0) { return 0; }
102 virtual std::uint64_t get_data_size() const;
103 virtual void unload() { }
106 void operator>>(const LexicalConverter &, TextureCubeFace &);