| Since | 17.5 |
string usd_purpose(<stage>stage, string primpath)
This function returns the given primitive’s purpose, e.g., “default”, “render”, “proxy”, “guide”, etc.
<stage>
When running in the context of a node (such as a wrangle LOP), this argument can be an integer representing the input number (starting at 0) to read the stage from. The integer is equivalent to the string form referencing a particular input, e.g., “opinput:0”.
You can also use this argument to refer to a USD file (e.g., “/path/to/file.usd”), or to another LOP node’s cooked stage using the op: as the path prefix (e.g., “op:/stage/lop_node”).
primpath
The path to the primitive.
Returns
The purpose of the given primitive.
Examples ¶
// Get the sphere primitive's purpose. string purpose = usd_purpose(0, "/geo/sphere");
| See also | |
| usd | |
| usd_prim |
|