Skip to content

Commit

Permalink
Add feature documentation to lib.rs docs
Browse files Browse the repository at this point in the history
  • Loading branch information
KirmesBude committed Jan 28, 2024
1 parent 4f048e0 commit 273684f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
3 changes: 3 additions & 0 deletions wgpu-core/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@
//! [https://renderdoc.org/](https://renderdoc.org/)
//! - **`strict_asserts`** --- Apply run-time checks, even in release builds. These are in addition
//! to the validation carried out at public APIs in all builds.
//! - **`serde`** --- Enables serde functionality on common wgpu types.
//! - **`serialize`** ---Enables serialize functionality on common wgpu types.
//! - **`deserialize`** --- Enables deserialize functionality on common wgpu types.
//! - **`trace`** --- Enable API tracing.
//! - **`replay`** --- Enable API replaying
//! - **`serial-pass`** --- Enable serializable compute/render passes, and bundle encoders.
Expand Down
3 changes: 3 additions & 0 deletions wgpu/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@
//! - **`strict_asserts`** --- Apply run-time checks, even in release builds. These are in addition
//! to the validation carried out at public APIs in all builds.
//! - **`api_log_info`** --- Log all API entry points at info instead of trace level.
//! - **`serde`** --- Enables serde functionality on common wgpu types.
//! - **`serialize`** ---Enables serialize functionality on common wgpu types.
//! - **`deserialize`** --- Enables deserialize functionality on common wgpu types.
//! - **`trace`** --- Allow writing of trace capture files. See [`Adapter::request_device`].
//! - **`replay`** --- Allow deserializing of trace capture files that were written with the `trace`
//! feature. To replay a trace file use the [wgpu
Expand Down

0 comments on commit 273684f

Please sign in to comment.