Open Asterune
BloomEffect

BloomEffect

Adds bloom around bright pixels.

Creatable
Instance.new("BloomEffect")
Inherits
PostEffectInstance
Replication
Standard

Behavior

BloomEffect adds bloom around bright pixels.

Summary

Members8
Properties7
  • Enabled: boolean = trueparallel read

    Whether this post-processing effect is applied to the rendered image.

  • EnergyConserving: boolean = falseparallel read

    Whether bloom redistributes image energy instead of only adding brightness.

  • Intensity: number = 0.4parallel read

    The strength of the rendered effect.

  • NeonGlow: number = 1parallel read

    The bloom contribution from neon materials.

  • NeonGlowSize: number = 1parallel read

    The spread of bloom around neon materials.

  • Size: number = 24parallel read

    The spatial extent of the image blur.

  • Threshold: number = 1parallel read

    The brightness threshold above which bloom is applied.

Methods1

Properties

Enabled

BloomEffect.Enabled: boolean = true

Whether this post-processing effect is applied to the rendered image.

EnergyConserving

BloomEffect.EnergyConserving: boolean = false

Whether bloom redistributes image energy instead of only adding brightness.

Intensity

BloomEffect.Intensity: number = 0.4

The strength of the rendered effect.

NeonGlow

BloomEffect.NeonGlow: number = 1

The bloom contribution from neon materials.

NeonGlowSize

BloomEffect.NeonGlowSize: number = 1

The spread of bloom around neon materials.

Size

BloomEffect.Size: number = 24

The spatial extent of the image blur.

Threshold

BloomEffect.Threshold: number = 1

The brightness threshold above which bloom is applied.

Methods

GetExecutionGroup

BloomEffect:GetExecutionGroup(): ExecutionGroup?

Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.

Inherited members

Inherited47
Instance47
Properties
ArchivableClassNameNameParent
Methods
AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
Events
AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying

Related APIs

PostEffect