Update and improve documentation

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

diff --git a/source/core/texture2d.h b/source/core/texture2d.h
index c6654df69222859a0a284c468c9859a737127d8c..427e179563943b312c7ea4f87b7ae3a5595e09db 100644 (file)
--- a/source/core/texture2d.h
+++ b/source/core/texture2d.h
@@ -9,9 +9,7 @@ namespace Msp {
 namespace GL {
 
 /**
-Two-dimensional texture.  Consists of an array of texels in the shape of a
-rectangle.  Texture coordinate have a range of [0, 1].  Coordinates outside of
-this range are subject to wrapping.  This is the most common type of texture.
+Two-dimensional texture, consisting of a rectangular array of texels.
 */
 class Texture2D: public Texture2DBackend
 {
@@ -39,27 +37,22 @@ private:
 public:
        virtual ~Texture2D();
 
-       /** Defines storage structure for the texture.  If lv is zero, the number
-       of mipmap levels is automatically determined from storage dimensions.
+       /** Sets storage format and dimensions and allocates memory for the texture.
+       If lv is zero, a complete mipmap pyramid is automatically created.  Storage
+       cannot be changed once set. */
+       void storage(PixelFormat, unsigned wd, unsigned ht, unsigned lv = 0);
 
-       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, unsigned lv = 0);
+       /** Replaces contents of an entire mipmap level.  Allocated storage must
+       exist.  The image data is interpreted according to the storage format and
+       must have size matching the selected mipmap level. */
+       virtual void image(unsigned level, const void *);
 
-       /** Updates the contents of the entire texture.  Storage must be defined
-       beforehand.  The image data must have dimensions and format matching the
-       defined storage. */
-       virtual void image(unsigned level, const void *data);
+       /** Replaces a rectangular region of the texture.  Allocated storage must
+       exist.  The image data is interpreted according to the storage format and
+       the region must be fully inside the selected mipmap level. */
+       void sub_image(unsigned level, int x, int y, unsigned wd, unsigned ht, const void *);
 
-       /** Updates a rectangular region of the texture.  Storage must be defined
-       beforehand.  The image data must be in a format mathing the defined storage
-       and the update region must be fully inside the texture. */
-       void sub_image(unsigned level, int x, int y, unsigned wd, unsigned ht, const void *data);
-
-       /** Updates the contents of the entire texture from an image.  If storage
-       has not been defined, it will be set to match the image.  Otherwise the
-       image must match the defined storage. */
-       virtual void image(const Graphics::Image &, unsigned lv = 0);
+       virtual void image(const Graphics::Image &, unsigned = 0);
 
        unsigned get_width() const { return width; }
        unsigned get_height() const { return height; }