source/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         /* Lowest six bits track allocation status of faces on the base level.  Bit
  56         seven is set if the entire base level is allocated. */
  57         unsigned allocated;
  58
  59         static TextureCubeFace face_order[6];
  60         static Vector3 directions[6];
  61         static unsigned orientations[12];
  62
  63 public:
  64         TextureCube();
  65
  66         /** Defines storage structure for the texture.  If lv is zero, the number
  67         of mipmap levels is automatically determined from storage dimensions.
  68
  69         Must be called before an image can be uploaded.  Once storage is defined,
  70         it can't be changed. */
  71         void storage(PixelFormat fmt, unsigned size, unsigned lv = 0);
  72
  73         DEPRECATED void storage(PixelComponents c, unsigned s, unsigned l = 0)
  74         { storage(make_pixelformat(c, UNSIGNED_BYTE), s, l); }
  75
  76         /** Allocates storage for the cube faces.  The contents are initially
  77         undefined.  If storage has already been allocated, does nothing. */
  78         void allocate(unsigned level);
  79
  80         /** Uploads image data to a face.  Storage must be defined beforehand.  The
  81         image data must have dimensions and format compatible with the defined
  82         storage. */
  83         void image(TextureCubeFace face, unsigned level,
  84                 PixelComponents comp, DataType type, const void *data);
  85
  86         /** Updates a rectangular region of a face.  Storage must be defined and
  87         allocated beforehand.  The update region must be fully inside the texture.
  88         The data format must be compatible with the defined storage. */
  89         void sub_image(TextureCubeFace face, unsigned level,
  90                 int x, int y, unsigned w, unsigned h,
  91                 PixelComponents comp, DataType type, const void *data);
  92
  93         void image(TextureCubeFace, const Graphics::Image &, bool = false);
  94
  95         virtual void image(const Graphics::Image &, unsigned, bool = false);
  96         using Texture::image;
  97
  98         unsigned get_size() const { return size; }
  99 private:
 100         unsigned get_n_levels() const;
 101         unsigned get_level_size(unsigned) const;
 102
 103 public:
 104         /** Translates indices into face constants.  Valid indices are between 0
 105         and 5, inclusive. */
 106         static TextureCubeFace enumerate_faces(unsigned);
 107
 108         static unsigned get_face_index(TextureCubeFace);
 109
 110         /** Returns a vector pointing out of the face. */
 111         static const Vector3 &get_face_direction(TextureCubeFace);
 112
 113         /** Returns a vector in the direction of the s axis of the face. */
 114         static const Vector3 &get_s_direction(TextureCubeFace);
 115
 116         /** Returns a vector in the direction of the t axis of the face. */
 117         static const Vector3 &get_t_direction(TextureCubeFace);
 118
 119         /** Returns a vector pointing to the center a texel. */
 120         Vector3 get_texel_direction(TextureCubeFace, unsigned, unsigned);
 121
 122         virtual AsyncLoader *load(IO::Seekable &, const Resources * = 0) { return 0; }
 123         virtual UInt64 get_data_size() const;
 124         virtual void unload() { }
 125 };
 126
 127 void operator>>(const LexicalConverter &, TextureCubeFace &);
 128
 129 } // namespace GL
 130 } // namespace Msp
 131
 132 #endif