Class BloomSettings

Contains settings for Bloom effect rendering.

System.Object
BloomSettings
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public sealed class BloomSettings : ValueType

Fields

BlurSigma

This affects the fall-off of the bloom. It's the standard deviation (sigma) used in the Gaussian blur formula when calculating the kernel of the bloom.

Declaration
[Limit(0F, 20F, 0.01F)]
[EditorOrder(3)]
public float BlurSigma
Field Value
System.Single

Enabled

If checked, bloom effect will be rendered.

Declaration
[EditorOrder(0)]
public bool Enabled
Field Value
System.Boolean

Intensity

Bloom effect strength. Set a value of 0 to disabled it, while higher values increase the effect.

Declaration
[Limit(0F, 20F, 0.01F)]
[EditorOrder(1)]
public float Intensity
Field Value
System.Single

Limit

Bloom effect brightness limit. Pixels with higher luminance will be capped to this brightness level.

Declaration
[Limit(0F, 100F, 0.01F)]
[EditorOrder(4)]
public float Limit
Field Value
System.Single

Threshold

Minimum pixel brightness value to start blooming. Values below this threshold are skipped.

Declaration
[Limit(0F, 15F, 0.01F)]
[EditorOrder(2)]
public float Threshold
Field Value
System.Single

Properties

Default

The default BloomSettings.

Declaration
public static BloomSettings Default { get; }
Property Value
BloomSettings

Extension Methods