Update and improve documentation

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

diff --git a/source/core/texture1d.h b/source/core/texture1d.h
index 1871a17caaa4d282ae1fee19fb656c3686808029..7ef55f80fdf17ec9c295efff74f2e914dd91e975 100644 (file)
--- a/source/core/texture1d.h
+++ b/source/core/texture1d.h
@@ -7,6 +7,9 @@
 namespace Msp {
 namespace GL {
 
+/**
+One-dimensional texture, consisting of a single row of texels.
+*/
 class Texture1D: public Texture1DBackend
 {
        friend Texture1DBackend;
@@ -26,18 +29,27 @@ public:
        };
 
 private:
-       unsigned width;
-       unsigned levels;
+       unsigned width = 0;
+       unsigned levels = 0;
 
 public:
-       Texture1D();
+       /** Sets storage format and size 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 lv = 0);
 
-       void storage(PixelFormat, unsigned, unsigned = 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. */
+       void image(unsigned level, const void *);
+
+       /** Replaces a range of texels in the texture.  Allocated storage must
+       exist.  The image data is interpreted according to the storage format and
+       the range must be fully inside the selected mipmap level. */
+       void sub_image(unsigned level, int x, unsigned wd, const void *);
 
-       void image(unsigned, const void *);
-       void sub_image(unsigned, int, unsigned, const void *);
        virtual void image(const Graphics::Image &, unsigned = 0);
-       using Texture::image;
+
        unsigned get_width() const { return width; }
 
 private:
@@ -46,7 +58,7 @@ private:
 
 public:
        virtual AsyncLoader *load(IO::Seekable &, const Resources * = 0) { return 0; }
-       virtual std::uint64_t get_data_size() const;
+       virtual std::size_t get_data_size() const;
        virtual void unload() { }
 };