Kit SDK Extensions

These extensions are included with Kit SDK:

Extensions

Description

omni.assets.plugins

Extension that loads Carbonite plugins, essential for working with assets: carb.assets, carb.datasource-file, carb.tasking and carb.imaging

omni.client

Omniverse Client Library provides foundation APIs for uniformly accessing Nucleus filesystem, local filesystem, HTTP resources, etc.

omni.kit.async_engine

Connects main python’s asyncio event loop and kit’s run loop

omni.kit.registry.nucleus

Extension registry implementation based on client library. Supports nucleus, http, filesystem storage.

carb.audio

A low level audio plugin for Omniverse applications

carb.windowing.plugins

A low level windowing and input plugins for Omniverse applications

omni.activity.core

The activity and the progress processor

omni.activity.profiler

Converts carb profiler events to omni activity events.

omni.activity.pump

The activity and the progress processor gets pumped every 0.25 seconds

omni.appwindow

create main/top-level application windows in kit

omni.blobkey

Provides an interface to the BlobKey key management system for various key-value stores in Omniverse.

omni.datastore

Derived data caches to store GPU-ready data for streaming by the RTX-Renderer and other systems

omni.fabric.commands

Commands for Fabric

omni.gpu_foundation

Low-level management of GPU-based resources and compute workloads.

omni.gpu_foundation.shadercache.d3d12

omni.gpu_foundation shader caches for D3D12

omni.gpu_foundation.shadercache.vulkan

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

omni.graph

Contains the implementation of the OmniGraph core (Python Support).

omni.graph.action_core

Contains nodes for Omnigraph Action Graphs.

omni.graph.core

Contains the implementation of the OmniGraph core.

omni.graph.exec

Composable and extensible execution orchestration framework.

omni.graph.image.core

Provides the runtime execution framework for OmniGraphs evaluated during the pre and post render stages.

omni.graph.image.nodes

Provides the entry point nodes into pre and post render graphs.

omni.graph.tools

Contains the implementation of the Omniverse Graph node generator scripts.

omni.hsscclient

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.rtx

Extension that exposes a SceneRenderer plugin as a Usd/Hydra RenderDelegate

omni.hydra.rtx.shadercache.d3d12

omni.hydra.rtx shader caches for D3D12

omni.hydra.rtx.shadercache.vulkan

omni.hydra.rtx shader caches for Vulkan

omni.hydra.scene_api

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.iray.libs

Binaries for the Iray Renderer and the MDL material backend.

omni.kit.actions.core

Core framework for generic actions.

omni.kit.audiodeviceenum

An audio device enumeration API which is available from python and C++

omni.kit.clipboard

Cross-platform clipboard utilities for copy & paste functionality.

omni.kit.commands

Core framework for commands and the undo/redo system in Kit

omni.kit.context_menu

Context menu libraries. For creation of context sensitive menu without using UI and helper functions to manage prims.

omni.kit.debug.python

Uses debugpy which implements the Debug Adapter Protocol

omni.kit.debug.vscode

VSCode python debugger support window.

omni.kit.exec.core

Execution orchestration layer for Kit.

omni.kit.helper.file_utils

Set of utilities for common file operations

omni.kit.hotkeys.core

The Hotkeys Core extension is a framework for creating, registering, and discovering hotkeys.

omni.kit.hydra_texture

Extension to setup and consume render output from a HydraEngine attached to a Usd.Stage

omni.kit.loop-default

Default implementation of omni::kit::IRunLoopRunner, an interface that pumps global update events

omni.kit.mainwindow

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.

omni.kit.manipulator.camera

Viewport / SceneUI Camera manipulation

omni.kit.manipulator.prim

Prim2 Manipulator Extension Bundle

omni.kit.manipulator.prim.core

Prim Manipulator Core Extension

omni.kit.manipulator.prim.fabric

Prim2 Manipulator Fabric Data Accessor Extension

omni.kit.manipulator.prim.usd

Prim Manipulator USD Data Accessor Extension

omni.kit.manipulator.selection

Viewport / SceneUI selection box and shape manipulator

omni.kit.manipulator.selector

Prim Manipulator Selector Extension

omni.kit.manipulator.tool.snap

Extension that provides snap functionality to transform manipulator as well as a registry for external snap tools

omni.kit.manipulator.transform

Transform Manipulator Extension

omni.kit.material.library

Material Utility Functions

omni.kit.menu.core

Menu Core

omni.kit.menu.create

Implementation of Create Menu.

omni.kit.menu.edit

Implementation of Edit Menu. Undo, Redo, Select All, Select None, etc.

omni.kit.menu.file

Implementation of File Menu. New, Open, Save, Exit etc.

omni.kit.menu.utils

Menu utilities to add, remove and update menus for the top bar of the window.

omni.kit.notification_manager

Extension that provides interface to post notifications.

omni.kit.pip_archive

Bundles common 3rd party pip packages used by many extensions in Kit

omni.kit.pipapi

Module to enable usage of pip install in Omniverse Kit environment

omni.kit.primitive.mesh

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

omni.kit.property.audio

View and Edit Audio Property Values

omni.kit.property.bundle

Load all property widgets

omni.kit.property.camera

View and Edit Camera Property Values

omni.kit.property.geometry

View and Edit Geometry Property Values

omni.kit.property.layer

Property Window widgets that displays Layer related information.

omni.kit.property.light

View and Edit Light Property Values

omni.kit.property.material

View and Edit Material Property Values

omni.kit.property.render

View and Edit Render Prim Property Values

omni.kit.property.transform

View and Edit Transform Property Values

omni.kit.property.usd

Property Window widgets that displays USD related information.

omni.kit.raycast.query

An extension wraps around RTX Raycast Query to provide simpler raycast interface into the stage.

omni.kit.renderer.capture

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.

omni.kit.renderer.core

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.

omni.kit.renderer.imgui

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

omni.kit.scene_view.usd

Uses USD primitives to display UI Scene objects as part of the USD scene

omni.kit.selection

USD prim selection commands with undo/redo support

omni.kit.stage_template.core

Allows custom stage templates to be loaded on omni.usd.get_context().new_stage_async()

omni.kit.telemetry

Telemetry for Omniverse Kit.

omni.kit.test

Python asyncio-centric testing system.

omni.kit.tool.collect

It’s a tool that could be used to collect and gather all dependencies an USD depends on.

omni.kit.usd.collect

Collects all dependencies of a USD file.

omni.kit.usd.layers

USD Layer-related utilities and workflows.

omni.kit.usd.mdl

USD Discovery and parser plugins for MDL

omni.kit.usd_undo

Utility to undo USD layer operations

omni.kit.viewport.actions

General Viewport Actions and Hotkeys

omni.kit.viewport.legacy_gizmos

Deprecated API to draw gizmos in the viewport.

omni.kit.viewport.manipulator.transform

Viewport Transform Manipulator Extension

omni.kit.viewport.menubar.camera

Adds a variety of camera settings

omni.kit.viewport.menubar.core

Adds a variety of functionality to a viewport by adding a menu-bar and items at the top

omni.kit.viewport.menubar.display

Adds a variety of display settings

omni.kit.viewport.menubar.render

Adds a variety of render settings

omni.kit.viewport.menubar.settings

Adds a variety of viewport settings

omni.kit.viewport.ready

Extension to inject a omni.ui element into the Viewport until rendering has begun

omni.kit.viewport.registry

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

omni.kit.viewport.utility

Utility functions to access [active] Viewport information

omni.kit.viewport.window

New OmniUI Based HydraEngine Viewport

omni.kit.widget.browser_bar

Treeview browser bar as embeddable widget

omni.kit.widget.context_menu

Context menu widget. An API to create menus from dictionaries

omni.kit.widget.filebrowser

Filebrowser embeddable widget

omni.kit.widget.filter

A filter button widget includes a popup window to show filter options.

omni.kit.widget.graph

Omniverse Kit Graph Widget which defines the common API for graph model, delegate and view.

omni.kit.widget.highlight_label

A label widget to show highlight word.

omni.kit.widget.nucleus_connector

Helper extension for connecting to Nucleus servers

omni.kit.widget.options_button

A option button widget includes a popup window to show options.

omni.kit.widget.options_menu

A popup menu widget to show options.

omni.kit.widget.path_field

String field widget with tooltips for branching

omni.kit.widget.prompt

Prompt dialog for use with omni.ui widgets

omni.kit.widget.searchable_combobox

Searchable ComboBox Widget

omni.kit.widget.searchfield

A widget to input search words.

omni.kit.widget.settings

Settings Widget

omni.kit.widget.stage

Stage Widget

omni.kit.widget.stage_icons

Default Set of Icons for the Stage Window.

omni.kit.widget.toolbar

Extension to create toolbar widget. It also comes with builtin tools for transform manipulation and animation playing.

omni.kit.widget.viewport

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

omni.kit.window.content_browser

A window for browsing Omniverse content

omni.kit.window.content_browser_registry

Registry for all customizations that are added to the Content Browser

omni.kit.window.drop_support

Drag & Drop support from outside kit

omni.kit.window.extensions

Customize and personalize Kit with extensions

omni.kit.window.file

Provides utility functions to new/open/save/close USD files

omni.kit.window.file_exporter

A dialog for exporting files

omni.kit.window.file_importer

A dialog for importing files

omni.kit.window.filepicker

Filepicker popup dialog and embeddable widget

omni.kit.window.popup_dialog

A variety of simple Popup Dialogs for taking in user inputs

omni.kit.window.preferences

A window which allows users to change preference settings

omni.kit.window.property

Kit Property Window.

omni.kit.window.stage

Omniverse Kit Stage Window

omni.kit.window.status_bar

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.

omni.materialx.libs

MaterialX + OpenPBR libraries.

omni.mdl

A SWIG generated Python binding for the native MDL SDK.

omni.mdl.neuraylib

Access the MDL shade nodes of the material system in OV.

omni.resourcemonitor

Monitor utility for device and host memory

omni.rtx.settings.core

Renderer Settings for RTX Realtime/PathTracer

omni.rtx.shadercache.d3d12

Shader caches for D3D12

omni.rtx.shadercache.vulkan

Shader caches for Vulkan

omni.rtx.window.settings

Core extension for renderers which use the carbonite settings framework

omni.stats

Concise overview window accounting for various statistics, including scene complexity, as well as GPU compute and memory utilization.

omni.timeline

Provides interface for time information

omni.ui

The Omniverse UI Framework

omni.ui.scene

The Omniverse 3D UI Framework

omni.uiaudio

An audio API for playing sounds for UI interactions.

omni.ujitso.client

A build system to facilitate retrieving, building and caching of derived data like GPU-ready geometry or textures.

omni.ujitso.default

Default UJITSO build system instance that ties together the build system and necessary processors.

omni.ujitso.processor.geometry

UJITSO processor to generate GPU-ready geometry data for the RTX renderer.

omni.ujitso.processor.texture

UJITSO processor to produce GPU-ready texture data for the RTX renderer.

omni.usd

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.

omni.usd.config

This extension sets environment variables that are used by other parts of the application.

omni.usd.core

The omni.usd.core extension loads and initializes USD and Hydra. It provides managed UsdContext for easy USD Stage access, and life-cycle management.

omni.usd.libs

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

omni.usd_resolver

The Omniverse Kit Resolver allows USD to work with files in Omniverse.

omni.volume

This lightweight extension loads carb.volume and its dependencies and provides the carb.volume Python bindings.

usdrt.scenegraph

The USDRT Scenegraph API for Kit

Extensions

Description

omni.activity.freeze_monitor

Shows a UI progress icon when main thread is busy

omni.activity.ui

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.coreapi.alpha.server

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.iray.shadercache.d3d12

omni.hydra.iray shader caches for D3D12

omni.hydra.iray.shadercache.vulkan

omni.hydra.iray shader caches for Vulkan

omni.hydra.pxr

Allows using the Pixar Hydra delegates in the Kit viewport.

omni.hydra.pxr.settings

Settings to an external Hydra delegate

omni.index

Provides access to the NVIDIA IndeX library.

omni.index.compute

Connects NVIDIA IndeX compute functionality with OmniGraph.

omni.index.kit.rtx_scientific

RTX Scientific render mode for scientific visualization with NVIDIA IndeX.

omni.index.libs

Contains the libraries used by other NVIDIA IndeX extensions.

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

omni.kit.actions.window

A window to show actions.

omni.kit.capture.viewport

An extension to capture Kit viewport into images and videos.

omni.kit.collaboration.channel_manager

The channel manager provides universal way to create/manage Omniverse Channel without caring about the state management but only message exchange between clients.

omni.kit.collaboration.presence_layer

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.

omni.kit.collaboration.telemetry

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

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

omni.kit.documentation.ui.style

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.

omni.kit.hotkeys.window

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.

omni.kit.scene_view.opengl

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.client and is searching for files in the current directory. The recursive search is not implemented.

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.

omni.kit.viewport.docs

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.

omni.kit.viewport_widgets_manager

The viewport widgets manager provides simple API to manage viewport widgets.

omni.kit.watched_config

Watch and reload config files.

omni.kit.widget.cache_indicator

omni.kit.widget.imageview

The widget that allows to view image in a canvas.

omni.kit.widget.layers

Omniverse Kit Layer Window

omni.kit.widget.live

omni.kit.widget.live_session_management

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.

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_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

omni.volume_nodes

Extensions

Deprecation Message

omni.app.setup

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.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

omni.kit.welcome.window

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