KisPaintDeviceCache Class Reference

#include <kis_paint_device_cache.h>

Classes
struct	ExactBoundsCache
struct	NonDefaultPixelCache
struct	RegionCache

Public Member Functions
QImage	createThumbnail (qint32 w, qint32 h, KisThumbnailBoundsMode boundsMode, qreal oversample, KoColorConversionTransformation::Intent renderingIntent, KoColorConversionTransformation::ConversionFlags conversionFlags)
QRect	exactBounds ()
QRect	exactBoundsAmortized ()
void	invalidate ()
	KisPaintDeviceCache (const KisPaintDeviceCache &rhs)
	KisPaintDeviceCache (KisPaintDevice *paintDevice)
QRect	nonDefaultPixelArea ()
KisRegion	region ()
int	sequenceNumber () const
void	setupCache ()

Private Attributes
ExactBoundsCache	m_exactBoundsCache
NonDefaultPixelCache	m_nonDefaultPixelAreaCache
KisPaintDevice *	m_paintDevice {nullptr}
RegionCache	m_regionCache
QAtomicInt	m_sequenceNumber
QHash< ThumbnailCacheKey, QImage >	m_thumbnails
QReadWriteLock	m_thumbnailsLock
bool	m_thumbnailsValid {false}

Detailed Description

Definition at line 31 of file kis_paint_device_cache.h.

Constructor & Destructor Documentation

KisPaintDeviceCache() [1/2]

KisPaintDeviceCache::KisPaintDeviceCache ( KisPaintDevice * paintDevice )

inline

Definition at line 34 of file kis_paint_device_cache.h.

        : m_paintDevice(paintDevice),
          m_exactBoundsCache(paintDevice),
          m_nonDefaultPixelAreaCache(paintDevice),
          m_regionCache(paintDevice),
          m_sequenceNumber(0)
    {
    }

KisPaintDeviceCache() [2/2]

KisPaintDeviceCache::KisPaintDeviceCache ( const KisPaintDeviceCache & rhs )

inline

Definition at line 43 of file kis_paint_device_cache.h.

        : m_paintDevice(rhs.m_paintDevice),
          m_exactBoundsCache(rhs.m_paintDevice),
          m_nonDefaultPixelAreaCache(rhs.m_paintDevice),
          m_regionCache(rhs.m_paintDevice),
          m_sequenceNumber(0)
    {
    }

Member Function Documentation

createThumbnail()

QImage KisPaintDeviceCache::createThumbnail ( qint32 w, qint32 h, KisThumbnailBoundsMode boundsMode, qreal oversample, KoColorConversionTransformation::Intent renderingIntent, KoColorConversionTransformation::ConversionFlags conversionFlags )

inline

Definition at line 93 of file kis_paint_device_cache.h.

                                                                                                                                                                                                                           {
        QImage thumbnail;
 
        if (h == 0 || w == 0) {
            return thumbnail;
        }
 
        auto key = std::make_tuple(QSize(w, h), oversample, boundsMode);
 
        {
            QReadLocker readLocker(&m_thumbnailsLock);
            if (m_thumbnailsValid) {
                if (m_thumbnails.contains(key)) {
                    thumbnail = m_thumbnails[key];
                }
            }
            else {
                readLocker.unlock();
                QWriteLocker writeLocker(&m_thumbnailsLock);
                m_thumbnails.clear();
                m_thumbnailsValid = true;
            }
        }
 
        if (thumbnail.isNull()) {
            const QRect bounds = boundsMode == KisThumbnailBoundsMode::Precise ? m_paintDevice->exactBounds() : m_paintDevice->extent();
            thumbnail = m_paintDevice->createThumbnailUncached(w, h, bounds, oversample, renderingIntent, conversionFlags);
 
            QWriteLocker writeLocker(&m_thumbnailsLock);
            m_thumbnails[key] = thumbnail;
            m_thumbnailsValid = true;
        }
 
        return thumbnail;
    }

References bounds, KisPaintDevice::createThumbnailUncached(), KisPaintDevice::exactBounds(), KisPaintDevice::extent(), m_paintDevice, m_thumbnails, m_thumbnailsLock, m_thumbnailsValid, oversample, and Precise.

exactBounds()

QRect KisPaintDeviceCache::exactBounds ( )

inline

Definition at line 64 of file kis_paint_device_cache.h.

                        {
        return m_exactBoundsCache.getValue(m_paintDevice->defaultBounds()->wrapAroundMode());
    }

References KisPaintDevice::defaultBounds(), KisLockFreeCacheWithModeConsistency< T, Mode >::getValue(), m_exactBoundsCache, m_paintDevice, and KisDefaultBoundsBase::wrapAroundMode().

exactBoundsAmortized()

QRect KisPaintDeviceCache::exactBoundsAmortized ( )

inline

The calculation of the exact bounds might be too slow in some special cases, e.g. for an empty canvas of 7k by 6k. So we just always return extent, when the exact bounds is not available.

Definition at line 68 of file kis_paint_device_cache.h.

                                 {
        QRect bounds;
        bool result = m_exactBoundsCache.tryGetValue(bounds, m_paintDevice->defaultBounds()->wrapAroundMode());
 
        if (!result) {
            bounds = m_paintDevice->extent();
        }
 
        return bounds;
    }

References bounds, KisPaintDevice::defaultBounds(), KisPaintDevice::extent(), m_exactBoundsCache, m_paintDevice, KisLockFreeCacheWithModeConsistency< T, Mode >::tryGetValue(), and KisDefaultBoundsBase::wrapAroundMode().

invalidate()

void KisPaintDeviceCache::invalidate ( )

inline

Definition at line 56 of file kis_paint_device_cache.h.

                      {
        m_thumbnailsValid = false;
        m_exactBoundsCache.invalidate();
        m_nonDefaultPixelAreaCache.invalidate();
        m_regionCache.invalidate();
        m_sequenceNumber++;
    }

References KisLockFreeCacheWithModeConsistency< T, Mode >::invalidate(), m_exactBoundsCache, m_nonDefaultPixelAreaCache, m_regionCache, m_sequenceNumber, and m_thumbnailsValid.

nonDefaultPixelArea()

QRect KisPaintDeviceCache::nonDefaultPixelArea ( )

inline

Definition at line 85 of file kis_paint_device_cache.h.

                                {
        return m_nonDefaultPixelAreaCache.getValue(m_paintDevice->defaultBounds()->wrapAroundMode());
    }

References KisPaintDevice::defaultBounds(), KisLockFreeCacheWithModeConsistency< T, Mode >::getValue(), m_nonDefaultPixelAreaCache, m_paintDevice, and KisDefaultBoundsBase::wrapAroundMode().

region()

KisRegion KisPaintDeviceCache::region ( )

inline

Definition at line 89 of file kis_paint_device_cache.h.

                       {
        return m_regionCache.getValue(m_paintDevice->defaultBounds()->wrapAroundMode());
    }

References KisPaintDevice::defaultBounds(), KisLockFreeCacheWithModeConsistency< T, Mode >::getValue(), m_paintDevice, m_regionCache, and KisDefaultBoundsBase::wrapAroundMode().

sequenceNumber()

int KisPaintDeviceCache::sequenceNumber ( ) const

inline

Definition at line 129 of file kis_paint_device_cache.h.

                               {
        return m_sequenceNumber;
    }

References m_sequenceNumber.

setupCache()

void KisPaintDeviceCache::setupCache ( )

inline

Definition at line 52 of file kis_paint_device_cache.h.

                      {
        invalidate();
    }

References invalidate().

Member Data Documentation

m_exactBoundsCache

ExactBoundsCache KisPaintDeviceCache::m_exactBoundsCache

private

Definition at line 166 of file kis_paint_device_cache.h.

m_nonDefaultPixelAreaCache

NonDefaultPixelCache KisPaintDeviceCache::m_nonDefaultPixelAreaCache

private

Definition at line 167 of file kis_paint_device_cache.h.

m_paintDevice

KisPaintDevice* KisPaintDeviceCache::m_paintDevice {nullptr}

private

Definition at line 134 of file kis_paint_device_cache.h.

{nullptr};

m_regionCache

RegionCache KisPaintDeviceCache::m_regionCache

private

Definition at line 168 of file kis_paint_device_cache.h.

m_sequenceNumber

QAtomicInt KisPaintDeviceCache::m_sequenceNumber

private

Definition at line 175 of file kis_paint_device_cache.h.

m_thumbnails

QHash<ThumbnailCacheKey, QImage> KisPaintDeviceCache::m_thumbnails

private

Definition at line 173 of file kis_paint_device_cache.h.

m_thumbnailsLock

QReadWriteLock KisPaintDeviceCache::m_thumbnailsLock

private

Definition at line 170 of file kis_paint_device_cache.h.

m_thumbnailsValid

bool KisPaintDeviceCache::m_thumbnailsValid {false}

private

Definition at line 171 of file kis_paint_device_cache.h.

{false};

---

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

• libs/image/kis_paint_device_cache.h