IEConvert.h

Go to the documentation of this file.

/*********************************************************\
 *  File: IEConvert.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_IMAGEEFFECT_CONVERT_H__
#define __PLGRAPHICS_IMAGEEFFECT_CONVERT_H__
#pragma once


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


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


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Image effect: Convert data and color type of an image
*
*  @note
*    - The color format "ColorPalette" is not supported as destination format
*    - If an alpha channel is added, the set alpha value for every pixel is 255 for integer formats and 1.0 for floating point formats...
*      this way, such an image can usually directly be used as a solid texture
*/
class IEConvert : public ImageEffect {


    //[-------------------------------------------------------]
    //[ RTTI interface                                        ]
    //[-------------------------------------------------------]
    pl_class(PLGRAPHICS_RTTI_EXPORT, IEConvert, "PLGraphics", PLGraphics::ImageEffect, "Image effect: Convert data and color type of an image")
    pl_class_end


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Constructor
        *
        *  @param[in] nDataFormat
        *    Desired data format
        *  @param[in] nColorFormat
        *    Desired color format
        */
        PLGRAPHICS_API IEConvert(EDataFormat nDataFormat, EColorFormat nColorFormat);

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


    //[-------------------------------------------------------]
    //[ Public virtual ImageEffect functions                  ]
    //[-------------------------------------------------------]
    public:
        PLGRAPHICS_API virtual bool Apply(ImageBuffer &cBuffer) const override;


    //[-------------------------------------------------------]
    //[ Private data                                          ]
    //[-------------------------------------------------------]
    private:
        EDataFormat  m_nDataFormat;     /**< Data format of the image */
        EColorFormat m_nColorFormat;    /**< Color format of the image */


};


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


#endif // __PLGRAPHICS_IMAGEEFFECT_CONVERT_H__