1 #ifndef MSP_GL_TEXTURECUBE_H_
2 #define MSP_GL_TEXTURECUBE_H_
4 #include <msp/gl/extensions/arb_texture_cube_map.h>
5 #include <msp/graphics/image.h>
23 Cube map texture, consisting of six square faces. All of the faces must be of
24 the same size. A cube map texture is addressed by three-dimensional texture
25 coordinates, with a principal range of [-1, 1]. The face is first selected
26 according to the largest coordinate, and the remaining two coordinates are used
27 to sample the face image. The images are oriented so that the cross product of
28 the s and t axes will point into the cube.
30 All faces of a cube map texture must be allocated for it to be usable.
32 Requires OpenGL version 1.3.
34 class TextureCube: public Texture
37 class Loader: public Msp::DataFile::DerivedObjectLoader<TextureCube, Texture::Loader>
40 Loader(TextureCube &);
41 Loader(TextureCube &, Collection &);
45 void external_image(TextureCubeFace, const std::string &);
46 void image_data(TextureCubeFace, const std::string &);
47 void raw_data(TextureCubeFace, const std::string &);
48 void storage(PixelFormat, unsigned);
49 void storage_levels(PixelFormat, unsigned, unsigned);
56 static const Vector3 directions[6];
57 static const unsigned orientations[12];
62 /** Defines storage structure for the texture. If lv is zero, the number
63 of mipmap levels is automatically determined from storage dimensions.
65 Must be called before an image can be uploaded. Once storage is defined,
66 it can't be changed. */
67 void storage(PixelFormat fmt, unsigned size, unsigned lv = 0);
69 /** Updates the contents of a face. Storage must be defined beforehand.
70 The image data must have dimensions and format matching the defined
72 void image(TextureCubeFace face, unsigned level, const void *data);
74 /** Updates a rectangular region of a face. Storage must be defined
75 beforehand. The image data must be in a format mathing the defined storage
76 and the update region must be fully inside the face. */
77 void sub_image(TextureCubeFace face, unsigned level, int x, int y, unsigned w, unsigned h, const void *data);
79 void image(TextureCubeFace, const Graphics::Image &);
81 virtual void image(const Graphics::Image &, unsigned = 0);
84 unsigned get_size() const { return size; }
86 unsigned get_n_levels() const;
87 unsigned get_level_size(unsigned) const;
90 /** Returns a vector pointing out of the face. */
91 static const Vector3 &get_face_direction(TextureCubeFace);
93 /** Returns a vector in the direction of the s axis of the face. */
94 static const Vector3 &get_s_direction(TextureCubeFace);
96 /** Returns a vector in the direction of the t axis of the face. */
97 static const Vector3 &get_t_direction(TextureCubeFace);
99 /** Returns a vector pointing to the center a texel. */
100 Vector3 get_texel_direction(TextureCubeFace, unsigned, unsigned);
102 virtual AsyncLoader *load(IO::Seekable &, const Resources * = 0) { return 0; }
103 virtual std::uint64_t get_data_size() const;
104 virtual void unload() { }
107 GLenum get_gl_cube_face(TextureCubeFace);
109 void operator>>(const LexicalConverter &, TextureCubeFace &);