Universal Scene Description
Exporting to USD Files
Universal Scene Description (USD) files can contain complex layering, overriding, and references to other files. Blender’s USD Exporter takes a much simpler approach. When exporting, all visible, supported objects in the scene are exported, optionally limited by their selection state. Blender does not (yet) support exporting invisible objects, USD layers, variants, skeletal animation, etc.
The following objects can be exported to USD:
Meshes (of different kinds, see below).
Cameras (perspective cameras only at the moment, not orthogonal ones).
Light (all types except area lights).
Hair (exported as curves, and limited to parent strands).
Volume (both static and animated volumes).
When exporting an animation, the final, evaluated mesh is written to USD. This means that the following meshes can be exported:
Deforming meshes; here the topology of the mesh does not change, but the locations of the vertices change over time. Examples are animated characters or bouncing (but not cracking) objects.
Arbitrarily animated meshes; here the topology does change. An example is the result of a fluid simulation, where splashes of fluid can break off the main body.
Metaballs are exported as animated meshes.
To export the Blender scene as a USDZ archive, set the file extension of the output file to .usdz. The exported USDZ package will be a zip archive containing the USD and its texture file dependencies.
The following options are available when exporting to USD:
- Selection Only
When checked, only selected objects are exported. Instanced objects, for example collections that are instanced in the scene, are considered ’selected’ when their instancer is selected.
- Visible Only
Only exports objects that are not hidden. Invisible parents of exported objects are exported as empty transforms.
When checked, the entire scene frame range is exported. When unchecked, only the current scene frame is exported.
When checked, parent hair strands are exported as a curve system. Hair strand colors are not exported.
- UV Maps
When checked, includes UV coordinates for exported meshes. The name of the UV map in USD is the same as the name in Blender. In USD the default name is
stwhereas in Blender the default name is
UVMap. To export to the standard UV map name
st, rename the UV map in Blender to
When checked, includes normals for exported meshes. This includes custom loop normals.
Exports material information of the object. By default the exporter approximates the Principled BSDF node tree by converting it to USD’s Preview Surface format. If To USD Preview Surface is disabled, the material is set to the viewport materials of meshes.
Additional material properties are set in the Material grouping of options.
When a mesh has multiple materials assigned, a geometry subset is created for each material. The first material (if any) is always applied to the mesh itself as well (regardless of the existence of geometry subsets), because the Hydra viewport does not support materials on subsets. See USD issue #542 for more information.
- Root Prim
If set, add a transform primitive with the given path to the stage as the parent of all exported data.
- Use Settings for
Determines the whether to use Viewport or Render visibility of collection, modifiers, or any other property that can be set for both the Viewport and Render.
Additional options when Materials are enabled for export.
- To USD Preview Surface
When exporting materials, approximate a Principled BSDF node tree to by converting it to USD’s Preview Surface format. If disabled, the material is set to the viewport materials of meshes.
Not all nodes are supported; currently only Diffuse, Principle, Image Textures, and UVMap nodes are support.
- Export Textures
Export textures referenced by shader nodes to a ”textures” folder which in the same directory as the USD file.
- Overwrite Textures
Allow overwriting existing texture files when exporting textures.
- Relative Paths
Use relative paths to reference external files (i.e. textures, volumes) in the exported USD file, otherwise use absolute paths.
As this is an experimental option. When unchecked, duplicated objects are exported as real objects, so a particle system with 100 particles that is displayed with 100 meshes will have 100 individual meshes in the exported file. When checked, duplicated objects are exported as a reference to the original object. If the original object is not part of the export, the first duplicate is exported as real object and used as reference.
- Single-sided and Double-sided Meshes
USD seems to support neither per-material nor per-face-group double-sidedness, so Blender uses the flag from the first material to mark the entire mesh as single/double-sided. If there is no material it defaults to double-sided.
- Mesh Normals
The mesh subdivision scheme in USD is ’Catmull-Clark’ by default, but Blender uses ’None’ instead, indicating that a polygonal mesh is exported. This is necessary for USD to understand the custom normals; otherwise the mesh is always rendered smooth.
- Vertex Velocities
Currently only fluid simulations (not meshes in general) have explicit vertex velocities. This is the most important case for exporting velocities, though, as the baked mesh changes topology all the time, and thus computing the velocities at import time in a post-processing step is hard.
- Coordinate System Orientation
Blender uses the Z axis as up axis. Since USD supports both Y up and Z up, the USD files written by Blender always use Z up.
Very simple versions of the materials are exported, using only the Viewport Display color, metallic, and roughness.
When there are multiple materials, the mesh faces are stored as geometry subset and each material is assigned to the appropriate subset. If there is only one material this is skipped. Note that the geometry subsets are not time-sampled, so it may break when an animated mesh changes topology.
Only the parent strands are exported, and only with a constant color. No UV coordinates, and no information about the normals.
Only perspective cameras are exported.
USD does not directly support spot lights, so those are not exported.
Particles are only written when they are alive, which means that they are always visible. There is currently no code that deals with marking them as invisible outside their lifespan.
Objects instanced by particle system are exported by suffixing the object name with the particle’s persistent ID, giving each particle transform a unique name.
This is still an experimental feature that can be enabled when exporting to USD. When enabled, instanced object meshes are written to USD as references to the original mesh. The first copy of the mesh is written for real, and the following copies are referencing the first. Which mesh is considered ’the first’ is chosen more or less arbitrarily.
Due to a current limitation in the USD library, UDIM textures cannot be include in the USDZ archive. This limitation will likely be addressed in a future version of USD. (See USD pull request #2133.)
Importing USD Files
USD files typically represent the scene as a hierarchy of primitives, or prims. Individual prims contain data to describe scene entities, such as geometry, lights, cameras and transform hierarchies. Blender’s USD importer converts USD prims to a hierarchy of Blender objects. Like the USD exporter, the importer does not yet handle more advanced USD concepts, such as layers and references.
The following USD data types can be imported as Blender objects:
For more information on how the various data types are handled, see the following descriptions of the Import Options.
When importing a USDZ archive, it is important to carefully consider the Import Textures option to determine whether and how to copy texture files from the zip archive.
Xform and Scope Primitives
USD provides an
Xform prim type, containing transform data, which can be
used to represent transform hierarchies and to organize the scene.
Xform prims are imported as Blender empty objects.
USD also supports
Scope primitives, which are entities
that do not contain transform data, but which serve to group other element of the scene.
Blender doesn’t have an exact counterpart to the concept of a scope,
so such primitives are imported as Blender empties located at the origin.
This is an imperfect representation, because empty objects have a transform and
Scopes do not,
but this approach nonetheless helps preserve the structure of the scene hierarchy.
The importer supports two types of animation:
Animating transforms: If a USD primitive has time-varying transform data, a Transform Cache constraint will be added to the imported Blender object.
Animating geometry: Animating mesh and curve geometry is supported by adding a Mesh Sequence Cache modifier to the imported data. Geometry attribute (USD Primvar) animation is currently supported only for Color Attributes and UVs. Note that USD file sequences (i.e. a unique file per frame) are not yet supported.
If a USD mesh or geometry subset has a bound material, the importer will assign to the Blender object a material with the same name as the USD material. If a Blender material with the same name already exists in the scene, the existing material may be used, depending on the Material Name Collision option. Otherwise, a new material will be created.
If the USD material has a USD Preview Surface shader source, the Viewport Display color, metallic, and roughness are set to the corresponding USD Preview Surface input values.
There is also an Import USD Preview option to convert USD Preview Surface shaders to Blender Principled BSDF shader nodes. This option can be lossy, as it does not yet handle converting all shader settings and types, but it can generate approximate visualizations of the materials.
Coordinate System Orientation
If the imported USD is Y up, a rotation will be automatically applied to root objects to convert to Blender’s Z up orientation.
The following options are available when importing from USD:
Import cameras (perspective and orthographic).
Import curve primitives, including USD basis and NURBS curves. (Note that support for Bézier basis is not yet fully implemented.)
Import lights. Does not currently include USD dome, cylinder or geometry lights.
Import USD OpenVDB field assets.
Imports USD primitive shapes (cubes, spheres, cones, ect) as Blender meshes.
- Path Mask
Import only the subset of the USD scene rooted at the given primitive.
Value by which to scale the imported objects in relation to the world’s origin.
- UV Coordinates
Read mesh UV coordinates.
- Color Attributes
Convert the USD mesh
displayColorvalues to Blender’s Color Attributes.
Create Subdivision Surface modifiers based on the USD
- Import Instance Proxies
Create unique Blender objects for USD instances.
- Visible Primitives Only
Do not import invisible USD primitives. Only applies to primitives with a non-animated visibility attribute. Primitives with animated visibility will always be imported.
Include primitives with purpose
Include primitives with purpose
Include primitives with purpose
- Set Frame Range
Update the scene’s start and end frame to match those of the USD stage.
- Relative Path
Select the file relative to the blend-file.
- Create Collection
Add all imported objects to a new collection.
- Light Intensity Scale
Scale for the intensity of imported lights.
- Import All Materials
Also import materials that are not used by any geometry. Note, when this option is false, materials referenced by geometry will still be imported.
- Import USD Preview
Convert USD Preview Surface shaders to Principled BSDF shader networks.
- Set Material Blend
If the Import USD Preview option is enabled, the material blend method will automatically be set based on the
opacityThresholdshader inputs, allowing for visualization of transparent objects.
- Material Name Collision
Behavior when the name of an imported material conflicts with an existing material.
- Make Unique:
Import each USD material as a unique Blender material.
- Reference Existing:
If a material with the same name already exists, reference that instead of importing.
When importing a USDZ package, the following options specify whether and how texture asset dependencies of the USD should be copied from the zip archive so they can be loaded into Blender.
- Import Textures
Behavior when importing textures from a USDZ archive.
Don’t import textures. Note that, with this option, material textures may fail to be resolved in Blender.
Import textures as packed data in the Blender file.
Copy files to the directory specified in the Textures Directory option.
- Textures Directory
Path to the directory where imported textures will be copied, when the Import Textures mode is Copy.
Note that the default textures directory is the relative path //textures, which requires the Blender file to have been saved before importing, so the relative path can be resolved.
- File Name Collision
Behavior when the name of an imported texture file conflicts with an existing file.
- Use Existing:
If a file with the same name already exists, use that instead of copying.
Overwrite existing files.