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:

  1. Go to the CloudXR Runtime page on NGC.

  2. Sign in with your NVIDIA account.

  3. Click Download and select your platform:

    • On Windows, download CloudXR-<version>-Win64-sdk.zip

    • On 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:

  1. In Xcode, go to FileAdd Package Dependencies.

  2. Enter the repository URL: https://github.com/NVIDIA/cloudxr-framework.

  3. Select the latest version.

  4. 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:

  1. Apply at the CloudXR Early Access Program.

  2. Provide a detailed description of your use cases.

  3. Applications are reviewed weekly. Once approved, you’ll receive an email with NGC setup instructions.

To download from NGC (after approval):

  1. Go to the CloudXR.js page on NGC.

  2. Sign in with your NVIDIA account.

  3. 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:

  1. Go to the Stream Manager page on NGC.

  2. Download the Windows package: Stream-Manager-<version>-win64.zip.

  3. 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.

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.

See Samples Overview for all available samples.

Next Steps#

After you download CloudXR components:

  1. Start with the Quick Start Guide: Quick Start Guide provides a practical workflow for getting your first deployment streaming.

  2. Review Requirements: Ensure your hardware and network meet the specifications: