KoColorTransformation Class Reference

#include <KoColorTransformation.h>

Inheritance diagram for KoColorTransformation:

Public Member Functions
virtual bool	isValid () const
virtual int	parameterId (const QString &name) const
virtual QList< QString >	parameters () const
virtual void	setParameter (int id, const QVariant &parameter)
void	setParameters (const QHash< QString, QVariant > &parameters)
virtual void	transform (const quint8 *src, quint8 *dst, qint32 nPixels) const =0
virtual	~KoColorTransformation ()

Detailed Description

This is the base class of all color transform that takes n pixels in input and n pixels in output.

They are created by color spaces.

For instance:

KoColorSpace* cs = KoColorSpaceRegistry::rgb8();
quint8 pixelsSrc[ nbpixels * cs->pixelSize() ];
quint8 pixelsDst[ nbpixels * cs->pixelSize() ];
KoColorTransformation* transfo = cs->createInvertTransformation();
transfo->transform( pixelsSrc, pixelsDst, nbpixels );

Definition at line 33 of file KoColorTransformation.h.

Constructor & Destructor Documentation

~KoColorTransformation()

KoColorTransformation::~KoColorTransformation ( )

virtual

Definition at line 11 of file KoColorTransformation.cpp.

{
}

Member Function Documentation

isValid()

virtual bool KoColorTransformation::isValid ( ) const

inlinevirtual

Returns

true

Reimplemented in KoColorConversionTransformation.

Definition at line 66 of file KoColorTransformation.h.

{ return true; }

parameterId()

int KoColorTransformation::parameterId ( const QString & name ) const

virtual

Get the parameter id for a parameter name

Reimplemented in KoFallBackColorTransformation, KisBurnHighlightsAdjustment< _channel_type_, traits >, KisBurnMidtonesAdjustment< _channel_type_, traits >, KisBurnShadowsAdjustment< _channel_type_, traits >, KisColorBalanceAdjustment< _channel_type_, traits >, KisDesaturateAdjustment< _channel_type_, traits >, KisDodgeHighlightsAdjustment< _channel_type_, traits >, KisDodgeMidtonesAdjustment< _channel_type_, traits >, KisDodgeShadowsAdjustment< _channel_type_, traits >, KisHSVAdjustment< _channel_type_, traits >, and KisHSVCurveAdjustment< _channel_type_, traits >.

Definition at line 20 of file KoColorTransformation.cpp.

{
    Q_UNUSED(name);
    qFatal("No parameter for this transformation");
    return -1;
}

parameters()

QList< QString > KoColorTransformation::parameters ( ) const

virtual

Returns

the list of parameters

Reimplemented in KoFallBackColorTransformation, KisBurnHighlightsAdjustment< _channel_type_, traits >, KisBurnMidtonesAdjustment< _channel_type_, traits >, KisBurnShadowsAdjustment< _channel_type_, traits >, KisColorBalanceAdjustment< _channel_type_, traits >, KisDesaturateAdjustment< _channel_type_, traits >, KisDodgeHighlightsAdjustment< _channel_type_, traits >, KisDodgeMidtonesAdjustment< _channel_type_, traits >, KisDodgeShadowsAdjustment< _channel_type_, traits >, KisHSVAdjustment< _channel_type_, traits >, and KisHSVCurveAdjustment< _channel_type_, traits >.

Definition at line 15 of file KoColorTransformation.cpp.

{
    return QList<QString>();
}

setParameter()

void KoColorTransformation::setParameter ( int id, const QVariant & parameter )

virtual

Update one parameter of a cached transformation object.

Reimplemented in KoFallBackColorTransformation, KisBurnHighlightsAdjustment< _channel_type_, traits >, KisBurnMidtonesAdjustment< _channel_type_, traits >, KisBurnShadowsAdjustment< _channel_type_, traits >, KisColorBalanceAdjustment< _channel_type_, traits >, KisDesaturateAdjustment< _channel_type_, traits >, KisDodgeHighlightsAdjustment< _channel_type_, traits >, KisDodgeMidtonesAdjustment< _channel_type_, traits >, KisDodgeShadowsAdjustment< _channel_type_, traits >, KisHSVAdjustment< _channel_type_, traits >, and KisHSVCurveAdjustment< _channel_type_, traits >.

Definition at line 27 of file KoColorTransformation.cpp.

{
    Q_UNUSED(id);
    Q_UNUSED(parameter);
    qFatal("No parameter for this transformation");
}

setParameters()

void KoColorTransformation::setParameters

(

const QHash< QString, QVariant > &

parameters

)

Definition at line 34 of file KoColorTransformation.cpp.

{
    for (QHash<QString, QVariant>::const_iterator it = parameters.begin(); it != parameters.end(); ++it) {
        setParameter( parameterId(it.key()), it.value());
    }
 
}

References parameterId(), parameters(), and setParameter().

transform()

virtual void KoColorTransformation::transform ( const quint8 * src, quint8 * dst, qint32 nPixels ) const

pure virtual

This function apply the transformation on a given number of pixels.

Parameters

src	a pointer to the source pixels
dst	a pointer to the destination pixels
nPixels	the number of pixels

This function may or may not be thread safe. You need to create one KoColorTransformation per thread.

Implemented in KoColorConversionFromAlphaTransformation< alpha_channel_type >, KoColorConversionAlphaToLab16Transformation< alpha_channel_type >, KoColorConversionGrayAFromAlphaTransformation< alpha_channel_type, gray_channel_type >, KoColorConversionToAlphaTransformation< alpha_channel_type >, KoColorConversionLab16ToAlphaTransformation< alpha_channel_type >, KoColorConversionGrayAToAlphaTransformation< gray_channel_type, alpha_channel_type >, KoCompositeColorTransformation, KoFallBackColorTransformation, KoU8InvertColorTransformer, KoU16InvertColorTransformer, KoF32InvertColorTransformer, KoF32GenInvertColorTransformer, KoLabDarkenColorTransformation< _lab_channels_type_ >, KoMultipleColorConversionTransformation, LcmsColorSpace< _CSTraits >::KoLcmsColorTransformation, ApplyRgbShaper< SrcCSTraits, DstCSTraits, Policy >, KisColorToFloatConvertor< _channel_type_, traits >, KisColorFromFloat< _channel_type_, traits >, KisColorFromGrayScaleFloat< _channel_type_, traits >, KisColorFromGrayScaleAlphaFloat< _channel_type_, traits >, KisASCCDLTransformation, KisIndexColorTransformation, KisNormalizeTransformation, KisPosterizeColorTransformation, KoColorConversionTransformation, KoSimpleColorConversionTransformation, KoLcmsColorConversionTransformation, KoLcmsColorProofingConversionTransformation, KoScaleColorConversionTransformation< _src_CSTraits_, _dst_CSTraits_ >, KoCopyColorConversionTransformation, KisBurnHighlightsAdjustment< _channel_type_, traits >, KisBurnMidtonesAdjustment< _channel_type_, traits >, KisBurnShadowsAdjustment< _channel_type_, traits >, KisColorBalanceAdjustment< _channel_type_, traits >, KisDesaturateAdjustment< _channel_type_, traits >, KisDodgeHighlightsAdjustment< _channel_type_, traits >, KisDodgeMidtonesAdjustment< _channel_type_, traits >, KisDodgeShadowsAdjustment< _channel_type_, traits >, KisHSVAdjustment< _channel_type_, traits >, and KisHSVCurveAdjustment< _channel_type_, traits >.

---

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

• libs/pigment/KoColorTransformation.h
• libs/pigment/KoColorTransformation.cpp