Technologies›AR & Spatial

USDKit

iOSmacOStvOSwatchOSvisionOS

USDKit manages Universal Scene Description layers and lets you compose spatial scenes through import, export, and hierarchical path-based access to scene elements. You work with a USDStage and its USDLayer and USDPrim values, reading and writing typed data through USDValue and USDToken and applying transforms with USDTransformOperation. The framework also models scene resources such as MeshData, MaterialData, TextureData, and DeformationData, each paired with an identifier like MeshID or MaterialID, and provides a USDPlayer for playing back stage content. It is available on iOS, macOS, tvOS, and visionOS.

Stages and Layers 4

The top-level containers that hold and compose Universal Scene Description content.

  • St
    USDStageiOS 27.0+
    A structure that composes USD layers into a unified scene you can read and edit.
  • St
    UsdStageiOS 27.0+
    A structure that represents an underlying USD stage of composed scene content.
  • St
    USDLayeriOS 27.0+
    A structure that represents a single Universal Scene Description layer of scene data.
  • St
    USDStageComponentiOS 27.0+
    A component that renders a USD stage as RealityKit entities.

Scene Hierarchy and Values 5

Path-based scene elements and the typed data you read and write on them.

  • St
    USDPrimiOS 27.0+
    A structure that represents a primitive scene element addressed by its hierarchical path.
  • St
    USDValueiOS 27.0+
    A type-erased container for a value stored in a Universal Scene Description
  • Pr
    USDValueProtocoliOS 27.0+
    A type that can be wrapped in a ``USDValue``.
  • St
    USDTokeniOS 27.0+
    A structure that represents an interned name token used to identify USD attributes and prims.
  • St
    USDTransformOperationiOS 27.0+
    A structure that describes a single transform applied to a prim, such as translation, rotation, or scale.

Playback 1

Types for playing back animated stage content.

  • Cl
    USDPlayeriOS 27.0+
    An object that plays back the content of a USD stage over time.

Mesh and Deformation Resources 4

Geometry and deformation data and the identifiers that reference them.

  • St
    MeshDataiOS 27.0+
    A structure that holds the geometry data for a mesh in a scene.
  • St
    MeshIDiOS 27.0+
    Mesh resource identifier
  • St
    DeformationDataiOS 27.0+
    A structure that holds deformation data applied to geometry in a scene.
  • St
    DeformationIDiOS 27.0+
    Deformation resource identifier

Material and Texture Resources 5

Surface appearance data and the identifiers and metadata that describe it.

  • St
    MaterialDataiOS 27.0+
    A structure that holds the material properties describing a surface's appearance.
  • St
    MaterialIDiOS 27.0+
    Material resource identifier
  • St
    TextureDataiOS 27.0+
    A structure that holds the image data for a texture used in a scene.
  • St
    TextureIDiOS 27.0+
    Texture resource identifier
  • St
    TextureLevelInfoiOS 27.0+
    A structure that describes the properties of a single mipmap level of a texture.

Extending the Framework 1

Protocols for plugging custom behavior into stage handling.

  • Pr
    StageKitPluginiOS 27.0+
    A protocol that custom plug-ins adopt to extend USDKit stage handling.

Rendering and Errors 2

Render-related messages and the errors that USDKit can report.

  • St
    USDRenderErroriOS 27.0+
    A structure that describes an error encountered while rendering USD content.
  • St
    UsdRenderMessageiOS 27.0+
    A structure that carries a message produced during USD rendering.

Extends 15

ArrayBoolIntInt32Int64UIntUInt32UInt64FloatDoubleStringInt8UInt8DictionaryNSNotification
← AR & Spatial