Reference API Roblox

Engine API

Website

Related

Reference API Roblox

BloomEffect

Simulates the camera viewing a very bright light.

Memory categoryInstances

Member index 3

HistoryMember
726Intensity: float
726Size: float
726Threshold: float
inherited from PostEffect
726Enabled: bool
inherited from Instance
726Archivable: bool
726Capabilities: SecurityCapabilities
726IsInSandbox: bool
726Name: string
726Parent: Instance
726PredictionMode: PredictionMode
726Sandboxed: bool
726UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
726children(): Instances
726clone(): Instance
726destroy(): null
726findFirstChild(name: string, recursive: bool = false): Instance
726getChildren(): Instances
726isDescendantOf(ancestor: Instance): bool
726remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
726childAdded(child: Instance)
inherited from Object
726ClassName: string
726className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
726isA(className: string): bool
647Changed(property: string)

Description

The BloomEffect simulates the camera viewing a very bright light. It causes brighter colors to glow, similar to applying the neon Material to everything, including the Sky. Multiple BloomEffect objects can be applied at once and they will compose their effects together.

Like other post-processing effects, BloomEffect will only work while Enabled and when parented to Lighting or Workspace.CurrentCamera. Also, it may render differently depending on your Studio settings (see the Quality Level settings in Rendering → Performance).

For more details on this effect and others, see Post-Processing Effects.

History 16

Members 3

Intensity

TypeDefault
float

Intensity determines how intensely the colors that bloom (determined by the Threshold) will additively blend with themselves. Higher values will produce brighter colors.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 5

Size

TypeDefault
float

Size determines the radius of the bloom effect in pixels in a similar manner to BlurEffect.Size. Larger values create a wider bloom effect, and a value of 0 will disable the bleed (but not the color adjustment).

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 5

  • 726 Change Default of Size from 24 to
  • 553 Change Default of Size from to 24
  • 486 Change ThreadSafety of Size from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Size from to ReadOnly
  • 243 Add Size

Threshold

TypeDefault
float

Threshold determines how bright a color can be before it blooms. If set to 1, only pure white colors will bloom. If set to 0, all colors will bloom.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 5

Settings