kit-manual: Omniverse Kit Manual

kit-manual

• Kit Overview
  • Omniverse Kit
    • USD/Hydra
    • Omni.USD
    • Omniverse Client Library
    • Carbonite
      • Plugins
    • Omniverse RTX Renderer
    • Scripting
    • Kit Extensions
    • omni.ui
• Kit Architecture
  • Extensions
  • Kit Kernel (kit.exe/IApp)
  • omni.kit.app (omni::kit::IApp)
  • Bundled Extensions
  • Different Modes Example
    • CLI utility
    • GUI CLI utility
• Kit Core IApp Interface
  • Loop runners
  • Extension manager
  • Scripting
  • General event system
  • General message bus (deprecated)
  • Shutdown sequence
  • Hang detector
• Extensions (Basic)
  • Open Extension Manager UI: Window -> Extensions
  • More Advanced Things To Try
    • Explore kit.exe
    • Explore other extensions
• Extensions (Advanced)
  • What is an Extension?
  • Extension in a single folder
  • Extension Id
  • Extension Version
  • Extension Package Id
  • Single File Extensions
  • App Extensions
  • Extension Search Paths
  • Extensions Source Linking: Dev Paths
    • Custom Search Paths Protocols
  • Extension Discovery
  • Extension Dependencies
  • Specifying Dependency Version
    • Pre-release versions
  • Optional Dependencies
  • Extension configuration file (extension.toml)
    • Config Fields
      • [core] section
        • [core.reloadable] (default: true)
        • [core.order] (default: 0)
      • [package] section
        • [package.version] (default: "0.0.0")
        • [package.title] default: ""
        • [package.description] default: ""
        • [package.category] (default: "")
        • [package.app] (default: false)
        • [package.feature] (default: false)
        • [package.toggleable] (default: true)
        • [package.authors] (default: [""])
        • [package.repository] (default: "")
        • [package.keywords] (default: [""])
        • [package.changelog] (default: "")
        • [package.readme] (default: "")
        • [package.preview_image] (default: "")
        • [package.icon] (default: "")
        • [package.target]
        • [package.writeTarget]
      • [dependencies] section
      • [python] section
        • [[python.module]]
        • [[python.scriptFolder]]
      • [native] section
        • [[native.plugin]]
        • [[native.library]] section
      • [settings] section
      • [[env]] section
      • [fswatcher] section
        • [fswatcher.patterns]
        • [fswatcher.paths]
      • [[test]] section
      • [documentation] section
      • [deprecation] section
        • [deprecation.warning] (default: "")
    • Config Filters
    • Example
  • Extension Enabling/Disabling
    • Python Modules
    • Native Plugins
    • Settings
    • Tokens
  • Extensions Manager
    • Reloading
    • Extension interfaces
    • Runtime Information
    • Hooks
    • Extension API Code Examples
      • Enable Extension
      • Get All Extensions
      • Get Extension Config
      • Get Extension Path
    • Other Settings
      • /app/extensions/disableStartup (default: false)
      • /app/extensions/precacheMode (default: false)
      • /app/extensions/debugMode (default: false)
      • /app/extensions/detailedSolverExplanation (default: false)
      • /app/extensions/registryEnabled (default: true)
      • /app/extensions/skipPublishVerification (default: false)
      • /app/extensions/excluded (default: [])
      • /app/extensions/preferLocalVersions (default: true)
      • /app/extensions/syncRegistryOnStartup (default: false)
      • /app/extensions/publishExtraDict (default: {})
      • /app/extensions/fsWatcherEnabled (default: true)
      • /app/extensions/mkdirExtFolders (default: true)
      • /app/extensions/installUntrustedExtensions (default: false)
      • /app/extensions/profileImportTime (default: false)
      • /app/extensions/fastImporter/enabled (default: true)
      • /app/extensions/fastImporter/searchInTopNamespaceOnly (default: true)
      • /app/extensions/fastImporter/fileCache (default: false)
      • /app/extensions/parallelPullEnabled (default: false)
  • Extension Registries
    • Publishing Extensions
    • Unpublishing Extensions
    • Pulling Extensions
    • Pre-downloading Extensions
    • Listing Extensions
    • Authentication and Users
  • Building Extensions
• Extensions (USD Schema)
• Extensions (API)
  • Python API
    • Example
    • Tool to check API: repo_checkapi
      • Common API Check Failures
      • Debugging the tool
    • API Deprecation
  • Actions API
• Testing Extensions with Python
  • Adding Extension Test: Build Scripts
  • How does it work?
  • Extension Search Paths
  • Writing First Test
  • Startup Test
  • Test Settings
    • Test Settings: Basics
    • Test Settings: Where to look for python tests?
    • Test Settings: Multiple test processes
    • Test Settings: Disable test on certain platform
    • Test Settings: Setup function
  • Running Your Test
    • Run subset of tests
    • Run subset of tests using Tests Sampling
    • Run tests from a file
    • Retry Strategy
    • Developing Tests
    • Tests Code Coverage (Python)
    • Debugging Coverage
    • Disabling a python test
    • Pass extra cmd args to the test
    • Choose an app to run tests in
    • Checking if we are running in a test run
    • Test Output
    • Python debugger
    • Wait for the debugger to attach
    • Reading Logs
  • Marking tests as unreliable
  • Running unreliable tests
  • Listing tests
  • repo_test: Running All Tests
    • Excluding Tests
  • Adding Info to Failed Test Summary
  • omni.kit.ui_test: Writing UI tests
  • Disabling OS Window
  • (Advanced) Generating new tests or adapting discovered tests at runtime
• Running Tests As Benchmarks
  • Writing Python Benchmarks
    • Adding Samples of Custom Metrics per Benchmark
    • Example Benchmark Python Code
  • CLI Parameters to Run Benchmarks Manually
    • Example Command
    • Benchmark Addendum
• Testing Extensions with C++
  • Doctest
  • Set up testable libraries
  • Running a single test case
  • Unit Tests
  • Image comparison with a golden image
    • Regression testing of an executable with a golden image:
    • Regression testing of a rendering test using comparison of backbuffer with a golden image:
    • How to update and upload a new golden image
    • Troubleshooting
    • How to use asset folder for storing data
  • Skipping Vulkan or Direct3D 12 graphics tests
  • Getting C++ Code Coverage Information
    • Understanding the Teamcity Coverage pipeline
    • Troubleshooting Code Coverage
• Documenting Extensions
  • Documenting Python API
    • Adding Extensions to the automatic-introspection documentation system
    • Python API Automatic Introspection
    • Dealing with Sphinx Warnings
      • MyST-parser warnings
      • Docstring syntax warnings
      • C++ docstring issues
• Publishing Extensions
  • Publish Verification
  • Other Publish Tool Settings
• Creating Kit Apps
  • Simple App
  • Application Dependencies Management
    • Updating Version Lock
    • Build-time extension dependencies
    • Version Specification Recommendations
    • Windows or Linux only dependencies
    • Caching extensions disabled by default
  • Deploying an App
  • Extensions without an App
  • Supported Targets Check
  • Other Precache Tool Settings
• Configuring
  • Quick Start
  • Application Config
  • Kit File
  • System Configs
  • Persistent Settings
  • Special Keys
    • Appending Arrays
    • Importing Other Configs
  • Developer Mode
  • Portable Mode
    • Cmd Args
    • Portable Configs (Markers)
  • Changing Settings With Command Line
    • Changing an array value with command line
  • Passing Command Line arguments to extensions
  • Code Examples
    • Get Setting
    • Set Setting
    • Set Persistent Setting
    • Subscribe To Setting Changes
  • Kit Kernel Settings
    • /app/enableDeveloperWarnings
    • /app/enableStdoutOutput (default: true)
    • /app/disableCmdArgs (default: false)
    • /app/printConfig (default: false)
    • /app/userConfigPath (default: ${data}/user.config.json)
    • /app/settings/persistent (default: true)
    • /app/settings/loadUserConfig (default: true)
    • /app/hangDetector/enabled (default: false)
    • /app/hangDetector/alwaysEnabled (default: false)
    • /app/hangDetector/timeout (default: 120)
    • /app/quitAfter (default: -1)
    • /app/quitAfterMs (default: -1.0)
    • /app/fastShutdown (default: true)
    • /app/python/logSysStdOutput (default: true)
    • /app/window/iconPath (default: '')
• Logging
  • Python Logging
  • Code Examples
    • Logging with python
    • Logging with C++
• Metrics
  • Overview
  • Implementation
  • Supported Metric Types
  • Integration with Observability Platforms
  • Built-in Kit Metrics
    • Streaming Metrics
    • USD Stage Metrics
  • See Also
• Profiling
  • Easy Start (Tracy)
  • Easy Start (ChromeTrace)
  • Profiling Backends
    • Chrome Trace
    • Tracy
      • On Demand
      • From Startup
    • Multiplexer
  • Instrumenting Code
  • Automatic Python Profiler
  • Profiling Startup Time
• Python Scripting
  • Overview
  • How to add a script folder
  • How to run a script
• UI Styling Best Practices
  • Overview
  • Table of Contents
  • Best Practice with Examples
    • 1. Styling Best Practices
      • 1.1 Two Levels of Styling
      • 1.2 Use styling constants
      • 1.3 No Scattered styles
      • 1.4 Use Hierarchical Selector Pattern (Type::Name:State)
      • 1.5 No inline styles - use name and style_type_name_override
      • 1.6 Don’t miss type selector
    • 2. ui.Window Best Practices
    • 3. Widget Development Best Practices
  • Quick Reference for Developers
    • Starting a New Application?
    • Starting a New Window Extension?
    • Checklist Before Committing
  • Current limitations
    • Workarounds for Extensions Not Yet Following Best Practices
      • 1. Override Window Background with frame.set_style()
      • 2. Add Missing Styles to Extension-Specific style.py
      • 3. Replace or Update Icons
      • 4. Adjust Widget Sizes When Needed
      • 5. Define Custom Style Constants
      • 6. Update widgets to fix the customized design
    • Migration Strategy
• Embedded Kit Python
  • Hello Python
  • Using system Python
  • Add extra search paths
  • Other Python Configuration Tweaks
  • Using numpy, Pillow etc.
  • Using Anaconda environment
  • Using other packages from pip
  • Why do some native Python modules not work in Kit?
  • Running Kit from Python
• Using Python pip packages
  • Runtime installation using omni.kit.pipapi
  • Build-time installation using repo_build
  • Installing packages from other repositories
  • pip packages included in Kit: omni.kit.pip_archive
    • Overriding the default pip packages
  • Code Examples
    • Install pip package at runtime
• Kit Python Package
  • Getting Started
  • KitApp Example
  • EULA
  • Editable Mode
• Dictionaries and Settings
  • Dictionaries
  • Settings
    • Default values
    • Notifications
    • Settings structure
    • Reacting to and consuming settings
    • Combining API and settings
• Events
  • API/design overview
    • Observing Events
    • Dispatching Events
    • Deferring Events
  • System Events
  • Message Events
  • Best Practices
    • Deferred callbacks
    • Event names
    • Transient subscriptions
    • Recursive dispatching
  • Additional Python Code examples
    • Subscribe to Shutdown Events
    • Subscribe to Update Events
    • Custom Message Event
• Legacy Events
  • History (Events 1.0)
  • Events 2.0
    • IEventDispatcher
    • IMessageQueue
  • Bridging the gap
    • Converting Events 1.0 Subscriptions to Events 2.0
    • Converting Events 1.0 Handler Functions to Events 2.0
    • Message Bus
    • Using IEventsAdapter to convert event streams
  • Conversion Guide
    • Conversion Examples
    • Kit Kernel (C++)
    • omni.appwindow
    • omni.kit.renderer.core
    • omni.timeline
    • omni.usd
• Tokens Reference
  • App Tokens
  • Environment Variable Tokens
  • Path Tokens
    • Omniverse Global Paths: omniverse.toml
    • Data Folder
    • Program data
    • Documents folder
    • Cache folder
    • Logs folder
    • Config folder
    • Temporary folder
    • Other useful paths
    • Platform tokens
    • Extension tokens
  • Overriding Tokens
  • Resolving your path
  • Checking Token Values
• Linux Troubleshooting
  • Q1) How to install a driver.
  • Q2) Omniverse kit logs only listed one of my GPUs, but nvidia-smi shows multiple GPUs.
  • Q3) How to verify a correct Vulkan setup with vulkaninfo or vulkaninfoSDK utility
  • Q4) I have a single GPU, but I see multiple GPUs of the same type reported in Omniverse kit logs.
  • Q5) Startup failure with: VkResult: ERROR_DEVICE_LOST
  • Q6) Startup failure with: GLFW initialization failed
  • Q7) Startup failure with: Failed to find a graphics and/or presenting queue.
  • Q8) Startup failure for carb::glinterop with X Error of failed request:  GLXBadFBConfig
  • Q9) How to specify what GPUs to run Omniverse apps on
  • Q10) Viewport is gray and nothing is rendered.
  • Q11) Getting spam of failures: Failed to create change watch for xxx: errno=28, No space left on device
    • To view the current watcher limit:
    • To update the watcher limit:
  • Q12) How to increase the file descriptor limit on Linux to render on more than 2 GPUs
    • To increase the file descriptor limit
• Frequently Asked Questions
  • Where can I find the core Kit config file?
  • Can I debug python extensions and scripts?
  • Random failures when loading omni.usd ?
• Migration Guide (110)
  • How to Use This Guide
  • Stage 1: Kit 107 → 108
    • Python 3.11 → 3.12
    • OpenUSD 24.05 → 25.02
    • carb::extras::Path: Implicit String Conversion Removed
    • Assert Macros Moved to Assert.h
    • Library.h: Macros Replace Functions
    • Livestream 2.0
    • Minimum GPU: Turing (sm_75) Required
    • Carbonite 208.3 — Binary ABI Break
      • ITokens::setValue() renamed to setValueS()
      • carb::detail::defineTupleCommon namespace cleanup
      • carb::variant::PyObjectVTable type name constant changed
      • Prefer carb::getCachedInterface<>() over acquireInterface<>() (Strongly Recommended)
    • OmniGraph Core 3.0.0 — ABI Break
    • OmniGraph — Parallel Node Registration Removed
    • Extensions Removed / Changed Default Dependencies
    • omni.kit.usd.layers — ILayers ABI 1.0 → 1.1
    • Layer Events — Migrate to Events 2.0
    • omni.ui — WindowHandle::isVisible() and WindowHandle::setVisible() Deprecated
    • omni.ui — Menu / Separator’s menu_compatibility Deprecated
    • omni.kit.ui — API Move and Transitive Dependency Removed
  • Stage 2: Kit 108 → 109
    • Before You Start: Clear the Extension Cache
    • CUDA 12.4.1 — Driver Requirement
    • NumPy 1.x → 2.x
    • Fabric API: TokenC / PathC Removed
    • Carbonite Changes
    • String Safety: ISettings / IError / IDictionary
    • mergeMaterials Default Changed — Load Performance Impact
    • Fabric Scene Delegate (FSD) Now Default
    • Windows Memory Allocator: mimalloc
    • UsdLux — DomeLight Default Orientation Changed
    • RTX Real-Time 2.0 — Now the Default Mode
    • MDL SDK — ABI Version 56 → 57
    • CloudXR — Runtime Extracted to New Extension
  • Stage 3: Kit 109 → 110
  • Before You Start
    • Clear the Extension Cache
    • Update the Kit SDK Version Pin
    • Update Extension Registry URLs
  • OpenUSD 25.02 → 25.11
    • UI Hint Deprecation
    • File Format Library Restructuring
    • Ndr / Sdr Consolidation
  • Carbonite 208.3 → 210
    • optional<bool> and expected<bool> Handling
    • Unicode String Constants Removed
    • g_carbClientName Type Change
    • Defines.h Split
    • Deprecated Headers Removed
    • CARB_CHECK Replaced
    • Livestream Renderer Methods Deprecated
  • Carbonite API Migrations (Recommended)
    • ITokens 2.0
    • IFileSystem 2.0
    • IDictionary 2.0 / ISettings 2.0
  • omni.ui 3.0.0 — C++ ABI Break
    • menu_compatibility Parameter Removed
    • ByteImageProvider.set_data() Deprecated
    • AbstractValueModel.subscribe_item_changed_fn() Deprecated
  • omni.ui.scene — intersection → gesture_payload Rename
  • Rendering
    • Hydra 2 Removed
    • Multi-Node Rendering Removed
    • omni.renderer_capture → omni.kit.renderer.capture
    • Viewport Camera — Clamp Default Changed
  • Python API Changes
    • omni.usd Layers
    • omni.usd New APIs
    • omni.usd Deprecated Utilities
    • omni.kit.usd.layers — register_open_stage_addon() Deprecated
  • Fabric API — IPath::create() and IToken::create() Deprecated
  • OmniGraph Changes
    • omni.graph.core 3.0.x → 3.1.x — ABI Additions
    • DeformedPointsToHydra Node Removed
    • OnCustomEvent: Bundle Attributes Deprecated
    • Nodes Deprecated — Scheduled for Removal
    • C++ OmniGraph API Deprecations
  • Extensions Changed or Removed
    • Extensions Removed in Kit 110
    • omni.kit.widget.nucleus_connector → omni.kit.widget.connection_manager
    • omni.hydra.scene_api — Still Present, Still Deprecated
  • MaterialX 1.38.10 → 1.39.3
  • Build System
  • Migration Checklist
    • Pre-Upgrade
    • C++ / Native — Rebuild Required
    • C++ / Native — Code Changes
    • Python API
    • Rendering
    • OmniGraph
    • Extensions
  • Official References
• Migration Guide (106→109)
  • How to Use This Guide
  • Stage 1: Kit 106.x → 107
    • Python 3.10 → 3.11
    • Linux C++ ABI Change
    • OpenUSD: nv_usd → usd
    • C++17 Support
    • omni.client Private API Removed
    • Python API Removals
    • Carbonite Events 2.0
    • Carbonite Logging
    • omni.kit.widget.toolbar / omni.kit.window.toolbar — Deprecated APIs Removed
    • Fabric API: Introduction of PathC / TokenC
  • Stage 2: Kit 107 → 108
    • Python 3.11 → 3.12
    • OpenUSD 24.05 → 25.02
    • carb::extras::Path: Implicit String Conversion Removed
    • Assert Macros Moved to Assert.h
    • Library.h: Macros Replace Functions
    • Livestream 2.0
    • Minimum GPU: Turing (sm_75) Required
    • Carbonite 208.3 — Binary ABI Break
      • ITokens::setValue() renamed to setValueS()
      • carb::detail::defineTupleCommon namespace cleanup
      • carb::variant::PyObjectVTable type name constant changed
      • Prefer carb::getCachedInterface<>() over acquireInterface<>() (Strongly Recommended)
    • OmniGraph Core 3.0.0 — ABI Break
    • OmniGraph — Parallel Node Registration Removed
    • Extensions Removed / Changed Default Dependencies
    • omni.kit.usd.layers — ILayers ABI 1.0 → 1.1
    • Layer Events — Migrate to Events 2.0
    • omni.ui — WindowHandle::isVisible() and WindowHandle::setVisible() Deprecated
    • omni.ui — Menu / Separator’s menu_compatibility Deprecated
    • omni.kit.ui — API Move and Transitive Dependency Removed
  • Stage 3: Kit 108 → 109
    • Before You Start: Clear the Extension Cache
    • CUDA 12.4.1 — Driver Requirement
    • NumPy 1.x → 2.x
    • Fabric API: TokenC / PathC Removed
    • Carbonite Changes
    • String Safety: ISettings / IError / IDictionary
    • mergeMaterials Default Changed — Load Performance Impact
    • Fabric Scene Delegate (FSD) Now Default
    • Windows Memory Allocator: mimalloc
    • UsdLux — DomeLight Default Orientation Changed
    • RTX Real-Time 2.0 — Now the Default Mode
    • MDL SDK — ABI Version 56 → 57
    • CloudXR — Runtime Extracted to New Extension
  • Isaac Sim: Extension Namespace Migration
    • Common Renames
    • USD Semantics API
    • Dynamic Control Toolbox
  • Migration Checklist
    • Environment & Toolchain
    • Dependencies & Build
    • C++ / Native
    • Python API
    • Configuration
    • Isaac Sim
  • Official References
• Migration Guide (108)
  • Table of Contents
  • Preparing for Migration
  • Carbonite
    • Required Code Updates
      • carb::extras::Path
      • Library.h
    • Other Breaking Changes
      • omni::string
      • carb.crashreporter-breakpad.plugin
      • omni.structuredlog.plugin
      • Assert macros moved to Assert.h
  • OpenUSD Update
    • Breaking Changes and Migration Requirements
  • Live Streaming
    • Extension Dependencies
    • Settings Migration
      • Primary Stream Settings Migration
      • Session Management Settings Migration
      • Logging Settings Migration
    • Command Line Migration
      • Primary Stream Command Line Migration
      • Session Management Command Line Migration
      • Logging Command Line Migration
    • Breaking Changes
    • Recommended Migration Steps
    • Validation
• Kit SDK Extensions
• API (python)