filament/io.github.erkko68.filament/BloomOptions

BloomOptions

Options to control the bloom post-processing effect.

Bloom allows bright areas to glow and bleed into surrounding areas, creating a luminous quality. The effect can be enhanced with lens flare, lens artifacts, and customizable bloom color and spread.

Constructors

BloomOptions

constructor()

Types

BlendMode

enum BlendMode : Enum<BloomOptions.BlendMode>

Bloom blending mode.

Properties

blendMode

var blendMode: BloomOptions.BlendMode

How the bloom effect is applied.

chromaticAberration

var chromaticAberration: Float

Amount of chromatic aberration in the lens flare effect. Default: 0.005.

dirt

var dirt: Texture?

A dirt/scratch/smudges texture (RGB) which gets added to the bloom effect. Smudges are visible where bloom occurs. Threshold must be enabled for the dirt effect to work properly. Default: null.

dirtStrength

var dirtStrength: Float

Strength of the dirt texture. Default: 0.2.

enabled

var enabled: Boolean

Enable or disable the bloom post-processing effect. Default: false.

ghostCount

var ghostCount: Int

Number of flare "ghosts" (lens artifacts). Default: 4.

ghostSpacing

var ghostSpacing: Float

Spacing of the ghost in screen units [0, 1). Default: 0.6.

ghostThreshold

var ghostThreshold: Float

HDR threshold for the ghosts. Default: 10.0.

haloRadius

var haloRadius: Float

Radius of halo in vertical screen units 0, 0.5. Default: 0.4.

haloThickness

var haloThickness: Float

Thickness of halo in vertical screen units, 0 to disable. Default: 0.1.

haloThreshold

var haloThreshold: Float

HDR threshold for the halo. Default: 10.0.

highlight

var highlight: Float

Limit highlights to this value before bloom, range 10, +inf. Default: 1000.0.

lensFlare

var lensFlare: Boolean

Enable screen-space lens flare effect. Default: false.

levels

var levels: Int

Number of successive blurs to achieve the blur effect. Minimum is 3 and maximum is 12. This value together with resolution influences the spread of the blur effect. This value can be silently reduced to accommodate the original image size. Default: 6.

quality

var quality: QualityLevel

Bloom quality level.

resolution

var resolution: Int

Resolution of bloom's minor axis. Minimum value is 2^levels and maximum is lower of the original resolution and 4096. This parameter is silently clamped to the minimum and maximum. Default: 384.

starburst

var starburst: Boolean

Enable starburst effect on lens flare. Default: true.

strength

var strength: Float

How much of the bloom is added to the original image, between 0 and 1. Default: 0.10.

threshold

var threshold: Boolean

When enabled, a threshold at 1.0 is applied on the source image, useful for artistic reasons and usually needed when a dirt texture is used. Default: true.