Graphics effect which enables bloom for shapes and objects that have a luciad::BloomStyle. More...

#include <luciad/maps/effects/BloomEffect.h>

Public Member Functions
	BloomEffect (const BloomEffect &)=delete
const std::shared_ptr< BloomModel > &	getModel () const
	Returns the bloom model.
bool	isEnabled () const
	Returns whether the bloom effect is enabled.
BloomEffect &	operator= (const BloomEffect &)=delete
void	setEnabled (bool enabled)
	Sets whether the bloom effect is enabled.
void	setModel (std::shared_ptr< BloomModel > model)
	Sets the bloom model.

Detailed Description

Graphics effect which enables bloom for shapes and objects that have a luciad::BloomStyle.

Left: no bloom. Right: bloom.

The effect is enabled by default.

Bloom can be used to increase the perceived brightness of an object. See the map effects article on how to use bloom.

You cannot create a BloomEffect. Instead, you can retrieve it from luciad::GraphicsEffects::getBloom.

Since: 2026.1

Constructor & Destructor Documentation

◆ BloomEffect()

luciad::BloomEffect::BloomEffect ( const BloomEffect & )

delete

Member Function Documentation

◆ getModel()

const std::shared_ptr< BloomModel > & luciad::BloomEffect::getModel ( ) const

Returns the bloom model.

The default is a bloom model with all the default values as described in the builder.

Returns: the bloom model.

◆ isEnabled()

bool luciad::BloomEffect::isEnabled ( ) const

Returns whether the bloom effect is enabled.

Returns: whether the bloom effect is enabled.

◆ operator=()

BloomEffect & luciad::BloomEffect::operator= ( const BloomEffect & )

delete

◆ setEnabled()

void luciad::BloomEffect::setEnabled ( bool enabled )

Sets whether the bloom effect is enabled.

The default is true.

Parameters

enabled true to enable the bloom effect or false to disable it.

◆ setModel()

void luciad::BloomEffect::setModel ( std::shared_ptr< BloomModel > model )

Sets the bloom model.