#include <KoChannelInfo.h>

Classes
struct	DoubleRange

Public Types
enum	enumChannelType { COLOR , ALPHA }
	enum to define the type of the channel More...

enum	enumChannelValueType { UINT8 , UINT16 , UINT32 , FLOAT16 , FLOAT32 , FLOAT64 , INT8 , INT16 , OTHER }
	enum to define the value of the channel More...

Public Member Functions
enumChannelType	channelType () const

enumChannelValueType	channelValueType () const

QColor	color () const

qint32	displayPosition () const

double	getUIMax (void) const

double	getUIMin (void) const

double	getUIUnitValue (void) const
	getUIUnitValue Gets the unit value for this channel. This is suitable for converting between representations.

	KoChannelInfo ()

	KoChannelInfo (const QString &name, qint32 npos, qint32 displayPosition, enumChannelType channelType, enumChannelValueType channelValueType, qint32 size=-1, const QColor &color=QColor(0, 0, 0), const DoubleRange &uiMinMax=DoubleRange())

QString	name () const

bool	operator< (const KoChannelInfo &info)

qint32	pos () const

qint32	size () const

Static Public Member Functions
static QList< KoChannelInfo * >	displayOrderSorted (const QList< KoChannelInfo * > &channels)

static int	displayPositionToChannelIndex (int displayPosition, const QList< KoChannelInfo * > &channels)

Private Attributes
enumChannelType	m_channelType

enumChannelValueType	m_channelValueType

QColor	m_color

qint32	m_displayPosition

QString	m_name

qint32	m_pos

qint32	m_size

DoubleRange	m_uiMinMax

Detailed Description

This class gives some basic information about a channel, that is, one of the components that makes up a particular pixel.

Definition at line 21 of file KoChannelInfo.h.

Member Enumeration Documentation

◆ enumChannelType

enum KoChannelInfo::enumChannelType

enum to define the type of the channel

Enumerator
COLOR	The channel represents a color.
ALPHA	The channel represents the opacity of a pixel.

Definition at line 41 of file KoChannelInfo.h.

                         {
        COLOR, 
        ALPHA 
        //SUBSTANCE, ///< The channel represents a real-world substance like pigments or medium
        //SUBSTRATE ///< The channel represents a real-world painting substrate like a canvas
    };

◆ enumChannelValueType

enum KoChannelInfo::enumChannelValueType

enum to define the value of the channel

Enumerator
UINT8	use this for an unsigned integer 8bits channel
UINT16	use this for an integer 16bits channel
UINT32	use this for an unsigned integer 21bits channel
FLOAT16	use this for a float 16bits channel
FLOAT32	use this for a float 32bits channel
FLOAT64	use this for a float 64bits channel
INT8	use this for an integer 8bits channel
INT16	use this for an integer 16bits channel
OTHER	Use this if the channel is neither an integer or a float.

Definition at line 48 of file KoChannelInfo.h.

                              {
        UINT8, 
        UINT16, 
        UINT32, 
        FLOAT16, 
        FLOAT32, 
        FLOAT64, 
        INT8, 
        INT16, 
        OTHER 
    };

Constructor & Destructor Documentation

◆ KoChannelInfo() [1/2]

KoChannelInfo::KoChannelInfo ( )

inline

Definition at line 61 of file KoChannelInfo.h.

61{ }

◆ KoChannelInfo() [2/2]

KoChannelInfo::KoChannelInfo	(	const QString &	name,
		qint32	npos,
		qint32	displayPosition,
		enumChannelType	channelType,
		enumChannelValueType	channelValueType,
		qint32	size = -1,
		const QColor &	color = QColor(0, 0, 0),
		const DoubleRange &	uiMinMax = DoubleRange() )

inline

Parameters

name	of the channel
npos	position of the channel in the pixel (in bytes)
displayPosition	the position of the channel in the user-visible order
channelType	type of the channel
channelValueType	type of the numerical data used by the channel
size	number of bytes (not bits) of the channel (if -1, it is deduced from the channelType)
color	a color to represent that channel (for instance in an histogram)
uiMinMax	the UI range

Definition at line 72 of file KoChannelInfo.h.

        : m_name(name)
        , m_pos(npos)
        , m_displayPosition(displayPosition)
        , m_channelType(channelType)
        , m_channelValueType(channelValueType)
        , m_size(size)
        , m_color(color)
        , m_uiMinMax(uiMinMax)
    {
        switch(m_channelValueType)
        {
        case UINT8:
        case INT8:
            Q_ASSERT(m_size == -1 || m_size == 1);
            m_size = 1;
            break;
        case UINT16:
        case INT16:
            Q_ASSERT(m_size == -1 || m_size == 2);
            m_size = 2;
            break;
        case UINT32:
            Q_ASSERT(m_size == -1 || m_size == 4);
            m_size = 4;
            break;
        case FLOAT16:
            Q_ASSERT(m_size == -1 || m_size == 2);
            m_size = 2;
            break;
        case FLOAT32:
            Q_ASSERT(m_size == -1 || m_size == 4);
            m_size = 4;
            break;
        case FLOAT64:
            Q_ASSERT(m_size == -1 || m_size == 8);
            m_size = 8;
            break;
        case OTHER:
            Q_ASSERT(m_size != -1);
        }
        if (!uiMinMax.isValid()) {
            switch (m_channelValueType) {
                case UINT8:
                    m_uiMinMax.minVal = std::numeric_limits<quint8>::min();
                    m_uiMinMax.maxVal = std::numeric_limits<quint8>::max();
                    break;
                case INT8:
                    m_uiMinMax.minVal = std::numeric_limits<qint8>::min();
                    m_uiMinMax.maxVal = std::numeric_limits<qint8>::max();
                    break;
                case UINT16:
                    m_uiMinMax.minVal = std::numeric_limits<quint16>::min();
                    m_uiMinMax.maxVal = std::numeric_limits<quint16>::max();
                    break;
                case INT16:
                    m_uiMinMax.minVal = std::numeric_limits<qint16>::min();
                    m_uiMinMax.maxVal = std::numeric_limits<qint16>::max();
                    break;
                case UINT32:
                    m_uiMinMax.minVal = std::numeric_limits<quint32>::min();
                    m_uiMinMax.maxVal = std::numeric_limits<quint32>::max();
                    break;
                default:
                    // assume real otherwise, which is 0..1 by default
                    m_uiMinMax.minVal = 0.0;
                    m_uiMinMax.maxVal = 1.0;
                    break;
            }
        }
        Q_ASSERT(m_uiMinMax.isValid());
    }

References FLOAT16, FLOAT32, FLOAT64, INT16, INT8, KoChannelInfo::DoubleRange::isValid(), m_channelValueType, m_size, m_uiMinMax, KoChannelInfo::DoubleRange::maxVal, KoChannelInfo::DoubleRange::minVal, OTHER, UINT16, UINT32, and UINT8.

Member Function Documentation

◆ channelType()

enumChannelType KoChannelInfo::channelType ( ) const

inline

Returns: the type of the channel

Definition at line 212 of file KoChannelInfo.h.

                                               {
        return m_channelType;
    }

References m_channelType.

◆ channelValueType()

enumChannelValueType KoChannelInfo::channelValueType ( ) const

inline

Returns: the type of the value of the channel (float, uint8 or uint16)

Definition at line 218 of file KoChannelInfo.h.

                                                         {
        return m_channelValueType;
    }

References m_channelValueType.

◆ color()

QColor KoChannelInfo::color ( ) const

inline

This is a color that can be used to represent this channel in histograms and so. By default this is black, so keep in mind that many channels might look the same

Definition at line 225 of file KoChannelInfo.h.

                                {
        return m_color;
    }

References m_color.

◆ displayOrderSorted()

static QList< KoChannelInfo * > KoChannelInfo::displayOrderSorted ( const QList< KoChannelInfo * > & channels )

inlinestatic

Definition at line 166 of file KoChannelInfo.h.

    {
        QList <KoChannelInfo*> sortedChannels;
        for (int i = 0; i < channels.size(); ++i) {
            Q_FOREACH (KoChannelInfo* channel, channels) {
                if (channel->displayPosition() == i) {
                    sortedChannels << channel;
                    break;
                }
            }
        }
        Q_ASSERT(channels.size() == sortedChannels.size());
        return sortedChannels;
    }

References displayPosition().

◆ displayPosition()

qint32 KoChannelInfo::displayPosition ( ) const

inline

Returns: the displayPosition of the channel in the pixel

Definition at line 198 of file KoChannelInfo.h.

                                          {
        return m_displayPosition;
    }

References m_displayPosition.

◆ displayPositionToChannelIndex()

static int KoChannelInfo::displayPositionToChannelIndex	(	int	displayPosition,
		const QList< KoChannelInfo * > &	channels )

inlinestatic

converts the display position to the pixel-order index in the channels vector.

Definition at line 156 of file KoChannelInfo.h.

    {
        for (int i = 0; i < channels.size(); ++i) {
            if (channels.at(i)->displayPosition() == displayPosition) {
                return i;
            }
        }
        return -1;
    }

References displayPosition().

◆ getUIMax()

double KoChannelInfo::getUIMax ( void ) const

inline

Gets the minimum value that this channel should have. This is suitable for UI use.

Definition at line 248 of file KoChannelInfo.h.

                                       {
        return m_uiMinMax.maxVal;
    }

References m_uiMinMax, and KoChannelInfo::DoubleRange::maxVal.

◆ getUIMin()

double KoChannelInfo::getUIMin ( void ) const

inline

Gets the minimum value that this channel should have. This is suitable for UI use.

Definition at line 240 of file KoChannelInfo.h.

                                       {
        return m_uiMinMax.minVal;
    }

References m_uiMinMax, and KoChannelInfo::DoubleRange::minVal.

◆ getUIUnitValue()

double KoChannelInfo::getUIUnitValue ( void ) const

inline

getUIUnitValue Gets the unit value for this channel. This is suitable for converting between representations.

Definition at line 257 of file KoChannelInfo.h.

                                             {
        return m_uiMinMax.maxVal - m_uiMinMax.minVal;
    }

References m_uiMinMax, KoChannelInfo::DoubleRange::maxVal, and KoChannelInfo::DoubleRange::minVal.

◆ name()

QString KoChannelInfo::name ( ) const

inline

User-friendly name for this channel for presentation purposes in the gui

Definition at line 184 of file KoChannelInfo.h.

                                {
        return m_name;
    }

References m_name.

◆ operator<()

bool KoChannelInfo::operator< ( const KoChannelInfo & info )

inline

A channel is less than another channel if its pos is smaller.

Definition at line 232 of file KoChannelInfo.h.

                                                      {
        return m_pos < info.m_pos;
    }

References m_pos.

◆ pos()

qint32 KoChannelInfo::pos ( ) const

inline

Returns: the position of the first byte of the channel in the pixel

Definition at line 191 of file KoChannelInfo.h.

                              {
        return m_pos;
    }

References m_pos.

◆ size()

qint32 KoChannelInfo::size ( ) const

inline

Returns: the number of bytes this channel takes

Definition at line 205 of file KoChannelInfo.h.

                               {
        return m_size;
    }

References m_size.

Member Data Documentation

◆ m_channelType

enumChannelType KoChannelInfo::m_channelType

private

Definition at line 266 of file KoChannelInfo.h.

◆ m_channelValueType

enumChannelValueType KoChannelInfo::m_channelValueType

private

Definition at line 267 of file KoChannelInfo.h.

◆ m_color

QColor KoChannelInfo::m_color

private

Definition at line 269 of file KoChannelInfo.h.

◆ m_displayPosition

qint32 KoChannelInfo::m_displayPosition

private

Definition at line 265 of file KoChannelInfo.h.

◆ m_name

QString KoChannelInfo::m_name

private

Definition at line 263 of file KoChannelInfo.h.

◆ m_pos

qint32 KoChannelInfo::m_pos

private

Definition at line 264 of file KoChannelInfo.h.

◆ m_size

qint32 KoChannelInfo::m_size

private

Definition at line 268 of file KoChannelInfo.h.

◆ m_uiMinMax

DoubleRange KoChannelInfo::m_uiMinMax

private

Definition at line 270 of file KoChannelInfo.h.

The documentation for this class was generated from the following file:

libs/pigment/KoChannelInfo.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ enumChannelType

◆ enumChannelValueType

Constructor & Destructor Documentation

◆ KoChannelInfo() [1/2]

◆ KoChannelInfo() [2/2]

Member Function Documentation

◆ channelType()

◆ channelValueType()

◆ color()

◆ displayOrderSorted()

◆ displayPosition()

◆ displayPositionToChannelIndex()

◆ getUIMax()

◆ getUIMin()

◆ getUIUnitValue()

◆ name()

◆ operator<()

◆ pos()

◆ size()

Member Data Documentation

◆ m_channelType

◆ m_channelValueType

◆ m_color

◆ m_displayPosition

◆ m_name

◆ m_pos

◆ m_size

◆ m_uiMinMax