Updated documentation.

Author: weegeekps

CONTRIBUTING.md

@@ -41,7 +41,7 @@ For ideas for Cesium WASM Utilities code contributions, see:
 - issues labeled [`good first issue`](https://github.com/CesiumGS/cesium/labels/good%20first%20issue) and
 - issues labeled [`type - roadmap`](https://github.com/CesiumGS/cesium/labels/type%20-%20roadmap).
 
-See the [Build Guide](Documentation/BuildGuide.md) for how to build and run Cesium on your system.
+See the [README](README.md) for how to build and run Cesium on your system.
 
 Always feel free to introduce yourself on the [Cesium community forum](https://community.cesium.com/) to brainstorm ideas and ask for guidance.
 

Documentation/BuildGuide.md

@@ -0,0 +1,79 @@
+# cesium-wasm-utils
+
+![Cesium](https://github.com/CesiumGS/cesium/wiki/logos/Cesium_Logo_Color.jpg)
+
+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](https://github.com/CesiumGS/cesium/blob/main/README.md).
+
+## Packages in this Repository
+
+- [wasm-splats](wasm-splats/README.md): High-performance algorithms used in the rendering Gaussian Splats in CesiumJS.
+
+# Get Started
+
+These instructions assume that you already
+have [CesiumJS](https://github.com/CesiumGS/cesium/blob/main/README.md#rocket-get-started) configured on your system.
+
+## Prerequisites
+
+- [Node.js](https://nodejs.org/en/download/) v22 or later.
+- [Rust](https://www.rust-lang.org/tools/install) v1.55 or later.
+- [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/) v0.13 or later.
+
+### Installation recommendations.
+
+#### Node.js
+
+##### Windows
+
+On Windows, we recommend using [chocolatey](https://chocolatey.org/) to install Node.js.
+
+```sh
+choco install nodejs
+```
+
+##### Linux and macOS
+
+On Linux and macOS, we recommend using [nvm](https://github.com/nvm-sh/nvm) to install Node.js.
+
+See the [nvm README](https://github.com/nvm-sh/nvm/blob/master/README.md) for installation instructions.
+
+#### Rust
+
+On all platforms, we recommend using [rustup](https://rustup.rs/) to install Rust.
+
+See the [rust website](https://www.rust-lang.org/tools/install) for installation instructions.
+
+#### wasm-pack
+
+On all platforms, we recommend using the wasm-pack installer to install wasm-pack.
+
+See the [wasm-pack website](https://rustwasm.github.io/wasm-pack/installer/) for installation instructions.
+
+## Clone the Repository
+
+```sh
+git clone [email protected]:CesiumGS/cesium-wasm-utils.git
+```
+
+## Generate Documentation and open in Browser
+
+To generate the documentation for all packages in the workspace and open in your default browser, run:
+
+```sh
+cargo doc --no-deps --document-private-items --open
+```
+
+## Further instructions
+
+For further instructions on building and running the packages in this repository, see the README in each package
+directory.

README.md

@@ -1,84 +1,28 @@
-<div align="center">
+# wasm-splats
 
-  <h1><code>wasm-pack-template</code></h1>
+The `wasm-splats` package contains high-performance algorithms used in the rendering Gaussian Splats in CesiumJS.
 
-  <strong>A template for kick starting a Rust and WebAssembly project using <a href="https://github.com/rustwasm/wasm-pack">wasm-pack</a>.</strong>
+## Getting Started
 
-  <p>
-    <a href="https://travis-ci.org/rustwasm/wasm-pack-template"><img src="https://img.shields.io/travis/rustwasm/wasm-pack-template.svg?style=flat-square" alt="Build Status" /></a>
-  </p>
+Follow the instructions in the [cesium-wasm-utils README](./README.md) to clone the repository and install
+prerequisites.
 
-  <h3>
-    <a href="https://rustwasm.github.io/docs/wasm-pack/tutorials/npm-browser-packages/index.html">Tutorial</a>
-    <span> | </span>
-    <a href="https://discordapp.com/channels/442252698964721669/443151097398296587">Chat</a>
-  </h3>
+### Building
 
-  <sub>Built with 🦀🕸 by <a href="https://rustwasm.github.io/">The Rust and WebAssembly Working Group</a></sub>
-</div>
+To build the package, run:
 
-## About
-
-[**📚 Read this template tutorial! 📚**][template-docs]
-
-This template is designed for compiling Rust libraries into WebAssembly and
-publishing the resulting package to NPM.
-
-Be sure to check out [other `wasm-pack` tutorials online][tutorials] for other
-templates and usages of `wasm-pack`.
-
-[tutorials]: https://rustwasm.github.io/docs/wasm-pack/tutorials/index.html
-[template-docs]: https://rustwasm.github.io/docs/wasm-pack/tutorials/npm-browser-packages/index.html
-
-## 🚴 Usage
-
-### 🐑 Use `cargo generate` to Clone this Template
-
-[Learn more about `cargo generate` here.](https://github.com/ashleygwilliams/cargo-generate)
-
-```
-cargo generate --git https://github.com/rustwasm/wasm-pack-template.git --name my-project
-cd my-project
+```sh
+wasm-pack build --release --target web --scope cesium
 ```
 
-### 🛠️ Build with `wasm-pack build`
+This will output a `pkg` directory containing the compiled WebAssembly module and JavaScript bindings.
 
-```
-wasm-pack build
-```
+### Testing
 
-### 🔬 Test in Headless Browsers with `wasm-pack test`
+To run the unit and integration tests, run:
 
+```sh
+wasm-pack test --headless --chrome --firefox
 ```
-wasm-pack test --headless --firefox
-```
-
-### 🎁 Publish to NPM with `wasm-pack publish`
-
-```
-wasm-pack publish
-```
-
-## 🔋 Batteries Included
-
-* [`wasm-bindgen`](https://github.com/rustwasm/wasm-bindgen) for communicating
-  between WebAssembly and JavaScript.
-* [`console_error_panic_hook`](https://github.com/rustwasm/console_error_panic_hook)
-  for logging panic messages to the developer console.
-* `LICENSE-APACHE` and `LICENSE-MIT`: most Rust projects are licensed this way, so these are included for you
-
-## License
-
-Licensed under either of
-
-* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
-* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
-
-at your option.
-
-### Contribution
 
-Unless you explicitly state otherwise, any contribution intentionally
-submitted for inclusion in the work by you, as defined in the Apache-2.0
-license, shall be dual licensed as above, without any additional terms or
-conditions.
+In macOS, you can also add `--safari` to run the tests in Safari.

wasm-splats/README.md

@@ -4,12 +4,9 @@ pub mod texture_gen;
 use js_sys::{Float32Array, Object, Uint32Array, Uint8Array};
 use wasm_bindgen::prelude::*;
 
-#[wasm_bindgen]
-extern "C" {
-    fn alert(s: &str);
-}
-
-//Wrapper func. Most are called directly
+/// Generate a splat texture from the given attributes.
+///
+/// Wraps the [`texture_gen::generate_texture_from_attrs`] function for access from JavaScript.
 #[wasm_bindgen]
 pub fn generate_splat_texture_from_attrs(
     positions: &Float32Array,

wasm-splats/src/lib.rs

@@ -1,13 +1,14 @@
 use js_sys::{Float32Array, Uint32Array};
 use wasm_bindgen::prelude::*;
 
+/// Sorts the Gaussian Splats by depth using a radix sort.
 #[wasm_bindgen]
 pub fn radix_sort_gaussians_indexes(
     positions: &Float32Array,
     model_view: &Float32Array,
     _texture_width: u32, // TODO: FIGURE OUT IF THIS IS NEEDED.
     count: usize,
-) -> Result<js_sys::Uint32Array, JsValue> {
+) -> Result<Uint32Array, JsValue> {
     if positions.length() as usize != count * 3 {
         return Err(JsValue::from_str("Invalid positions length"));
     }

wasm-splats/src/radix.rs

@@ -1,30 +1,38 @@
 use js_sys::{Float32Array, Uint8Array};
 use wasm_bindgen::prelude::*;
 
+/// Represents a texture data object.
 #[wasm_bindgen]
 pub struct TextureData {
+    /// The texture data.
     data: Vec<u32>,
+    /// Width of the texture in pixels.
     width: u32,
+    /// Height of the texture in pixels.
     height: u32,
 }
 
 #[wasm_bindgen]
 impl TextureData {
+    /// Getter for the underlying texture data. Always returns a copy.
     #[wasm_bindgen(getter)]
     pub fn data(&self) -> Vec<u32> {
         self.data.clone()
     }
 
+    /// Getter for the width of the texture in pixels.
     #[wasm_bindgen(getter)]
     pub fn width(&self) -> u32 {
         self.width
     }
 
+    /// Getter for the height of the texture in pixels.
     #[wasm_bindgen(getter)]
     pub fn height(&self) -> u32 {
         self.height
     }
 
+    /// Creates a new texture data object with the underlying data, width, and height.
     pub fn new(data: Vec<u32>, width: u32, height: u32) -> Self {
         TextureData {
             data,
@@ -34,9 +42,10 @@ impl TextureData {
     }
 }
 
-//Algorithm from ILM
-//https://github.com/mitsuba-renderer/openexr/blob/master/IlmBase/Half/half.cpp
+/// Converts a 32-bit float to a 16-bit integer.
 fn float_to_half(f: f32) -> i16 {
+    //Algorithm from ILM
+    //https://github.com/mitsuba-renderer/openexr/blob/master/IlmBase/Half/half.cpp
     let f_int = f.to_bits() as i32;
     let sign = (f_int >> 16) & 0x00008000;
     let mut exp = ((f_int >> 23) & 0x000000ff) - (127 - 15);
@@ -78,6 +87,7 @@ fn float_to_half(f: f32) -> i16 {
     (sign | (exp << 10) | (frac >> 13)) as i16
 }
 
+/// Generates a texture from the given attributes.
 #[wasm_bindgen]
 pub fn generate_texture_from_attrs(
     positions: &Float32Array,