RealityRenderer

activeCamera

get activeCamera(): (Entity) | null

var activeCamera: Entity? { get set }

The camera to be used for rendering.

activeCamera

set activeCamera(value: (Entity) | null)

var activeCamera: Entity? { get set }

The camera to be used for rendering.

audioListener

get audioListener(): (Entity) | null

var audioListener: Entity? { get set }

The entity which defines the listener position and orientation for spatial audio. By default this `audioListener` property is nil, which means that the active camera entity will be used as the audio listener. The `audioListener` can be set to any entity in the `scene` to use the transform of the entity as the audio listener position and orientation.

audioListener

set audioListener(value: (Entity) | null)

var audioListener: Entity? { get set }

The entity which defines the listener position and orientation for spatial audio. By default this `audioListener` property is nil, which means that the active camera entity will be used as the audio listener. The `audioListener` can be set to any entity in the `scene` to use the transform of the entity as the audio listener position and orientation.

cameraSettings

get cameraSettings(): RealityRenderer_CameraSettings

var cameraSettings: RealityRenderer.CameraSettings

The settings to be used for rendering with `activeCamera`.

cameraSettings

set cameraSettings(value: RealityRenderer_CameraSettings)

var cameraSettings: RealityRenderer.CameraSettings

The settings to be used for rendering with `activeCamera`.

updateAndRender

updateAndRender(deltaTime: number, cameraOutput: RealityRenderer_CameraOutput, whenScheduled?: (((arg0: RealityRenderer) => void)) | null, onComplete?: (((arg0: RealityRenderer) => void)) | null, actionsBeforeRender?: Array<RealityRenderer_MetalEventAction>, actionsAfterRender?: Array<RealityRenderer_MetalEventAction>): Promise<void>

@MainActor @preconcurrency func updateAndRender(deltaTime: TimeInterval, cameraOutput: RealityRenderer.CameraOutput, whenScheduled: (@Sendable (RealityRenderer) -> Void)? = nil, onComplete: (@Sendable (RealityRenderer) -> Void)? = nil, actionsBeforeRender: [RealityRenderer.MetalEventAction] = [], actionsAfterRender: [RealityRenderer.MetalEventAction] = []) throws

Tick the simulation and render using activeCamera and the camera rendering output. - Parameters: - deltaTime: The delta time to advance the simulation - cameraOutput: Specifies output for rendering with ``activeCamera`` - whenScheduled: A handler that is called when the corresponding MTLCommandBuffer is scheduled - onComplete: A handler that is called when the corresponding MTLCommandBuffer is complete - actionsBeforeRender: Array of events and values to wait before GPU rendering work - actionsAfterRender: Array of events and values to signal after GPU rendering work

extendedDynamicRangeOutput

get extendedDynamicRangeOutput(): boolean

var extendedDynamicRangeOutput: Bool { get set }

Specify whether the target Metal layer has been configured for EDR output. If the Metal layer that this ``RealityRenderer`` will be rendering into has been configured to output extended dynamic range content (i.e. the property ``QuartzCore/CAMetalLayer/wantsExtendedDynamicRangeContent`` on the target ``QuartzCore/CAMetalLayer`` has been set to `true` and a pixel format that supports EDR content has been set), this property should be set to `true` so that ``RealityRenderer`` adjusts its tone mapping accordingly. To control the amount of headroom available for extended dynamic range content, see ``extendedDynamicRangeHeadroom``. The default value is `false`.

extendedDynamicRangeOutput

set extendedDynamicRangeOutput(value: boolean)

var extendedDynamicRangeOutput: Bool { get set }

Specify whether the target Metal layer has been configured for EDR output. If the Metal layer that this ``RealityRenderer`` will be rendering into has been configured to output extended dynamic range content (i.e. the property ``QuartzCore/CAMetalLayer/wantsExtendedDynamicRangeContent`` on the target ``QuartzCore/CAMetalLayer`` has been set to `true` and a pixel format that supports EDR content has been set), this property should be set to `true` so that ``RealityRenderer`` adjusts its tone mapping accordingly. To control the amount of headroom available for extended dynamic range content, see ``extendedDynamicRangeHeadroom``. The default value is `false`.

extendedDynamicRangeHeadroom

get extendedDynamicRangeHeadroom(): number

var extendedDynamicRangeHeadroom: Float { get set }

The amount of headroom available for extended dynamic range content. When EDR output is enabled using ``extendedDynamicRangeOutput``, standard dynamic range values output by this ``RealityRenderer`` will be scaled such that there's some _headroom_ to display extended range values. This value is in the range `[1.0-16.0]`. The default value is `2.0`.

extendedDynamicRangeHeadroom

set extendedDynamicRangeHeadroom(value: number)

var extendedDynamicRangeHeadroom: Float { get set }

The amount of headroom available for extended dynamic range content. When EDR output is enabled using ``extendedDynamicRangeOutput``, standard dynamic range values output by this ``RealityRenderer`` will be scaled such that there's some _headroom_ to display extended range values. This value is in the range `[1.0-16.0]`. The default value is `2.0`.

update

update(deltaTime: number): Promise<void>

@MainActor func update(_ deltaTime: TimeInterval) throws

Tick the simulation - Parameter deltaTime: The delta time to advance the simulation

entities

get entities(): Promise<RealityRenderer_EntityCollection>

@MainActor var entities: RealityRenderer.EntityCollection { get set }

A collection of RealityKit entities that this renderer renders within the scene.

entities

setEntities(value: RealityRenderer_EntityCollection): Promise<void>

@MainActor var entities: RealityRenderer.EntityCollection { get set }

A collection of RealityKit entities that this renderer renders within the scene.

lighting

get lighting(): Promise<RealityRenderer_ImageBasedLight>

@MainActor var lighting: RealityRenderer.ImageBasedLight { get set }

The lighting used in the environment of a particular scene.

lighting

setLighting(value: RealityRenderer_ImageBasedLight): Promise<void>

@MainActor var lighting: RealityRenderer.ImageBasedLight { get set }

The lighting used in the environment of a particular scene.

init

static init(): Promise<RealityRenderer>

@MainActor init() throws