Package com.google.android.filament

Class View.BloomOptions

  • Enclosing class:
    View
    public static class View.BloomOptions
extends java.lang.Object
    Options for controlling the Bloom effect enabled: Enable or disable the bloom post-processing effect. Disabled by default. levels: Number of successive blurs to achieve the blur effect, the minimum is 3 and the maximum is 11. This value together with resolution influences the spread of the blur effect. This value can be silently reduced to accommodate the original image size. resolution: Resolution of bloom's vertical axis. The minimum value is 2^levels and the the maximum is lower of the original resolution and 2048. This parameter is silently clamped to the minimum and maximum. It is highly recommended that this value be smaller than the target resolution after dynamic resolution is applied (horizontally and vertically). strength: how much of the bloom is added to the original image. Between 0 and 1. blendMode: Whether the bloom effect is purely additive (false) or mixed with the original image (true). anamorphism: Bloom's aspect ratio (x/y), for artistic purposes. threshold: When enabled, a threshold at 1.0 is applied on the source image, this is useful for artistic reasons and is usually needed when a dirt texture is used. dirt: A dirt/scratch/smudges texture (that can be 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. dirtStrength: Strength of the dirt texture.
    See Also:
    View.setBloomOptions(com.google.android.filament.View.BloomOptions)

    • Constructor Summary

      Constructors 
      Constructor Description
      BloomOptions()  

    • Method Summary

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • dirt

        @Nullable
public Texture dirt
        User provided dirt texture

      • dirtStrength

        public float dirtStrength
        strength of the dirt texture

      • strength

        public float strength
        Strength of the bloom effect, between 0.0 and 1.0

      • resolution

        public int resolution
        Resolution of minor axis (2^levels to 2048)

      • anamorphism

        public float anamorphism
        Bloom x/y aspect-ratio (1/32 to 32)

      • levels

        public int levels
        Number of blur levels (3 to 11)

      • threshold

        public boolean threshold
        Whether to threshold the source

      • enabled

        public boolean enabled
        enable or disable bloom

      • highlight

        public float highlight
        limit highlights to this value before bloom. Use +inf for no limiting. minimum value is 10.0.

      • lensFlare

        public boolean lensFlare
        enable screen-space lens flare

      • starburst

        public boolean starburst
        enable starburst effect on lens flare

      • chromaticAberration

        public float chromaticAberration
        amount of chromatic aberration

      • ghostCount

        public int ghostCount
        number of flare "ghosts"

      • ghostSpacing

        public float ghostSpacing
        spacing of the ghost in screen units [0, 1[

      • ghostThreshold

        public float ghostThreshold
        hdr threshold for the ghosts

      • haloThickness

        public float haloThickness
        thickness of halo in vertical screen units, 0 to disable

      • haloRadius

        public float haloRadius
        radius of halo in vertical screen units [0, 0.5]

      • haloThreshold

        public float haloThreshold
        hdr threshold for the halo

    • Constructor Detail

      • BloomOptions

        public BloomOptions()