Jérôme Bousquié
29 lines
1.4 KiB
Rust
29 lines
1.4 KiB
Rust
//! # WSG Library — Public API Surface
|
|
//!
|
|
//! Re-exports all submodules so consumers can access types via `wsg::mesh::Mesh`, etc.
|
|
//! The library's core responsibility is to abstract five wgpu objects (Instance, Surface, Adapter, Device, Queue)
|
|
//! into a single Context for simpler user interaction.
|
|
//!
|
|
//! ## Module Interactions
|
|
//! - **context** owns hardware resources (Device, Queue, Surface) across the frame lifecycle.
|
|
//! - **pipeline_cache** compiles WGSL shaders into RenderPipelines once, caching them via HashMap + Arc.
|
|
//! - **material** requests pipelines from PipelineCache to define per-object appearance.
|
|
//! - **mesh** holds vertex/index buffers sent to the GPU once at creation time.
|
|
//! - **renderer** orchestrates draw calls using Material + Mesh references passed in at render time.
|
|
//! - **vertex** defines the CPU-side vertex layout matching GPU shader input attributes.
|
|
//! - **error** provides application-level error types mapping each failure mode to a message.
|
|
//! - **conf** centralizes shared constants like shader paths and embedded fallback sources.
|
|
|
|
pub mod conf;
|
|
pub mod context;
|
|
pub mod error;
|
|
pub mod frame;
|
|
pub mod material;
|
|
pub mod mesh;
|
|
pub mod pipeline_cache;
|
|
pub mod renderer;
|
|
pub mod vertex;
|
|
|
|
/// Re-export of the application-level error type for direct use by consumers.
|
|
pub use error::WsgError; // For convenient import without path prefix
|