omni.kit.renderer.capture

class omni.renderer_capture.IRendererCapture

Bases: pybind11_builtins.pybind11_object

capture_next_frame_rp_resource(self: omni.renderer_capture._renderer_capture.IRendererCapture, filepath: str, resource: omni.gpu_foundation_factory._gpu_foundation_factory.RpResource, app_window: omni.appwindow._appwindow.IAppWindow = None)None

Request capture RTX resource manager RpResource and save to a file.

capture_next_frame_rp_resource_callback(self: omni.renderer_capture._renderer_capture.IRendererCapture, callback: Callable[[capsule, int, int, int, omni.ui._ui.TextureFormat], None], resource: omni.gpu_foundation_factory._gpu_foundation_factory.RpResource, app_window: omni.appwindow._appwindow.IAppWindow = None)None

Request capture RTX resource manager RpResource and trigger a callback when capture buffer is available.

capture_next_frame_rp_resource_list_callback(self: omni.renderer_capture._renderer_capture.IRendererCapture, callback: Callable[[List[int], int, int, int, omni.ui._ui.TextureFormat], None], resource: omni.gpu_foundation_factory._gpu_foundation_factory.RpResource, app_window: omni.appwindow._appwindow.IAppWindow = None)None

Request capture RTX resource manager RpResource and trigger a callback when capture buffer is available.

capture_next_frame_swapchain(self: omni.renderer_capture._renderer_capture.IRendererCapture, filepath: str, app_window: omni.appwindow._appwindow.IAppWindow = None)None

Request capture swapchain and save to a file.

capture_next_frame_swapchain_callback(self: omni.renderer_capture._renderer_capture.IRendererCapture, callback: Callable[[capsule, int, int, int, omni.ui._ui.TextureFormat], None], app_window: omni.appwindow._appwindow.IAppWindow = None)None

Request capture swapchain and trigger a callback when capture buffer is available.

request_callback_memory_ownership(self: omni.renderer_capture._renderer_capture.IRendererCapture)bool

Request memory ownership of a buffer passed into callback. Should be called from within a callback.

set_capture_sync(self: omni.renderer_capture._renderer_capture.IRendererCapture, sync: bool, app_window: omni.appwindow._appwindow.IAppWindow = None)bool

Set synchronous capture mode.

shutdown(self: omni.renderer_capture._renderer_capture.IRendererCapture)bool

Internal function. Shuts down capture interface.

startup(self: omni.renderer_capture._renderer_capture.IRendererCapture)bool

Internal function. Starts up capture interface.

wait_async_capture(self: omni.renderer_capture._renderer_capture.IRendererCapture, app_window: omni.appwindow._appwindow.IAppWindow = None)None

Wait for asynchronous capture to complete.

omni.renderer_capture.acquire_renderer_capture_interface(plugin_name: str = None, library_path: str = None) → omni::renderercapture::IRendererCapture