magnum/src/AbstractImage.h

#ifndef Magnum_AbstractImage_h
#define Magnum_AbstractImage_h
/*
    Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz>

    This file is part of Magnum.

    Magnum is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License version 3
    only, as published by the Free Software Foundation.

    Magnum is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU Lesser General Public License version 3 for more details.
*/

/** @file
 * @brief Class Magnum::AbstractImage
 */

#include "Magnum.h"

namespace Magnum {

/**
@brief Non-templated base for one-, two- or three-dimensional images

See Image, BufferedImage, Trade::ImageData documentation for more information.
*/
class MAGNUM_EXPORT AbstractImage {
    AbstractImage(const AbstractImage& other) = delete;
    AbstractImage(AbstractImage&& other) = delete;
    AbstractImage& operator=(const AbstractImage& other) = delete;
    AbstractImage& operator=(AbstractImage&& other) = delete;

    public:
        /**
         * @{ @name Image formats
         *
         * Note that some formats can be used only for framebuffer reading
         * (using Framebuffer::read()) and some only for texture data (using
         * Texture::setData() and others).
         */

        /** @brief Color components */
        enum class Components: GLenum {
            Red = GL_RED,                   /**< One-component (red channel) */

            /** One-component (green channel). For framebuffer reading only. */
            Green = GL_GREEN,

            /** One-component (green channel). For framebuffer reading only. */
            Blue = GL_BLUE,

            /** Two-component (red and green channel). For texture data only. */
            RedGreen = GL_RG,

            RGB = GL_RGB,                   /**< Three-component RGB */
            BGR = GL_BGR,                   /**< Three-component BGR */
            RGBA = GL_RGBA,                 /**< Four-component RGBA */
            BGRA = GL_BGRA,                 /**< Four-component BGRA */

            /** Depth component. For framebuffer reading only. */
            Depth = GL_DEPTH_COMPONENT,

            /** Stencil index. For framebuffer reading only. */
            StencilIndex = GL_STENCIL_INDEX,

            /**
             * Depth and stencil component. For framebuffer reading only.
             *
             * @requires_gl30 Extension <tt>EXT_packed_depth_stencil</tt>
             */
            DepthStencil = GL_DEPTH_STENCIL
        };

        /** @brief Data type */
        enum class ComponentType: GLenum {
            UnsignedByte = GL_UNSIGNED_BYTE, /**< Each component unsigned byte */
            Byte = GL_BYTE,                 /**< Each component byte */
            UnsignedShort = GL_UNSIGNED_SHORT, /**< Each component unsigned short */
            Short = GL_SHORT,               /**< Each component short */
            UnsignedInt = GL_UNSIGNED_INT,  /**< Each component unsigned int */
            Int = GL_INT,                   /**< Each component int */

            /**
             * Each component half float (16bit). For framebuffer reading only.
             *
             * @requires_gl30 Extension <tt>NV_half_float</tt> / <tt>ARB_half_float_pixel</tt>
             */
            HalfFloat = GL_HALF_FLOAT,

            Float = GL_FLOAT,               /**< Each component float (32bit) */

            /**
             * Three-component RGB, unsigned normalized, red and green 3bit,
             * blue 2bit, 8bit total.
             */
            RGB332 = GL_UNSIGNED_BYTE_3_3_2,

            /**
             * Three-component BGR, unsigned normalized, red and green 3bit,
             * blue 2bit, 8bit total.
             */
            BGR233 = GL_UNSIGNED_BYTE_2_3_3_REV,

            /**
             * Three-component RGB, unsigned normalized, red and blue 5bit,
             * green 6bit, 16bit total.
             */
            RGB565 = GL_UNSIGNED_SHORT_5_6_5,

            /**
             * Three-component BGR, unsigned normalized, red and blue 5bit,
             * green 6bit, 16bit total.
             */
            BGR565 = GL_UNSIGNED_SHORT_5_6_5_REV,

            /**
             * Four-component RGBA, unsigned normalized, each component 4bit,
             * 16bit total.
             */
            RGBA4 = GL_UNSIGNED_SHORT_4_4_4_4,

            /**
             * Four-component ABGR, unsigned normalized, each component 4bit,
             * 16bit total.
             */
            ABGR4 = GL_UNSIGNED_SHORT_4_4_4_4_REV,

            /**
             * Four-component RGBA, unsigned normalized, each RGB component
             * 5bit, alpha 1bit, 16bit total.
             */
            RGB5Alpha1 = GL_UNSIGNED_SHORT_5_5_5_1,

            /**
             * Four-component ABGR, unsigned normalized, each RGB component
             * 5bit, alpha 1bit, 16bit total.
             */
            Alpha1BGR5 = GL_UNSIGNED_SHORT_1_5_5_5_REV,

            /**
             * Four-component RGBA, unsigned normalized, each component 8bit,
             * 32bit total.
             */
            RGBA8 = GL_UNSIGNED_INT_8_8_8_8,

            /**
             * Four-component ABGR, unsigned normalized, each component 8bit,
             * 32bit total.
             */
            ABGR8 = GL_UNSIGNED_INT_8_8_8_8_REV,

            /**
             * Four-component RGBA, unsigned normalized, each RGB component
             * 10bit, alpha 2bit, 32bit total.
             */
            RGB10Alpha2 = GL_UNSIGNED_INT_10_10_10_2,

            /**
             * Four-component ABGR, unsigned normalized, each RGB component
             * 10bit, alpha 2bit, 32bit total.
             */
            Alpha2RGB10 = GL_UNSIGNED_INT_2_10_10_10_REV,

            /**
             * Three-component BGR, float, red and green 11bit, blue 10bit,
             * 32bit total. For framebuffer reading only.
             *
             * @requires_gl30 Extension <tt>EXT_packed_float</tt>
             */
            B10GR11Float = GL_UNSIGNED_INT_10F_11F_11F_REV,

            /**
             * Three-component BGR, unsigned integers with exponent, each
             * component 9bit, exponent 5bit, 32bit total. For framebuffer
             * reading only.
             *
             * @requires_gl30 Extension <tt>EXT_texture_shared_exponent</tt>
             */
            Exponent5RGB9 = GL_UNSIGNED_INT_5_9_9_9_REV,

            /**
             * 24bit depth and 8bit stencil component, 32bit total. For
             * framebuffer reading only.
             *
             * @requires_gl30 Extension <tt>EXT_packed_depth_stencil</tt>
             */
            Depth24Stencil8 = GL_UNSIGNED_INT_24_8,

            /**
             * 32bit float depth component and 8bit stencil component, 64bit
             * total. For framebuffer reading only.
             *
             * @requires_gl30 Extension <tt>ARB_depth_buffer_float</tt>
             */
            Depth32FloatStencil8 = GL_FLOAT_32_UNSIGNED_INT_24_8_REV
        };

        /*@}*/

        /**
         * @brief Pixel size (in bytes)
         * @param components        Color components
         * @param type              Data type
         */
        static size_t pixelSize(Components components, ComponentType type);

        /**
         * @brief Constructor
         * @param components        Color components of passed data
         * @param type              %Image data type
         */
        inline AbstractImage(Components components, ComponentType type): _components(components), _type(type) {}

        /** @brief Destructor */
        virtual ~AbstractImage() = 0;

        /** @brief Color components */
        inline Components components() const { return _components; }

        /** @brief Data type */
        inline ComponentType type() const { return _type; }

    protected:
        Components _components;     /**< @brief Color components */
        ComponentType _type;        /**< @brief Data type */
};

inline AbstractImage::~AbstractImage() {}

}

#endif