Getting CloudXR#
The NVIDIA CloudXR™ SDK consists of three main components, which are distributed separately:
CloudXR Runtime (Server): Download from NGC. An OpenXR-compliant runtime for Windows and Linux servers. Required for all deployments.
CloudXR Framework (Apple clients): Download from GitHub. A native Swift framework for building visionOS and iOS clients. Required for Apple Vision Pro, iPhone, and iPad support.
CloudXR.js (Early Access for Web clients): Download from NGC. A JavaScript framework for building web-based XR clients. Required for Meta Quest, Pico, and browser-based experiences. Currently in Early Access.
Additionally, there is a Stream Manager service that you can use to manage CloudXR Runtime instances, and many Sample Applications are available to help you get started.
CloudXR Runtime#
CloudXR Runtime is distributed through NVIDIA NGC (NVIDIA GPU Cloud).
To download:
Go to the CloudXR Runtime page on NGC.
Sign in with your NVIDIA account.
Click Download and select your platform:
On Windows, download
CloudXR-<version>-Win64-sdk.zipOn Linux, download
CloudXR-<version>-Linux-sdk.tar.gz
To get started: Refer to CloudXR Runtime for detailed instructions, or follow the LÖVR CloudXR sample for a quick start.
CloudXR Framework#
CloudXR Framework is distributed as an open-source Swift package on GitHub.
To add CloudXR Framework to Your Xcode Project:
In Xcode, go to File → Add Package Dependencies.
Enter the repository URL:
https://github.com/NVIDIA/cloudxr-framework.Select the latest version.
Add the package to your project targets.
To get started: Refer to CloudXR Framework for detailed instructions, or follow the CloudXR Framework tutorial for a quick start.
CloudXR.js (Early Access)#
Warning
CloudXR.js is currently in Early Access, and is distributed through NVIDIA NGC after approval. Features and APIs may change in future releases.
To apply for Early Access:
Apply at the CloudXR Early Access Program.
Provide a detailed description of your use cases.
Applications are reviewed weekly. Once approved, you’ll receive an email with NGC setup instructions.
To download from NGC (after approval):
Go to the CloudXR.js page on NGC.
Sign in with your NVIDIA account.
Download the npm package tarball:
cloudxr-js-<version>.tgz.
To get started: Refer to CloudXR.js (Early Access) for detailed instructions, or follow the CloudXR.js tutorial for a quick start.
Stream Manager (Optional)#
Stream Manager is a Windows service for managing CloudXR Runtime instances.
To download:
Go to the Stream Manager page on NGC.
Download the Windows package: Stream-Manager-<version>-win64.zip.
Extract to your desired location.
To get started: Refer to Stream Manager for detailed instructions.
Sample Applications#
LÖVR CloudXR Sample#
The LÖVR sample is a lightweight OpenXR application that’s ideal for testing your CloudXR deployment.
Repository: NVIDIA/cloudxr-lovr-sample
Platforms: Windows and Linux
Purpose: Validate server setup and client connections
We strongly recommend this sample as your first server application before moving to more complex applications like Omniverse or Unreal Engine.
Generic Viewer (Apple)#
Generic Viewer is a complete reference client for Apple platforms.
Repository: NVIDIA/cloudxr-apple-generic-viewer
Platforms: visionOS and iOS
Purpose: Example CloudXR Framework integration
See Samples Overview for all available samples.
Next Steps#
After you download CloudXR components:
Start with the Quick Start Guide: Quick Start Guide provides a practical workflow for getting your first deployment streaming.
Review Requirements: Ensure your hardware and network meet the specifications:
CloudXR Runtime Requirements: Server requirements
Network Setup: Network configuration (critical for success)