source/core/texturecube.h

   1 #ifndef MSP_GL_TEXTURECUBE_H_
   2 #define MSP_GL_TEXTURECUBE_H_
   3
   4 #include <msp/gl/extensions/arb_texture_cube_map.h>
   5 #include <msp/graphics/image.h>
   6 #include "texture.h"
   7 #include "vector.h"
   8
   9 namespace Msp {
  10 namespace GL {
  11
  12 enum TextureCubeFace
  13 {
  14         POSITIVE_X = GL_TEXTURE_CUBE_MAP_POSITIVE_X,
  15         NEGATIVE_X = GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
  16         POSITIVE_Y = GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
  17         NEGATIVE_Y = GL_TEXTURE_CUBE_MAP_NEGATIVE_Y,
  18         POSITIVE_Z = GL_TEXTURE_CUBE_MAP_POSITIVE_Z,
  19         NEGATIVE_Z = GL_TEXTURE_CUBE_MAP_NEGATIVE_Z
  20 };
  21
  22 /**
  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.
  29
  30 All faces of a cube map texture must be allocated for it to be usable.
  31
  32 Requires OpenGL version 1.3.
  33 */
  34 class TextureCube: public Texture
  35 {
  36 public:
  37         class Loader: public Msp::DataFile::DerivedObjectLoader<TextureCube, Texture::Loader>
  38         {
  39         public:
  40                 Loader(TextureCube &);
  41                 Loader(TextureCube &, Collection &);
  42         private:
  43                 void init();
  44
  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);
  50         };
  51
  52 private:
  53         unsigned size;
  54         unsigned levels;
  55
  56         static const TextureCubeFace face_order[6];
  57         static const Vector3 directions[6];
  58         static const unsigned orientations[12];
  59
  60 public:
  61         TextureCube();
  62
  63         /** Defines storage structure for the texture.  If lv is zero, the number
  64         of mipmap levels is automatically determined from storage dimensions.
  65
  66         Must be called before an image can be uploaded.  Once storage is defined,
  67         it can't be changed. */
  68         void storage(PixelFormat fmt, unsigned size, unsigned lv = 0);
  69
  70         /** Updates the contents of a face.  Storage must be defined beforehand.
  71         The image data must have dimensions and format matching the defined
  72         storage. */
  73         void image(TextureCubeFace face, unsigned level, const void *data);
  74
  75         /** Updates a rectangular region of a face.  Storage must be defined
  76         beforehand.  The image data must be in a format mathing the defined storage
  77         and the update region must be fully inside the face. */
  78         void sub_image(TextureCubeFace face, unsigned level, int x, int y, unsigned w, unsigned h, const void *data);
  79
  80         void image(TextureCubeFace, const Graphics::Image &);
  81
  82         virtual void image(const Graphics::Image &, unsigned = 0);
  83         using Texture::image;
  84
  85         unsigned get_size() const { return size; }
  86 private:
  87         unsigned get_n_levels() const;
  88         unsigned get_level_size(unsigned) const;
  89
  90 public:
  91         /** Translates indices into face constants.  Valid indices are between 0
  92         and 5, inclusive. */
  93         static TextureCubeFace enumerate_faces(unsigned);
  94
  95         static unsigned get_face_index(TextureCubeFace);
  96
  97         /** Returns a vector pointing out of the face. */
  98         static const Vector3 &get_face_direction(TextureCubeFace);
  99
 100         /** Returns a vector in the direction of the s axis of the face. */
 101         static const Vector3 &get_s_direction(TextureCubeFace);
 102
 103         /** Returns a vector in the direction of the t axis of the face. */
 104         static const Vector3 &get_t_direction(TextureCubeFace);
 105
 106         /** Returns a vector pointing to the center a texel. */
 107         Vector3 get_texel_direction(TextureCubeFace, unsigned, unsigned);
 108
 109         virtual AsyncLoader *load(IO::Seekable &, const Resources * = 0) { return 0; }
 110         virtual std::uint64_t get_data_size() const;
 111         virtual void unload() { }
 112 };
 113
 114 void operator>>(const LexicalConverter &, TextureCubeFace &);
 115
 116 } // namespace GL
 117 } // namespace Msp
 118
 119 #endif