ImageLoaderBMP.h

Go to the documentation of this file.

/*********************************************************\
 *  File: ImageLoaderBMP.h                               *
 *
 *  Copyright (C) 2002-2012 The PixelLight Team (http://www.pixellight.org/)
 *
 *  This file is part of PixelLight.
 *
 *  PixelLight is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  PixelLight 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with PixelLight. If not, see <http://www.gnu.org/licenses/>.
\*********************************************************/


#ifndef __PLGRAPHICS_IMAGELOADER_BMP_H__
#define __PLGRAPHICS_IMAGELOADER_BMP_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include "PLGraphics/Image/ImageLoader.h"


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
namespace PLGraphics {


//[-------------------------------------------------------]
//[ Forward declarations                                  ]
//[-------------------------------------------------------]
class Image;


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Image loader implementation for BMP file formats
*
*  @note
*    - BMP specifications: http://en.wikipedia.org/wiki/BMP_file_format
*    - The BGR(A) color format of BMP is automatically converted to RGB(A)
*/
class ImageLoaderBMP : public ImageLoader {


    //[-------------------------------------------------------]
    //[ RTTI interface                                        ]
    //[-------------------------------------------------------]
    pl_class(PLGRAPHICS_RTTI_EXPORT, ImageLoaderBMP, "PLGraphics", PLGraphics::ImageLoader, "Image loader implementation for BMP file formats")
        // Properties
        pl_properties
            pl_property("Formats",  "bmp,BMP")
            pl_property("Load",     "1")
            pl_property("Save",     "1")
        pl_properties_end
        // Constructors
        pl_constructor_0(DefaultConstructor,    "Default constructor",  "")
        // Methods
        pl_method_2(Load,   pl_ret_type(bool),  Image&,         PLCore::File&,  "Load method",  "")
        pl_method_2(Save,   pl_ret_type(bool),  const Image&,   PLCore::File&,  "Save method",  "")
    pl_class_end


    //[-------------------------------------------------------]
    //[ Public RTTI methods                                   ]
    //[-------------------------------------------------------]
    public:
        PLGRAPHICS_API bool Load(Image &cImage, PLCore::File &cFile);
        PLGRAPHICS_API bool Save(const Image &cImage, PLCore::File &cFile);


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Default constructor
        */
        PLGRAPHICS_API ImageLoaderBMP();

        /**
        *  @brief
        *    Destructor
        */
        PLGRAPHICS_API virtual ~ImageLoaderBMP();


};


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
} // PLGraphics


#endif // __PLGRAPHICS_IMAGELOADER_BMP_H__