Kit SDK Extensions#
These extensions are included with Kit SDK:
Extensions |
Description |
|---|---|
A low level audio plugin for Omniverse applications |
|
carb.windowing.plugins |
A low level windowing and input plugins for Omniverse applications |
The activity and the progress processor |
|
Converts carb profiler events to omni activity events. |
|
The activity and the progress processor gets pumped every 0.25 seconds |
|
Create main/top-level application windows in kit. |
|
omni.assets.plugins |
Extension that loads Carbonite plugins, essential for working with assets: carb.assets, carb.datasource-file, carb.tasking and carb.imaging |
omni.blobkey |
Provides an interface to the BlobKey key management system for various key-value stores in Omniverse. |
Omniverse Client Library Kit Integration. Adds carb.datasource, carb.omniclient plugins. Starts liveProcess() calls. |
|
omni.client.lib |
Omniverse Client Library provides foundation APIs for uniformly accessing Nucleus filesystem, local filesystem, HTTP resources, etc. |
Derived data caches to store GPU-ready data for streaming by the RTX-Renderer and other systems |
|
Commands for Fabric |
|
Low-level management of GPU-based resources and compute workloads. |
|
omni.gpu_foundation shader caches for D3D12 |
|
omni.gpu_foundation shader caches for Vulkan |
|
omni.gpucompute.plugins |
Provides an abstraction layer between CUDA compute and D3D/Vulkan compute. It is used as fabric’s gateway to CUDA |
Contains the implementation of the OmniGraph core (Python Support). |
|
Contains nodes for Omnigraph Action Graphs. |
|
Contains the implementation of the OmniGraph core. |
|
Composable and extensible execution orchestration framework. |
|
Provides the runtime execution framework for OmniGraphs evaluated during the pre and post render stages. |
|
Provides the entry point nodes into pre and post render graphs. |
|
Contains the implementation of the Omniverse Graph node generator scripts. |
|
Extension that wraps and tests the carb.hsscclient plugin; this provides a client interface to the High Speed Static Cache for UJITSO and other systems. |
|
omni.hydra.engine.stats |
Provide Python bindings to read GPU stats and performance info for rendering. |
omni.hydra.iray shader caches for D3D12 |
|
omni.hydra.iray shader caches for Vulkan |
|
omni.hydra.rtx |
Extension that exposes a SceneRenderer plugin as a Usd/Hydra RenderDelegate |
omni.hydra.rtx shader caches for D3D12 |
|
omni.hydra.rtx shader caches for Vulkan |
|
This extension provides a scene delegate that can load in the background, and also python api for adding and removing those scene delegates. |
|
omni.hydra.scene_delegate |
Custom Hydra scene delegates for fast update of USD scene |
omni.hydra.usdrt_delegate |
Custom Hydra scene delegates for fast update of USD scene, using USDRT |
omni.index |
Provides access to the NVIDIA IndeX library. |
omni.index.libs |
Contains the libraries used by other NVIDIA IndeX extensions. |
omni.iray.libs |
Binaries for the Iray Renderer and the MDL material backend. |
Core framework for generic actions. |
|
Connects main python’s asyncio event loop and kit’s run loop |
|
An audio device enumeration API which is available from python and C++ |
|
Cross-platform clipboard utilities for copy & paste functionality. |
|
Core framework for commands and the undo/redo system in Kit |
|
Context menu libraries. For creation of context sensitive menu without using UI and helper functions to manage prims. |
|
Uses debugpy which implements the Debug Adapter Protocol |
|
omni.kit.debug.vscode |
VSCode python debugger support window. |
Execution orchestration layer for Kit. |
|
Set of utilities for common file operations |
|
The Hotkeys Core extension is a framework for creating, registering, and discovering hotkeys. |
|
Extension to setup and consume render output from a HydraEngine attached to a Usd.Stage |
|
Default implementation of omni::kit::IRunLoopRunner, an interface that pumps global update events |
|
The extension manages the main window of the application. It provides methods to set up the main window docking, show or hide the main menu bar and status bar. |
|
Viewport / SceneUI Camera manipulation |
|
Prim Manipulator Extension Bundle |
|
Prim Manipulator Core Extension |
|
Prim Manipulator Fabric Data Accessor Extension |
|
Prim Manipulator USD Data Accessor Extension |
|
Viewport / SceneUI selection box and shape manipulator |
|
Prim Manipulator Selector Extension |
|
Extension that provides snap functionality to transform manipulator as well as a registry for external snap tools |
|
Transform Manipulator Extension |
|
Material Utility Functions |
|
Menu Core |
|
Implementation of Create Menu. |
|
Implementation of Edit Menu. Undo, Redo, Select All, Select None, etc. |
|
Implementation of File Menu. New, Open, Save, Exit etc. |
|
Menu utilities to add, remove and update menus for the top bar of the window. |
|
Integrates a Kit app with the NVIDIA License Service (NLS). |
|
Extension that provides interface to post notifications. |
|
omni.kit.pip_archive |
Bundles common 3rd party pip packages used by many extensions in Kit |
Module to enable usage of |
|
Generators for basic mesh geometry. |
|
omni.kit.property.adapter.core |
Core adapter classes for property adapters and the adapter registry. |
omni.kit.property.adapter.fabric |
Allows Property Widget to read and write attributes to Fabric |
omni.kit.property.adapter.usd |
Allows Property Widget to read and write attributes to USD |
View and Edit Audio Property Values |
|
Load all property widgets |
|
View and Edit Camera Property Values |
|
omni.kit.property.geometry |
View and Edit Geometry Property Values |
Property Window widgets that displays Layer related information. |
|
View and Edit Light Property Values |
|
View and Edit Material Property Values |
|
omni.kit.property.render |
View and Edit Render Prim Property Values |
View and Edit Transform Property Values |
|
Property Window widgets that displays USD related information. |
|
An extension wraps around RTX Raycast Query to provide simpler raycast interface into the stage. |
|
Extension registry implementation based on client library. Supports nucleus, http, filesystem storage. |
|
This is an extension to capture different graphics resources to a file. It can be used to save specific swapchain buffer, GUI texture, or RpResource into a file with specified compression parameters. |
|
This is a low level abstract GUI rendering extension, i.e. it manages (through carb::graphics) swapchains, basic resources like textures/buffers, and implements an event structure for higher level systems (e.g. ImGui renderer, which is just one of the possible GUI renderers in theory). It supports multi-window too, including virtual windows. |
|
This extension subscribes to rendering events emitted from the omni.kit.renderer.core and implements an ImGUI rendering backend, i.e. it does actual windows, buttons, fonts rendering. |
|
omni.kit.renderer.init |
It is an integral part of omni.kit.renderer.core, which starts the graphics subsystem initialization, the point of separation is that other extensions can load while the graphics subsystem is initialized in the background thread |
Uses USD primitives to display UI Scene objects as part of the USD scene |
|
USD prim selection commands with undo/redo support |
|
Allows custom stage templates to be loaded on omni.usd.get_context().new_stage_async() |
|
Telemetry for Omniverse Kit. |
|
omni.kit.test |
Python asyncio-centric testing system. |
It’s a tool that could be used to collect and gather all dependencies an USD depends on. |
|
Collects all dependencies of a USD file. |
|
USD Layer-related utilities and workflows. |
|
USD Discovery and parser plugins for MDL |
|
Utility to undo USD layer operations |
|
General Viewport Actions and Hotkeys |
|
Deprecated API to draw gizmos in the viewport. |
|
omni.kit.viewport.manipulator.transform |
Viewport Transform Manipulator Extension |
Adds a variety of camera settings |
|
Adds a variety of functionality to a viewport by adding a menu-bar and items at the top |
|
Adds a variety of display settings |
|
Adds a variety of render settings |
|
Adds a variety of viewport settings |
|
Extension to inject a omni.ui element into the Viewport until rendering has begun |
|
Registration for items that want to be added to all viewports |
|
omni.kit.viewport.scene_camera_model |
Automatically updates camera when it’s updated in UsdContext |
Utility functions to access [active] Viewport information |
|
New OmniUI Based HydraEngine Viewport |
|
Treeview browser bar as embeddable widget |
|
Context menu widget. An API to create menus from dictionaries |
|
Filebrowser embeddable widget |
|
A filter button widget includes a popup window to show filter options. |
|
Omniverse Kit Graph Widget which defines the common API for graph model, delegate and view. |
|
A label widget to show highlight word. |
|
Helper extension for connecting to Nucleus servers |
|
A option button widget includes a popup window to show options. |
|
A popup menu widget to show options. |
|
String field widget with tooltips for branching |
|
Prompt dialog for use with omni.ui widgets |
|
Searchable ComboBox Widget |
|
A widget to input search words. |
|
Settings Widget |
|
Stage Widget |
|
Default Set of Icons for the Stage Window. |
|
Extension to create toolbar widget. It also comes with builtin tools for transform manipulation and animation playing. |
|
Widget for displaying a render of a Usd Stage |
|
omni.kit.window.console |
The activity and event log viewer and a simple command line tool |
A window for browsing Omniverse content |
|
Registry for all customizations that are added to the Content Browser |
|
Drag & Drop support from outside kit |
|
Customize and personalize Kit with extensions |
|
Provides utility functions to new/open/save/close USD files |
|
A dialog for exporting files |
|
A dialog for importing files |
|
Filepicker popup dialog and embeddable widget |
|
A variety of simple Popup Dialogs for taking in user inputs |
|
A window which allows users to change preference settings |
|
Kit Property Window. |
|
Omniverse Kit Stage Window |
|
Status Bar supports setting the progress and the message using the message bus. |
|
omni.kit.window.toolbar |
Extension to create a dockable toolbar. It also comes with builtin tools for transform manipulation and animation playing. |
MaterialX + OpenPBR libraries. |
|
A SWIG generated Python binding for the native MDL SDK. |
|
Access the MDL shade nodes of the material system in OV. |
|
omni.metrics.core |
Allow opentelemetry metrics to be used via carb plugin carb.metrics |
omni.resourcemonitor |
Monitor utility for device and host memory |
omni.rtx.settings.core |
Renderer Settings for RTX Realtime/PathTracer |
Shader caches for D3D12 |
|
Shader caches for Vulkan |
|
omni.rtx.window.settings |
Core extension for renderers which use the carbonite settings framework |
Concise overview window accounting for various statistics, including scene complexity, as well as GPU compute and memory utilization. |
|
Provides interface for time information |
|
The Omniverse UI Framework |
|
The Omniverse 3D UI Framework |
|
An audio API for playing sounds for UI interactions. |
|
A build system to facilitate retrieving, building and caching of derived data like GPU-ready geometry or textures. |
|
Default UJITSO build system instance that ties together the build system and necessary processors. |
|
UJITSO processor to generate GPU-ready geometry data for the RTX renderer. |
|
UJITSO processor to produce GPU-ready texture data for the RTX renderer. |
|
The omni.usd extension is the python frontend of omni.usd.core extension. It provides both synchronous/asynchronous interfaces in C++ and Python to manage UsdContext, and do state query. It also provides common utitlies and undoable commands for wrapped USD operations. omni.usd is the foundation component for all other extentions that need to access USD. |
|
This extension sets environment variables that are used by other parts of the application. |
|
The omni.usd.core extension loads and initializes USD and Hydra. It provides managed UsdContext for easy USD Stage access, and life-cycle management. |
|
Extension to load native USD binaries. |
|
omni.usd.schema.anim |
USD Animation schema |
omni.usd.schema.audio |
USD audio schema |
omni.usd.schema.geospatial |
USD Geospatial schema |
omni.usd.schema.omnigraph |
USD Schemas defined for the objects in OmniGraph |
The Omniverse Kit Resolver allows USD to work with files in Omniverse. |
|
This lightweight extension loads carb.volume and its dependencies and provides the carb.volume Python bindings. |
|
The USDRT Scenegraph API for Kit |
Extensions |
Description |
|---|---|
omni.activity.freeze_monitor |
Shows a UI progress icon when main thread is busy |
Activity window displaying high-level and detailed file loading progress |
|
omni.activity.usd_resolver |
Listen to USD resolve/read/write events in order to generate corresponding activities |
omni.audioplayer |
An audio player API which is available from python and C++ |
omni.audiorecorder |
An audio recorder API which is available from python and C++ |
omni.example.ui |
Examples for using omni.ui library |
omni.hydra.index |
Provides the RTX Scientific renderer. |
omni.hydra.index_remote |
Enables distributed cluster/network rendering with NVIDIA IndeX. |
omni.hydra.pxr |
Allows using the Pixar Hydra delegates in the Kit viewport. |
omni.hydra.pxr.settings |
Settings to an external Hydra delegate |
Connects NVIDIA IndeX compute functionality with OmniGraph. |
|
omni.index.kit.rtx_scientific |
RTX Scientific render mode for scientific visualization with NVIDIA IndeX. |
omni.index.renderer |
Shared functionality for renderers that incorporate NVIDIA IndeX. |
omni.index.settings.core |
Settings to control NVIDIA IndeX rendering. |
omni.index.usd |
Connects the USD scene representation to the NVIDIA IndeX Hydra Engine. |
omni.inspect |
Provides interfaces you can add to your ABI to provide data inspection information in a compliant way |
A window to show actions. |
|
omni.kit.capture.viewport |
An extension to capture Kit viewport into images and videos. |
The channel manager provides universal way to create/manage Omniverse Channel without caring about the state management but only message exchange between clients. |
|
This extension manages the presence layer for sharing persistent data for all users in a Live Session. |
|
omni.kit.collaboration.selection_outline |
The extension that manages selection outline in live session. |
omni.kit.collaboration.settings |
This extension manages settings for Live Collaboration Workflow. |
omni.kit.collaboration.stage_columns |
This extensions extend columns about Live Session for stage window. |
Telemetry support for the ‘omni.kit.collaboration.*’ extensions. |
|
omni.kit.collaboration.viewport.camera |
The viewport widget that displays camera name of users joined the same stage. |
omni.kit.compatibility_checker |
Sample extension for limiting applications to a specific (or range of) GPU and drivers. |
omni.kit.compatibility_mode |
This Extension handles detection and possible re-launch of applications without RTX |
omni.kit.documentation.builder |
The interactive documentation builder for omni.ui extensions |
The interactive documentation for omni.ui style |
|
omni.kit.example.toolbar_button |
|
omni.kit.exec.example-carb |
Example of extending the Exectuion Framework using a Carbonite Plugin. |
omni.kit.exec.example-omni |
Example of extending the Exectuion Framework using an Omniverse Module. |
omni.kit.extpath.git |
|
omni.kit.filebrowser_column.acl |
The column that is showing the access flags of the file. |
omni.kit.filebrowser_column.tags |
The column that is showing the tags for the file. |
A window to show hotkeys. |
|
omni.kit.menu.aov |
Implementation of AOV Menu. |
omni.kit.menu.common |
Implementation of parts of Window and Help menus. |
omni.kit.property.skel |
View and Edit Skeleton Animation Property Values |
omni.kit.property.tagging |
View and Edit Tagging Property Values |
omni.kit.quicklayout |
Set of tools for controlling layout. |
An omni.ui.SceneView widget that renders its omni.ui.SceneView.Scene with OpenGL |
|
omni.kit.search_core |
The extension provides the base classes for search and registering search engines. |
omni.kit.search_example |
The example extension adds a new search engine to the content browser. The extension is based on |
omni.kit.stage.copypaste |
The ability to copy and paste USD Prims |
omni.kit.stage.mdl_converter |
The ability to export USD Material to MDL |
omni.kit.stage_column.active |
This extension provides extended columns for stage window. |
omni.kit.stage_templates |
Allows custom stage templates to be loaded on omni.usd.get_context().new_stage_async() |
omni.kit.tagging |
A plugin to connect kit to the tagging service. |
omni.kit.ui.actions |
General UI Actions and Hotkeys |
omni.kit.ui_test |
UI Testing Helper functions |
omni.kit.uiapp |
UI App. |
omni.kit.usda_edit |
Context menu to edit USD layers as USDA files |
omni.kit.usdz_export |
Packages assets into a USDZ archive. |
omni.kit.viewport.bundle |
A bundle of Viewport extensions that creates a baseline interactive Viewport. |
The documentation for the next Viewport API in Kit |
|
omni.kit.viewport.iray |
A bundle of extensions required to render with the Iray renderer |
omni.kit.viewport.pxr |
Extension to make external HydraDelegate renderers and settings available for the Viewport. |
omni.kit.viewport.rtx |
Extension to make the RTX Realtime and Pathtraced renderer and settings available for the Viewport. |
Watch and reload config files. |
|
omni.kit.widget.cache_indicator |
|
omni.kit.widget.imageview |
The widget that allows to view image in a canvas. |
Omniverse Kit Layer Window |
|
omni.kit.widget.live |
|
This extension includes shared live session widgets used by other extentions to re-use widgets for session management. |
|
omni.kit.widget.live_session_management.ui |
This extension includes shared live session widgets used by other extentions to re-use widgets for session management. |
omni.kit.widget.nucleus_info |
Reports the services that are available from a Nucleus server. |
omni.kit.widget.opengl |
A simple widget for drawing in omni.ui with OpenGL |
omni.kit.widget.search_delegate |
Base module that provides a search widget for searching the file system |
omni.kit.widget.spinner |
A Spinner widget includes a value field and a set of arrow (up/down or left/right) to change field value. |
omni.kit.widget.text_editor |
Bindings to ImGuiColorTextEdit |
omni.kit.widget.versioning |
Versioning widgets that displays branch and checkpoint related information. |
omni.kit.window.about |
Show application/build information. |
omni.kit.window.commands |
Commands viewer |
omni.kit.window.cursor |
Extension to manage main window cursor. |
omni.kit.window.script_editor |
Window to edit and run python scripts. |
omni.kit.window.splash |
|
omni.kit.window.stats |
|
omni.kit.window.tests |
Window to list/run all found python tests. |
omni.kit.window.title |
Extension to control title bar behavior. |
omni.kit.window.usd_paths |
Lists paths in USD file and allows editing |
omni.kit.window.welcome |
Post startup window that displays a welcome message and a link to the documentation. |
omni.mdl.distill_and_bake |
MDL distill and bake to UsdPreviewSurface extension. |
omni.mdl.usd_converter |
MDL to USD converter extension. |
omni.rtx.geometrysource |
|
omni.rtx.index_composite |
Image-based compositing for Volume and Points prims rendered by NVIDIA IndeX together with the RTX Renderer. |
An extension for providing python access to the synthetic data sensors, useful helper functions and sensor visualization. |
|
omni.timeline.live_session |
An extension to provide synchronization of the timeline between live session users |
omni.ui_query |
Find UI elements from queries/expressions, and vice versa. Available as omni.ui.query |
omni.usd.schema.omni_lens_distortion |
USD Schemas for RTX lens distortion models |
omni.usd.schema.omni_sensors |
USD Schemas for RTX Sensor |
omni.usd.schema.omniscripting |
USD Schemas defined for the objects in OmniScripting |
omni.usd.schema.render_settings.rtx |
USD Applied API Schemas for RTX renderer |
omni.usd.schema.semantics |
USD semantics schema |
omni.videoencoding |
|
Extensions |
Deprecation Message |
|---|---|
Extension deprecated since Kit 106.0. omni.app.setup replaced by setup extensions in omni-app-templates. |
|
omni.app.workflow.startup |
Extension deprecated since Kit 106.0 |
omni.command.usd |
Extension deprecated since Kit 106.0. omni.command.usd is being replaced by omni.usd. |
omni.debugdraw |
Extension deprecated since Kit 106.0. omni.debugdraw is being replaced by omni.ui.scene. |
omni.hydra.iray |
Extension deprecated since Kit 106.0 |
omni.iray.settings.core |
Extension deprecated since Kit 106.0 |
omni.kit.app_snippets |
Extension deprecated since Kit 106.0 |
omni.kit.autocapture |
Extension deprecated since Kit 106.0 |
omni.kit.manipulator.viewport |
Extension deprecated since Kit 106.0 |
omni.kit.property.file |
Extension deprecated since Kit 106.0 |
omni.kit.viewport_widgets_manager |
Extension deprecated, use omni.scene instead |
omni.kit.welcome.about |
Extension deprecated since Kit 106.0 |
omni.kit.welcome.extensions |
Extension deprecated since Kit 106.0 |
omni.kit.welcome.learn |
Extension deprecated since Kit 106.0 |
omni.kit.welcome.open |
Extension deprecated since Kit 106.0 |
omni.kit.welcome.whats_new |
Extension deprecated since Kit 106.0 |
Extension deprecated since Kit 106.0 |
|
omni.kit.window.audio.oscilloscope |
Extension deprecated since Kit 106.0 |
omni.kit.window.audioplayer |
Extension deprecated since Kit 106.0 |
omni.kit.window.audiorecorder |
Extension deprecated since Kit 106.0 |
omni.kit.window.images |
Extension deprecated since Kit 106.0 |
omni.kit.window.imageviewer |
Extension deprecated since Kit 106.0 |
omni.kit.window.material_swap |
Extension deprecated since Kit 106.0 |
omni.kit.window.privacy |
Extension deprecated since Kit 106.0 |
omni.kit.window.provide_feedback |
Extension deprecated since Kit 106.0 |
omni.kit.window.reshade_editor |
Extension deprecated since Kit 106.0 |
omni.kit.window.splash_close_example |
Extension deprecated since Kit 106.0 |
omni.kit.window.viewport |
Extension deprecated since Kit 106.0. omni.kit.viewport_legacy is being replaced by omni.kit.viewport.window. |
omni.spatialindex |
Extension deprecated since Kit 106.0 |