Skip to content

add module doc to bevy_render #20469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Aug 9, 2025
Merged

add module doc to bevy_render #20469

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b8e925a
add module doc to bevy_render
atlv24 Aug 9, 2025
0507304
Update crates/bevy_render/src/lib.rs
atlv24 Aug 9, 2025
946be3d
Update crates/bevy_render/src/lib.rs
atlv24 Aug 9, 2025
264cb5a
Update crates/bevy_render/src/lib.rs
atlv24 Aug 9, 2025
9be8e84
Update crates/bevy_render/src/lib.rs
atlv24 Aug 9, 2025
6d959c1
Update crates/bevy_render/src/lib.rs
atlv24 Aug 9, 2025
e2305d3
Update crates/bevy_render/src/lib.rs
atlv24 Aug 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions crates/bevy_render/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
//! # Useful Environment Variables
//!
//! Both `bevy_render` and `wgpu` have a number of environment variable options for changing the runtime behavior
//! of both crates. Many of these may be useful in development or release environments.
//!
//! - `WGPU_DEBUG=1` enables debug labels, which can be useful in release builds.
//! - `WGPU_VALIDATION=0` disables validation layers. This can help with particularly spammy errors.
//! - `WGPU_FORCE_FALLBACK_ADAPTER=1` attempts to force software rendering. This typically matches what is used in CI.
//! - `WGPU_ADAPTER_NAME` allows selecting a specific adapter by name.
//! - `WGPU_SETTINGS_PRIO=webgl2` uses webgl2 limits.
//! - `WGPU_SETTINGS_PRIO=compatibility` uses webgpu limits.
//! - `VERBOSE_SHADER_ERROR=1` prints more detailed information about WGSL compilation errors, such as shader defs and shader entrypoint.

#![expect(missing_docs, reason = "Not all docs are written yet, see #3492.")]
#![expect(unsafe_code, reason = "Unsafe code is used to improve performance.")]
#![cfg_attr(
Expand Down
Loading