IStageUpdate

class omni.stageupdate.IStageUpdate

Bases: pybind11_object

Methods

__init__(*args, **kwargs)
destroy_stage_update(self, name)	Destroys the StageUpdate with the given name if nothing references it.
get_stage_update(self[, name])	Returns the StageUpdate with the given name or creates a new if it does not exist.

__init__(*args, **kwargs)

destroy_stage_update(self: omni.stageupdate._stageupdate.IStageUpdate, name: str) → bool

Destroys the StageUpdate with the given name if nothing references it. Does not release the default StageUpdate.

Parameters

StageUpdate. (name of the) –

Returns

True if a StageUpdate was deleted, False otherwise. The latter happens when the StageUpdate does not exist, it is in use, or it is the default StageUpdate.

get_stage_update(self: omni.stageupdate._stageupdate.IStageUpdate, name: str = '') → omni.stageupdate._stageupdate.StageUpdate

Returns the StageUpdate with the given name or creates a new if it does not exist.

Parameters

name – The name of the StageUpdate.

Returns

StageUpdate object.