XR

XR Overview

XR is a general term used to describe the concept of Extended Reality, which includes Virtual Reality (VR), Augmented Reality (AR), and Mixed Reality (MR).

Architecture

Galacean provides a clean and flexible design for XR:

  • Clean: When no XR capabilities are required, the package contains no XR logic, and the size remains unchanged.
  • Flexible: Pluggable features simplify development.
  • Future-ready: A multi-backend design that can be adapted to different platforms and interfaces in the future.
image.png

Module Management

PackageDescriptionRelated Documentation
@galacean/engine-xrCore architecture logicAPI
@galacean/engine-web-xrBackend packageDoc
@galacean/engine-toolkit-xrAdvanced tool componentsDoc

@galacean/engine-xr and @galacean/engine-web-xr are mandatory dependencies for implementing WebXR. In contrast, @galacean/engine-toolkit-xr is not required but simplifies XR development in the editor.

The dependency rules between XR packages follow the version dependency rules:

  • The versions of @galacean/engine-xr and @galacean/engine-web-xr must match the version of @galacean/engine.
  • The major version of @galacean/engine-toolkit-xr must match that of @galacean/engine.

Quick Start

In this section, you will learn to:

Was this page helpful?