USDKit · IOS API REFERENCE

USDPrim.Payload

struct · iOS 27.0+ · SDK 27.1

struct Payload

A payload to an external asset. Payloads are similar to references but designed for deferred loading. Heavy assets like detailed geometry can be added as payloads and loaded on demand rather than at composition time.

Members (7)

get · iOS 27.0+

layerOffset

TypeScript

get layerOffset(): USDLayer_TimeOffset

Swift declaration

var layerOffset: USDLayer.TimeOffset { get set }

Time-axis remap applied to the payload's animation.

set · iOS 27.0+

layerOffset

TypeScript

set layerOffset(value: USDLayer_TimeOffset)

Swift declaration

var layerOffset: USDLayer.TimeOffset { get set }

Time-axis remap applied to the payload's animation.

get · iOS 27.0+

primPath

TypeScript

get primPath(): (USDLayer_Path) | null

Swift declaration

var primPath: USDLayer.Path? { get set }

The target prim path within the referenced asset, or `nil` to use the asset's default prim.

set · iOS 27.0+

primPath

TypeScript

set primPath(value: (USDLayer_Path) | null)

Swift declaration

var primPath: USDLayer.Path? { get set }

The target prim path within the referenced asset, or `nil` to use the asset's default prim.

init · iOS 27.0+

init

TypeScript

static init(assetPath?: (string) | null, primPath?: (USDLayer_Path) | null, layerOffset?: USDLayer_TimeOffset): USDPrim_Payload

Swift declaration

init(assetPath: String? = nil, primPath: USDLayer.Path? = nil, layerOffset: USDLayer.TimeOffset = USDLayer.TimeOffset())

Creates a payload. - Parameters: - assetPath: The asset path to target. Pass `nil` if not yet set. - primPath: The prim path within the referenced asset. Pass `nil` to use the asset's default prim. - layerOffset: The time transformation applied during composition.

get · iOS 27.0+

assetPath

TypeScript

get assetPath(): (string) | null

Swift declaration

var assetPath: String? { get set }

The asset path the payload targets, or `nil` if not yet set.

set · iOS 27.0+

assetPath

TypeScript

set assetPath(value: (string) | null)

Swift declaration

var assetPath: String? { get set }

The asset path the payload targets, or `nil` if not yet set.

Skipped declarations

No declarations were skipped in this snapshot.

All USDKit types →