Omniverse Kit

Kit

• Kit Overview
  • What is Omniverse Kit?
• Developer Manuals
  • Scripting in Omniverse Kit
    • NVIDIA Omniverse™ Kit Python API
    • Carbonite SDK
• Python Snippets
  • Omniverse Kit Python Snippets
    • Events
      • Create Custom Events with Payloads
      • Subscribe to App Shutdown Event
      • Subscribe to App Update Event
    • Extensions
      • Enable a Kit Extension
        • Immediate
        • Non-Immediate
      • Get All the Registered Extensions
      • Get the Config for an Extension
      • Get the File Path to an Extension
    • Python
      • Install a New Python Package from PyPI
      • Write to Log
        • logging Library
        • carb Library
    • Selection
      • Get the Current Selected Prims
      • Select a Prim by Prim Path
        • Omniverse Kit Commands
        • omni.usd API
    • Settings
      • Get the Value of a Setting
      • Set the Value of a Persistent Setting
      • Set the Value of a Setting
      • Subscribe to Setting Changes
    • User Interface
      • Open a File Browser Dialog
        • File Import Dialog
        • File Export Dialog
    • Viewport
      • Change the Viewport’s Active Camera
      • Create a Viewport Popup Notification
      • Focus, Zoom or Frame a Prim
        • Basic
        • Advanced
      • Get the Active Viewport Window
• Release Notes
  • Highlight Overview
  • Key Updates:
    • 103.5.1
      • omni.kit.hydra
      • omni.hydra.scene
      • omni.kit.viewport.window
      • omni.kit.gfn
      • omni.kit.widget.viewport
      • omni.kit.widget.graph
      • omni.kit.viewport.menubar.render
      • omni.kit.viewport.menubar.display
      • rtx_plugins
      • omni.kit.widget.layers
      • omni.kit.window.extensions
      • omni.ui
      • omni.kit.embedded
      • omni.kit.renderer.core
      • omni.kit.menu.utils
      • Additional
    • 103.5
      • omni.kit.widget.stage
      • omni.kit.viewport.menubar.core
      • omni.kit.viewport.window
      • omni.kit.viewport.menubar.camera
      • omni.kit.viewport.pxr
      • omni.kit.hydra
      • omni.kit.thumbnails.usd
      • omni.kit.renderer.core
      • omni.graph
      • omni.kit.manipulator.camera
      • omni.graph.ui
      • omni.ui
      • omni.kit.usd.layers
      • omni.kit.context
      • omni.kit.window.stage
      • omni.graph.core
      • omni.usd
      • omni.ui.scene
      • omni.gpucompute
      • omni.syntheticdata
      • omni.graph.action
      • omni.kit.window.console
      • omni.kit.viewport.menubar.display
      • omni.kit.widget.layers
      • omni.kit.widget.live
      • omni.kit.viewport.legacy
      • omni.graph.nodes
      • omni.kit.menu.edit
      • omni.kit.widget.viewport
      • omni.kit.window.popup
      • omni.kit.material.library
      • omni.kit.manipulator.prim
      • omni.kit.viewport.menubar.settings
      • omni.kit.window.extensions
      • omni.kit.collaboration.channel
      • omni.kit.property.transform
    • 102.0
      • omni.usd
      • omni.kit.window.file
      • omni.kit.window.movie
      • omni.kit.widget.stage
      • omni.graph.core
      • carb.flatcache
      • omni.kit.property.layer
      • omni.kit.window.filepicker
      • omni.kit.widget.filebrowser
      • omni.ui
      • omni.kit.usda
      • omni.ext
      • omni.kit.widget.layers
      • omni.kit.material.library
      • omni.kit.tool.collect
      • omni.kit.core.tests
      • omni.kit.window.preferences
      • omni.flowusd
      • omni.kit.window.viewport
      • omni.kit.window.content
      • omni.kit.thumbnails.usd
      • omni.kit.compatibility
      • omni.kit.app
      • omni.graph.ui
      • omni.rtx.window.settings
      • omni.graph
      • omni.example.ui
      • omni.kit.window.usd
      • omni.kit.window.property
      • omni.kit.capture
      • omni.kit.registry.nucleus
      • omni.kit
      • omni.kit.livestream.core
      • omni.kit.commands
      • omni.kit.window.profiler
      • omni.kit.window.popup
      • omni.example.hydra
      • omni.kit.test
      • omni.kit.widget.versioning
      • omni.renderer
      • omni.kit.window.toolbar
      • omni.debugdraw
      • omni.kit.window.render
      • omni.kit.window.extensions
      • omni.kit.window.material
      • omni.kit.context
      • omni.kit.telemetry
      • omni.kit.property.usd
      • omni.appwindow
      • omni.kit.menu.file
      • omni.kit.menu.utils
      • omni.kit.renderer.core
      • omni.kit.splash
      • omni.kit.window.script
      • omni.hydra
      • omni.hydra.scene
      • omni.kit.notification
      • omni.usd.schema.anim
      • omni.kit.xr
      • omni.kit.versioning
      • omni.graph.tools
      • omni.kit.widget.graph
      • omni.videoencoding
      • omni.services.transport.client.idl
      • omni.gpu
      • omni.kit.stage
      • omni.renderer.utils
      • omni.ui.ImageProvider
      • omni.kit.property.light
      • omni.services.thumbnails.images
      • omni.kit.window.stage
      • omni.services.transport.client.https
      • omni.kit.tagging
      • omni.kit.window.cache
      • omni.hydra.pxr
      • omni.kit.quicklayout
      • omni.kit.window.stream
      • omni.services.mdl
      • omni.services.core
      • omni.services.client
      • omni.usd.config
      • omni.kit.viewport
      • omni.example.greet
      • omni.kit.widget.settings
      • omni.timeline
      • omni.graph.core.ogn
      • omni.kit.menu.select
      • omni.kit.property.material
      • omni.kit.stage.copypaste
      • omni.graph.examples.cpp
      • omni.iray.render
      • omni.kit.property.transform
      • omni.kit.menu.create
      • omni.kit.menu.edit
      • omni.graph.nodes
      • omni.ansel
      • omni.kit.tool.asset
      • omni.kit.renderer.capture
      • omni.kit.autocapture
      • omni.kit.property.geometry
      • omni.kit.widget.fast
      • omni.kit.primitive.mesh
      • omni.usd.libs
      • omni.command.usd
      • omni.usd.schema.sequence
      • omni.usd.schema.physics
      • omni.kit.livestream.webrtc
      • omni.kit.widget.prompt
      • omni.kit.window.splash
      • omni.kit.widget.cef
      • omni.kit.widget.webview
      • omni.kit.window.transform
      • omni.kit.debug.python
      • omni.kit.async
      • omni.kit.livestream.native
      • omni.services.transport.server.tcp
      • omni.kit.window.console
      • omni.graph.expression
      • omni.kit.asset
      • omni.services.registry
      • omni.kit.window.status
      • omni.services.transport.client.http
      • omni.kit.skelvis
      • omni.kit.numpy.common
      • omni.hydra.examples
      • omni.kit.utility.prim
      • omni.ui.bind
      • omni.kit.mainwindow
      • omni.isaac
      • omni.kit.ui
      • omni.kit.editor
      • omni.kit.usd
      • other
    • 100.1.1 Hotfix
    • Kit 100.1
      • Asset Import/export
      • UI
      • Particles/Dynamics
      • Extensions
      • USD/Hydra
      • Omnigraph
      • Content Browser
      • Filebrowser/Picker
      • Physics
      • Miscellaneous
      • Rendering
    • 2020.3.2 Hot Fix
      • General
    • 2020.3
      • Content Browser
      • omni.ui
      • Property window and widget extensions
      • FilePicker
      • Kit Microservices Framework
      • Thumbnail Generation Service
      • Render Settings
      • Movie Capture (new-gen capture tool which works with async rendering, IRay renderer)
      • IRay
      • Extensions System
      • Hydra
      • Script Editor
      • Console
      • Materials and MDL support
      • ImageViewer
      • Asset Importer
      • Stage Widget
      • USD Collector Tool
      • Omni::UI Graph Widget
      • Splash Screen
      • Menu
      • Layer Window
    • Kit 2020.2.2 Hotfix
      • General
      • Core Framework & USD
    • 2020.2.1 Hotfix
      • General
      • Client Library
      • omni.usd
      • Extension System
      • Omniverse RTX
    • 2020.2.1 Hotfix
      • General
      • Client Library
      • omni.usd
      • Extension System
      • Omniverse RTX
    • 2020.2
      • Client Library
      • Extensions System
      • General Improvements
      • Animation
      • UI Framework
      • Kit Application UI/Material Workflow
      • Cloud and Microservices
      • Hydra Viewport
      • Viewport Window
      • Ansel
      • Materials
      • Physics & Simulation - General
      • Physics & Simulation - Vehicles
      • Physics & Simulation - Blast
    • 2020.1: Hotfix
      • General
      • Isaac Sim
      • Physics/Simulation
    • 2020.1
      • Core Framework & USD
      • UI Framework
      • Kit Application UI/Material Workflow
      • Cloud and Microservices
      • Streaming
      • Known issues caused by driver bugs or missing functionality
      • Materials
      • OmniGraph
      • Animation
      • Physics / Simulation
    • Kit Known Limitations
• 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

RTX Rendering

• Lights
  • Lighting Overview
  • Light Sources
    • Distant Light
    • Sphere Light
    • Rectangular (Rect) Light
    • Disc Light
    • Cylinder Light
    • Dome Light
    • Common Light Properties
  • Light Linking
    • Property Panel Settings
    • Light Link
    • Shadow Link
• Cameras
  • Using Cameras (Video)
  • Camera Properties
    • Lens Properties
    • Aperture Properties
    • Clipping Properties
    • Fisheye Properties
    • Shutter Properties
• Omniverse MDL Materials
  • Overview
  • Material Templates
    • OmniPBR
      • Overview
    • OmniPBR ClearCoat
      • Overview
      • Parameters
        • Albedo
        • Reflectivity
        • AO
        • Emissive
        • Opacity
        • Clearcoat
        • Normal
        • UV
    • OmniGlass
      • Overview
      • Parameters
        • Color
        • Roughness
        • Refraction
        • Reflection
        • Normal
        • Opacity
        • UV
    • UsdPreviewSurface
    • OmniPBR_Opacity
    • OmniPBR ClearCoat Opacity
    • OmniGlass Opacity
    • OmniSurfaceBase and OmniSurfaceLiteBase
      • Overview
      • Parameters
        • Base (Diffuse reflection, Metal)
        • Specular (Specular reflection)
        • Transmission (Specular transmission)
        • Subsurface (Subsurface scattering, Diffuse transmission)
        • Coat (Specular reflection thin-shell)
        • Sheen (Specular retro-reflection)
        • Emission
        • Thin Film
        • Geometry Section (Opacity, Geometry normal, Displacement)
      • Presets
    • OmniHairBase
      • Overview
      • Parameters
        • Color
        • Specular (Specular reflection)
        • Diffuse (Diffuse Scattering)
        • Emission
        • Geometry (Opacity, Geometry normal, Displacement)
      • Presets
    • References
    • Color Space
  • Applying Materials
    • Apply a Material to a Mesh
      • Search Material List
    • Drag and Drop Assignment
  • Creating Materials
    • Create Material on Mesh
    • Create Material in Scene
  • Material Selection
    • Looks
    • Scene Material Quick Linking
    • Locate MDLs on your Nucleus
    • Finding Objects attached to a Material
  • Material Swap
    • Choose a Target Material
    • Choose a Source Material
    • Swap
  • UDIM Support
    • Overview
    • Using UDIM’s in Omniverse Create (Video)
    • Example
  • Primvars
  • Expanding Your Library
    • MDL in Substance (Video)
• Render Settings Overview
  • Saving Settings Presets
• Common Rendering Settings
  • Geometry
  • Materials
  • Lighting
  • Global Volumetric Effects
  • Simple Fog
  • Flow
  • Debug View
• RTX Real-Time Settings
  • Eco Mode
  • Anti-Aliasing
  • Direct Lighting
  • Reflections
  • Translucency
  • Subsurface Scattering (Experimental)
  • Caustics
  • Indirect Diffuse Lighting
  • Multi-GPU
• RTX Interactive (Path Tracing) Settings
  • Anti-Aliasing
  • Firefly Filtering
  • Path-Tracing
  • Sampling & Caching
  • Denoising
  • Path-Traced Fog
  • Non-uniform Volumes
    • How to create a VDB volume object
    • How to create a procedural volume object
  • Multi-GPU
• RTX Accurate (Iray) Settings
  • Overview
  • Device Settings
  • Scheduler Settings
  • Render Settings
  • Spectral Rendering
  • Matte Ground Plane Settings
  • Advanced
• Post Processing Render Settings
  • Tone Mapping
  • Auto Exposure
  • Color Correction
  • Color Grading
  • XR Alpha and Video Compositing
  • Chromatic Aberration
  • Depth of Field
  • Motion Blur
  • FFT Bloom
  • TV Noise
  • Reshade

Learning and Feedback

• Omniverse Glossary of Terms
• Essential Skills
  • Omniverse Create Skills
    • Layer Setup (Outdoor Scenario)
    • Viewport Navigation
    • Model vs Prim (Selection Modes)
    • Prop Placement
    • Changing Materials (Outdoor Scene)
    • Paint Tool
    • Dome Light
    • Dynamic Sky
    • Sun Study Extension
    • Emissive Materials
    • Flow (Fire)
    • Make Camera
    • Camera Animation
    • Render Settings
    • Rendering A Sun Study
    • Layer Setup (Indoor Scenario)
    • Domelighting
    • IES Lights
    • Prop Placement with Snap
    • Flow Candle
    • Duplication
    • Zero-G Placement
    • Material Change (Indoor Scenario)
    • Render Settings
    • Depth of Field
    • 360 Degree Render
    • Tone Mapping
    • Autoexposure
    • Reshade
    • Animation and Movie Capture
    • Three Render Modes
  • Omniverse View Skills
    • Edit Mode vs Review Mode
    • Rendering Options (Draft/Preview/Photo)
    • Cameras and Playlists
    • Waypoints
    • Stage
    • Materials
    • Skies
    • Section Tool
    • Movie Maker
    • Light Toggle
    • Asset Browser
• Nvidia On-Demand Video List
  • Product
  • Type
  • Topic
  • Partner
• Documentation Fix Request
• General Feedback

Licenses

• NVIDIA OMNIVERSE LICENSE AGREEMENT
  • 1. Definitions
  • 2. Licenses
  • 3. Distribution Requirements.
  • 4. Authorized Users.
  • 5. User Content
  • 6. Limitations
• SOFTWARE SUPPORT SUPPLEMENT
  • Scope
  • Services
  • Exclusions
  • Your Responsibilities
  • Service Fees; Payment Terms
  • Definitions
• Other Licenses
  • -release License
  • -release License
  • DeltaFormatPlugins.linux64_release License
  • MarkupSafe License
  • NVIDIA License
  • OmniverseKit License
  • PIP-packages Licenses
  • PyInstaller License
  • PyYAML License
  • aftermath License
  • aiohttp License
  • altgraph License
  • animx License
  • anselcontrolsdk License
  • anselsdk License
  • api_server License
  • assimp License
  • async_timeout License
  • atomicwrites License
  • attrs License
  • basemdls License
  • boost License
  • boost License
  • boost_1_0 License
  • breakpad License
  • breakpad License
  • brotli License
  • brotli License
  • bzip2 License
  • bzip2 License
  • c License
  • c License
  • c-blosc License
  • carb_gfx_plugins License
  • carb_gfx_plugins License
  • carb_sdk License
  • carb_sdk License
  • carb_sdk_plugins License
  • carb_sdk_plugins License
  • carbonite License
  • catch2 License
  • cchardet License
  • client-library License
  • client-library License
  • compile-time-regular-expressions License
  • compile-time-regular-expressions License
  • concurrentqueue License
  • concurrentqueue License
  • concurrentqueue-mpmc_sema License
  • concurrentqueue-mpmc_sema License
  • cpp License
  • cpp License
  • cpp-httplib License
  • cpp-httplib License
  • cpp_redis License
  • cpptoml License
  • cpptoml License
  • ctre License
  • cuda License
  • cxxopts License
  • cxxopts License
  • d3dcompiler License
  • doctest-1 License
  • doctest-1 License
  • doctest License
  • doctest License
  • drivepdk License
  • drivepdk License
  • dxc License
  • easywsclient License
  • eigen License
  • embree License
  • embree License
  • ext_assetimport_release License
  • fast-quadric-mesh-simplification License
  • fastlz License
  • filmgrain2 License
  • flatbuffers License
  • fmt License
  • forgeaudio License
  • forgeaudio License
  • freetype License
  • gcc License
  • glew License
  • glew License
  • glfw License
  • glfw License
  • gli License
  • gli License
  • glm License
  • glm License
  • glslang License
  • gsl License
  • h5py License
  • hiredis License
  • hiredis License
  • idl.client.js License
  • idl.client.js-NPM Licenses
  • idl.client.js-PIP Licenses
  • idl.core.py License
  • idl.core.py-pip License
  • idl.cpp License
  • idl.cpp License
  • idl.py License
  • idl.py-PIP Licenses
  • idl.py-pip License
  • idl.transpiler License
  • idl.transpiler-NPM Licenses
  • idl.transpiler-npm License
  • idl.transpiler.linux License
  • ilmbase License
  • ilmbase License
  • imgui License
  • imguicolortextedit License
  • imguizmo License
  • iray License
  • iray-for-omniverse License
  • jinja2 License
  • jwt-cpp License
  • kaguya License
  • kaguya License
  • legion License
  • leveldb License
  • libbacktrace License
  • libbacktrace License
  • libcurl License
  • libcurl License
  • libffi License
  • libflac License
  • libflac License
  • libgcc License
  • libgcc License
  • libogg License
  • libogg License
  • libomnifuse License
  • libopus License
  • libopus License
  • libprometheus License
  • library License
  • library License
  • libstdc++ License
  • libstdc++ License
  • libunwind License
  • libuv License
  • libvorbis License
  • libvorbis License
  • libwebsockets License
  • libxml2 License
  • ltc License
  • lua License
  • lua License
  • lz4 License
  • mayatestsamples License
  • mdl License
  • mdl-sdk-for-arnold License
  • mdl-sdk-for-omniverse License
  • mdl_arnold License
  • mikktspace License
  • minhook License
  • minhook License
  • minimp3 License
  • minimp3 License
  • ms License
  • ms License
  • nanosvg License
  • nanovdb License
  • nanovg License
  • ngx_sdk License
  • ngx_snippets License
  • nlohmann-json License
  • nlohmann-json License
  • nng License
  • nv_usd License
  • nv_usd License
  • nvapi License
  • nvenc License
  • nvflow License
  • nvrtc License
  • nvtt3 License
  • nvtx License
  • nvtx License
  • nvwebview License
  • omni-asset.linux-x86_64 License
  • omni-client-library License
  • omni-config-cpp License
  • omni-config-cpp License
  • omni-connect-wrapper License
  • omni-core-materials License
  • omni-core-materials License
  • omni-image.linux64_release License
  • omni_physics License
  • omnitrace License
  • omnitrace License
  • omniverse-3dsmax License
  • omniverse-3dsmax-connector License
  • omniverse-asset-converter License
  • omniverse-maya-connector License
  • omniverse-sketchup License
  • omniverse.auth.client.c License
  • omniverse.auth.client.c-linux-x86_64 License
  • omniverse.auth.client.c-windows-x86_64 License
  • omniverse.discovery.client License
  • omniverse.discovery.client.c-linux-x86_64 License
  • omniverse.discovery.client.c-windows-x86_64 License
  • omniverse.discovery.client.c.linux-x86_64 License
  • omniverse.discovery.client.c.windows-x86_64 License
  • omniverse.discovery.client.py License
  • omniverse.discovery.client.py-pip License
  • omniverse.nucleus-server.bin.linux-x86_64 License
  • omniverse.search.client.py License
  • omniverse.search.client.py-pip License
  • omniverse.tagging.client.py License
  • omniverse_client_library License
  • omniverse_connection License
  • omniverse_connection License
  • omniverse_connection.windows-x86_64-release License
  • omniverse_resolvers License
  • omniverse_resolvers.linux-x86_64-release License
  • oneeurofilter License
  • openexr License
  • openexr License
  • openssl License
  • openssl License
  • opensubdiv License
  • opensubdiv License
  • openvdb License
  • openvr License
  • optix License
  • package-licenses_omniverse-revit License
  • package-licenses_omniverse-rhino License
  • packman-packager License
  • packman-packager-npm License
  • packman-packager-pip License
  • physxdevice License
  • physxsdk License
  • pillow License
  • ptex License
  • ptex License
  • pugixml License
  • pugixml License
  • pybind11 License
  • pybind11 License
  • pytest License
  • pytest_aiohttp License
  • python-1 License
  • python-1 License
  • python-2 License
  • python-2 License
  • python-3 License
  • python-3 License
  • python-4 License
  • python-4 License
  • python License
  • python License
  • rapidjson License
  • rapidjson License
  • rapidxml License
  • realm4kit License
  • redis-ms License
  • redis-ms License
  • rendering License
  • rtx_plugins License
  • samplingsphericalcaps License
  • sdl_gamecontrollerdb License
  • sdlgamecontrollerdb License
  • sdlgamecontrollerdb License
  • slang License
  • snappy-1 License
  • snappy License
  • spirv-headers License
  • spirv-tools License
  • sqlite License
  • sqlite License
  • stb License
  • stb License
  • stdint License
  • streamsdk License
  • tbb License
  • tbb License
  • teamcity_messages License
  • thirdparty License
  • tiny-process-library License
  • tinytoml License
  • tinytoml License
  • tracy License
  • tracy License
  • tracy_client_source License
  • tracy_client_source License
  • usd License
  • usd License
  • usd_audio_schema License
  • usd_ext_animation License
  • usd_ext_physics License
  • usd_ext_physics License
  • usd_schema_semantics License
  • valgrind-header License
  • valgrind-header License
  • valijson License
  • valijson License
  • vhacd License
  • video-xcode License
  • vulkan-2 License
  • vulkan-3 License
  • vulkan License
  • vulkan-root License
  • vulkansdk License
  • websockets License
  • winpixeventruntime License
  • xed License
  • xed License
  • zlib-1 License
  • zlib-1 License
  • zlib-2 License
  • zlib-2 License
  • zlib License
  • zlib License
  • zstd License
  • zstd License