ImageSet.h

Go to the documentation of this file.

#ifndef GLIMG_IMAGE_SET_H
#define GLIMG_IMAGE_SET_H

#include "ImageFormat.h"
#include "boost/shared_ptr.hpp"
#include "boost/noncopyable.hpp"

namespace glimg
{

    struct Dimensions
    {
        int numDimensions;  
        int width;          
        int height;         
        int depth;          

        int NumLines() const
        {
            switch(numDimensions)
            {
            case 1:
                return 1;
            case 2:
                return height;
            case 3:
                return depth * height;
            }

            //Should not be possible.
            return -1;
        }
    };

    namespace detail
    {
        class ImageSetImpl;
        typedef boost::shared_ptr<const ImageSetImpl> ImageSetImplPtr;
    }

    class ImageSet;

    class SingleImage
    {
    public:
        Dimensions GetDimensions() const;

        ImageFormat GetFormat() const;

        const void *GetImageData() const;

        size_t GetImageByteSize() const;

    private:
        detail::ImageSetImplPtr m_pImpl;
        int m_arrayIx;
        int m_faceIx;
        int m_mipmapLevel;

        friend class detail::ImageSetImpl;
        friend class ImageSet;

        SingleImage(detail::ImageSetImplPtr pImpl, int mipmapLevel, int arrayIx, int faceIx);
    };

    class ImageSet
    {
    public:
        Dimensions GetDimensions() const;

        int GetMipmapCount() const;

        int GetArrayCount() const;

        int GetFaceCount() const;

        ImageFormat GetFormat() const;

        SingleImage GetImage(int mipmapLevel, int arrayIx = 0, int faceIx = 0) const;

        const void *GetImageArray(int mipmapLevel) const;

    private:
        detail::ImageSetImplPtr m_pImpl;

        explicit ImageSet(detail::ImageSetImplPtr pImpl);

        friend class ImageCreator;
        friend void CreateTexture(unsigned int textureName, const ImageSet *pImage, unsigned int forceConvertBits);
    };

}


#endif //GLIMG_IMAGE_SET_H