Overview#

omni.kit.widget.opengl provides a simple framework for integrating OpenGL rendering into omni.ui. This extension gives developers an easy path to incorporate OpenGL drawing within a UI widget, enabling custom visualization and processing through familiar callbacks.

Concepts#

The extension exposes three public APIs: OpenGLWidget, OpenGLImageProvider, and OpenGLScene.
OpenGLScene is designed for subclassing so that users can implement custom OpenGL initialization and drawing routines through defined callbacks.
OpenGLWidget and OpenGLImageProvider serve as building blocks for embedding OpenGL content within the omni.ui environment.

Functionality#

The OpenGLScene class sets up a basic structure for managing OpenGL states and viewport adjustments.
Developers can override initialization and drawing methods to handle viewport resize events and perform rendering operations using OpenGL.
This approach is ideal for straightforward OpenGL visual tasks requiring integration with omni.ui while leveraging a familiar callback model.

Relationships#

This extension depends on omni.ui for the user interface and omni.gpu_foundation for GPU support, ensuring that OpenGL content is effectively integrated with the broader UI toolkit.
It is a lightweight solution intended for applications that require direct OpenGL drawing capabilities within the omniverse Kit SDK.

Settings#

A specific setting, resize.rateLimit (set to 60), is available to control the refresh rate during widget resizing.

This extension serves as a practical solution for developers looking to embed and control OpenGL rendering in custom UI widgets using the Omniverse Kit SDK.