gloss_rs/lib.rs
1#![deny(missing_docs)]
2
3//! ## Crate Items Overview
4//!
5//! This section provides quick links to the main items in Gloss.
6//!
7//! ### Modules
8//! - [`gloss_renderer`](crate::gloss_renderer) - The core renderer and viewer
9//! - [`gloss_img`](crate::gloss_img) - Image-related functionality.
10//! - [`easy_wgpu`](crate::easy_wgpu) - Abstractions for wgpu.
11//! - [`gloss_hecs`](crate::gloss_hecs) - A wrapper around hecs forECS-related functionality.
12//! - [`gloss_utils`](crate::gloss_utils) - Utility functions and helpers.
13//! - [`gloss_geometry`](crate::gloss_geometry) - Geometry-related functionality.
14//! - [`wgpu_burn_global_device`](crate::wgpu_burn_global_device) - A global wgpu device for use with burn.
15//! - [`gloss_burn_multibackend`](crate::gloss_burn_multibackend) - A backend for Burn that can dynamically change between backends.
16//! - [`wgpu_burn_interop`](crate::wgpu_burn_interop) - A small library interop via cubecl between wgpu and burn.
17//!
18//! ## Examples
19//! Below are the examples you can explore in the `examples/` folder of the
20//! repository:
21//!
22//! - **Camera Control**: [cam_control.py](https://github.com/Meshcapade/gloss/bindings/gloss_py/examples/cam_control.py)
23//! - **Depth Map**: [depth_map.py](https://github.com/Meshcapade/gloss/bindings/gloss_py/examples/depth_map.py)
24//! - **Empty Scene**: [empty.py](https://github.com/Meshcapade/gloss/bindings/gloss_py/examples/empty.py)
25//! - **Show Mesh as Point Cloud**: [show_mesh_as_point_cloud.py](https://github.com/Meshcapade/gloss/bindings/gloss_py/examples/show_mesh_as_point_cloud.py)
26//!
27//! These examples demonstrate various features of Gloss and can be run
28//! directly.
29
30// Re-exports
31pub use easy_wgpu;
32pub use gloss_burn_multibackend;
33pub use gloss_geometry;
34pub use gloss_img;
35pub use gloss_renderer;
36pub use gloss_utils;
37pub use wgpu_burn_global_device;
38pub use wgpu_burn_interop;