KisIndirectPaintingSupport Class Reference

#include <kis_indirect_painting_support.h>

Inheritance diagram for KisIndirectPaintingSupport:

Classes
struct	FinalMergeSuspender
struct	ReadLocker
struct	WriteLocker

Public Types
using	FinalMergeSuspenderSP = QSharedPointer<FinalMergeSuspender>

Public Member Functions
bool	hasTemporaryTarget () const
	KisIndirectPaintingSupport ()
void	mergeToLayer (KisNodeSP layer, KUndo2Command *parentCommand, const KUndo2MagicString &transactionText, int timedID)
virtual void	mergeToLayerThreaded (KisNodeSP layer, KUndo2Command *parentCommand, const KUndo2MagicString &transactionText, int timedID, QVector< KisRunnableStrokeJobData * > *jobs)
virtual void	setCurrentColor (const KoColor &color)
void	setTemporaryChannelFlags (const QBitArray &channelFlags)
void	setTemporaryCompositeOp (const QString &id)
void	setTemporaryOpacity (qreal o)
void	setTemporarySelection (KisSelectionSP selection)
void	setTemporaryTarget (KisPaintDeviceSP t)
void	setupTemporaryPainter (KisPainter *painter) const
virtual bool	supportsNonIndirectPainting () const
KisPaintDeviceSP	temporaryTarget () const
FinalMergeSuspenderSP	trySuspendFinalMerge ()
virtual	~KisIndirectPaintingSupport ()
Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Public Attributes
QBitArray	channelFlags
QString	compositeOp
qreal	compositeOpacity
bool	finalMergeInProgress = true
QReadWriteLock	lock
KisSelectionSP	selection
KisPaintDeviceSP	temporaryTarget
Public Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Protected Types
using	WriteLockerSP = QSharedPointer<WriteLocker>

Protected Member Functions
void	lockTemporaryTargetForWrite () const
void	mergeToLayerImpl (KisPaintDeviceSP dst, KUndo2Command *parentCommand, const KUndo2MagicString &transactionText, int timedID, bool cleanResources, WriteLockerSP sharedWriteLock, QVector< KisRunnableStrokeJobData * > *jobs)
void	releaseResources ()
QString	temporaryCompositeOp () const
virtual void	writeMergeData (KisPainter *painter, KisPaintDeviceSP src, const QRect &rc)

Private Member Functions
	KisIndirectPaintingSupport (const KisIndirectPaintingSupport &)
void	lockTemporaryTarget () const
KisIndirectPaintingSupport &	operator= (const KisIndirectPaintingSupport &)
KisSelectionSP	temporarySelection () const
void	unlockTemporaryTarget () const

Private Attributes
Private *const	d

Friends
class	KisPainterBasedStrokeStrategy

Detailed Description

For classes that support indirect painting.

XXX: Name doesn't suggest an object – is KisIndirectPaintingLayer a better name? (BSAR)

Definition at line 25 of file kis_indirect_painting_support.cpp.

Member Typedef Documentation

FinalMergeSuspenderSP

using KisIndirectPaintingSupport::FinalMergeSuspenderSP = QSharedPointer<FinalMergeSuspender>

Definition at line 94 of file kis_indirect_painting_support.h.

WriteLockerSP

using KisIndirectPaintingSupport::WriteLockerSP = QSharedPointer<WriteLocker>

protected

Definition at line 149 of file kis_indirect_painting_support.h.

Constructor & Destructor Documentation

KisIndirectPaintingSupport() [1/2]

KisIndirectPaintingSupport::KisIndirectPaintingSupport ( const KisIndirectPaintingSupport & )

private

KisIndirectPaintingSupport() [2/2]

KisIndirectPaintingSupport::KisIndirectPaintingSupport

(

)

Definition at line 38 of file kis_indirect_painting_support.cpp.

    : d(new Private)
{
}

~KisIndirectPaintingSupport()

KisIndirectPaintingSupport::~KisIndirectPaintingSupport ( )

virtual

Definition at line 43 of file kis_indirect_painting_support.cpp.

{
    delete d;
}

References d.

Member Function Documentation

hasTemporaryTarget()

bool KisIndirectPaintingSupport::hasTemporaryTarget

(

)

const

Definition at line 120 of file kis_indirect_painting_support.cpp.

{
    return d->temporaryTarget;
}

References d.

lockTemporaryTarget()

void KisIndirectPaintingSupport::lockTemporaryTarget ( ) const

private

Lock the temporary target. It should be done for guarding every access to temporaryTarget() or original() NOTE: well, not "every", but...

Definition at line 78 of file kis_indirect_painting_support.cpp.

{
    d->lock.lockForRead();
}

References d.

lockTemporaryTargetForWrite()

void KisIndirectPaintingSupport::lockTemporaryTargetForWrite ( ) const

protected

Definition at line 83 of file kis_indirect_painting_support.cpp.

{
    d->lock.lockForWrite();
    d->finalMergeInProgress = true;
}

References d.

mergeToLayer()

void KisIndirectPaintingSupport::mergeToLayer	(	KisNodeSP	layer,
		KUndo2Command *	parentCommand,
		const KUndo2MagicString &	transactionText,
		int	timedID )

Writes the temporary target into the paint device of the layer. This action will lock the temporary target itself.

When merging, we use barrier jobs only for ensuring that the merge jobs are not split by the update jobs. Merge jobs hold the shared lock, so forcing them out of CPU will basically cause a deadlock. When running in the fake executor, the jobs cannot be split anyway, so there is no danger in that.

Definition at line 133 of file kis_indirect_painting_support.cpp.

{
    QVector<KisRunnableStrokeJobData*> jobs;
    mergeToLayerThreaded(layer, parentCommand, transactionText, timedID, &jobs);
 
    KisFakeRunnableStrokeJobsExecutor executor(KisFakeRunnableStrokeJobsExecutor::AllowBarrierJobs);
    executor.addRunnableJobs(implicitCastList<KisRunnableStrokeJobDataBase*>(jobs));
}

References KisFakeRunnableStrokeJobsExecutor::addRunnableJobs(), KisFakeRunnableStrokeJobsExecutor::AllowBarrierJobs, and mergeToLayerThreaded().

mergeToLayerImpl()

void KisIndirectPaintingSupport::mergeToLayerImpl ( KisPaintDeviceSP dst, KUndo2Command * parentCommand, const KUndo2MagicString & transactionText, int timedID, bool cleanResources, WriteLockerSP sharedWriteLock, QVector< KisRunnableStrokeJobData * > * jobs )

protected

Move tool may not have an undo adapter

Brushes don't apply the selection, we apply that during the indirect painting merge operation. It is cheaper calculation-wise.

Definition at line 172 of file kis_indirect_painting_support.cpp.

{
    struct SharedState {
        QScopedPointer<KisTransaction> transaction;
    };
 
    QSharedPointer<SharedState> sharedState(new SharedState());
 
    KritaUtils::addJobSequential(*jobs,
        [sharedState, sharedWriteLock, dst, parentCommand, transactionText, timedID] () {
            Q_UNUSED(sharedWriteLock); // just a RAII holder object for the lock
 
             if (parentCommand) {
                 sharedState->transaction.reset(
                     new KisTransaction(transactionText, dst, parentCommand, timedID));
             }
        }
    );
 
    KisPaintDeviceSP src = d->temporaryTarget;
    Q_FOREACH (const QRect &rc, src->region().rects()) {
        KritaUtils::addJobConcurrent(*jobs,
            [this, rc, src, dst, sharedState, sharedWriteLock] () {
                Q_UNUSED(sharedWriteLock); // just a RAII holder object for the lock
 
                KisPainter gc(dst);
                setupTemporaryPainter(&gc);
                this->writeMergeData(&gc, src, rc);
            }
        );
    }
 
    KritaUtils::addJobSequential(*jobs,
        [this, sharedState, sharedWriteLock, cleanResources] () {
            Q_UNUSED(sharedWriteLock); // just a RAII holder object for the lock
 
            if (cleanResources) {
                releaseResources();
            }
 
            if (sharedState->transaction) {
                // the internal command is stored using
                // the link to the parent command
                (void) sharedState->transaction->endAndTake();
            }
        }
    );
}

References KritaUtils::addJobConcurrent(), KritaUtils::addJobSequential(), d, releaseResources(), setupTemporaryPainter(), void(), and writeMergeData().

mergeToLayerThreaded()

void KisIndirectPaintingSupport::mergeToLayerThreaded ( KisNodeSP layer, KUndo2Command * parentCommand, const KUndo2MagicString & transactionText, int timedID, QVector< KisRunnableStrokeJobData * > * jobs )

virtual

We create the lock in an unlocked state to avoid a deadlock, when layer-stack updating jobs push out the stroke jobs from the CPU and start sleeping on lockTemporaryTarget().

Now wait for all update jobs to finish and lock the indirect target

Reimplemented in KisColorizeMask.

Definition at line 149 of file kis_indirect_painting_support.cpp.

{
    WriteLockerSP sharedWriteLock(new WriteLocker(this, std::defer_lock));
 
    KritaUtils::addJobBarrier(*jobs,
        [sharedWriteLock] () {
            sharedWriteLock->relock();
        });
 
    mergeToLayerImpl(layer->paintDevice(), parentCommand, transactionText,
                     timedID, true, sharedWriteLock,
                     jobs);
}

References KritaUtils::addJobBarrier(), mergeToLayerImpl(), and KisBaseNode::paintDevice().

operator=()

KisIndirectPaintingSupport & KisIndirectPaintingSupport::operator= ( const KisIndirectPaintingSupport & )

private

releaseResources()

void KisIndirectPaintingSupport::releaseResources ( )

protected

Definition at line 235 of file kis_indirect_painting_support.cpp.

{
    d->temporaryTarget = 0;
    d->selection = 0;
    d->compositeOp = COMPOSITE_OVER;
    d->compositeOpacity = OPACITY_OPAQUE_F;
    d->channelFlags.clear();
}

References COMPOSITE_OVER, d, and OPACITY_OPAQUE_F.

setCurrentColor()

void KisIndirectPaintingSupport::setCurrentColor ( const KoColor & color )

virtual

Reimplemented in KisColorizeMask.

Definition at line 48 of file kis_indirect_painting_support.cpp.

{
    Q_UNUSED(color);
}

setTemporaryChannelFlags()

void KisIndirectPaintingSupport::setTemporaryChannelFlags

(

const QBitArray &

channelFlags

)

Definition at line 68 of file kis_indirect_painting_support.cpp.

{
    d->channelFlags = channelFlags;
}

References channelFlags, and d.

setTemporaryCompositeOp()

void KisIndirectPaintingSupport::setTemporaryCompositeOp

(

const QString &

id

)

Definition at line 58 of file kis_indirect_painting_support.cpp.

{
    d->compositeOp = id;
}

References d.

setTemporaryOpacity()

void KisIndirectPaintingSupport::setTemporaryOpacity

(

qreal

o

)

Definition at line 63 of file kis_indirect_painting_support.cpp.

{
    d->compositeOpacity = o;
}

References d.

setTemporarySelection()

void KisIndirectPaintingSupport::setTemporarySelection

(

KisSelectionSP

selection

)

Definition at line 73 of file kis_indirect_painting_support.cpp.

{
    d->selection = selection;
}

References d, and selection.

setTemporaryTarget()

void KisIndirectPaintingSupport::setTemporaryTarget

(

KisPaintDeviceSP

t

)

Definition at line 53 of file kis_indirect_painting_support.cpp.

{
    d->temporaryTarget = t;
}

References d.

setupTemporaryPainter()

void KisIndirectPaintingSupport::setupTemporaryPainter

(

KisPainter *

painter

)

const

Configures the painter to conform the painting parameters stored for th temporary target, such as compositeOp, opacity, channel flags and selection. Please do not setup them manually, but use this function instead.

Definition at line 125 of file kis_indirect_painting_support.cpp.

{
     painter->setOpacityF(d->compositeOpacity);
     painter->setCompositeOpId(d->compositeOp);
     painter->setChannelFlags(d->channelFlags);
     painter->setSelection(d->selection);
}

References d, KisPainter::setChannelFlags(), KisPainter::setCompositeOpId(), KisPainter::setOpacityF(), and KisPainter::setSelection().

supportsNonIndirectPainting()

bool KisIndirectPaintingSupport::supportsNonIndirectPainting ( ) const

virtual

Reimplemented in KisColorizeMask.

Definition at line 100 of file kis_indirect_painting_support.cpp.

{
    return true;
}

temporaryCompositeOp()

QString KisIndirectPaintingSupport::temporaryCompositeOp ( ) const

protected

Definition at line 110 of file kis_indirect_painting_support.cpp.

{
    return d->compositeOp;
}

References d.

temporarySelection()

KisSelectionSP KisIndirectPaintingSupport::temporarySelection ( ) const

private

Only for debugging purposes. Please use setupTemporaryPainter() instead.

Definition at line 115 of file kis_indirect_painting_support.cpp.

{
    return d->selection;
}

References d.

temporaryTarget()

KisPaintDeviceSP KisIndirectPaintingSupport::temporaryTarget

(

)

const

trySuspendFinalMerge()

KisIndirectPaintingSupport::FinalMergeSuspenderSP KisIndirectPaintingSupport::trySuspendFinalMerge

(

)

When the stroke uses multithreaded final merge and supports suspension, then it should also suspend the final merge explicitly by requesting a special RAII object for the whole period of suspension.

Definition at line 105 of file kis_indirect_painting_support.cpp.

{
    return toQShared(d->finalMergeInProgress ? new FinalMergeSuspender(this) : nullptr);
}

References d, and toQShared().

unlockTemporaryTarget()

void KisIndirectPaintingSupport::unlockTemporaryTarget ( ) const

private

Unlock the temporary target

See also

lockTemporaryTarget()

Definition at line 89 of file kis_indirect_painting_support.cpp.

{
    d->lock.unlock();
    d->finalMergeInProgress = false;
}

References d.

writeMergeData()

void KisIndirectPaintingSupport::writeMergeData ( KisPainter * painter, KisPaintDeviceSP src, const QRect & rc )

protectedvirtual

Reimplemented in KisColorizeMask.

Definition at line 230 of file kis_indirect_painting_support.cpp.

{
    painter->bitBlt(rc.topLeft(), src, rc);
}

References KisPainter::bitBlt().

Friends And Related Symbol Documentation

KisPainterBasedStrokeStrategy

friend class KisPainterBasedStrokeStrategy

friend

Definition at line 175 of file kis_indirect_painting_support.h.

Member Data Documentation

channelFlags

QBitArray KisIndirectPaintingSupport::channelFlags

Definition at line 30 of file kis_indirect_painting_support.cpp.

compositeOp

QString KisIndirectPaintingSupport::compositeOp

Definition at line 28 of file kis_indirect_painting_support.cpp.

compositeOpacity

qreal KisIndirectPaintingSupport::compositeOpacity

Definition at line 29 of file kis_indirect_painting_support.cpp.

d

Private* const KisIndirectPaintingSupport::d

private

Definition at line 185 of file kis_indirect_painting_support.h.

finalMergeInProgress

bool KisIndirectPaintingSupport::finalMergeInProgress = true

Definition at line 34 of file kis_indirect_painting_support.cpp.

lock

QReadWriteLock KisIndirectPaintingSupport::lock

Definition at line 33 of file kis_indirect_painting_support.cpp.

selection

KisSelectionSP KisIndirectPaintingSupport::selection

Definition at line 31 of file kis_indirect_painting_support.cpp.

temporaryTarget

KisPaintDeviceSP KisIndirectPaintingSupport::temporaryTarget

Definition at line 27 of file kis_indirect_painting_support.cpp.

---

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

• libs/image/kis_indirect_painting_support.cpp
• libs/image/kis_indirect_painting_support.h