dcolorcomposer.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2006-03-02
 * Description : DColor methods for composing
 *
 * Copyright (C) 2006-2009 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 *
 * This program 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, or (at your option)
 * any later version.
 *
 * This program 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.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_DCOLOR_COMPOSER_H
#define DIGIKAM_DCOLOR_COMPOSER_H
 
// Local includes
 
#include "dcolor.h"
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT DColorComposer
{
public:
 
    enum CompositingOperation
    {
        PorterDuffNone,
        PorterDuffClear,
        PorterDuffSrc,
        PorterDuffSrcOver,
        PorterDuffDstOver,
        PorterDuffSrcIn,
        PorterDuffDstIn,
        PorterDuffSrcOut,
        PorterDuffDstOut,
        PorterDuffSrcAtop,
        PorterDuffDstAtop,
        PorterDuffXor
    };
 
    enum MultiplicationFlags
    {
        NoMultiplication = 0x00,
        PremultiplySrc   = 0x01,
        PremultiplyDst   = 0x02,
        DemultiplyDst    = 0x04,
 
        MultiplicationFlagsDImg                     = PremultiplySrc | PremultiplyDst | DemultiplyDst,
        MultiplicationFlagsPremultipliedColorOnDImg = PremultiplyDst | DemultiplyDst
    };
 
    static DColorComposer* getComposer(CompositingOperation rule);
 
    virtual void compose(DColor& dest, DColor& src) = 0;
 
    virtual void compose(DColor& dest, DColor& src, MultiplicationFlags multiplicationFlags);
 
    DColorComposer()          = default;
    virtual ~DColorComposer() = default;
 
private:
 
    Q_DISABLE_COPY(DColorComposer)
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DCOLOR_COMPOSER_H