]> git.tdb.fi Git - libs/gl.git/blobdiff - source/texture2d.h
Use DerivedObjectLoader in Texture2D
[libs/gl.git] / source / texture2d.h
index f1b76783f7e5c5a242c96bb3528d7e7a8929ec40..35346e0091e2bbc8a24bf827bec4a96d921cbbd8 100644 (file)
@@ -1,16 +1,9 @@
-/* $Id$
-
-This file is part of libmspgl
-Copyright © 2007  Mikko Rasa, Mikkosoft Productions
-Distributed under the LGPL
-*/
-
 #ifndef MSP_GL_TEXTURE2D_H_
 #define MSP_GL_TEXTURE2D_H_
 
 #include <string>
-#include <msp/datafile/loader.h>
-#include <msp/gbase/image.h>
+#include <msp/graphics/image.h>
+#include "datatype.h"
 #include "pixelformat.h"
 #include "texture.h"
 
@@ -18,60 +11,66 @@ namespace Msp {
 namespace GL {
 
 /**
-Two-dimensional texture class.  This is the most common type of texture.
+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
+       class Loader: public Msp::DataFile::DerivedObjectLoader<Texture2D, Texture::Loader>
        {
        public:
                Loader(Texture2D &);
        private:
                void image_data(const std::string &);
                void raw_data(const std::string &);
-               void storage(PixelFormat, unsigned, unsigned, unsigned);
+               void storage(PixelFormat, unsigned, unsigned);
+               void storage_b(PixelFormat, unsigned, unsigned, unsigned);
        };
 
 private:
        PixelFormat ifmt;
-       sizei width;
-       sizei height;
-       int border;
+       unsigned width;
+       unsigned height;
+       unsigned allocated;
 
 public:
        Texture2D();
 
-       /**
-       Defines the texture storage.  This function may only be successfully called
-       once.
-       */
-       void storage(PixelFormat fmt, sizei wd, sizei ht, int brd);
+       /** 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 have been called prior to
-       this, and the image must have dimensions conforming to the specified
-       storage.
-       */
-       void image(int level, PixelFormat fmt, DataType type, const void *data);
+       /** 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);
 
-       /**
-       Uploads a sub-image into the texture.  Unlike full image upload, there are
-       no constraints on the size of the sub-image.
-       */
-       void sub_image(int level, int x, int y, sizei wd, sizei ht, 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 called, the storage format will be set to match the loaded image.
-       */
+       /** 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);
 
-       sizei get_width() const  { return width; }
-       sizei get_height() const { return height; }
-
 private:
        void image(const Graphics::Image &);
+
+public:
+       unsigned get_width() const  { return width; }
+       unsigned get_height() const { return height; }
+
+private:
+       void get_level_size(unsigned, unsigned &, unsigned &);
 };
 
 } // namespace GL