stageRenderingEventType#
Fully qualified name: omni::usd::stageRenderingEventType
- inline carb::cpp::optional<StageRenderingEventType> omni::usd::stageRenderingEventType( ) noexcept#
Parses the StageRenderingEventType from a stage rendering event RString.
- Parameters:
event – The event name, typically generated from
stageRenderingEventName()
.pContext – May be
nullptr
. If notnullptr
and a validoptional
is returned, this will receive the USD context name parsed from the event name. Ifcarb::cpp::nullopt
is returned, the pointed atstring_view
is in an unspecified state.pImmediate – May be
nullptr
. If notnullptr
and a validoptional
is returned, this will receive whether the event name is an ‘immediate’ event that occurs at the point where the event situation occurs. Iffalse
is received, the event is a deferred even that happens at a safer point in the frame.
- Returns:
A valid
optional
containing the determinedStageRenderingEventType
if parsing is successful. Otherwise,carb::cpp::nullopt
is returned to indicate that the given event name is not a valid stage event name.