RealityFoundation · IOS API REFERENCE

BloomOptionsComponent

struct · iOS 27.0+ · SDK 27.1

struct BloomOptionsComponent

A component that sets the properties for the bloom post-processing effects. This component has no effect without a BloomComponent in your scene. It's best to maintain a single BloomOptionsComponent in your scene. If more than one BloomOptionsComponent exists in your scene, one will be chosen based on proximity to the camera and depth in the entity hierarchy.

Members (7)

get · iOS 27.0+

blurRadius

TypeScript

get blurRadius(): number

Swift declaration

var blurRadius: Float

The width of the bloom blur kernel as a percentage of viewport height Valid range: `[3, 12]`

set · iOS 27.0+

blurRadius

TypeScript

set blurRadius(value: number)

Swift declaration

var blurRadius: Float

The width of the bloom blur kernel as a percentage of viewport height Valid range: `[3, 12]`

get · iOS 27.0+

strength

TypeScript

get strength(): number

Swift declaration

var strength: Float

The intensity of the bloom effect. Higher values create a more pronounced glow effect. The values can be be in the range `[0.0, 2.0]`, where: - `0.0` disables the bloom effect entirely - `0.25` provides a subtle bloom (default) - `1.0` creates a strong, dramatic bloom effect - `>1` extremely intense effects but may have some visual artifacts

set · iOS 27.0+

strength

TypeScript

set strength(value: number)

Swift declaration

var strength: Float

get · iOS 27.0+

threshold

TypeScript

get threshold(): number

Swift declaration

var threshold: Float

The brightness threshold for bloom activation. Only pixels with luminance values above this threshold will contribute to the bloom effect. The value is typically in the range `[0.0, 1.x]`: - `0.0` makes all pixels contribute to bloom - `1.0` standard threshold for HDR content (default) - `>1` only very bright highlights will bloom Higher thresholds create more selective bloom that only affects the brightest elements in the scene.

set · iOS 27.0+

threshold

TypeScript

set threshold(value: number)

Swift declaration

var threshold: Float

init · iOS 27.0+

init

TypeScript

static init(): BloomOptionsComponent

Swift declaration

init()

Creates a Bloom Options Component with default settings. The default configuration provides a moderate bloom effect with: - `strength`: 0.25 (25% bloom intensity) - `threshold`: 1.0 (pixels brighter than 1.0 will bloom) - `blurRadius`: 6 (6% of viewport height)

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →