omni.kit.renderer.capture¶
-
class
omni.renderer_capture.
IRendererCapture
¶ -
capture_next_frame_rp_resource
(self: omni.kit.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.kit.renderer_capture._renderer_capture.IRendererCapture, callback: Callable[[capsule, int, int, int, omni.gpu_foundation_factory._gpu_foundation_factory.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.kit.renderer_capture._renderer_capture.IRendererCapture, callback: Callable[[List[int], int, int, int, omni.gpu_foundation_factory._gpu_foundation_factory.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_to_file
(self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, filepath: str, resource: omni.gpu_foundation_factory._gpu_foundation_factory.RpResource, app_window: omni.appwindow._appwindow.IAppWindow = None, format_desc: object = None) → None¶ Request capture RTX resource manager RpResource and save to a file.
-
capture_next_frame_swapchain
(self: omni.kit.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.kit.renderer_capture._renderer_capture.IRendererCapture, callback: Callable[[capsule, int, int, int, omni.gpu_foundation_factory._gpu_foundation_factory.TextureFormat], None], app_window: omni.appwindow._appwindow.IAppWindow = None) → None¶ Request capture swapchain and trigger a callback when capture buffer is available.
-
capture_next_frame_swapchain_to_file
(self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, filepath: str, app_window: omni.appwindow._appwindow.IAppWindow = None, format_desc: object = None) → None¶ Request capture swapchain and save to a file.
-
capture_next_frame_texture
(self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, filepath: str, texture: omni.gpu_foundation_factory._gpu_foundation_factory.Texture = None, app_window: omni.appwindow._appwindow.IAppWindow = None) → None¶ Request capture texture and save to a file.
-
capture_next_frame_texture_callback
(self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, callback: Callable[[capsule, int, int, int, omni.gpu_foundation_factory._gpu_foundation_factory.TextureFormat], None], texture: omni.gpu_foundation_factory._gpu_foundation_factory.Texture = None, app_window: omni.appwindow._appwindow.IAppWindow = None) → None¶ Request capture texture and trigger a callback when capture buffer is available.
-
capture_next_frame_texture_to_file
(self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, filepath: str, texture: omni.gpu_foundation_factory._gpu_foundation_factory.Texture = None, app_window: omni.appwindow._appwindow.IAppWindow = None, format_desc: object = None) → None¶ Request capture texture and save to a file.
-
capture_next_frame_using_render_product
(self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, viewport_handle: int, filepath: str, render_product: str) → None¶ Request capture of all resources in render product
-
request_callback_memory_ownership
(self: omni.kit.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.kit.renderer_capture._renderer_capture.IRendererCapture, sync: bool, app_window: omni.appwindow._appwindow.IAppWindow = None) → bool¶ Set synchronous capture mode.
-
shutdown
(self: omni.kit.renderer_capture._renderer_capture.IRendererCapture) → bool¶ Internal function. Shuts down capture interface.
-
start_frame_updates
(self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, app_window: omni.appwindow._appwindow.IAppWindow = None) → bool¶ Starts per frame updates to collect capturing related data during each frame, such as FPS.
-
startup
(self: omni.kit.renderer_capture._renderer_capture.IRendererCapture) → bool¶ Internal function. Starts up capture interface.
-
wait_async_capture
(self: omni.kit.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::kit::renderercapture::IRendererCapture¶
-
omni.renderer_capture.
convert_raw_bytes_to_list
(arg0: capsule, arg1: int, arg2: int, arg3: int, arg4: omni.gpu_foundation_factory._gpu_foundation_factory.TextureFormat) → List[int]¶
-
omni.renderer_capture.
convert_raw_bytes_to_rgba_tuples
(arg0: capsule, arg1: int, arg2: int, arg3: int, arg4: omni.gpu_foundation_factory._gpu_foundation_factory.TextureFormat) → List[tuple]¶