Comment updates for texture and framebuffer classes.

[libs/gl.git] / source / texture2d.h

diff --git a/source/texture2d.h b/source/texture2d.h
index 86c2a89bccb700b87e0424aa7599a17fdc7d7337..ff4d35b64b24685661f842b6f652604b0d4220a4 100644 (file)
--- a/source/texture2d.h
+++ b/source/texture2d.h
@@ -2,19 +2,72 @@
 #define MSP_GL_TEXTURE2D_H_
 
 #include <string>
+#include <msp/graphics/image.h>
+#include "datatype.h"
+#include "pixelformat.h"
 #include "texture.h"
 
 namespace Msp {
 namespace GL {
 
+/**
+Two-dimensional texture.  Consists of an array of texels in the shape of a
+rectangle.  Texture coordinate have a principal range of [0, 1].  This is the
+most common type of texture.
+*/
 class Texture2D: public Texture
 {
+public:
+       class Loader: public Texture::Loader
+       {
+       public:
+               Loader(Texture2D &);
+       private:
+               void image_data(const std::string &);
+               void raw_data(const std::string &);
+               void storage(PixelFormat, unsigned, unsigned);
+               void storage_b(PixelFormat, unsigned, unsigned, unsigned);
+       };
+
+private:
+       PixelFormat ifmt;
+       unsigned width;
+       unsigned height;
+       unsigned allocated;
+
 public:
        Texture2D();
-       void image(int, int, sizei, sizei, int, GLenum, GLenum, void *);
-       void image(int, sizei, sizei, TextureFormat, void *);
-       void image(const std::string &);
+
+       /** Defines storage structure for the texture.  Must be called before an
+       image can be uploaded.  Once storage is defined, it can't be changed. */
+       void storage(PixelFormat fmt, unsigned wd, unsigned ht);
+
+       /** Allocates storage for the texture.  The contents are initially
+       undefined.  If storage has already been allocated, does nothing. */
+       void allocate(unsigned level);
+       
+       /** Uploads an image to the texture.  Storage must be defined beforehand.
+       The image data must have dimensions and format compatible with the defined
+       storage. */
+       void image(unsigned level, PixelFormat fmt, DataType type, const void *data);
+
+       /** Updates a rectangular region of the texture.  Storage must be defined
+       and allocated beforehand.  The update region must be fully inside the
+       texture. */
+       void sub_image(unsigned level, int x, int y, unsigned wd, unsigned ht,
+               PixelFormat fmt, DataType type, const void *data);
+
+       /** Loads an image from a file and uploads it to the texture.  If storage
+       has not been defined, it will be set to match the loaded image.  Otherwise
+       the image must be compatible with the defined storage. */
+       void load_image(const std::string &fn);
+
+       unsigned get_width() const  { return width; }
+       unsigned get_height() const { return height; }
+
 private:
+       void image(const Graphics::Image &);
+       void get_level_size(unsigned, unsigned &, unsigned &);
 };
 
 } // namespace GL