.. role:: ts-api-decorator

##############
BloomLayerInfo
##############

.. container:: ts-api-section

   .. js:class:: BloomLayerInfo

      Describes a single layer in the bloom effect.

      See [[View.setBloomLayers]].



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-interface

   * :js:attr:`~BloomLayerInfo.blurInterval`
   * :js:attr:`~BloomLayerInfo.blurSamples`
   * :js:attr:`~BloomLayerInfo.intensity`





------------

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: BloomLayerInfo.blurInterval

      :type: (number, BlurIntervalUnit) :ts-api-decorator:`optional`

      The distance between samples taken during the Gaussian blur operation
      executed when rendering this layer.

      The [[BlurIntervalUnit.Pixels]] unit is interpreted based on the
      dimensions of the current layer, which are half the dimensions
      of the previous layer (or the source image if this is the first layer).

      Using ``[1, Pixels]`` will ensure that each pixel in the previous layer
      contributes to the current layer, but will cause the bloom size to
      be dependent on the canvas size. It may therefore be advisable to adjust
      the interval using [[BlurIntervalUnit.Pixels]] and translate it
      to one of the other units. This has been done for the default settings.

      If unspecified, the value will be ``[1, Pixels]``.



.. container:: ts-api-section

   .. js:attribute:: BloomLayerInfo.blurSamples

      :type: number :ts-api-decorator:`optional`

      The number of samples taken in each of the two passes of the
      Gaussian blur operation executed when rendering this layer.

      If unspecified, the value will be ``9``.



.. container:: ts-api-section

   .. js:attribute:: BloomLayerInfo.intensity

      :type: number :ts-api-decorator:`optional`

      A number used to scale the contribution of the layer to the image.
      Can be greater than ``1``.

      If unspecified, the value will be ``1``.

      See [[View.setBloomIntensityScale]].



