dcolor.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2005-12-02
 * Description : 8-16 bits color container.
 *
 * Copyright (C) 2005-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * 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_H
#define DIGIKAM_DCOLOR_H
 
// C++ includes
 
#include <cmath>
 
// Qt includes
 
#include <QColor>
 
// Local includes
 
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT DColor
{
public:
 
    DColor()
        : m_red       (0),
          m_green     (0),
          m_blue      (0),
          m_alpha     (0),
          m_sixteenBit(false)
    {
    }
 
    explicit DColor(uchar* data, bool sixteenBit = false)
    {
        setColor(data, sixteenBit);
    }
 
    DColor(int red, int green, int blue, int alpha, bool sixteenBit)
        : m_red         (red),
          m_green       (green),
          m_blue        (blue),
          m_alpha       (alpha),
          m_sixteenBit  (sixteenBit)
    {
    }
 
    explicit DColor(const QColor& color, bool sixteenBit=false);
 
    // Use default copy constructor, assignment operator and destructor
 
    inline void setColor(uchar* const data, bool sixteenBit = false);
 
    inline void setPixel(uchar* const data) const;
 
    int red()                               const
    {
        return m_red;
    }
 
    int green()                             const
    {
        return m_green;
    }
 
    int blue()                              const
    {
        return m_blue;
    }
 
    int alpha()                             const
    {
        return m_alpha;
    }
 
    bool sixteenBit()                       const
    {
        return m_sixteenBit;
    }
 
    void setRed(int red)
    {
        m_red = red;
    }
 
    void setGreen(int green)
    {
        m_green = green;
    }
 
    void setBlue (int blue)
    {
        m_blue = blue;
    }
 
    void setAlpha(int alpha)
    {
        m_alpha = alpha;
    }
 
    void setSixteenBit(bool sixteenBit)
    {
        m_sixteenBit = sixteenBit;
    }
 
    QColor getQColor() const;
 
    inline bool isPureGrayValue(int v)
    {
        return ((m_red == v) && (m_green == v) && (m_blue == v));
    }
 
    inline bool isPureGray()
    {
        return ((m_red == m_green) && (m_red == m_blue));
    }
 
    void convertToSixteenBit();
    void convertToEightBit();
 
    void premultiply();
    void demultiply();
 
    void getHSL(int* const h, int* const s, int* const l) const;
 
    void setHSL(int h, int s, int l, bool sixteenBit);
 
    void getYCbCr(double* const y, double* const cb, double* const cr) const;
 
    void setYCbCr(double y, double cb, double cr, bool sixteenBit);
 
private:
 
    int  m_red;
    int  m_green;
    int  m_blue;
    int  m_alpha;
 
    bool m_sixteenBit;
 
public:
 
    inline void blendZero();
    inline void blendAlpha8(int alpha);
    inline void blendInvAlpha8(int alpha);
    inline void blendAlpha16(int alpha);
    inline void blendInvAlpha16(int alpha);
    inline void premultiply16(int alpha);
    inline void premultiply8(int alpha);
    inline void demultiply16(int alpha);
    inline void demultiply8(int alpha);
    inline void blendAdd(const DColor& src);
    inline void blendClamp8();
    inline void blendClamp16();
    inline void multiply(float factor);
};
 
} // namespace Digikam
 
// Inline methods
 
#include "dcolorpixelaccess.h"
#include "dcolorblend.h"
 
#endif // DIGIKAM_DCOLOR_H