.. _stdlib_bloom_component:

=====
Bloom
=====

.. das:module:: bloom_component




+++++++
Classes
+++++++

.. _struct-bloom_component-Bloom:

.. das:attribute:: Bloom : NativeComponent

This component adds a bloom (glow) post-processing effect.

Bloom simulates the visual perception of bright areas by making them glow outwards.
It works by extracting highlights from the rendered frame above the provided threshold,
blurring them across multiple mip levels, and adding the result back on top of the image.

To use this component, add the following line to your project file::

    require engine.core_components.bloom_component // or require engine.core

Usage example::

    let renderSettings = create_render_settings()
    get_component(renderSettings) $(var bloom : Bloom?) {
        bloom.active = true
        bloom.intensity = 0.8
    }



:Properties:

.. _function-bloom_component__dot__rq_active_Bloom:

.. das:operator:: Bloom.active() : bool




.. _function-bloom_component__dot__rq_active_rq_clone_Bloom_bool:

.. das:operator:: Bloom.active =(value: bool)

Active flag. Allows for toggling bloom on and off without removing the component.


:Arguments: * **value** : bool

.. _function-bloom_component__dot__rq_threshold_Bloom:

.. das:operator:: Bloom.threshold() : float




.. _function-bloom_component__dot__rq_threshold_rq_clone_Bloom_float:

.. das:operator:: Bloom.threshold =(value: float)

Luminance threshold for bloom. Pixels below this value do not contribute to bloom.


:Arguments: * **value** : float

.. _function-bloom_component__dot__rq_scatter_Bloom:

.. das:operator:: Bloom.scatter() : float




.. _function-bloom_component__dot__rq_scatter_rq_clone_Bloom_float:

.. das:operator:: Bloom.scatter =(value: float)

Bloom halation scatter factor.


:Arguments: * **value** : float

.. _function-bloom_component__dot__rq_intensity_Bloom:

.. das:operator:: Bloom.intensity() : float




.. _function-bloom_component__dot__rq_intensity_rq_clone_Bloom_float:

.. das:operator:: Bloom.intensity =(value: float)

Bloom intensity multiplier.


:Arguments: * **value** : float

.. _function-bloom_component__dot__rq_tint_Bloom:

.. das:operator:: Bloom.tint() : float3




.. _function-bloom_component__dot__rq_tint_rq_clone_Bloom_float3:

.. das:operator:: Bloom.tint =(value: float3)

Color tint of the bloom halation. Strengthens the effect per channel.


:Arguments: * **value** : float3