---

provider_bmp.h

Go to the documentation of this file.

/*
        $Id: provider_bmp.h,v 1.1 2001/03/06 15:09:12 mbn Exp $

        ------------------------------------------------------------------------
        ClanLib, the platform independent game SDK.

        This library is distributed under the GNU LIBRARY GENERAL PUBLIC LICENSE
        version 2. See COPYING for details.

        For a total list of contributers see CREDITS.

        ------------------------------------------------------------------------

        File purpose:
                BMP surface provider.
*/

//This code currently supports Win32 DIBs in uncompressed 8 and 24 bpp.



#ifndef header_bmpprovider
#define header_bmpprovider

#define BITMAP_ID     0x4D42      // universal id for a bitmap

/* Compression encodings for BMP files */

#ifndef WIN32
#define BI_RGB          0
#define BI_RLE8         1
#define BI_RLE4         2
#define BI_BITFIELDS    3
#endif


#include "generic_surfaceprovider.h"
#include "../Display/pixelformat.h"
#include <fstream>

class CL_BMPProvider : public CL_SurfaceProvider_Generic
//: Surface provider that can load BMP files.
{
public:
        
        static CL_Surface *create(
                std::string handle,
                CL_InputSourceProvider *provider,
                bool transparent=false,
                short trans_col=-1);
        //: Loads the bmp file 'handle' from the inputsource provider 'provider. 
        //: Creates a CL_Surface using the bmp image and returns it.


        CL_BMPProvider(
                std::string name,
                CL_InputSourceProvider *provider,
                bool transparent=false,
                short trans_col=-1);
        //: Constructs a surface provider that can read bmp files.

        virtual ~CL_BMPProvider();

        virtual unsigned int get_pitch() const;
        //: Returns the pitch of the image (bytes per line).
/*
        virtual int get_translate_x() const { return biWidth; }
        //: Returns how many pixels to translate the image (X axis).

        virtual int get_translate_y() const { return biHeight; }
        //: Returns how many pixels to translate the image (Y axis).
*/
        virtual unsigned int get_width() const { return biWidth; }
        //: Returns the width of the image.

        virtual unsigned int get_height() const { return biHeight; }
        //: Returns the height of the image.

        virtual unsigned int get_num_frames() const { return 1; }
        //: Returns the number of subsprites in the image.
/*
        virtual EPixelFormat get_pixel_format() const;
        //: Returns the pixelformat used by the image.
*/
        virtual unsigned int get_red_mask() const;
        virtual unsigned int get_green_mask() const;
        virtual unsigned int get_blue_mask() const;
        virtual unsigned int get_alpha_mask() const;
        virtual unsigned int get_depth() const;

        virtual CL_Palette *get_palette() const { return palette; }
        //: Returns the palette used by the image. NULL if system palette.

        virtual bool is_indexed() const { return biBitCount == 8;}
        
        virtual bool uses_src_colorkey() const { return trans_col != -1; }

        virtual unsigned int get_src_colorkey() const { return trans_col; }
        //: Returns the transparency color used, -1 if none.

        virtual void *get_data() const { return image; }
        //: Returns the image data. Provider must be locked before pointer is valid.

        virtual void perform_lock();
        //: Locks the surface provider.

        virtual void perform_unlock();
        //: Unlocks the surface provider.

private:
        CL_InputSourceProvider *provider;
        //int pitch, height, width;
        //int bounding_left, bounding_top, bounding_right, bounding_bottom;
        bool transparent;
        int trans_col;
        std::string name;
//      EPixelFormat pixelformat;
/*
        unsigned int Rmask;
        unsigned int Gmask;
        unsigned int Bmask;
*/
        /* The Win32 BMP file header (14 bytes) */
        char   magic[2];
        unsigned int bfSize;
        unsigned short bfReserved1;
        unsigned short bfReserved2;
        unsigned int bfOffBits;

        /* The Win32 BITMAPINFOHEADER struct (40 bytes) */
        unsigned int biSize;
        int biWidth;
        int biHeight;
        unsigned short biPlanes;
        unsigned short biBitCount;
        unsigned int biCompression;
        unsigned int biSizeImage;
        int biXPelsPerMeter;
        int biYPelsPerMeter;
        unsigned int biClrUsed;
        unsigned int biClrImportant;


        CL_Palette *palette;
        unsigned char *image;
};

#endif

---