QGIS API Documentation 4.1.0-Master (9af12b5a203)
Loading...
Searching...
No Matches
QgsBloomSettings Class Reference

Contains the configuration of the lighting "bloom" effect. More...

#include <qgsbloomsettings.h>

Public Member Functions

 QgsBloomSettings ()=default
 QgsBloomSettings (const QgsBloomSettings &other)
double intensity () const
 Returns the intensity of the bloom effect.
bool isEnabled () const
 Returns whether the bloom effect is enabled.
QgsBloomSettingsoperator= (QgsBloomSettings const &rhs)
double radius () const
 Returns the filter radius for the bloom.
void readXml (const QDomElement &element, const QgsReadWriteContext &context)
 Reads settings from a DOM element.
void setEnabled (bool enabled)
 Sets whether the bloom effect is enabled.
void setIntensity (double factor)
 Sets the intensity of the bloom effect.
void setRadius (double radius)
 Sets the filter radius for the bloom.
void writeXml (QDomElement &element, const QgsReadWriteContext &context) const
 Writes settings to a DOM element.

Detailed Description

Contains the configuration of the lighting "bloom" effect.

Note
Not available in Python bindings
Since
QGIS 4.2

Definition at line 36 of file qgsbloomsettings.h.

Constructor & Destructor Documentation

◆ QgsBloomSettings() [1/2]

QgsBloomSettings::QgsBloomSettings ( )
default

◆ QgsBloomSettings() [2/2]

QgsBloomSettings::QgsBloomSettings ( const QgsBloomSettings & other)

Definition at line 25 of file qgsbloomsettings.cpp.

Member Function Documentation

◆ intensity()

double QgsBloomSettings::intensity ( ) const
inline

Returns the intensity of the bloom effect.

See also
setIntensity()

Definition at line 83 of file qgsbloomsettings.h.

◆ isEnabled()

bool QgsBloomSettings::isEnabled ( ) const
inline

Returns whether the bloom effect is enabled.

See also
setEnabled()

Definition at line 69 of file qgsbloomsettings.h.

◆ operator=()

QgsBloomSettings & QgsBloomSettings::operator= ( QgsBloomSettings const & rhs)

Definition at line 31 of file qgsbloomsettings.cpp.

◆ radius()

double QgsBloomSettings::radius ( ) const
inline

Returns the filter radius for the bloom.

See also
setRadius()

Definition at line 97 of file qgsbloomsettings.h.

◆ readXml()

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

Reads settings from a DOM element.

See also
writeXml()

Definition at line 42 of file qgsbloomsettings.cpp.

◆ setEnabled()

void QgsBloomSettings::setEnabled ( bool enabled)
inline

Sets whether the bloom effect is enabled.

See also
isEnabled()

Definition at line 62 of file qgsbloomsettings.h.

◆ setIntensity()

void QgsBloomSettings::setIntensity ( double factor)
inline

Sets the intensity of the bloom effect.

See also
intensity()

Definition at line 76 of file qgsbloomsettings.h.

◆ setRadius()

void QgsBloomSettings::setRadius ( double radius)
inline

Sets the filter radius for the bloom.

See also
radius()

Definition at line 90 of file qgsbloomsettings.h.

◆ writeXml()

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

Writes settings to a DOM element.

See also
readXml()

Definition at line 49 of file qgsbloomsettings.cpp.


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