CesiumJS is a JavaScript library for creating 3D globes and 2D maps in a web browser without a plugin. It uses WebGL for hardware-accelerated graphics, and is cross-platform, cross-browser, and tuned for dynamic-data visualization.
Built on open formats, CesiumJS is designed for robust interoperability and scaling for massive datasets.
The cesium-wasm-utils mono-repository contains utilities for CesiumJS written in WebAssembly (Wasm) for
performance-critical tasks.
NOTE: This repository is only required for development of these WebAssembly packages. If you are a CesiumJS user or contributor, you do not need to clone this repository. Instead, follow the instructions in the CesiumJS README.
- wasm-splats: High-performance algorithms used in the rendering of Gaussian Splats in CesiumJS.
These instructions assume that you already have CesiumJS configured on your system.
On Windows, we recommend using chocolatey to install Node.js.
choco install nodejsOn Linux and macOS, we recommend using nvm to install Node.js.
See the nvm README for installation instructions.
On all platforms, we recommend using rustup to install Rust.
See the rust website for installation instructions.
On all platforms, we recommend using the wasm-pack installer to install wasm-pack.
See the wasm-pack website for installation instructions.
Clone the repository:
git clone [email protected]:CesiumGS/cesium-wasm-utils.gitYou need to fork cesium-wasm-utils:
- Fork the repository on GitHub.
- Clone your fork, e.g.,
git clone [email protected]:yourusername/cesium.git. - Make changes in a branch, e.g.,
git checkout -b my-feature.
To generate the documentation for all packages in the workspace and open in your default browser, run:
cargo doc --no-deps --document-private-items --openFor further instructions on building and running the packages in this repository, see the README in each package directory.