One Logo Pool Ball
App Frameworks · IOS API REFERENCE

USDKit

Author, compose, and manipulate Universal Scene Description content from Swift.

126 types

1,004 callable entries

56 skipped

95% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

USDArray

struct · iOS 27.0+

USDArray.ArrayLiteralElement

typealias · iOS 27.0+

USDArray.Index

typealias · iOS 27.0+

USDArray.Indices

typealias · iOS 27.0+

USDArray.Iterator

typealias · iOS 27.0+

USDArray.SubSequence

typealias · iOS 27.0+

USDLayer

struct · iOS 27.0+

USDLayer.AssetPath

struct · iOS 27.0+

USDLayer.AssetPath.ExtendedGraphemeClusterLiteralType

typealias · iOS 27.0+

USDLayer.AssetPath.StringLiteralType

typealias · iOS 27.0+

USDLayer.AssetPath.UnicodeScalarLiteralType

typealias · iOS 27.0+

USDLayer.ChangeList

struct · iOS 27.0+

USDLayer.ChangeList.Entry

struct · iOS 27.0+

USDLayer.ChangeList.Entry.Flags

struct · iOS 27.0+

USDLayer.ChangeList.Entry.InfoChange

struct · iOS 27.0+

USDLayer.ListOperation

struct · iOS 27.0+

USDLayer.ListOperationType

enum · iOS 27.0+

USDLayer.OpenOptions

struct · iOS 27.0+

USDLayer.OpenOptions.ArrayLiteralElement

typealias · iOS 27.0+

USDLayer.Path

struct · iOS 27.0+

USDLayer.Path.ExtendedGraphemeClusterLiteralType

typealias · iOS 27.0+

USDLayer.Path.Kind

enum · iOS 27.0+

USDLayer.Path.StringInterpolation

typealias · iOS 27.0+

USDLayer.Path.StringLiteralType

typealias · iOS 27.0+

USDLayer.Path.UnicodeScalarLiteralType

typealias · iOS 27.0+

USDLayer.PathExpression

struct · iOS 27.0+

USDLayer.PathExpression.ExtendedGraphemeClusterLiteralType

typealias · iOS 27.0+

USDLayer.PathExpression.StringLiteralType

typealias · iOS 27.0+

USDLayer.PathExpression.UnicodeScalarLiteralType

typealias · iOS 27.0+

USDLayer.Permission

enum · iOS 27.0+

USDLayer.Relocate

typealias · iOS 27.0+

USDLayer.RelocatesMap

typealias · iOS 27.0+

USDLayer.Spec

struct · iOS 27.0+

USDLayer.Spec.FieldCollection

protocol · iOS 27.0+

USDLayer.Spec.MetadataCollection

protocol · iOS 27.0+

USDLayer.SpecType

enum · iOS 27.0+

USDLayer.TimeCode

struct · iOS 27.0+

USDLayer.TimeCode.FloatLiteralType

typealias · iOS 27.0+

USDLayer.TimeOffset

struct · iOS 27.0+

USDPrim

struct · iOS 27.0+

USDPrim.Attribute

struct · iOS 27.0+

USDPrim.Attribute.Spec

struct · iOS 27.0+

USDPrim.Attribute.Value

protocol · iOS 27.0+

USDPrim.Attribute.ValueType

struct · iOS 27.0+

USDPrim.Attribute.ValueType.TupleDimensions

enum · iOS 27.0+

USDPrim.InheritCollection

struct · iOS 27.0+

USDPrim.ListPosition

enum · iOS 27.0+

USDPrim.Payload

struct · iOS 27.0+

USDPrim.PayloadCollection

struct · iOS 27.0+

USDPrim.Predicate

struct · iOS 27.0+

USDPrim.Predicate.ArrayLiteralElement

typealias · iOS 27.0+

USDPrim.Property

struct · iOS 27.0+

USDPrim.Property.Spec

struct · iOS 27.0+

USDPrim.Property.Spec.SymmetryCollection

protocol · iOS 27.0+

USDPrim.Property.Spec.ValueCollection

protocol · iOS 27.0+

USDPrim.Property.Variability

enum · iOS 27.0+

USDPrim.PseudoRootSpec

struct · iOS 27.0+

USDPrim.Reference

struct · iOS 27.0+

USDPrim.ReferenceCollection

struct · iOS 27.0+

USDPrim.Relationship

struct · iOS 27.0+

USDPrim.Relationship.Spec

struct · iOS 27.0+

USDPrim.Spec

struct · iOS 27.0+

USDPrim.SpecializeCollection

struct · iOS 27.0+

USDPrim.Specifier

enum · iOS 27.0+

USDPrim.VariantSelectionMap

typealias · iOS 27.0+

USDPrim.VariantSet

struct · iOS 27.0+

USDPrim.VariantSetCollection

struct · iOS 27.0+

USDPrim.VariantSetSpec

struct · iOS 27.0+

USDPrim.VariantsMap

typealias · iOS 27.0+

USDPrim.VariantSpec

struct · iOS 27.0+

USDStage

struct · iOS 27.0+

USDStage.EditTarget

struct · iOS 27.0+

USDStage.ExportOptions

struct · iOS 27.0+

USDStage.ExportOptions.ArrayLiteralElement

typealias · iOS 27.0+

USDStage.ExportOptions.TextureQuality

struct · iOS 27.0+

USDStage.InitialLoadRule

enum · iOS 27.0+

USDStage.Notice

protocol · iOS 27.0+

USDStage.Object

struct · iOS 27.0+

USDStage.Object.MetadataCollection

protocol · iOS 27.0+

USDStage.Object.MetadataValue

protocol · iOS 27.0+

USDStage.ObjectsDidChange

struct · iOS 27.0+

USDStage.ObservationToken

struct · iOS 27.0+

USDStage.OpenOptions

struct · iOS 27.0+

USDStage.OpenOptions.ArrayLiteralElement

typealias · iOS 27.0+

USDStage.TimeCode

struct · iOS 27.0+

USDStage.TimeCode.FloatLiteralType

typealias · iOS 27.0+

USDToken

struct · iOS 27.0+

USDToken.ExtendedGraphemeClusterLiteralType

typealias · iOS 27.0+

USDToken.StringLiteralType

typealias · iOS 27.0+

USDToken.UnicodeScalarLiteralType

typealias · iOS 27.0+

USDTransformOperation

struct · iOS 27.0+

USDTransformOperation.Kind

enum · iOS 27.0+

USDTransformOperation.Precision

enum · iOS 27.0+

USDValue

struct · iOS 27.0+

USDValue.Matrix2d

struct · iOS 27.0+

USDValue.Matrix2d.VectorType

typealias · iOS 27.0+

USDValue.Matrix2f

struct · iOS 27.0+

USDValue.Matrix2f.VectorType

typealias · iOS 27.0+

USDValue.Matrix3d

struct · iOS 27.0+

USDValue.Matrix3d.VectorType

typealias · iOS 27.0+

USDValue.Matrix3f

struct · iOS 27.0+

USDValue.Matrix3f.VectorType

typealias · iOS 27.0+

USDValue.Matrix4d

struct · iOS 27.0+

USDValue.Matrix4d.VectorType

typealias · iOS 27.0+

USDValue.Matrix4f

struct · iOS 27.0+

USDValue.Matrix4f.VectorType

typealias · iOS 27.0+

USDValue.Quatd

struct · iOS 27.0+

USDValue.Quatf

struct · iOS 27.0+

USDValue.Quath

struct · iOS 27.0+

USDValue.Vec2d

struct · iOS 27.0+

USDValue.Vec2f

struct · iOS 27.0+

USDValue.Vec2h

struct · iOS 27.0+

USDValue.Vec2i

struct · iOS 27.0+

USDValue.Vec3d

struct · iOS 27.0+

USDValue.Vec3d.ArrayLiteralElement

typealias · iOS 27.0+

USDValue.Vec3f

struct · iOS 27.0+

USDValue.Vec3f.ArrayLiteralElement

typealias · iOS 27.0+

USDValue.Vec3h

struct · iOS 27.0+

USDValue.Vec3i

struct · iOS 27.0+

USDValue.Vec4d

struct · iOS 27.0+

USDValue.Vec4d.ArrayLiteralElement

typealias · iOS 27.0+

USDValue.Vec4f

struct · iOS 27.0+

USDValue.Vec4f.ArrayLiteralElement

typealias · iOS 27.0+

USDValue.Vec4h

struct · iOS 27.0+

USDValue.Vec4i

struct · iOS 27.0+

USDValueProtocol

protocol · iOS 27.0+

Functions and constants

get · iOS 27.0+

startIndex

TypeScript
get startIndex(): number
Swift declaration
var startIndex: Int { get }

The position of the first element in a nonempty collection. If the collection is empty, `startIndex` is equal to `endIndex`.

method · iOS 27.0+

index

TypeScript
indexAfter(i: number): number
Swift declaration
func index(after i: Int) -> Int

Returns the position immediately after the given index. The successor of an index must be well defined. For an index `i` into a collection `c`, calling `c.index(after: i)` returns the same index every time. - Parameter i: A valid index of the collection. `i` must be less than `endIndex`. - Returns: The index value immediately after `i`.

method · iOS 27.0+

index

TypeScript
indexBefore(i: number): number
Swift declaration
func index(before i: Int) -> Int

Returns the position immediately before the given index. - Parameter i: A valid index of the collection. `i` must be greater than `startIndex`. - Returns: The index value immediately before `i`.

method · iOS 27.0+

append

TypeScript
append(newElement: number): void
Swift declaration
mutating func append(_ newElement: Element)
get · iOS 27.0+

endIndex

TypeScript
get endIndex(): number
Swift declaration
var endIndex: Int { get }

The collection's "past the end" position---that is, the position one greater than the last valid subscript argument. When you need a range that includes the last element of a collection, use the half-open range operator (`..<`) with `endIndex`. The `..<` operator creates a range that doesn't include the upper bound, so it's always safe to use with `endIndex`. For example: let numbers = [10, 20, 30, 40, 50] if let index = numbers.firstIndex(of: 30) { print(numbers[index ..< numbers.endIndex]) } // Prints "[30, 40, 50]" If the collection is empty, `endIndex` is equal to `startIndex`.

get · iOS 27.0+

valueType

TypeScript
static get valueType(): USDPrim_Attribute_ValueType
Swift declaration
static var valueType: USDPrim.Attribute.ValueType { get }
init · iOS 27.0+

init

TypeScript
static init(): USDArray<number>
Swift declaration
init()
init · iOS 27.0+

init

TypeScript
static init98238(): USDArray<number>
Swift declaration
init()
init · iOS 27.0+

init

TypeScript
static init38428(): USDArray<number>
Swift declaration
init()
subscript · iOS 27.0+

subscript

TypeScript
subscript(index: number): number
Swift declaration
subscript(index: Int) -> Element { get }

Accesses the element at the specified position. The following example accesses an element of an array through its subscript to print its value: var streets = ["Adams", "Bryant", "Channing", "Douglas", "Evarts"] print(streets[1]) // Prints "Bryant" You can subscript a collection with any valid index other than the collection's end index. The end index refers to the position one past the last element of a collection, so it doesn't correspond with an element. - Parameter position: The position of the element to access. `position` must be a valid index of the collection that is not equal to the `endIndex` property. - Complexity: O(1)

get · iOS 27.0+

isExplicit

TypeScript
get isExplicit(): boolean
Swift declaration
var isExplicit: Bool { get }

Whether the operation is in explicit mode — i.e., its items replace the entire list during composition.

method · iOS 27.0+

clearAndMakeExplicit

TypeScript
clearAndMakeExplicit(): void
Swift declaration
mutating func clearAndMakeExplicit()

Removes all authored slots and switches to explicit mode with no items.

method · iOS 27.0+

clear

TypeScript
clear(): void
Swift declaration
mutating func clear()

Removes all authored slots, leaving an empty operation.

method · iOS 27.0+

compose

TypeScript
compose(stronger: USDLayer_ListOperation<SDKHandle>, operation: USDLayer_ListOperationType): void
Swift declaration
mutating func compose(stronger: USDLayer.ListOperation<T>, for operation: USDLayer.ListOperationType)

Composes a stronger operation into this one for the given slot. - Parameters: - stronger: The stronger operation to compose into this one. - operation: The slot to update.

get · iOS 27.0+

hasKeys

TypeScript
get hasKeys(): boolean
Swift declaration
var hasKeys: Bool { get }

Whether any operation slot has been authored.

init · iOS 27.0+

init

TypeScript
static initExplicitItems(explicitItems: Array<number>): USDLayer_ListOperation<number>
Swift declaration
init(explicitItems: [Int])
init · iOS 27.0+

init

TypeScript
static initPrependedItemsAppendedItemsDeletedItems(prependedItems?: Array<number>, appendedItems?: Array<number>, deletedItems?: Array<number>): USDLayer_ListOperation<number>
Swift declaration
init(prependedItems: [Int] = [], appendedItems: [Int] = [], deletedItems: [Int] = [])
init · iOS 27.0+

init

TypeScript
static initExplicitItems13658(explicitItems: Array<number>): USDLayer_ListOperation<number>
Swift declaration
init(explicitItems: [UInt])
init · iOS 27.0+

init

TypeScript
static initPrependedItemsAppendedItemsDeletedItems70000(prependedItems?: Array<number>, appendedItems?: Array<number>, deletedItems?: Array<number>): USDLayer_ListOperation<number>
Swift declaration
init(prependedItems: [UInt] = [], appendedItems: [UInt] = [], deletedItems: [UInt] = [])

Skipped declarations

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

USDLayer.OpenOptions.init(arrayLiteral:)

A variable number of Swift arguments is not supported.

USDLayer.ListOperation.init(explicitItems:)

This declaration needs Swift generic type arguments. (no canonical witness for T)

USDLayer.ListOperation.init(prependedItems:appendedItems:deletedItems:)

The containing type needs Swift generic type arguments. (no canonical witness for T)

USDLayer.ListOperation.has(item:)

This declaration needs Swift generic type arguments. (no canonical witness for T)

USDLayer.ListOperation.items(for:)

This declaration needs Swift generic type arguments. (no canonical witness for T)

USDLayer.ListOperation.appliedItems

This declaration needs Swift generic type arguments. (no canonical witness for T)

USDLayer.ListOperation.setItems(_:for:)

This declaration needs Swift generic type arguments. (no canonical witness for T)

USDLayer.ListOperation.replaceItems(in:at:count:with:)

This declaration needs Swift generic type arguments. (no canonical witness for T)

USDArray.init(_:)

This parameter hides a concrete Swift type.

USDArray.init(arrayLiteral:)

A variable number of Swift arguments is not supported.

USDArray.init(_:)

This parameter hides a concrete Swift type.

USDArray.init(arrayLiteral:)

A variable number of Swift arguments is not supported.

USDPrim.subscript(_:as:)

Passing a Swift type itself is not supported.

USDPrim.subscript(_:as:)

Passing a Swift type itself is not supported.

USDPrim.subscript(_:as:)

Passing a Swift type itself is not supported.

USDPrim.subscript(_:as:)

Passing a Swift type itself is not supported.

USDStage.Object.MetadataCollection.metadata(_:)

The iOS SDK compiler rejected this binding: ambiguous use of 'metadata'

USDStage.Object.MetadataCollection.metadata(_:keyPath:)

The iOS SDK compiler rejected this binding: ambiguous use of 'metadata(_:keyPath:)'

USDStage.Object.MetadataCollection.metadata(_:)

The iOS SDK compiler rejected this binding: ambiguous use of 'metadata'

USDStage.Object.MetadataCollection.metadata(_:keyPath:)

The iOS SDK compiler rejected this binding: ambiguous use of 'metadata(_:keyPath:)'

USDPrim.Predicate.init(arrayLiteral:)

A variable number of Swift arguments is not supported.

USDStage.OpenOptions.init(arrayLiteral:)

A variable number of Swift arguments is not supported.

USDStage.Object.MetadataCollection.isHidden

The iOS SDK compiler rejected this binding: cannot assign to property: 'o' is a 'let' constant

USDStage.Object.MetadataCollection.customData

The iOS SDK compiler rejected this binding: cannot assign to property: 'o' is a 'let' constant

USDStage.Object.MetadataCollection.assetInfo

The iOS SDK compiler rejected this binding: cannot assign to property: 'o' is a 'let' constant

USDStage.Object.MetadataCollection.documentation

The iOS SDK compiler rejected this binding: cannot assign to property: 'o' is a 'let' constant

USDStage.Object.MetadataCollection.displayName

The iOS SDK compiler rejected this binding: cannot assign to property: 'o' is a 'let' constant

USDStage.addObserver(for:using:)

Passing a Swift type itself is not supported.

USDValue.Vec3d.init(arrayLiteral:)

A variable number of Swift arguments is not supported.

USDValue.Vec3f.init(arrayLiteral:)

A variable number of Swift arguments is not supported.