Package com.luciad.maps.effects

Class BloomEffect

java.lang.Object

com.luciad.maps.effects.BloomEffect

All Implemented Interfaces:

AutoCloseable

public final class BloomEffect
extends Object
implements AutoCloseable

Graphics effect which enables bloom for shapes and objects that have a 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 GraphicsEffects#getBloom.

Since:

2026.1

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	finalize()
BloomModel	getModel()	Returns the bloom model.
boolean	isEnabled()	Returns whether the bloom effect is enabled.
void	setEnabled(boolean enabled)	Sets whether the bloom effect is enabled.
void	setModel(BloomModel model)	Sets the bloom model.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

isEnabled

public boolean isEnabled()

Returns whether the bloom effect is enabled.

Returns:

whether the bloom effect is enabled.

setEnabled

public void setEnabled(boolean 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.

getModel

@NotNull
public BloomModel getModel()

Returns the bloom model.

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

Returns:

the bloom model.

setModel

public void setModel(@NotNull
 BloomModel model)
              throws NullPointerException

Sets the bloom model.

Parameters:

model - the new bloom model.

Throws:

NullPointerException - if the model is null.