Improve interface documentation a bit

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

diff --git a/source/texture2d.h b/source/texture2d.h
index 35346e0091e2bbc8a24bf827bec4a96d921cbbd8..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
 {
@@ -22,7 +22,10 @@ public:
        {
        public:
                Loader(Texture2D &);
+               Loader(Texture2D &, Collection &);
        private:
+               void init();
+
                void image_data(const std::string &);
                void raw_data(const std::string &);
                void storage(PixelFormat, unsigned, unsigned);
@@ -45,7 +48,7 @@ public:
        /** 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. */
@@ -57,16 +60,18 @@ 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. */
-       void load_image(const std::string &fn);
+       /// Loads a Graphics::Image from a file and uploads it to the texture.
+       void load_image(const std::string &fn, bool srgb = false);
 
-private:
-       void image(const Graphics::Image &);
+       /** 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.
 
-public:
-       unsigned get_width() const  { return width; }
+       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; }
        unsigned get_height() const { return height; }
 
 private: