Debugging composition with LIVERPS: Worked Example — Composition (NVIDIA-Certified Professional: OpenUSD Development)
Debugging Composition with LIVERPS: A Step-by-Step Worked Example In the context of the NVIDIA-Certified Professional: OpenUSD Development exam...
Debugging Composition with LIVERPS: A Step-by-Step Worked Example
In the context of the NVIDIA-Certified Professional: OpenUSD Development exam, composition is a critical topic that involves authoring and designing with composition arcs. One of the essential skills is debugging composition using LIVERPS, a powerful diagnostic tool that helps visualize and analyze how layers combine in a USD stage.
This worked example demonstrates how to use LIVERPS to debug a composition issue in a realistic scenario involving multiple composition arcs.
Scenario Description
You are working on a USD stage that combines several layers using different composition arcs: references, over, and payloads. The final rendered scene is missing a key geometry, and you suspect a composition error. Your task is to identify the cause of the missing geometry by debugging the composition with LIVERPS.
Step 1: Launch LIVERPS on the USD Stage
First, open the USD stage in your development environment and launch the LIVERPS tool. This tool provides a graphical representation of the composition arcs and the resulting prims and properties.
- Run the command: usdview --liverps path/to/your_stage.usda
- Wait for the LIVERPS interface to load the stage and display the composition graph.
Step 2: Identify the Missing Geometry Prim
In LIVERPS, navigate the prim hierarchy to locate the missing geometry prim by name. If it does not appear in the final composed stage, check the composition arcs contributing to its definition.
- Use the search or filter feature to find the prim.
- Observe which layers contribute to this prim's composition.
Step 3: Analyze Composition Arcs Affecting the Prim
Examine the composition arcs such as references, over, and payloads that apply to the prim:
- Check if the prim is referenced from an external layer that might be missing or invalid.
- Verify if an over arc is overriding or masking the prim.
- Confirm if a payload arc is correctly loaded or if the payload is unloaded, causing the prim to be absent.
Step 4: Inspect Layer Contributions and Composition Errors
Use LIVERPS to view the layer stack and composition arcs in detail:
- Look for error indicators or warnings in the layer stack.
- Check for stronger opinions in the composition arcs that might mask the prim.
- Verify if any layers are missing or have invalid paths.
Step 5: Pinpoint the Composition Issue
In this example, you discover that the prim is referenced from a layer that is not loaded due to an incorrect file path in the reference arc. This causes the prim to be absent in the final composition.
Step 6: Correct the Composition Arc
Update the reference path in the USD layer to point to the correct file location:
- Edit the layer that contains the reference arc.
- Fix the file path to the referenced USD file.
- Save the changes and reload the stage in LIVERPS.
Step 7: Verify the Fix in LIVERPS
Reload the stage and observe that the missing geometry prim now appears in the composed stage. The composition arcs show the reference is correctly resolved, and the geometry is included.
Summary
This worked example illustrates how to methodically use LIVERPS to debug composition issues in OpenUSD development. By inspecting composition arcs, layer stacks, and prim contributions, you can identify and resolve errors such as missing references or unloaded payloads, ensuring your 3D content pipelines function correctly.
Mastering this debugging process is essential for success in the NVIDIA-Certified Professional: OpenUSD Development exam and professional OpenUSD pipeline development.
More in this topic
Ready to test your knowledge?
Put what you've learned into practice with a quick quiz and track your progress.
Test your knowledge →