_USDKit_RealityKit · IOS API REFERENCE

USDPlayer

class · iOS 27.0+ · SDK 27.1

final class USDPlayer

Drives timeline playback of a USD stage and produces per-frame render data.

Members (3)

method · iOS 27.0+

TypeScript

importCustomIBLTexture(data: ArrayBuffer): USDPlayer_TextureData

Swift declaration

final func importCustomIBLTexture(data: Data) throws -> USDPlayer.TextureData

Imports a custom IBL texture. Expects input data from an HDR image.

init · iOS 27.0+

TypeScript

static initStageGpuFamily(stage: _USDKit_USDStage, gpuFamily: _Metal_MTLGPUFamily): USDPlayer

Swift declaration

convenience init(stage: USDStage, gpuFamily: MTLGPUFamily)

Creates a Metal-less player for the given USD stage. `gpuFamily` is required for CPU-side texture processing.

init · iOS 27.0+

TypeScript

static initStage(stage: _USDKit_USDStage): USDPlayer

Swift declaration

convenience init(stage: USDStage)

Creates a Metal-enabled player for the given USD stage.

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

USDPlayer.update(timeCode:)

The iOS SDK compiler rejected this binding: cannot convert value of type 'USDPlayer.FrameUpdate?' to expected argument type 'Any?'