Extension: omni.ocio-0.1.1 |
Documentation Generated: Sep 22, 2025 |
Overview#
Omni Ocio is a low-level plugin that exposes key OpenColorIO functionality through Python. It is designed to create and manage OpenColorIO contexts, enabling applications to query and utilize color management parameters such as display names, view names, and looks. This extension is ideal for developers who require direct access to OpenColorIO configuration details within Omniverse Kit SDK based applications.
Concepts#
The main abstraction provided by this extension is the OpenColorIO context. The context acts as the centralized object through which the underlying color management settings are accessed. It allows users to:
Retrieve a context from a specific OpenColorIO configuration file.
Query details such as the default display, default view, and the total count and names of displays, views, and looks.
Functionality#
The public API focuses on interfacing with OpenColorIO settings:
Use the provided get_context() function to create or obtain a color management context from a configuration file.
Access functions such as get_default_display_name() and get_default_view_name() to retrieve primary color settings.
Query the number and specific names of the available displays, views, and looks with functions like get_display_count(), get_display_name(), get_look_count(), get_look_name(), and get_view_count()/get_view_name().
Use release_context() to properly free a context when color management operations are completed.
These functions enable developers to integrate color management insights into their pipelines without needing to directly invoke lower-level OpenColorIO operations.
Relationships#
This extension depends on the “omni.hydra.rtx” package, which supports features like postprocessing in raytracing workflows. By leveraging this dependency, Omni Ocio provides essential color management capabilities that can be integrated seamlessly with other rendering and image processing tools in the Omniverse Kit SDK environment.
Considerations#
Omni Ocio is a low-level interface to OpenColorIO. As such, it assumes familiarity with OpenColorIO concepts and terms.
Given its specialized focus, the extension primarily consolidates OpenColorIO settings within a single context rather than providing high-level color management routines.
The integration with “omni.hydra.rtx” suggests that users should ensure that dependency is present to fully utilize the extension’s functionality.