Improve interface documentation a bit

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

diff --git a/source/texture2d.h b/source/texture2d.h
index dce58a7873213e772381582e490c11363f8557b6..639d47a6cee591d3a39ad6cbeced110c75550a0a 100644 (file)
--- a/source/texture2d.h
+++ b/source/texture2d.h
@@ -12,8 +12,8 @@ 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.
+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.
 */
 class Texture2D: public Texture
 {
@@ -60,14 +60,15 @@ public:
        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. */
+       /// Loads a Graphics::Image from a file and uploads it to the texture.
        void load_image(const std::string &fn, bool srgb = false);
 
        /** Uploads an image to the texture.  If storage has not been defined, it
        will be set to match the image.  Otherwise the image must be compatible with
-       the defined storage. */
+       the defined storage.
+
+       If srgb is true and storage is determined by this call, then an sRGB pixel
+       format will be used. */
        void image(const Graphics::Image &, bool srgb = false);
 
        unsigned get_width() const { return width; }