Kit Programming Manual

Contents

• Overview
  • Omniverse Kit
• Architecture
  • Extensions
  • omni.kit.app (omni::kit::IApp)
  • Configuration
  • Bundled Extensions
  • Different Modes Example
• Getting Started: Extensions
  • 1. Open Extension Manager UI: Window -> Extensions
  • 2. Create New Extension Project: Press “Plus” button on the top left
  • 1. Push it to git
  • More Advanced Things To Try
• Extensions
  • What is an Extension?
  • Extension in a single folder
  • Single File Extensions
  • App Extensions
  • Extension Search Paths
  • Extension Discovery
  • Extension Dependencies
  • Extension configuration file (extension.toml)
  • Extension Enabling/Disabling
  • Extensions Manager
  • Extension Registries
  • Building Extensions
• Configuration
  • Quick Start
  • Application Config
  • Kit File
  • User Settings
  • Special Keys
  • Portable Mode
  • Changing Configuration With Command line
  • Passing Command Line arguments to extensions
• Tokens
  • Resolving your path
• Scripting
  • Overview
  • How to add a script folder
  • How to run a script
• Embedded 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 some native Python modules don’t work in Kit?
  • Running Kit from Python
• Dictionaries and Settings
  • Dictionaries
  • Settings
• Event streams
  • API/design overview
  • Recommended usage
• Omniverse Kit Core IApp interface
  • Loop runners
  • Extension manager
  • Scripting
  • General message bus
  • Shutdown sequence
  • Hang detector
• Extension Testing
  • Adding Extension Test: Build Scripts
  • How does it work?
  • Writing First Test
  • Test Settings
  • Running Your Test
  • Marking tests as unreliable
  • Running unreliable tests
  • Listing tests
  • repo_test: Running All Tests
  • omni.kit.ui_test: Writing UI tests
  • C++ tests using doctest
• Profiling
  • Easy Start
  • Profiling Backends
  • Instrumenting Code
  • Automatic Python Profiler: omni.kit.profile_python
• 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 ?
• USD Schema
  • USD Schema extensions
• Bundled Extensions
  • omni.appwindow
  • omni.client
  • omni.fabric
  • OmniGraph Action Graph
  • OmniGraph Action Graph Bundle
  • OmniGraph
  • omni.graph.example.ext
  • OmniGraph C++ Example Nodes
  • OmniGraph Python Example Nodes
  • OmniGraph Expression Node
  • OmniGraph IndeX Nodes
  • OmniGraph Instancing
  • OmniGraph I/O
  • OmniGraph Built-In Nodes
  • OmniGraph Script Node
  • OmniGraph Integration Testing
  • OmniGraph Tools And .ogn Node Generator
  • OmniGraph Walkthrough Tutorials
  • OmniGraph User Interfaces
  • OmniGraph Python Scripting
  • omni.hydra.engine.stats
  • omni.inspect: Omniverse Data Inspector
  • omni.kit.actions.core
  • omni.kit.actions.window
  • omni.kit.app.snippets
  • omni.kit.audio.test.usd
  • omni.kit.commands
  • omni.kit.compatibility_checker
  • omni.kit.context_menu
  • omni.kit.debug.python
  • Embedded Scripts : Scripting inside Kit
  • omni.kit.extpath.git
  • omni.kit.mainwindow
  • omni.kit.material.library
  • omni.kit.menu.aov
  • omni.kit.notification_manager: Notification Manager Extension
  • omni.kit.pipapi
  • omni.kit.property.render
  • omni.kit.registry.nucleus
  • omni.kit.renderer.capture
  • omni.kit.renderer.core
  • omni.kit.renderer.cuda_interop
  • omni.kit.renderer.imgui
  • omni.kit.stage.mdl_converter
  • omni.kit.stage_templates
  • omni.kit.test
  • omni.kit.test_app_compat
  • omni.kit.test_app_full_nonrtx
  • omni.kit.test_helpers_gfx
  • omni.kit.test_suite.helpers
  • omni.kit.test_suite.layer_window
  • omni.kit.test_suite.menu
  • omni.kit.test_suite.stage_window
  • omni.kit.test_suite.viewport
  • omni.kit.ui_test
  • omni.kit.usd.layers
  • omni.kit.viewport_widgets_manager
  • omni.kit.widget.browser_bar
  • omni.kit.widget.filebrowser
  • omni.kit.widget.path_field
  • omni.kit.widget.searchable_combobox
  • omni.kit.widget.text_editor
  • omni.kit.window.content_browser
  • omni.kit.window.drop_support
  • omni.kit.window.file
  • omni.kit.window.file_exporter
  • omni.kit.window.file_importer
  • omni.kit.window.filepicker
  • omni.kit.debug.windows module
  • omni.kit.window.popup_dialog
  • omni.kit.window.preferences
  • omni.kit.window.property: Property Window Extension
  • omni.mdl.neuraylib
  • omni.mdl.pymdlsdk
  • omni.timeline
  • omni.ui_query
  • omni.usd module
  • usdrt.scenegraph: USDRT Scenegraph API for Kit
• Core Python API Reference
  • carb package
  • omni.kit package
  • pxr package
• Documenting
  • Documenting Python API
• Testing
  • Running a single test case
  • Image comparison with a golden image
  • Skipping Vulkan or Direct3D 12 graphics tests

Indices and tables

• Index

• Module Index

• Search Page