stageRenderingEventType

Fully qualified name: omni::usd::stageRenderingEventType

inline carb::cpp::optional<StageRenderingEventType> omni::usd::stageRenderingEventType(

carb::RString event,

carb::cpp::string_view *pContext = nullptr,

bool *pImmediate = nullptr,

) noexcept

Parses the StageRenderingEventType from a stage rendering event RString.

Parameters:

• event – The event name, typically generated from stageRenderingEventName().

• pContext – May be nullptr. If not nullptr and a valid optional is returned, this will receive the USD context name parsed from the event name. If carb::cpp::nullopt is returned, the pointed at string_view is in an unspecified state.

• pImmediate – May be nullptr. If not nullptr and a valid optional is returned, this will receive whether the event name is an ‘immediate’ event that occurs at the point where the event situation occurs. If false is received, the event is a deferred even that happens at a safer point in the frame.

Returns:

A valid optional containing the determined StageRenderingEventType if parsing is successful. Otherwise, carb::cpp::nullopt is returned to indicate that the given event name is not a valid stage event name.