MdlEntitySnapshot#

class omni.mdl.neuraylib.MdlEntitySnapshot#

Bases: pybind11_object

MDL representation of a shade node along with the currently set parameters. Parameters can be inspected while changes are reflected from USD (in rtx.hydra.plugin). This snapshot is passed to the ISceneRenderer for creating and updating the renderer material.

Created from an MdlEntity at a certain point in time. When the MdlEntity did not change in the meantime, the same MdlEntitySnapshot can be accessed using the create function. When the MdlEntity changed (different module or function name), a new snapshot can be created while to old one still exist but might not be valid anymore (in case of reloads).

Methods

__init__(*args, **kwargs)

getMdlModule(self)

Handle to the module that contains the entities definition.

Attributes

dbName

Name of a MDL material instance or functions call in the neuray database.

dbScopeName

Name of the neuray database scope (of the ISceneRenderer) in which this entity is stored in.

simpleNameWithSignature

Name of the material or function within its module along with its parameter list attached.

__init__(*args, **kwargs)#
getMdlModule(
self: omni.mdl.neuraylib._neuraylib.MdlEntitySnapshot,
) omni.mdl.neuraylib._neuraylib.MdlModule#

Handle to the module that contains the entities definition. Since this module is not ‘created’ here, don’t call `destroy` on it.

property dbName#

Name of a MDL material instance or functions call in the neuray database.

property dbScopeName#

Name of the neuray database scope (of the ISceneRenderer) in which this entity is stored in.

property simpleNameWithSignature#

Name of the material or function within its module along with its parameter list attached.