ImageBitmap.h

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////////////
//    Scorched3D (c) 2000-2009
//
//    This file is part of Scorched3D.
//
//    Scorched3D is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation; either version 2 of the License, or
//    (at your option) any later version.
//
//    Scorched3D 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 General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with Scorched3D; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
////////////////////////////////////////////////////////////////////////////////

#if !defined(AFX_ImageBitmap_H__315BF771_5E56_4C78_9D9F_51608D8CB3F0__INCLUDED_)
#define AFX_ImageBitmap_H__315BF771_5E56_4C78_9D9F_51608D8CB3F0__INCLUDED_

#include <image/Image.h>

/**
A class that wraps the loading of windows .bmp image data into
a format that can be easily consumed by a GLTexture object.
The bitmap data is unpacked and is stored in either RGB or
RGBA format.  One ubyte per component.
No attempt is made to ensure the bitmap conforms to the
GLTexture specification (sizes == pow(2, x))
*/
class ImageBitmap : public Image
{
public:
        ImageBitmap();
        ImageBitmap(int width, int height, bool alpha = false, unsigned char fill = 255);
        virtual ~ImageBitmap();

        void clear();

        virtual unsigned char *getBits() { return newbits_; }
        virtual int getWidth() { return width_; }
        virtual int getHeight() { return height_; }
        virtual int getAlignment() { return 4; }
        virtual int getComponents() { return alpha_?4:3; }
        virtual bool getAlpha() { return alpha_; }

        void setBits(unsigned char *bits) { newbits_ = bits; }

        /**
        Overwrite the bitmap with the contents of the given file.
        If alpha is true then any black areas in the bitmap have full
        opacity.  When creating an alpha bitmap the bitmap is created
        in RGBA format, otherwise in RGB format.
        */
        bool loadFromFile(const char *filename, bool alpha = false);
        bool loadFromFile(const char * filename, const char *alphafilename, bool invert);

        virtual void removeOwnership() { owner_ = false; }

protected:
        bool owner_;
        unsigned char *newbits_;
        int width_;
        int height_;
        bool alpha_;

        void createBlankInternal(int width, int height, 
                bool alpha = false, unsigned char fill = 255);

private:
        ImageBitmap(ImageBitmap &other);
        ImageBitmap &operator=(ImageBitmap &other);
};

#endif // !defined(AFX_ImageBitmap_H__315BF771_5E56_4C78_9D9F_51608D8CB3F0__INCLUDED_)

---