setDisplayName#

Fully qualified name: usdex::core::setDisplayName

bool usdex::core::setDisplayName(
pxr::UsdPrim prim,
const std::string &name,
)#

Sets this prim’s display name (metadata).

DisplayName is meant to be a descriptive label, not necessarily an alternate identifier; therefore there is no restriction on which characters can appear in it

The value is authored to both uiHints:displayName and the original displayName field in the current edit target so the resulting file behaves consistently in every supported OpenUSD runtime.

Parameters:

  • prim – The prim to set the display name for

  • name – The value to set

Returns:

True on success, otherwise false

On this page