Overview#

omni.kit.compatibility_checker is an extension that validates system hardware and software compatibility for Omniverse applications. It performs automated checks for GPU support, graphics driver versions, and operating system requirements to ensure applications run properly on the target system.

The extension runs compatibility validation automatically during application startup and provides detailed feedback when compatibility issues are detected. This helps prevent runtime errors and provides clear guidance to users about system requirements.

Functionality#

Hardware Validation#

The extension validates GPU compatibility by checking installed graphics hardware against configurable lists of supported devices. It uses pattern matching to identify compatible GPUs and filters out unsupported graphics adapters like the Microsoft Basic Render Driver.

Driver Version Checking#

Graphics driver versions are validated against blacklist ranges that contain known problematic driver versions. The extension can identify driver versions that cause crashes, image artifacts, or other compatibility issues and warn users accordingly.

Operating System Requirements#

The extension verifies that the current operating system meets minimum version requirements. It supports platform-specific OS version checking for Windows and Linux systems, including both x86_64 and ARM64 architectures.

RTX Renderer Validation#

For applications that require RTX rendering capabilities, the extension can check RTX renderer initialization status to ensure ray-tracing features are available and properly configured.

Key Components#

Compatibility Check Functions#

The core validation functions provide specific compatibility checks:

[get_gpus_list_from_device](omni.kit.compatibility_checker/omni.kit.compatibility_checker.get_gpus_list_from_device)() retrieves available GPU names from graphics devices
[check_supported_gpu](omni.kit.compatibility_checker/omni.kit.compatibility_checker.check_supported_gpu)() validates GPU compatibility against supported patterns
[get_driver_version_from_device](omni.kit.compatibility_checker/omni.kit.compatibility_checker.get_driver_version_from_device)() extracts driver version information
[check_driver_version](omni.kit.compatibility_checker/omni.kit.compatibility_checker.check_driver_version)() checks driver versions against blacklist ranges
[check_os_version](omni.kit.compatibility_checker/omni.kit.compatibility_checker.check_os_version)() validates operating system version requirements

Configuration Settings#

Compatibility criteria are configured through extension settings that define:

Supported GPU patterns using wildcard matching
Driver blacklist ranges with version spans and reason descriptions
Minimum OS version requirements per platform
Timing controls for when compatibility checks execute

Notification Integration#

When compatibility issues are detected, the extension integrates with omni.kit.notification_manager to display user-friendly notifications about system requirements and compatibility problems.

Usage Examples#

The extension runs automatically during application startup, but individual compatibility checks can also be performed programmatically:

import omni.kit.compatibility_checker

# Check if current GPUs meet requirements
gpus = omni.kit.compatibility_checker.get_gpus_list_from_device(device)
supported_patterns = ["*GeForce RTX*", "*Quadro RTX*"]
is_gpu_supported = omni.kit.compatibility_checker.check_supported_gpu(gpus, supported_patterns)

# Validate driver version against blacklist
driver_version = omni.kit.compatibility_checker.get_driver_version_from_device(device)
blacklist_ranges = [["460.0", "461.92", "Driver crashes or artifacts"]]
driver_ok, issues = omni.kit.compatibility_checker.check_driver_version(driver_version, blacklist_ranges)

# Check OS version requirements
min_version = 19042  # Windows build number
os_compatible, current_version = omni.kit.compatibility_checker.check_os_version(min_version)

Considerations#

The extension’s automatic startup checking can be controlled through the waitFrames setting, which determines how many frames to wait before performing compatibility validation. Setting this to a negative value disables automatic checking entirely.

Platform-specific configuration is supported through settings that target specific operating system and architecture combinations, allowing different compatibility requirements for Windows, Linux x86_64, and Linux ARM64 systems.