You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This document enumerates the primary Cargo features exposed by the workspace relevant to rendering and validation behavior. It defines defaults, relationships, and expected behavior in debug and release builds.
19
+
This document enumerates the primary Cargo features exposed by the workspace
20
+
relevant to rendering, validation, and audio behavior. It defines defaults,
21
+
relationships, and expected behavior in debug and release builds.
20
22
21
23
## Table of Contents
22
24
-[Overview](#overview)
23
25
-[Defaults](#defaults)
24
-
-[Rendering Backends](#rendering-backends)
25
-
-[Shader Backends](#shader-backends)
26
-
-[Render Validation](#render-validation)
26
+
-[`lambda-rs`](#lambda-rs)
27
+
-[`lambda-rs-platform`](#lambda-rs-platform)
27
28
-[Changelog](#changelog)
28
29
29
30
## Defaults
30
31
- Workspace defaults prefer `wgpu` on supported platforms and `naga` for shader compilation.
31
32
- Debug builds enable all validations unconditionally via `debug_assertions`.
32
33
- Release builds enable only cheap safety checks by default; validation logs and per-draw checks MUST be enabled explicitly via features.
34
+
- Audio features are disabled by default and incur runtime cost only when an
35
+
audio device is initialized and kept alive.
33
36
34
-
## Rendering Backends
35
-
-`lambda-rs`
36
-
-`with-wgpu` (default): enables the `wgpu` platform backend via `lambda-rs-platform`.
runtime cost is proportional to the output callback workload and buffer size;
65
+
no runtime cost is incurred unless an `AudioOutputDevice` is built and kept
66
+
alive.
67
+
68
+
Render validation
44
69
45
70
Umbrella features (crate: `lambda-rs`)
46
71
-`render-validation`: enables common builder/pipeline validation logs (MSAA counts, depth clear advisories, stencil format upgrades, render-target compatibility) by composing granular validation features. This umbrella includes `render-validation-msaa`, `render-validation-depth`, `render-validation-stencil`, `render-validation-pass-compat`, and `render-validation-render-targets`.
@@ -84,7 +109,30 @@ Usage examples
84
109
- Enable only MSAA validation in release:
85
110
-`cargo test -p lambda-rs --features render-validation-msaa`
86
111
112
+
## `lambda-rs-platform`
113
+
114
+
This crate provides platform and dependency abstractions for `lambda-rs`.
115
+
Applications MUST NOT depend on `lambda-rs-platform` directly.
116
+
117
+
Rendering backend
118
+
-`wgpu` (default): enables the `wgpu` backend.
119
+
-`wgpu-with-vulkan`: enables Vulkan support.
120
+
-`wgpu-with-metal`: enables Metal support.
121
+
-`wgpu-with-dx12`: enables DirectX 12 support.
122
+
-`wgpu-with-gl`: enables OpenGL/WebGL support.
123
+
124
+
Shader backends
125
+
-`shader-backend-naga` (default): uses `naga` for shader handling.
126
+
127
+
Audio
128
+
-`audio` (umbrella, disabled by default): enables platform audio support by
129
+
composing granular platform audio features. This umbrella includes
130
+
`audio-device`.
131
+
-`audio-device` (granular, disabled by default): enables the internal audio
132
+
backend module `lambda_platform::cpal` backed by `cpal =0.17.1`.
133
+
87
134
## Changelog
135
+
- 0.1.7 (2026-01-30): Group features by crate and document audio feature flags.
88
136
- 0.1.6 (2026-01-25): Remove the deprecated legacy shader backend
89
137
documentation.
90
138
- 0.1.5 (2025-12-22): Align `lambda-rs` Cargo feature umbrella composition with
0 commit comments