QgsColorGradingSettings Class Reference

Contains the configuration of the scene's color grading settings, such as exposure and tone mapping. More...

#include <qgscolorgradingsettings.h>

Public Member Functions
	QgsColorGradingSettings ()=default
	QgsColorGradingSettings (const QgsColorGradingSettings &other)
double	exposureAdjustment () const
	Returns the exposure adjustment value.
QgsColorGradingSettings &	operator= (QgsColorGradingSettings const &rhs)
void	readXml (const QDomElement &element, const QgsReadWriteContext &context)
	Reads settings from a DOM element.
void	setExposureAdjustment (double adjustment)
	Sets the exposure adjustment value.
void	setToneMapping (Qgis::ToneMappingMethod mapping)
	Sets the tone mapping method.
Qgis::ToneMappingMethod	toneMapping () const
	Returns the tone mapping method applied to the scene.
void	writeXml (QDomElement &element, const QgsReadWriteContext &context) const
	Writes settings to a DOM element.

Detailed Description

Contains the configuration of the scene's color grading settings, such as exposure and tone mapping.

Note

Not available in Python bindings

Since

QGIS 4.2

Definition at line 37 of file qgscolorgradingsettings.h.

Constructor & Destructor Documentation

QgsColorGradingSettings() [1/2]

QgsColorGradingSettings::QgsColorGradingSettings ( )

default

QgsColorGradingSettings() [2/2]

QgsColorGradingSettings::QgsColorGradingSettings

(

const QgsColorGradingSettings &

other

)

Definition at line 25 of file qgscolorgradingsettings.cpp.

Member Function Documentation

exposureAdjustment()

double QgsColorGradingSettings::exposureAdjustment ( ) const

inline

Returns the exposure adjustment value.

Exposure adjustment is applied to the linear color values before bloom and tone mapping are evaluated.

A value of 0.0 represents no adjustment. Positive values will brighten the scene, while negative values will darken it.

See also

setExposureAdjustment()

Definition at line 68 of file qgscolorgradingsettings.h.

operator=()

QgsColorGradingSettings & QgsColorGradingSettings::operator=

(

QgsColorGradingSettings const &

rhs

)

Definition at line 30 of file qgscolorgradingsettings.cpp.

readXml()

void QgsColorGradingSettings::readXml	(	const QDomElement &	element,
		const QgsReadWriteContext &	context )

Reads settings from a DOM element.

See also

writeXml()

Definition at line 40 of file qgscolorgradingsettings.cpp.

setExposureAdjustment()

void QgsColorGradingSettings::setExposureAdjustment ( double adjustment )

inline

Sets the exposure adjustment value.

See also

exposureAdjustment()

Definition at line 75 of file qgscolorgradingsettings.h.

setToneMapping()

void QgsColorGradingSettings::setToneMapping ( Qgis::ToneMappingMethod mapping )

inline

Sets the tone mapping method.

See also

toneMapping()

Definition at line 92 of file qgscolorgradingsettings.h.

toneMapping()

Qgis::ToneMappingMethod QgsColorGradingSettings::toneMapping ( ) const

inline

Returns the tone mapping method applied to the scene.

Tone mapping handles the transformation of High Dynamic Range (HDR) colors into the Low Dynamic Range (LDR) range. It is evaluated after exposure and bloom effects have been applied.

See also

setToneMapping()

Definition at line 86 of file qgscolorgradingsettings.h.

writeXml()

void QgsColorGradingSettings::writeXml	(	QDomElement &	element,
		const QgsReadWriteContext &	context ) const

Writes settings to a DOM element.

See also

readXml()

Definition at line 46 of file qgscolorgradingsettings.cpp.

---

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

• /build/qgis-4.1.0+git20260604+ca2ac17535b+99sid/src/3d/qgscolorgradingsettings.h
• /build/qgis-4.1.0+git20260604+ca2ac17535b+99sid/src/3d/qgscolorgradingsettings.cpp