krita

KisChannelInfo Class Reference

#include <kis_channelinfo.h>

List of all members.


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 30 of file kis_channelinfo.h.


Public Types

enum  enumChannelType { COLOR, ALPHA, SUBSTANCE, SUBSTRATE }
enum  enumChannelValueType {
  UINT8, UINT16, FLOAT16, FLOAT32,
  INT8, INT16, OTHER
}
enum  enumChannelFlags { FLAG_COLOR = 1, FLAG_ALPHA = (1 << 1), FLAG_SUBSTANCE = (1 << 2), FLAG_SUBSTRATE = (1 << 3) }

Public Member Functions

 KisChannelInfo ()
 KisChannelInfo (const QString &name, Q_INT32 npos, enumChannelType channelType, enumChannelValueType channelValueType, Q_INT32 size=1, QColor color=QColor(0, 0, 0))
QString name () const
Q_INT32 pos () const
Q_INT32 size () const
enumChannelType channelType () const
enumChannelValueType channelValueType () const
QColor color () const

Member Function Documentation

enumChannelType KisChannelInfo::channelType  )  const [inline]
 

returns the type of the channel

Definition at line 77 of file kis_channelinfo.h.

enumChannelValueType KisChannelInfo::channelValueType  )  const [inline]
 

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

Definition at line 81 of file kis_channelinfo.h.

QColor KisChannelInfo::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 86 of file kis_channelinfo.h.

QString KisChannelInfo::name  )  const [inline]
 

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

Definition at line 62 of file kis_channelinfo.h.

Q_INT32 KisChannelInfo::pos  )  const [inline]
 

returns the position of the first byte of the channel in the pixel

Definition at line 67 of file kis_channelinfo.h.

Q_INT32 KisChannelInfo::size  )  const [inline]
 

returns the number of bytes this channel takes

Definition at line 72 of file kis_channelinfo.h.


The documentation for this class was generated from the following file:
KDE Home | KDE Accessibility Home | Description of Access Keys