Python API reference#

This reference is generated from the installed library package and its public docstrings.

class isaacsim.ovgl_viewport.debug.Camera(
target: tuple[float, float, float] = (0.0, 0.0, 0.0),
yaw_radians: float = -0.65,
pitch_radians: float = 0.38,
distance: float = 6.0,
)#

Bases: object

Initial state for interactive viewport navigation.

Parameters:
  • target – Camera look-at target in stage coordinates.

  • yaw_radians – Horizontal view angle in radians.

  • pitch_radians – Vertical view angle in radians.

  • distance – Distance from the camera to target in stage units.

distance: float#
pitch_radians: float#
target: tuple[float, float, float]#
yaw_radians: float#
class isaacsim.ovgl_viewport.debug.CameraPose#

Bases: object

World pose produced by debug camera navigation.

property orientation#

XYZW-ordered camera orientation quaternion.

property position#

Camera position in stage coordinates.

class isaacsim.ovgl_viewport.debug.Frame#

Bases: object

One top-down OVGL RGBA8 frame.

property frame_number#

Monotonic viewport frame number.

property height#

Image height in pixels.

property rgba#

Tightly packed, top-down RGBA8 pixels.

property stage_ordinal#

Rendered OVStage ordinal.

property width#

Image width in pixels.

class isaacsim.ovgl_viewport.debug.Viewport(
stage: Stage,
*,
render_product_path: str = '/Render/ViewportProduct',
camera_path: str = '/ViewportCamera',
title: str = 'Isaac Sim OVGL Viewport',
width: int = 1280,
height: int = 720,
maximum_frames: int = 0,
visible: bool = True,
camera: Camera | None = None,
camera_pose_writer: Callable[[CameraPose], None] | None = None,
)#

Bases: object

Interactive OVGL viewport for a populated Foundation OVStage.

Parameters:
  • stage – Populated OVStage that remains alive while the viewport is open.

  • render_product_path – Absolute path of the authored render product to display.

  • camera_path – Absolute path of the camera controlled by viewport navigation.

  • title – User-facing window title.

  • width – Initial window width in pixels.

  • height – Initial window height in pixels.

  • maximum_frames – Frame limit, or zero to continue until closed.

  • visible – Whether to create a user-visible window.

  • camera – Initial and reset navigation state.

  • camera_pose_writer – Optional replacement for the default Foundation camera-pose writer.

Raises:

RuntimeError – If stage is invalid or is not an OVStage.

close() → None#

Release the native viewport and its borrowed stage references.

poll_events() → bool#

Process input and return whether the viewport remains open.

Returns:

Whether the viewport remains open.

render() → Frame#

Render and optionally present the latest sealed OVStage ordinal.

Visible viewports present directly on the GPU and return an empty RGBA payload. Invisible viewports return captured RGBA pixels.

Returns:

Borrowed frame data that remains valid until the next render or viewport closure.

property closed: bool#

Return whether the viewport has been closed.

isaacsim.ovgl_viewport.debug.author_viewport(
stage: Stage,
*,
camera_path: str = '/ViewportCamera',
render_product_path: str = '/Render/ViewportProduct',
render_var_path: str = '/Render/Vars/LdrColor',
resolution: tuple[int, int] = (1280, 720),
) → None#

Author the camera and render product required by an OVGL viewport.

Parameters:
  • stage – OpenUSD Foundation stage to author.

  • camera_path – Absolute path for the viewport camera.

  • render_product_path – Absolute path for the render product.

  • render_var_path – Absolute path for the LDR color render variable.

  • resolution – Render width and height in pixels.

Raises:
  • RuntimeError – If stage is invalid, is not an OpenUSD stage, or cannot be found in the USD stage cache.

  • ValueError – If resolution is not positive.