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 has designed XR to be clean and flexible:
- Clean: When XR capabilities are not needed, the package does not contain any XR logic, and the size does not increase at all.
- Flexible: Pluggable functionality makes development easier.
- Future-oriented: Multi-backend design allows for adaptation to different platforms and interfaces in the future.
Module Management
| Package | Description | Related Documentation |
|---|---|---|
| @galacean/engine-xr | Core architecture logic | API |
| @galacean/engine-web-xr | Backend package | Doc |
| @galacean/engine-toolkit-xr | Advanced tool components | Doc |
@galacean/engine-xrand@galacean/engine-web-xrare dependencies that must be introduced to implement WebXR. Compared to these two packages,@galacean/engine-toolkit-xris not mandatory, but its presence can make XR development in the editor much simpler.
The dependency rules between XR packages follow the version dependency rules, meaning that the versions of
@galacean/engine-xrand@galacean/engine-web-xrmust be consistent with@galacean/engine, and the major version of@galacean/engine-toolkit-xrmust be consistent with@galacean/engine.
Quick Start
In this section, you can:
- Quickly develop XR interactions and debug XR interactions without any specialized knowledge.
- If you want to deeply understand Galacean XR, refer to XR Core Logic.
- Finally, by understanding XR Compatibility, you can overall control project risks.