ImageProvider

class omni.ui.ImageProvider

Bases: pybind11_object

ImageProvider class, the goal of this class is to provide ImGui reference for the image to be rendered.

Methods

__init__(self, **kwargs)	doc
destroy(self)
get_managed_resource(self)
set_image_data(*args, **kwargs)	Overloaded function.

Attributes

height	Gets image height.
is_reference_valid	Returns true if ImGui reference is valid, false otherwise.
width	Gets image width.

__init__(self: omni.ui._ui.ImageProvider, **kwargs) → None

doc

destroy(self: omni.ui._ui.ImageProvider) → None

get_managed_resource(self: omni.ui._ui.ImageProvider) → omni.gpu_foundation_factory._gpu_foundation_factory.RpResource

set_image_data(*args, **kwargs)

Overloaded function.

1. set_image_data(self: omni.ui._ui.ImageProvider, arg0: capsule, arg1: int, arg2: int, arg3: omni.gpu_foundation_factory._gpu_foundation_factory.TextureFormat) -> None

2. set_image_data(self: omni.ui._ui.ImageProvider, rp_resource: omni.gpu_foundation_factory._gpu_foundation_factory.RpResource, presentation_key: int = 0) -> None

property height

Gets image height.

property is_reference_valid

Returns true if ImGui reference is valid, false otherwise.

property width

Gets image width.