USD Core API Reference

The version of USD supported in this package release is v23.02.

Overview

This package provides a C# API which mirrors the names and parameters of the methods in the corresponding USD C++ API. In many cases the C# API methods call directly through to their C++ equivalent.

All of the common USD modules are provided, such as Usd, UsdGeom, UsdShade, Sdf, and more. However, because this package is still in development, there are still some modules, APIs, and methods which are not yet availiable as C# API bindings.

Here are some examples of the mapping from C# to C++:

C#	C++
UsdStage.Open(string filePath, UsdStage.InitialLoadSet load)	USDStage::Open(const std::string& filePath, InitialLoadSet load=LoadAll)
USDShadeShader.GetInput(TfToken name)	UsdShadeShader::GetInput(const TfToken &name) const
UsdPrim.ApplyAPI(TfToken schemaIdentifier, TfToken instanceName)	UsdPrim::ApplyAPI(const TfToken &schemaIdentifier, const TfToken &instanceName) const

We recommend consulting the API documentation at OpenUSD API to find detailed instructions on how to use the API.

Disclaimer

The primary purpose of this USD Core package pre-release is to support the requirements of the Unity USD Importer and USD Exporter packages.

This package is at the pre-release state in Unity's package lifecycle. As such the OpenUSD API coverage and documentation provided by this package are still evolving. Bugs, feedback and features requests can be logged by following the guidance here..