Classes
class	PostProcessingParameters

class	PreviewParameters

Public Types
enum	ColorManagementSettings { NoColorConversion , ApplyTransform , ConvertForEditor , ConvertToSRGB , ConvertForDisplay , ConvertForOutput }

enum	RawDecodingHint { RawDecodingDefaultSettings , RawDecodingGlobalSettings , RawDecodingCustomSettings , RawDecodingTimeOptimized }

Public Member Functions
QString	cacheKey () const

bool	equalsIgnoreReducedVersion (const LoadingDescription &other) const

bool	equalsOrBetterThan (const LoadingDescription &other) const

bool	isPreviewImage () const

bool	isReducedVersion () const

bool	isThumbnail () const

	LoadingDescription ()

	LoadingDescription (const QString &filePath, ColorManagementSettings=NoColorConversion)

	LoadingDescription (const QString &filePath, const DRawDecoding &settings, RawDecodingHint rawDecodingHint=RawDecodingCustomSettings, ColorManagementSettings=NoColorConversion)

	LoadingDescription (const QString &filePath, const PreviewSettings &settings, int size, ColorManagementSettings=NoColorConversion, PreviewParameters::PreviewType=PreviewParameters::PreviewImage)

QStringList	lookupCacheKeys () const

bool	needCheckRawDecoding () const

bool	operator!= (const LoadingDescription &other) const

bool	operator== (const LoadingDescription &other) const

ThumbnailIdentifier	thumbnailIdentifier () const

Static Public Member Functions
static QStringList	possibleCacheKeys (const QString &filePath)

static QStringList	possibleThumbnailCacheKeys (const QString &filePath)

Public Attributes
QString	filePath

PostProcessingParameters	postProcessingParameters

PreviewParameters	previewParameters

RawDecodingHint	rawDecodingHint

DRawDecoding	rawDecodingSettings

Member Enumeration Documentation

◆ ColorManagementSettings

enum Digikam::LoadingDescription::ColorManagementSettings

Enumerator
NoColorConversion
ApplyTransform	IccData is an IccTransform.
ConvertForEditor
ConvertToSRGB
ConvertForDisplay	IccData can be the output profile.
ConvertForOutput	IccData is the output profile.

◆ RawDecodingHint

enum Digikam::LoadingDescription::RawDecodingHint

Enumerator
RawDecodingDefaultSettings	The raw decoding options passed are taken from default, hardcoded settings
RawDecodingGlobalSettings	The raw decoding options passed are taken from global settings
RawDecodingCustomSettings	The raw decoding options may be customly edited by the user
RawDecodingTimeOptimized	The raw decoding options are hardcoded settings optimized for loading time The halfSizeColorImage and 16bit settings can be adjusted separately

Constructor & Destructor Documentation

◆ LoadingDescription() [1/4]

Digikam::LoadingDescription::LoadingDescription ( )

An invalid LoadingDescription

◆ LoadingDescription() [2/4]

Digikam::LoadingDescription::LoadingDescription	(	const QString &	filePath,
		ColorManagementSettings	cm = `NoColorConversion`
	)

explicit

Use this for full loading of non-raw files

References Digikam::LoadingDescription::PostProcessingParameters::colorManagement, and postProcessingParameters.

◆ LoadingDescription() [3/4]

Digikam::LoadingDescription::LoadingDescription	(	const QString &	filePath,
		const DRawDecoding &	settings,
		RawDecodingHint	rawDecodingHint = `RawDecodingCustomSettings`,
		ColorManagementSettings	cm = `NoColorConversion`
	)

Use this for full loading of raw files

References Digikam::LoadingDescription::PostProcessingParameters::colorManagement, and postProcessingParameters.

◆ LoadingDescription() [4/4]

Digikam::LoadingDescription::LoadingDescription	(	const QString &	filePath,
		const PreviewSettings &	settings,
		int	size,
		ColorManagementSettings	cm = `NoColorConversion`,
		PreviewParameters::PreviewType	type = `PreviewParameters::PreviewImage`
	)

For preview and thumbnail jobs: Stores preview max size and Exif rotation. Raw files / preview jobs: If size is not 0, the embedded preview will be loaded if available. If size is 0, DImg based loading will be used with default raw decoding settings. You can also adjust raw decoding settings and hint in this case.

References Digikam::LoadingDescription::PostProcessingParameters::colorManagement, postProcessingParameters, previewParameters, Digikam::LoadingDescription::PreviewParameters::previewSettings, Digikam::LoadingDescription::PreviewParameters::size, and Digikam::LoadingDescription::PreviewParameters::type.

Member Function Documentation

◆ cacheKey()

QString Digikam::LoadingDescription::cacheKey ( ) const

Return the cache key for this description

References Digikam::LoadingDescription::PreviewParameters::DetailThumbnail, Digikam::LoadingDescription::PreviewParameters::extraParameter, filePath, Digikam::DRawDecoderSettings::halfSizeColorImage, Digikam::LoadingDescription::PreviewParameters::NoPreview, previewParameters, RawDecodingCustomSettings, RawDecodingGlobalSettings, rawDecodingHint, rawDecodingSettings, RawDecodingTimeOptimized, Digikam::DRawDecoding::rawPrm, Digikam::DRawDecoderSettings::sixteenBitsImage, Digikam::LoadingDescription::PreviewParameters::size, Digikam::LoadingDescription::PreviewParameters::storageReference, suffix, Digikam::LoadingDescription::PreviewParameters::Thumbnail, and Digikam::LoadingDescription::PreviewParameters::type.

Referenced by Digikam::SharedLoadingTask::cacheKey(), Digikam::ThumbnailLoadThread::Private::checkDescription(), Digikam::SharedLoadingTask::execute(), Digikam::PreviewLoadingTask::execute(), Digikam::ThumbnailLoadingTask::execute(), lookupCacheKeys(), and Digikam::ThumbnailLoadThread::thumbnailLoaded().

◆ equalsIgnoreReducedVersion()

bool Digikam::LoadingDescription::equalsIgnoreReducedVersion ( const LoadingDescription & other ) const

Returns whether the other loading task equals this one ignoring parameters used to specify a reduced version.

References filePath.

Referenced by Digikam::SharedLoadingTask::notifyNewLoadingProcess().

◆ equalsOrBetterThan()

bool Digikam::LoadingDescription::equalsOrBetterThan ( const LoadingDescription & other ) const

Returns whether this loading task equals the other one or is superior to it, if the other one is a reduced version

References filePath, Digikam::DRawDecoding::optimizeTimeLoading(), previewParameters, rawDecodingSettings, and Digikam::LoadingDescription::PreviewParameters::size.

◆ isPreviewImage()

bool Digikam::LoadingDescription::isPreviewImage ( ) const

Returns if this description will load a preview

References Digikam::LoadingDescription::PreviewParameters::PreviewImage, previewParameters, and Digikam::LoadingDescription::PreviewParameters::type.

◆ isReducedVersion()

bool Digikam::LoadingDescription::isReducedVersion ( ) const

Returns whether this description describes a loading operation which loads the image in a reduced version (quality, size etc.)

References Digikam::DRawDecoderSettings::halfSizeColorImage, Digikam::LoadingDescription::PreviewParameters::NoPreview, previewParameters, rawDecodingSettings, Digikam::DRawDecoding::rawPrm, and Digikam::LoadingDescription::PreviewParameters::type.

Referenced by Digikam::SharedLoadingTask::notifyNewLoadingProcess().

◆ isThumbnail()

bool Digikam::LoadingDescription::isThumbnail ( ) const

Returns if this description will load a thumbnail

References Digikam::LoadingDescription::PreviewParameters::DetailThumbnail, previewParameters, Digikam::LoadingDescription::PreviewParameters::Thumbnail, and Digikam::LoadingDescription::PreviewParameters::type.

Referenced by thumbnailIdentifier().

◆ lookupCacheKeys()

QStringList Digikam::LoadingDescription::lookupCacheKeys ( ) const

Return all possible cache keys, starting with the best choice, for which a result may be found in the cache for this description. Included in the list are better quality versions, if this description is reduced.

References cacheKey(), Digikam::LoadingDescription::PreviewParameters::DetailThumbnail, filePath, Digikam::DRawDecoderSettings::halfSizeColorImage, Digikam::LoadingDescription::PreviewParameters::NoPreview, previewParameters, RawDecodingCustomSettings, RawDecodingDefaultSettings, RawDecodingGlobalSettings, rawDecodingHint, rawDecodingSettings, RawDecodingTimeOptimized, Digikam::DRawDecoding::rawPrm, Digikam::DRawDecoderSettings::sixteenBitsImage, Digikam::LoadingDescription::PreviewParameters::size, Digikam::LoadingDescription::PreviewParameters::Thumbnail, and Digikam::LoadingDescription::PreviewParameters::type.