KisImageConfig Class Reference

#include <kis_image_config.h>

Public Member Functions
QString	animationCacheDir (bool defaultValue=false) const
int	animationCacheFrameSizeLimit (bool defaultValue=false) const
qreal	animationCacheRegionOfInterestMargin (bool defaultValue=false) const
bool	autoKeyEnabled (bool requestDefault=false) const
bool	autoKeyModeDuplicate (bool requestDefault=false) const
int	defaultFrameColorLabel () const
KisProofingConfigurationSP	defaultProofingconfiguration (bool requestDefault=false)
bool	detectFpsLimit (bool defaultValue=false) const
bool	enablePerfLog (bool requestDefault=false) const
bool	enableProgressReporting (bool requestDefault=false) const
KisPropertiesConfigurationSP	exportConfiguration (const QString &exportConfigId, bool defaultValue=false) const
QString	exportConfigurationXML (const QString &exportConfigId, bool defaultValue=false) const
int	fpsLimit (bool defaultValue=false) const
int	frameRenderingClones (bool defaultValue=false) const
int	frameRenderingTimeout (bool defaultValue=false) const
bool	hasExportConfiguration (const QString &exportConfigID)
	KisImageConfig (bool readOnly)
int	maxBrushSize (bool defaultValue=false) const
qreal	maxCollectAlpha () const
int	maxMaskingBrushSize () const
qreal	maxMergeAlpha () const
qreal	maxMergeCollectAlpha () const
int	maxNumberOfThreads (bool defaultValue=false) const
int	maxSwapSize (bool requestDefault=false) const
qreal	memoryHardLimitPercent (bool requestDefault=false) const
qreal	memoryPoolLimitPercent (bool requestDefault=false) const
qreal	memorySoftLimitPercent (bool requestDefault=false) const
int	numberOfOnionSkins () const
int	onionSkinOpacity (int offset, bool requestDefault=false) const
bool	onionSkinState (int offset) const
QColor	onionSkinTintColorBackward () const
QColor	onionSkinTintColorForward () const
int	onionSkinTintFactor () const
int	poolLimit () const
template<class T >
T	readEntry (const QString &name, const T &defaultValue=T())
template<class T >
QList< T >	readList (const QString &name, const QList< T > &defaultValue=QList< T >())
bool	renameDuplicatedLayers (bool defaultValue=false) const
bool	renameMergedLayers (bool defaultValue=false) const
qreal	schedulerBalancingRatio () const
qreal	selectionOutlineOpacity (bool defaultValue=false) const
QColor	selectionOverlayMaskColor (bool defaultValue=false) const
void	setAnimationCacheDir (const QString &value)
void	setAnimationCacheFrameSizeLimit (int value)
void	setAnimationCacheRegionOfInterestMargin (qreal value)
void	setAutoKeyEnabled (bool value)
void	setAutoKeyModeDuplicate (bool value)
void	setDefaultFrameColorLabel (int label)
void	setDefaultProofingConfig (const KisProofingConfiguration &config)
void	setDetectFpsLimit (bool value)
void	setEnablePerfLog (bool value)
void	setEnableProgressReporting (bool value)
void	setExportConfiguration (const QString &exportConfigId, KisPropertiesConfigurationSP properties)
void	setFpsLimit (int value)
void	setFrameRenderingClones (int value)
void	setFrameRenderingTimeout (int value)
void	setMaxBrushSize (int value)
void	setMaxNumberOfThreads (int value)
void	setMaxSwapSize (int value)
void	setMemoryHardLimitPercent (qreal value)
void	setMemoryPoolLimitPercent (qreal value)
void	setMemorySoftLimitPercent (qreal value)
void	setNumberOfOnionSkins (int value)
void	setOnionSkinOpacity (int offset, int value)
void	setOnionSkinState (int offset, bool value)
void	setOnionSkinTintColorBackward (const QColor &value)
void	setOnionSkinTintColorForward (const QColor &value)
void	setOnionSkinTintFactor (int value)
void	setRenameDuplicatedLayers (bool value)
void	setRenameMergedLayers (bool value)
void	setSchedulerBalancingRatio (qreal value)
void	setSelectionOutlineOpacity (qreal value)
void	setSelectionOverlayMaskColor (const QColor &color)
void	setShowAdditionalOnionSkinsSettings (bool value)
void	setSwapDir (const QString &swapDir)
void	setSwapSlabSize (int value)
void	setSwapWindowSize (int value)
void	setUpdatePatchHeight (int value)
void	setUpdatePatchWidth (int value)
void	setUseAnimationCacheFrameSizeLimit (bool value)
void	setUseAnimationCacheRegionOfInterest (bool value)
void	setUseLodForColorizeMask (bool value)
void	setUseOnDiskAnimationCacheSwapping (bool value)
bool	showAdditionalOnionSkinsSettings (bool requestDefault=false) const
QString	swapDir (bool requestDefault=false)
int	swapSlabSize () const
int	swapWindowSize () const
int	tilesHardLimit () const
int	tilesSoftLimit () const
qreal	transformMaskOffBoundsReadArea () const
int	updatePatchHeight () const
int	updatePatchWidth () const
bool	useAnimationCacheFrameSizeLimit (bool defaultValue=false) const
bool	useAnimationCacheRegionOfInterest (bool defaultValue=false) const
bool	useLodForColorizeMask (bool requestDefault=false) const
bool	useOnDiskAnimationCacheSwapping (bool defaultValue=false) const
template<class T >
void	writeEntry (const QString &name, const T &value)
template<class T >
void	writeList (const QString &name, const QList< T > &value)
	~KisImageConfig ()

Static Public Member Functions
static void	resetConfig ()
static int	totalRAM ()

Private Member Functions
QString	safelyGetWritableTempLocation (const QString &suffix, const QString &configKey, bool requestDefault) const

Private Attributes
KConfigGroup	m_config
bool	m_readOnly

Detailed Description

Definition at line 15 of file kis_image_config.h.

Constructor & Destructor Documentation

KisImageConfig()

KisImageConfig::KisImageConfig

(

bool

readOnly

)

Definition at line 34 of file kis_image_config.cpp.

    : m_config(KSharedConfig::openConfig()->group(QString()))
    , m_readOnly(readOnly)
{
    if (!readOnly) {
        KIS_SAFE_ASSERT_RECOVER_RETURN(qApp->thread() == QThread::currentThread());
    }
#ifdef Q_OS_MACOS
    // clear /var/folders/ swap path set by old broken Krita swap implementation in order to use new default swap dir.
    QString swap = m_config.readEntry("swaplocation", "");
    if (swap.startsWith("/var/folders/")) {
        m_config.deleteEntry("swaplocation");
    }
#endif
}

References KIS_SAFE_ASSERT_RECOVER_RETURN, and m_config.

~KisImageConfig()

KisImageConfig::~KisImageConfig

(

)

Definition at line 50 of file kis_image_config.cpp.

{
    if (m_readOnly) return;
 
    if (qApp->thread() != QThread::currentThread()) {
        dbgKrita << "KisImageConfig: requested config synchronization from nonGUI thread! Called from" << kisBacktrace();
        return;
    }
 
    m_config.sync();
}

References dbgKrita, kisBacktrace(), m_config, and m_readOnly.

Member Function Documentation

animationCacheDir()

QString KisImageConfig::animationCacheDir

(

bool

defaultValue = false

)

const

Definition at line 637 of file kis_image_config.cpp.

{
    return safelyGetWritableTempLocation("animation_cache", "animationCacheDir", defaultValue);
}

References safelyGetWritableTempLocation().

animationCacheFrameSizeLimit()

int KisImageConfig::animationCacheFrameSizeLimit

(

bool

defaultValue = false

)

const

Definition at line 657 of file kis_image_config.cpp.

{
    return defaultValue ? 2500 : m_config.readEntry("animationCacheFrameSizeLimit", 2500);
}

References m_config.

animationCacheRegionOfInterestMargin()

qreal KisImageConfig::animationCacheRegionOfInterestMargin

(

bool

defaultValue = false

)

const

Definition at line 677 of file kis_image_config.cpp.

{
    return defaultValue ? 0.25 : m_config.readEntry("animationCacheRegionOfInterestMargin", 0.25);
}

References m_config.

autoKeyEnabled()

bool KisImageConfig::autoKeyEnabled

(

bool

requestDefault = false

)

const

Definition at line 390 of file kis_image_config.cpp.

{
    return !requestDefault ?
        m_config.readEntry("lazyFrameCreationEnabled", true) : true;
}

References m_config.

autoKeyModeDuplicate()

bool KisImageConfig::autoKeyModeDuplicate

(

bool

requestDefault = false

)

const

Definition at line 401 of file kis_image_config.cpp.

{
    return !requestDefault ?
        m_config.readEntry("lazyFrameModeDuplicate", true) : true;
}

References m_config.

defaultFrameColorLabel()

int KisImageConfig::defaultFrameColorLabel

(

)

const

Definition at line 505 of file kis_image_config.cpp.

{
    return m_config.readEntry("defaultFrameColorLabel", 0);
}

References m_config.

defaultProofingconfiguration()

KisProofingConfigurationSP KisImageConfig::defaultProofingconfiguration

(

bool

requestDefault = false

)

Definition at line 515 of file kis_image_config.cpp.

{
    KisProofingConfiguration *proofingConfig= new KisProofingConfiguration();
    if (!requestDefault) {
        proofingConfig->proofingProfile = m_config.readEntry("defaultProofingProfileName", "Chemical proof");
        proofingConfig->proofingModel = m_config.readEntry("defaultProofingProfileModel", "CMYKA");
        proofingConfig->proofingDepth = m_config.readEntry("defaultProofingProfileDepth", "U8");
        proofingConfig->displayIntent = KoColorConversionTransformation::Intent(m_config.readEntry("defaultProofingProfileIntent", int(INTENT_ABSOLUTE_COLORIMETRIC)));
        proofingConfig->conversionIntent = KoColorConversionTransformation::Intent(m_config.readEntry("defaultProofingConversionIntent", int(INTENT_RELATIVE_COLORIMETRIC)));
        proofingConfig->useBlackPointCompensationFirstTransform = m_config.readEntry("defaultProofingBlackpointCompensation", true);
 
        proofingConfig->displayFlags.setFlag(KoColorConversionTransformation::BlackpointCompensation, m_config.readEntry("defaultProofingDisplayBlackpointCompensation", true));
        proofingConfig->displayMode = KisProofingConfiguration::DisplayTransformState(m_config.readEntry("defaultProofingDisplayMode", int(KisProofingConfiguration::Paper)));
        QColor def(Qt::green);
        def = m_config.readEntry("defaultProofingGamutwarning", def);
        KoColor col(KoColorSpaceRegistry::instance()->rgb8());
        col.fromQColor(def);
        col.setOpacity(1.0);
        proofingConfig->warningColor = col;
        proofingConfig->setLegacyAdaptationState(m_config.readEntry("defaultProofingAdaptationState", 1.0));
    }
    return toQShared(proofingConfig);
}

References KoColorConversionTransformation::BlackpointCompensation, KisProofingConfiguration::conversionIntent, KisProofingConfiguration::displayFlags, KisProofingConfiguration::displayIntent, KisProofingConfiguration::displayMode, KoColor::fromQColor(), KoColorSpaceRegistry::instance(), INTENT_ABSOLUTE_COLORIMETRIC, INTENT_RELATIVE_COLORIMETRIC, m_config, KisProofingConfiguration::Paper, KisProofingConfiguration::proofingDepth, KisProofingConfiguration::proofingModel, KisProofingConfiguration::proofingProfile, KisProofingConfiguration::setLegacyAdaptationState(), KoColor::setOpacity(), toQShared(), KisProofingConfiguration::useBlackPointCompensationFirstTransform, and KisProofingConfiguration::warningColor.

detectFpsLimit()

bool KisImageConfig::detectFpsLimit

(

bool

defaultValue = false

)

const

Definition at line 617 of file kis_image_config.cpp.

{
    return defaultValue ? true : m_config.readEntry("detectFpsLimit", true);
}

References m_config.

enablePerfLog()

bool KisImageConfig::enablePerfLog

(

bool

requestDefault = false

)

const

Definition at line 73 of file kis_image_config.cpp.

{
    return !requestDefault ?
        m_config.readEntry("enablePerfLog", false) :false;
}

References m_config.

enableProgressReporting()

bool KisImageConfig::enableProgressReporting

(

bool

requestDefault = false

)

const

Definition at line 62 of file kis_image_config.cpp.

{
    return !requestDefault ?
        m_config.readEntry("enableProgressReporting", true) : true;
}

References m_config.

exportConfiguration()

KisPropertiesConfigurationSP KisImageConfig::exportConfiguration	(	const QString &	exportConfigId,
		bool	defaultValue = false ) const

Definition at line 753 of file kis_image_config.cpp.

{
    KisPropertiesConfigurationSP cfg = new KisPropertiesConfiguration();
    const QString xmlData = exportConfigurationXML(exportConfigId, defaultValue);
    cfg->fromXML(xmlData);
    return cfg;
}

References exportConfigurationXML().

exportConfigurationXML()

QString KisImageConfig::exportConfigurationXML	(	const QString &	exportConfigId,
		bool	defaultValue = false ) const

Definition at line 743 of file kis_image_config.cpp.

{
    return (defaultValue ? QString() : m_config.readEntry("ExportConfiguration-" + exportConfigId, QString()));
}

References m_config.

fpsLimit()

int KisImageConfig::fpsLimit

(

bool

defaultValue = false

)

const

Definition at line 606 of file kis_image_config.cpp.

{
    int limit = defaultValue ? 100 : m_config.readEntry("fpsLimit", 100);
    return limit > 0 ? limit : 1;
}

References m_config.

frameRenderingClones()

int KisImageConfig::frameRenderingClones

(

bool

defaultValue = false

)

const

Definition at line 584 of file kis_image_config.cpp.

{
    const int defaultClonesCount = qMax(1, maxNumberOfThreads(defaultValue) / 2);
    return defaultValue ? defaultClonesCount : m_config.readEntry("frameRenderingClones", defaultClonesCount);
}

References m_config, and maxNumberOfThreads().

frameRenderingTimeout()

int KisImageConfig::frameRenderingTimeout

(

bool

defaultValue = false

)

const

Definition at line 595 of file kis_image_config.cpp.

{
    const int defaultFrameRenderingTimeout = 30000; // 30 ms
    return defaultValue ? defaultFrameRenderingTimeout : m_config.readEntry("frameRenderingTimeout", defaultFrameRenderingTimeout);
}

References m_config.

hasExportConfiguration()

bool KisImageConfig::hasExportConfiguration

(

const QString &

exportConfigID

)

Definition at line 748 of file kis_image_config.cpp.

{
    return m_config.hasKey("ExportConfiguration-" + exportConfigID);
}

References m_config.

maxBrushSize()

int KisImageConfig::maxBrushSize

(

bool

defaultValue = false

)

const

Definition at line 708 of file kis_image_config.cpp.

{
    return !defaultValue ? m_config.readEntry("maximumBrushSize", 1000) : 1000;
}

References m_config.

maxCollectAlpha()

qreal KisImageConfig::maxCollectAlpha

(

)

const

Definition at line 113 of file kis_image_config.cpp.

{
    return m_config.readEntry("maxCollectAlpha", 2.5);
}

References m_config.

maxMaskingBrushSize()

int KisImageConfig::maxMaskingBrushSize

(

)

const

Definition at line 718 of file kis_image_config.cpp.

{
    return qMin(15000, 3 * maxBrushSize());
}

References maxBrushSize().

maxMergeAlpha()

qreal KisImageConfig::maxMergeAlpha

(

)

const

Definition at line 118 of file kis_image_config.cpp.

{
    return m_config.readEntry("maxMergeAlpha", 1.);
}

References m_config.

maxMergeCollectAlpha()

qreal KisImageConfig::maxMergeCollectAlpha

(

)

const

Definition at line 123 of file kis_image_config.cpp.

{
    return m_config.readEntry("maxMergeCollectAlpha", 1.5);
}

References m_config.

maxNumberOfThreads()

int KisImageConfig::maxNumberOfThreads

(

bool

defaultValue = false

)

const

Definition at line 570 of file kis_image_config.cpp.

{
    return (defaultValue ? QThread::idealThreadCount() : m_config.readEntry("maxNumberOfThreads", QThread::idealThreadCount()));
}

References m_config.

maxSwapSize()

int KisImageConfig::maxSwapSize

(

bool

requestDefault = false

)

const

Definition at line 141 of file kis_image_config.cpp.

{
    return !requestDefault ?
        m_config.readEntry("maxSwapSize", 4096) : 4096; // in MiB
}

References m_config.

memoryHardLimitPercent()

qreal KisImageConfig::memoryHardLimitPercent

(

bool

requestDefault = false

)

const

Definition at line 195 of file kis_image_config.cpp.

{
    return !requestDefault ?
        m_config.readEntry("memoryHardLimitPercent", 50.) : 50.;
}

References m_config.

memoryPoolLimitPercent()

qreal KisImageConfig::memoryPoolLimitPercent

(

bool

requestDefault = false

)

const

Definition at line 217 of file kis_image_config.cpp.

{
    return !requestDefault ?
        m_config.readEntry("memoryPoolLimitPercent", 0.0) : 0.0;
}

References m_config.

memorySoftLimitPercent()

qreal KisImageConfig::memorySoftLimitPercent

(

bool

requestDefault = false

)

const

Definition at line 206 of file kis_image_config.cpp.

{
    return !requestDefault ?
        m_config.readEntry("memorySoftLimitPercent", 2.) : 2.;
}

References m_config.

numberOfOnionSkins()

int KisImageConfig::numberOfOnionSkins

(

)

const

Definition at line 319 of file kis_image_config.cpp.

{
    return m_config.readEntry("numberOfOnionSkins", 10);
}

References m_config.

onionSkinOpacity()

int KisImageConfig::onionSkinOpacity	(	int	offset,
		bool	requestDefault = false ) const

Definition at line 339 of file kis_image_config.cpp.

{
    int value = m_config.readEntry("onionSkinOpacity_" + QString::number(offset), -1);
 
    if (value < 0 || requestDefault) {
        const int num = numberOfOnionSkins();
        if (num > 0) {
            const qreal dx = qreal(qAbs(offset)) / num;
            value = 0.7 * exp(-pow2(dx) / 0.5) * 255;
        }
    }
 
    return value;
}

References m_config, numberOfOnionSkins(), pow2(), and value().

onionSkinState()

bool KisImageConfig::onionSkinState

(

int

offset

)

const

Definition at line 359 of file kis_image_config.cpp.

{
    bool enableByDefault = (qAbs(offset) <= 2);
    return m_config.readEntry("onionSkinState_" + QString::number(offset), enableByDefault);
}

References m_config.

onionSkinTintColorBackward()

QColor KisImageConfig::onionSkinTintColorBackward

(

)

const

Definition at line 370 of file kis_image_config.cpp.

{
    return m_config.readEntry("onionSkinTintColorBackward", QColor(Qt::red));
}

References m_config.

onionSkinTintColorForward()

QColor KisImageConfig::onionSkinTintColorForward

(

)

const

Definition at line 380 of file kis_image_config.cpp.

{
    return m_config.readEntry("oninSkinTintColorForward", QColor(Qt::green));
}

References m_config.

onionSkinTintFactor()

int KisImageConfig::onionSkinTintFactor

(

)

const

Definition at line 329 of file kis_image_config.cpp.

{
    return m_config.readEntry("onionSkinTintFactor", 192);
}

References m_config.

poolLimit()

int KisImageConfig::poolLimit

(

)

const

Definition at line 187 of file kis_image_config.cpp.

{
    qreal hp = qreal(memoryHardLimitPercent()) / 100.0;
    qreal pp = qreal(memoryPoolLimitPercent()) / 100.0;
 
    return totalRAM() * hp * pp;
}

References memoryHardLimitPercent(), memoryPoolLimitPercent(), and totalRAM().

readEntry()

template<class T >

T KisImageConfig::readEntry ( const QString & name, const T & defaultValue = T() )

inline

Definition at line 165 of file kis_image_config.h.

                                                                {
        return m_config.readEntry(name, defaultValue);
    }

readList()

template<class T >

QList< T > KisImageConfig::readList ( const QString & name, const QList< T > & defaultValue = QList<T>() )

inline

Definition at line 170 of file kis_image_config.h.

                                                                                    {
        return m_config.readEntry(name, defaultValue);
    }

renameDuplicatedLayers()

bool KisImageConfig::renameDuplicatedLayers

(

bool

defaultValue = false

)

const

Definition at line 733 of file kis_image_config.cpp.

{
    return defaultValue ? true : m_config.readEntry("renameDuplicatedLayers", true);
}

References m_config.

renameMergedLayers()

bool KisImageConfig::renameMergedLayers

(

bool

defaultValue = false

)

const

Definition at line 723 of file kis_image_config.cpp.

{
    return defaultValue ? true : m_config.readEntry("renameMergedLayers", true);
}

References m_config.

resetConfig()

void KisImageConfig::resetConfig ( )

static

Definition at line 768 of file kis_image_config.cpp.

{
    KConfigGroup config = KSharedConfig::openConfig()->group(QString());
    config.deleteGroup();
}

safelyGetWritableTempLocation()

QString KisImageConfig::safelyGetWritableTempLocation ( const QString & suffix, const QString & configKey, bool requestDefault ) const

private

On NTFS, isWritable() doesn't check for attributes due to performance reasons, so we should try it in a brute-force way... (yes, there is a hacky-global-variable workaround, but let's be safe)

Definition at line 228 of file kis_image_config.cpp.

{
#ifdef Q_OS_MACOS
    // On OSX, QDir::tempPath() gives us a folder we cannot reply upon (usually
    // something like /var/folders/.../...) and that will have vanished when we
    // try to create the tmp file in KisMemoryWindow::KisMemoryWindow using
    // swapFileTemplate. thus, we just pick the home folder if swapDir does not
    // tell us otherwise.
 
    // the other option here would be to use a "garbled name" temp file (i.e. no name
    // KRITA_SWAP_FILE_XXXXXX) in an obscure /var/folders place, which is not
    // nice to the user. having a clearly named swap file in the home folder is
    // much nicer to Krita's users.
 
    // NOTE: QStandardPaths::AppLocalDataLocation on macos sandboxed envs
    // does not return writable locations at all times, using QDir static methods
    // will always return locations inside the sandbox Container
 
    // furthermore, this is just a default and swapDir can always be configured
    // to another location.
 
    QString swap;
 
    KisMacosSecurityBookmarkManager *bookmarkmngr = KisMacosSecurityBookmarkManager::instance();
    if ( bookmarkmngr->isSandboxed() ) {
        QDir sandboxHome = QDir::home();
        if (sandboxHome.cd("tmp")) {
            swap = sandboxHome.path();
        }
    } else {
        swap = QStandardPaths::writableLocation(QStandardPaths::AppLocalDataLocation) + '/' + suffix;
    }
#else
    Q_UNUSED(suffix);
    QString swap = QDir::tempPath();
#endif
    if (requestDefault) {
       return swap;
    }
    const QString configuredSwap = m_config.readEntry(configKey, swap);
    if (!configuredSwap.isEmpty()) {
        swap = configuredSwap;
    }
 
    QString chosenLocation;
    QStringList proposedSwapLocations;
 
    proposedSwapLocations << swap;
    proposedSwapLocations << QDir::tempPath();
    proposedSwapLocations << QDir::homePath();
 
    Q_FOREACH (const QString location, proposedSwapLocations) {
        if (!QFileInfo(location).isWritable()) continue;
 
        QTemporaryFile tempFile;
        tempFile.setFileTemplate(location + '/' + "krita_test_swap_location");
        if (tempFile.open() && !tempFile.fileName().isEmpty()) {
            chosenLocation = location;
            break;
        }
    }
 
    if (chosenLocation.isEmpty()) {
        qCritical() << "CRITICAL: no writable location for a swap file found! Tried the following paths:" << proposedSwapLocations;
        qCritical() << "CRITICAL: hope I don't crash...";
        chosenLocation = swap;
    }
 
    if (chosenLocation != swap) {
        qWarning() << "WARNING: configured swap location is not writable, using a fall-back location" << swap << "->" << chosenLocation;
    }
 
    return chosenLocation;
}

References KisMacosSecurityBookmarkManager::instance(), KisMacosSecurityBookmarkManager::isSandboxed(), and m_config.

schedulerBalancingRatio()

qreal KisImageConfig::schedulerBalancingRatio

(

)

const

updates-queue-size / strokes-queue-size

Definition at line 128 of file kis_image_config.cpp.

{
    return m_config.readEntry("schedulerBalancingRatio", 100.);
}

References m_config.

selectionOutlineOpacity()

qreal KisImageConfig::selectionOutlineOpacity

(

bool

defaultValue = false

)

const

Definition at line 687 of file kis_image_config.cpp.

{
    return defaultValue ? 1.0 : m_config.readEntry("selectionOutlineOpacity", 1.0);
}

References m_config.

selectionOverlayMaskColor()

QColor KisImageConfig::selectionOverlayMaskColor

(

bool

defaultValue = false

)

const

Definition at line 697 of file kis_image_config.cpp.

{
    QColor def(255, 0, 0, 128);
    return (defaultValue ? def : m_config.readEntry("selectionOverlayMaskColor", def));
}

References m_config.

setAnimationCacheDir()

void KisImageConfig::setAnimationCacheDir

(

const QString &

value

)

Definition at line 642 of file kis_image_config.cpp.

{
    m_config.writeEntry("animationCacheDir", value);
}

References m_config, and value().

setAnimationCacheFrameSizeLimit()

void KisImageConfig::setAnimationCacheFrameSizeLimit

(

int

value

)

Definition at line 662 of file kis_image_config.cpp.

{
    m_config.writeEntry("animationCacheFrameSizeLimit", value);
}

References m_config, and value().

setAnimationCacheRegionOfInterestMargin()

void KisImageConfig::setAnimationCacheRegionOfInterestMargin

(

qreal

value

)

Definition at line 682 of file kis_image_config.cpp.

{
    m_config.writeEntry("animationCacheRegionOfInterestMargin", value);
}

References m_config, and value().

setAutoKeyEnabled()

void KisImageConfig::setAutoKeyEnabled

(

bool

value

)

Definition at line 396 of file kis_image_config.cpp.

{
    m_config.writeEntry("lazyFrameCreationEnabled", value);
}

References m_config, and value().

setAutoKeyModeDuplicate()

void KisImageConfig::setAutoKeyModeDuplicate

(

bool

value

)

Definition at line 407 of file kis_image_config.cpp.

{
    m_config.writeEntry("lazyFrameModeDuplicate", value);
}

References m_config, and value().

setDefaultFrameColorLabel()

void KisImageConfig::setDefaultFrameColorLabel

(

int

label

)

Definition at line 510 of file kis_image_config.cpp.

{
    m_config.writeEntry("defaultFrameColorLabel", label);
}

References m_config.

setDefaultProofingConfig()

void KisImageConfig::setDefaultProofingConfig

(

const KisProofingConfiguration &

config

)

Definition at line 539 of file kis_image_config.cpp.

{
    if (*defaultProofingconfiguration() == config) return;
 
    m_config.writeEntry("defaultProofingProfileName", config.proofingProfile);
    m_config.writeEntry("defaultProofingProfileModel", config.proofingModel);
    m_config.writeEntry("defaultProofingProfileDepth", config.proofingDepth);
    m_config.writeEntry("defaultProofingConversionIntent", int(config.conversionIntent));
    m_config.writeEntry("defaultProofingBlackpointCompensation", config.useBlackPointCompensationFirstTransform);
    QColor c;
    c = config.warningColor.toQColor();
    m_config.writeEntry("defaultProofingGamutwarning", c);
    m_config.writeEntry("defaultProofingAdaptationState", config.legacyAdaptationState());
    m_config.writeEntry("defaultProofingDisplayBlackpointCompensation", config.displayFlags.testFlag(KoColorConversionTransformation::BlackpointCompensation));
    m_config.writeEntry("defaultProofingProfileIntent", int(config.displayIntent));
    m_config.writeEntry("defaultProofingDisplayMode", int(config.displayMode));
 
    KisImageConfigNotifier::instance()->notifyGlobalProofingConfigChanged();
}

References KoColorConversionTransformation::BlackpointCompensation, KisProofingConfiguration::conversionIntent, defaultProofingconfiguration(), KisProofingConfiguration::displayFlags, KisProofingConfiguration::displayIntent, KisProofingConfiguration::displayMode, KisImageConfigNotifier::instance(), KisProofingConfiguration::legacyAdaptationState(), m_config, KisImageConfigNotifier::notifyGlobalProofingConfigChanged(), KisProofingConfiguration::proofingDepth, KisProofingConfiguration::proofingModel, KisProofingConfiguration::proofingProfile, KoColor::toQColor(), KisProofingConfiguration::useBlackPointCompensationFirstTransform, and KisProofingConfiguration::warningColor.

setDetectFpsLimit()

void KisImageConfig::setDetectFpsLimit

(

bool

value

)

Definition at line 622 of file kis_image_config.cpp.

{
    m_config.writeEntry("detectFpsLimit", value);
}

References m_config, and value().

setEnablePerfLog()

void KisImageConfig::setEnablePerfLog

(

bool

value

)

Definition at line 79 of file kis_image_config.cpp.

{
    m_config.writeEntry("enablePerfLog", value);
}

References m_config, and value().

setEnableProgressReporting()

void KisImageConfig::setEnableProgressReporting

(

bool

value

)

Definition at line 68 of file kis_image_config.cpp.

{
    m_config.writeEntry("enableProgressReporting", value);
}

References m_config, and value().

setExportConfiguration()

void KisImageConfig::setExportConfiguration	(	const QString &	exportConfigId,
		KisPropertiesConfigurationSP	properties )

Definition at line 761 of file kis_image_config.cpp.

{
    const QString exportConfig = properties->toXML();
    QString configId = "ExportConfiguration-" + exportConfigId;
    m_config.writeEntry(configId, exportConfig);
}

References m_config.

setFpsLimit()

void KisImageConfig::setFpsLimit

(

int

value

)

Definition at line 612 of file kis_image_config.cpp.

{
    m_config.writeEntry("fpsLimit", value);
}

References m_config, and value().

setFrameRenderingClones()

void KisImageConfig::setFrameRenderingClones

(

int

value

)

Definition at line 590 of file kis_image_config.cpp.

{
    m_config.writeEntry("frameRenderingClones", value);
}

References m_config, and value().

setFrameRenderingTimeout()

void KisImageConfig::setFrameRenderingTimeout

(

int

value

)

Definition at line 601 of file kis_image_config.cpp.

{
    m_config.writeEntry("frameRenderingTimeout", value);
}

References m_config, and value().

setMaxBrushSize()

void KisImageConfig::setMaxBrushSize

(

int

value

)

Definition at line 713 of file kis_image_config.cpp.

{
    m_config.writeEntry("maximumBrushSize", value);
}

References m_config, and value().

setMaxNumberOfThreads()

void KisImageConfig::setMaxNumberOfThreads

(

int

value

)

Definition at line 575 of file kis_image_config.cpp.

{
    if (value == QThread::idealThreadCount()) {
        m_config.deleteEntry("maxNumberOfThreads");
    } else {
        m_config.writeEntry("maxNumberOfThreads", value);
    }
}

References m_config, and value().

setMaxSwapSize()

void KisImageConfig::setMaxSwapSize

(

int

value

)

Definition at line 147 of file kis_image_config.cpp.

{
    m_config.writeEntry("maxSwapSize", value);
}

References m_config, and value().

setMemoryHardLimitPercent()

void KisImageConfig::setMemoryHardLimitPercent

(

qreal

value

)

Definition at line 201 of file kis_image_config.cpp.

{
    m_config.writeEntry("memoryHardLimitPercent", value);
}

References m_config, and value().

setMemoryPoolLimitPercent()

void KisImageConfig::setMemoryPoolLimitPercent

(

qreal

value

)

Definition at line 223 of file kis_image_config.cpp.

{
    m_config.writeEntry("memoryPoolLimitPercent", value);
}

References m_config, and value().

setMemorySoftLimitPercent()

void KisImageConfig::setMemorySoftLimitPercent

(

qreal

value

)

Definition at line 212 of file kis_image_config.cpp.

{
    m_config.writeEntry("memorySoftLimitPercent", value);
}

References m_config, and value().

setNumberOfOnionSkins()

void KisImageConfig::setNumberOfOnionSkins

(

int

value

)

Definition at line 324 of file kis_image_config.cpp.

{
    m_config.writeEntry("numberOfOnionSkins", value);
}

References m_config, and value().

setOnionSkinOpacity()

void KisImageConfig::setOnionSkinOpacity	(	int	offset,
		int	value )

Definition at line 354 of file kis_image_config.cpp.

{
    m_config.writeEntry("onionSkinOpacity_" + QString::number(offset), value);
}

References m_config, and value().

setOnionSkinState()

void KisImageConfig::setOnionSkinState	(	int	offset,
		bool	value )

Definition at line 365 of file kis_image_config.cpp.

{
    m_config.writeEntry("onionSkinState_" + QString::number(offset), value);
}

References m_config, and value().

setOnionSkinTintColorBackward()

void KisImageConfig::setOnionSkinTintColorBackward

(

const QColor &

value

)

Definition at line 375 of file kis_image_config.cpp.

{
    m_config.writeEntry("onionSkinTintColorBackward", value);
}

References m_config, and value().

setOnionSkinTintColorForward()

void KisImageConfig::setOnionSkinTintColorForward

(

const QColor &

value

)

Definition at line 385 of file kis_image_config.cpp.

{
    m_config.writeEntry("oninSkinTintColorForward", value);
}

References m_config, and value().

setOnionSkinTintFactor()

void KisImageConfig::setOnionSkinTintFactor

(

int

value

)

Definition at line 334 of file kis_image_config.cpp.

{
    m_config.writeEntry("onionSkinTintFactor", value);
}

References m_config, and value().

setRenameDuplicatedLayers()

void KisImageConfig::setRenameDuplicatedLayers

(

bool

value

)

Definition at line 738 of file kis_image_config.cpp.

{
    m_config.writeEntry("renameDuplicatedLayers", value);
}

References m_config, and value().

setRenameMergedLayers()

void KisImageConfig::setRenameMergedLayers

(

bool

value

)

Definition at line 728 of file kis_image_config.cpp.

{
    m_config.writeEntry("renameMergedLayers", value);
}

References m_config, and value().

setSchedulerBalancingRatio()

void KisImageConfig::setSchedulerBalancingRatio

(

qreal

value

)

Definition at line 136 of file kis_image_config.cpp.

{
    m_config.writeEntry("schedulerBalancingRatio", value);
}

References m_config, and value().

setSelectionOutlineOpacity()

void KisImageConfig::setSelectionOutlineOpacity

(

qreal

value

)

Definition at line 692 of file kis_image_config.cpp.

{
    m_config.writeEntry("selectionOutlineOpacity", value);
}

References m_config, and value().

setSelectionOverlayMaskColor()

void KisImageConfig::setSelectionOverlayMaskColor

(

const QColor &

color

)

Definition at line 703 of file kis_image_config.cpp.

{
    m_config.writeEntry("selectionOverlayMaskColor", color);
}

References m_config.

setShowAdditionalOnionSkinsSettings()

void KisImageConfig::setShowAdditionalOnionSkinsSettings

(

bool

value

)

Definition at line 500 of file kis_image_config.cpp.

{
    m_config.writeEntry("showAdditionalOnionSkinsSettings", value);
}

References m_config, and value().

setSwapDir()

void KisImageConfig::setSwapDir

(

const QString &

swapDir

)

Definition at line 314 of file kis_image_config.cpp.

{
    m_config.writeEntry("swaplocation", swapDir);
}

References m_config, and swapDir().

setSwapSlabSize()

void KisImageConfig::setSwapSlabSize

(

int

value

)

Definition at line 157 of file kis_image_config.cpp.

{
    m_config.writeEntry("swapSlabSize", value);
}

References m_config, and value().

setSwapWindowSize()

void KisImageConfig::setSwapWindowSize

(

int

value

)

Definition at line 167 of file kis_image_config.cpp.

{
    m_config.writeEntry("swapWindowSize", value);
}

References m_config, and value().

setUpdatePatchHeight()

void KisImageConfig::setUpdatePatchHeight

(

int

value

)

Definition at line 96 of file kis_image_config.cpp.

{
    m_config.writeEntry("updatePatchHeight", value);
}

References m_config, and value().

setUpdatePatchWidth()

void KisImageConfig::setUpdatePatchWidth

(

int

value

)

Definition at line 108 of file kis_image_config.cpp.

{
    m_config.writeEntry("updatePatchWidth", value);
}

References m_config, and value().

setUseAnimationCacheFrameSizeLimit()

void KisImageConfig::setUseAnimationCacheFrameSizeLimit

(

bool

value

)

Definition at line 652 of file kis_image_config.cpp.

{
    m_config.writeEntry("useAnimationCacheFrameSizeLimit", value);
}

References m_config, and value().

setUseAnimationCacheRegionOfInterest()

void KisImageConfig::setUseAnimationCacheRegionOfInterest

(

bool

value

)

Definition at line 672 of file kis_image_config.cpp.

{
    m_config.writeEntry("useAnimationCacheRegionOfInterest", value);
}

References m_config, and value().

setUseLodForColorizeMask()

void KisImageConfig::setUseLodForColorizeMask

(

bool

value

)

Definition at line 565 of file kis_image_config.cpp.

{
    m_config.writeEntry("useLodForColorizeMask", value);
}

References m_config, and value().

setUseOnDiskAnimationCacheSwapping()

void KisImageConfig::setUseOnDiskAnimationCacheSwapping

(

bool

value

)

Definition at line 632 of file kis_image_config.cpp.

{
    m_config.writeEntry("useOnDiskAnimationCacheSwapping", value);
}

References m_config, and value().

showAdditionalOnionSkinsSettings()

bool KisImageConfig::showAdditionalOnionSkinsSettings

(

bool

requestDefault = false

)

const

Definition at line 494 of file kis_image_config.cpp.

{
    return !requestDefault ?
        m_config.readEntry("showAdditionalOnionSkinsSettings", true) : true;
}

References m_config.

swapDir()

QString KisImageConfig::swapDir

(

bool

requestDefault = false

)

Returns

a specific directory for the swapfile, if set. If not set, return an empty QString and use the default KDE directory.

Definition at line 309 of file kis_image_config.cpp.

{
    return safelyGetWritableTempLocation("swap", "swaplocation", requestDefault);
}

References safelyGetWritableTempLocation().

swapSlabSize()

int KisImageConfig::swapSlabSize

(

)

const

Definition at line 152 of file kis_image_config.cpp.

{
    return m_config.readEntry("swapSlabSize", 64); // in MiB
}

References m_config.

swapWindowSize()

int KisImageConfig::swapWindowSize

(

)

const

Definition at line 162 of file kis_image_config.cpp.

{
    return m_config.readEntry("swapWindowSize", 16); // in MiB
}

References m_config.

tilesHardLimit()

int KisImageConfig::tilesHardLimit

(

)

const

Definition at line 172 of file kis_image_config.cpp.

{
    qreal hp = qreal(memoryHardLimitPercent()) / 100.0;
    qreal pp = qreal(memoryPoolLimitPercent()) / 100.0;
 
    return totalRAM() * hp * (1 - pp);
}

References memoryHardLimitPercent(), memoryPoolLimitPercent(), and totalRAM().

tilesSoftLimit()

int KisImageConfig::tilesSoftLimit

(

)

const

Definition at line 180 of file kis_image_config.cpp.

{
    qreal sp = qreal(memorySoftLimitPercent()) / 100.0;
 
    return tilesHardLimit() * sp;
}

References memorySoftLimitPercent(), and tilesHardLimit().

totalRAM()

int KisImageConfig::totalRAM ( )

static

Definition at line 425 of file kis_image_config.cpp.

{
    // let's think that default memory size is 1000MiB
    int totalMemory = 1000; // MiB
    int error = 1;
 
#if defined Q_OS_LINUX
    struct sysinfo info;
 
    error = sysinfo(&info);
    if(!error) {
        totalMemory = info.totalram * info.mem_unit / (1UL << 20);
    }
#elif defined Q_OS_HAIKU
    system_info info;
    error = get_system_info(&info) == B_OK ? 0 : 1;
    if (!error) {
        uint64_t size = (info.max_pages * B_PAGE_SIZE);
    totalMemory = size >> 20;
    }
#elif defined Q_OS_FREEBSD || defined Q_OS_NETBSD || defined Q_OS_OPENBSD
    u_long physmem;
#   if defined HW_PHYSMEM64 // NetBSD only
    int mib[] = {CTL_HW, HW_PHYSMEM64};
#   else
    int mib[] = {CTL_HW, HW_PHYSMEM};
#   endif
    size_t len = sizeof(physmem);
 
    error = sysctl(mib, 2, &physmem, &len, 0, 0);
    if(!error) {
        totalMemory = physmem >> 20;
    }
#elif defined Q_OS_WIN
    MEMORYSTATUSEX status;
    status.dwLength = sizeof(status);
    error  = !GlobalMemoryStatusEx(&status);
 
    if (!error) {
        totalMemory = status.ullTotalPhys >> 20;
    }
 
    // For 32 bit windows, the total memory available is at max the 2GB per process memory limit.
#   if defined ENV32BIT
    totalMemory = qMin(totalMemory, 2000);
#   endif
#elif defined Q_OS_MACOS
    int mib[2] = { CTL_HW, HW_MEMSIZE };
    u_int namelen = sizeof(mib) / sizeof(mib[0]);
    uint64_t size;
    size_t len = sizeof(size);
 
    errno = 0;
    if (sysctl(mib, namelen, &size, &len, 0, 0) >= 0) {
        totalMemory = size >> 20;
        error = 0;
    }
    else {
        dbgKrita << "sysctl(\"hw.memsize\") raised error" << strerror(errno);
    }
#endif
 
    if (error) {
        warnKrita << "Cannot get the size of your RAM. Using 1 GiB by default.";
    }
 
    return totalMemory;
}

References dbgKrita, and warnKrita.

transformMaskOffBoundsReadArea()

qreal KisImageConfig::transformMaskOffBoundsReadArea

(

)

const

Definition at line 84 of file kis_image_config.cpp.

{
    return m_config.readEntry("transformMaskOffBoundsReadArea", 0.5);
}

References m_config.

updatePatchHeight()

int KisImageConfig::updatePatchHeight

(

)

const

Definition at line 89 of file kis_image_config.cpp.

{
    int patchHeight = m_config.readEntry("updatePatchHeight", 512);
    if (patchHeight <= 0) return 512;
    return patchHeight;
}

References m_config.

updatePatchWidth()

int KisImageConfig::updatePatchWidth

(

)

const

Definition at line 101 of file kis_image_config.cpp.

{
    int patchWidth = m_config.readEntry("updatePatchWidth", 512);
    if (patchWidth <= 0) return 512;
    return patchWidth;
}

References m_config.

useAnimationCacheFrameSizeLimit()

bool KisImageConfig::useAnimationCacheFrameSizeLimit

(

bool

defaultValue = false

)

const

Definition at line 647 of file kis_image_config.cpp.

{
    return defaultValue ? true : m_config.readEntry("useAnimationCacheFrameSizeLimit", true);
}

References m_config.

useAnimationCacheRegionOfInterest()

bool KisImageConfig::useAnimationCacheRegionOfInterest

(

bool

defaultValue = false

)

const

Definition at line 667 of file kis_image_config.cpp.

{
    return defaultValue ? true : m_config.readEntry("useAnimationCacheRegionOfInterest", true);
}

References m_config.

useLodForColorizeMask()

bool KisImageConfig::useLodForColorizeMask

(

bool

requestDefault = false

)

const

Definition at line 559 of file kis_image_config.cpp.

{
    return !requestDefault ?
        m_config.readEntry("useLodForColorizeMask", false) : false;
}

References m_config.

useOnDiskAnimationCacheSwapping()

bool KisImageConfig::useOnDiskAnimationCacheSwapping

(

bool

defaultValue = false

)

const

Definition at line 627 of file kis_image_config.cpp.

{
    return defaultValue ? true : m_config.readEntry("useOnDiskAnimationCacheSwapping", true);
}

References m_config.

writeEntry()

template<class T >

void KisImageConfig::writeEntry ( const QString & name, const T & value )

inline

Definition at line 155 of file kis_image_config.h.

                                                         {
        m_config.writeEntry(name, value);
    }

References value().

writeList()

template<class T >

void KisImageConfig::writeList ( const QString & name, const QList< T > & value )

inline

Definition at line 160 of file kis_image_config.h.

                                                               {
        m_config.writeEntry(name, value);
    }

References value().

Member Data Documentation

m_config

KConfigGroup KisImageConfig::m_config

private

Definition at line 190 of file kis_image_config.h.

m_readOnly

bool KisImageConfig::m_readOnly

private

Definition at line 191 of file kis_image_config.h.

---

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

• libs/image/kis_image_config.h
• libs/image/kis_image_config.cpp