IRendererCapture#

class omni.kit.renderer.capture.IRendererCapture#

Bases: pybind11_object

Render capture interface.

Methods

`__init__`(args, *kwargs)
`capture_next_frame_rp_resource`(self, ...)	Request capture RTX resource manager RpResource and save to a file.
`capture_next_frame_rp_resource_callback`(...)	Request capture RTX resource manager RpResource and trigger a callback when capture buffer is available.
`capture_next_frame_rp_resource_list_callback`(...)	Request capture RTX resource manager RpResource and trigger a callback when capture buffer is available.
`capture_next_frame_rp_resource_to_file`(self, ...)	Request capture RTX resource manager RpResource and save to a file.
`capture_next_frame_swapchain`(self, filepath, ...)	Request capture swapchain and save to a file.
`capture_next_frame_swapchain_callback`(self, ...)	Request capture swapchain and trigger a callback when capture buffer is available.
`capture_next_frame_swapchain_to_file`(self, ...)	Request capture swapchain and save to a file.
`capture_next_frame_texture`(self, filepath, ...)	Request capture texture and save to a file.
`capture_next_frame_texture_callback`(self, ...)	Request capture texture and trigger a callback when capture buffer is available.
`capture_next_frame_texture_to_file`(self, ...)	Request capture texture and save to a file.
`capture_next_frame_using_render_product`(...)	Request capture of all resources in render product.
`request_callback_memory_ownership`(self)	Request memory ownership of a buffer passed into callback.
`set_capture_sync`(self, sync, app_window)	Set synchronous capture mode.
`shutdown`(self)	Internal function. Shuts down capture interface.
`start_frame_updates`(self, app_window)	Starts per frame updates to collect capturing related data during each frame, such as FPS.
`startup`(self)	Internal function. Starts up capture interface.
`wait_async_capture`(self, app_window)	Wait for asynchronous capture to complete.

__init__(*args, **kwargs)#

capture_next_frame_rp_resource( self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, filepath: str, resource: rtx::resourcemanager::RpResource, app_window: omni::kit::IAppWindow = None, metadata: omni.kit.renderer_capture._renderer_capture.Metadata = None, ) → None#

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

Args:

filepath (str):: The file path where the file is saved to
resource (RpResource):: requested gpu resources.
app_window (omni::kit::IAppWindow):: app window. Default to None.
metadata (omni.kit.renderer_capture._renderer_capture.Metadata):: metadata passed to the capture request. Default to None.

capture_next_frame_rp_resource_callback(self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, callback: Callable[[capsule, int, int, int, carb::Format], None], resource: rtx::resourcemanager::RpResource, app_window: omni::kit::IAppWindow = None, metadata: omni.kit.renderer_capture._renderer_capture.Metadata = None) → None#

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

Args:

callback (typing.Callable[[capsule, int, int, int, TextureFormat], None]):: callback called when capture buffer is available.
resource (RpResource):: requested gpu resources.
app_window (omni::kit::IAppWindow):: app window. Default to None.
metadata (omni.kit.renderer_capture._renderer_capture.Metadata):: metadata passed to the capture request. Default to None.

capture_next_frame_rp_resource_list_callback(self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, callback: Callable[[List[int], int, int, int, carb::Format], None], resource: rtx::resourcemanager::RpResource, app_window: omni::kit::IAppWindow = None, metadata: omni.kit.renderer_capture._renderer_capture.Metadata = None) → None#

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

Args:

callback (typing.Callable[[typing.List[int], int, int, int, TextureFormat], None]):: callback called when capture buffer is available.
resource (RpResource):: requested gpu resources.
app_window (omni::kit::IAppWindow):: app window. Default to None.
metadata (omni.kit.renderer_capture._renderer_capture.Metadata):: metadata passed to the capture request. Default to None.

capture_next_frame_rp_resource_to_file( self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, filepath: str, resource: rtx::resourcemanager::RpResource, app_window: omni::kit::IAppWindow = None, format_desc: object = None, metadata: omni.kit.renderer_capture._renderer_capture.Metadata = None, ) → None#

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

Args:

filepath (str):
The file path where the file is saved to

resource (RpResource):
requested gpu resources

app_window (omni::kit::IAppWindow):
app window. Default to None

format_desc (object):
a dict of the config of the file, e.g. format, compression etc. Default to None

metadata (omni.kit.renderer_capture._renderer_capture.Metadata):
metadata passed to the capture request. Default to None.

capture_next_frame_swapchain( self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, filepath: str, app_window: omni::kit::IAppWindow = None, metadata: omni.kit.renderer_capture._renderer_capture.Metadata = None, ) → None#

Request capture swapchain and save to a file.

Args:

filepath (str):
The file path where the file is saved to.

app_window (omni::kit::IAppWindow):
app window. Default to None.

metadata (omni.kit.renderer_capture._renderer_capture.Metadata):
metadata passed to the capture request. Default to None.

capture_next_frame_swapchain_callback(self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, callback: Callable[[capsule, int, int, int, carb::Format], None], app_window: omni::kit::IAppWindow = None, metadata: omni.kit.renderer_capture._renderer_capture.Metadata = None) → None#

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

Args:

callback (typing.Callable[[capsule, int, int, int, TextureFormat], None]):: callback called when capture buffer is available.
app_window (omni::kit::IAppWindow):: app window. Default to None.
metadata (omni.kit.renderer_capture._renderer_capture.Metadata):: metadata passed to the capture request. Default to None.

capture_next_frame_swapchain_to_file( self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, filepath: str, app_window: omni::kit::IAppWindow = None, format_desc: object = None, metadata: omni.kit.renderer_capture._renderer_capture.Metadata = None, ) → None#

Request capture swapchain and save to a file.

Args:

filepath (str):
The file path where the file is saved to

app_window (omni::kit::IAppWindow):
app window. Default to None

format_desc (object):
a dict of the config of the file, e.g. format, compression etc. Default to None

metadata (omni.kit.renderer_capture._renderer_capture.Metadata):
metadata passed to the capture request. Default to None.

capture_next_frame_texture( self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, filepath: str, texture: carb::graphics::Texture = None, app_window: omni::kit::IAppWindow = None, metadata: omni.kit.renderer_capture._renderer_capture.Metadata = None, ) → None#

Request capture texture and save to a file.

Args:

filepath (str):
The file path where the file is saved to.

texture (carb::graphics::Texture):
Captured texture.

app_window (omni::kit::IAppWindow):
app window. Default to None.

metadata (omni.kit.renderer_capture._renderer_capture.Metadata):
metadata passed to the capture request. Default to None.

capture_next_frame_texture_callback(self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, callback: Callable[[capsule, int, int, int, carb::Format], None], texture: carb::graphics::Texture = None, app_window: omni::kit::IAppWindow = None, metadata: omni.kit.renderer_capture._renderer_capture.Metadata = None) → None#

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

Args:

callback (typing.Callable[[typing.List[int], int, int, int, TextureFormat], None]):
callback called when capture buffer is available.

texture (carb::graphics::Texture):
Captured texture.

app_window (omni::kit::IAppWindow):
app window. Default to None.

metadata (omni.kit.renderer_capture._renderer_capture.Metadata):
metadata passed to the capture request. Default to None.

capture_next_frame_texture_to_file( self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, filepath: str, texture: carb::graphics::Texture = None, app_window: omni::kit::IAppWindow = None, format_desc: object = None, metadata: omni.kit.renderer_capture._renderer_capture.Metadata = None, ) → None#

Request capture texture and save to a file.

Args:

filepath (str):
The file path where the file is saved to

texture (carb::graphics::Texture):
Captured texture.

app_window (omni::kit::IAppWindow):
app window. Default to None

format_desc (object):
a dict of the config of the file, e.g. format, compression etc. Default to None

metadata (omni.kit.renderer_capture._renderer_capture.Metadata):
metadata passed to the capture request. Default to None.

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.

This is not well supported. Please don’t use it.

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.

Returns:
bool: whether the request is successful.

set_capture_sync( self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, sync: bool, app_window: omni::kit::IAppWindow = None, ) → bool#

Set synchronous capture mode.

Args:

sync (bool):
Whether to use synchronous capture mode

app_window (omni::kit::IAppWindow):
app window. Default to None.

Returns:
bool: previous state of whether to use synchronous capture mode.

shutdown( self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, ) → bool#

Internal function. Shuts down capture interface.

Returns:: bool: True.

start_frame_updates( self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, app_window: omni::kit::IAppWindow = None, ) → bool#

Starts per frame updates to collect capturing related data during each frame, such as FPS.

Args:

app_window (omni::kit::IAppWindow):
app window. Default to None.

Returns:
bool: whether the app window context is ready.

startup( self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, ) → bool#

Internal function. Starts up capture interface.

Returns:: bool: whether the capture interface startups successfully

wait_async_capture( self: omni.kit.renderer_capture._renderer_capture.IRendererCapture, app_window: omni::kit::IAppWindow = None, ) → None#

Wait for asynchronous capture to complete.

Args:

app_window (omni::kit::IAppWindow):
app window. Default to None.