RealityFoundation · IOS API REFERENCE

VirtualEnvironmentProbeComponent.Probe

struct · iOS 18.0+ · SDK 27.1

struct Probe

A sample of the environment around a point in a scene the system uses for environment-based lighting.

Members (5)

init · iOS 18.0+

init

TypeScript

static init(environment: EnvironmentResource, intensityExponent?: number): VirtualEnvironmentProbeComponent_Probe

Swift declaration

init(environment: EnvironmentResource, intensityExponent: Float = 0)

Creates a virtual-environment probe from an environment resource and intensity value. - Parameters: - environment: An environment resource. - intensityExponent: An intensity value for the resource.

get · iOS 18.0+

environment

TypeScript

get environment(): EnvironmentResource

Swift declaration

var environment: EnvironmentResource

The resource that stores a representation of diffuse and specular environment lighting.

set · iOS 18.0+

environment

TypeScript

set environment(value: EnvironmentResource)

Swift declaration

var environment: EnvironmentResource

The resource that stores a representation of diffuse and specular environment lighting.

get · iOS 18.0+

intensityExponent

TypeScript

get intensityExponent(): number

Swift declaration

var intensityExponent: Float

The intensity value for the resource, which RealityKit defines on a logarithmic scale. RealityKit multiplies the intensity of the probe by `2^intensityExponent`. An `intensityExponent` of `0.0` means using the diffuse and specular intensities as-is.

set · iOS 18.0+

intensityExponent

TypeScript

set intensityExponent(value: number)

Swift declaration

var intensityExponent: Float

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →