IEMonochrome.h

Go to the documentation of this file.

/*********************************************************\
 *  File: IEMonochrome.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_MONOCHROME_H__
#define __PLGRAPHICS_IMAGEEFFECT_MONOCHROME_H__
#pragma once


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


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


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Image effect: Convert color to grayscale using "human eye formula" (red*0.299 + green*0.587 + blue*0.114)
*
*  @note
*    - The color format "ColorPalette" is not supported
*/
class IEMonochrome : public ImageEffect {


    //[-------------------------------------------------------]
    //[ RTTI interface                                        ]
    //[-------------------------------------------------------]
    pl_class(PLGRAPHICS_RTTI_EXPORT, IEMonochrome, "PLGraphics", PLGraphics::ImageEffect, "Image effect: Convert color to gray scale using \"human eye formula\" (red*0.299 + green*0.587 + blue*0.114)")
    pl_class_end


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

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


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


};


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


#endif // __PLGRAPHICS_IMAGEEFFECT_MONOCHROME_H__