One Logo Pool Ball
RealityFoundation · IOS API REFERENCE

DiffuseLightProbeReceiverComponent

struct · iOS 27.0+ · SDK 27.1

struct DiffuseLightProbeReceiverComponent

A component that receives diffuse lighting from a referenced probe group. Attach this component to entities that should receive spatially-varying diffuse indirect lighting. As the entity moves through the scene, the system automatically interpolates diffuse lighting from the probe group based on the entity's current position. This follows the same receiver pattern as `ImageBasedLightReceiverComponent`. ```swift character.components[DiffuseLightProbeReceiverComponent.self] = DiffuseLightProbeReceiverComponent(probeGroup: probeGroupEntity) ``` ## See Also - ``DiffuseLightProbeGroupComponent`` - ``DiffuseProbeResource``

Members (3)

get · iOS 27.0+

probeGroup

TypeScript
get probeGroup(): Entity
Swift declaration
var probeGroup: Entity

The entity providing diffuse probe lighting to this receiver. The referenced entity must have a ``DiffuseLightProbeGroupComponent`` attached and must exist within the scene hierarchy. The receiver's diffuse lighting is interpolated from probes in this group based on the receiver entity's position.

set · iOS 27.0+

probeGroup

TypeScript
set probeGroup(value: Entity)
Swift declaration
var probeGroup: Entity

The entity providing diffuse probe lighting to this receiver. The referenced entity must have a ``DiffuseLightProbeGroupComponent`` attached and must exist within the scene hierarchy. The receiver's diffuse lighting is interpolated from probes in this group based on the receiver entity's position.

init · iOS 27.0+

init

TypeScript
static init(probeGroup: Entity): DiffuseLightProbeReceiverComponent
Swift declaration
init(probeGroup: Entity)

Creates a diffuse light probe receiver component. - Parameter probeGroup: An entity with a ``DiffuseLightProbeGroupComponent`` attached.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →