Skip to content

Commit 2ae6419

Browse files
committed
[update] action to install alsa on linux builds and update documentation to specify the requirement for it.
1 parent df62c62 commit 2ae6419

File tree

3 files changed

+17
-6
lines changed

3 files changed

+17
-6
lines changed

.github/workflows/compile_lambda_rs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ jobs:
4848
pkg-config libx11-dev libxcb1-dev libxcb-render0-dev \
4949
libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev \
5050
libwayland-dev libudev-dev \
51+
libasound2-dev \
5152
libvulkan-dev libvulkan1 mesa-vulkan-drivers vulkan-tools
5253
5354
- name: Configure Vulkan (Ubuntu)

docs/features.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ title: "Cargo Features Overview"
33
document_id: "features-2025-11-17"
44
status: "living"
55
created: "2025-11-17T23:59:00Z"
6-
last_updated: "2026-01-30T22:48:05Z"
7-
version: "0.1.9"
6+
last_updated: "2026-01-30T23:40:49Z"
7+
version: "0.1.10"
88
engine_workspace_version: "2023.1.30"
99
wgpu_version: "26.0.1"
1010
shader_backend_default: "naga"
1111
winit_version: "0.29.10"
12-
repo_commit: "e179f7de3b43f9cd822b4f7ab520c095dc3c6911"
12+
repo_commit: "df62c624ca869e0493a3a92297d1cebe94251e69"
1313
owners: ["lambda-sh"]
1414
reviewers: ["engine", "rendering"]
1515
tags: ["guide", "features", "validation", "cargo", "audio"]
@@ -33,6 +33,9 @@ relationships, and expected behavior in debug and release builds.
3333
- Release builds enable only cheap safety checks by default; validation logs and per-draw checks MUST be enabled explicitly via features.
3434
- Audio support in `lambda-rs` is enabled by default and incurs runtime cost
3535
only when an audio device is initialized and kept alive.
36+
- Linux builds that include the default audio backend MUST provide ALSA
37+
development headers and `pkg-config` (for example, `libasound2-dev` on
38+
Debian/Ubuntu).
3639

3740
## lambda-rs
3841

@@ -132,6 +135,8 @@ Audio
132135
backend module `lambda_platform::cpal` backed by `cpal =0.17.1`.
133136

134137
## Changelog
138+
- 0.1.10 (2026-01-30): Document Linux system dependencies required by the
139+
default audio backend.
135140
- 0.1.9 (2026-01-30): Clarify workspace default audio behavior after enabling
136141
`lambda-rs` audio features by default.
137142
- 0.1.8 (2026-01-30): Enable `lambda-rs` audio features by default and update

docs/specs/audio-devices.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ title: "Audio Device Abstraction"
33
document_id: "audio-device-abstraction-2026-01-28"
44
status: "draft"
55
created: "2026-01-28T22:59:00Z"
6-
last_updated: "2026-01-30T23:21:06Z"
7-
version: "0.1.12"
6+
last_updated: "2026-01-30T23:40:49Z"
7+
version: "0.1.13"
88
engine_workspace_version: "2023.1.30"
99
wgpu_version: "26.0.1"
1010
shader_backend_default: "naga"
1111
winit_version: "0.29.10"
12-
repo_commit: "7e7851da903fbc7b4aa35acd511999df659af237"
12+
repo_commit: "df62c624ca869e0493a3a92297d1cebe94251e69"
1313
owners: ["lambda-sh"]
1414
reviewers: ["engine", "rendering"]
1515
tags: ["spec", "audio", "lambda-rs", "platform", "cpal"]
@@ -555,6 +555,9 @@ Feature gating requirements
555555
- It MUST NOT perform I/O.
556556
- User-provided output callbacks MUST follow the same real-time safety rules as
557557
the stream callback.
558+
- Linux builds with `audio-output-device` enabled MUST provide ALSA development
559+
headers and `pkg-config` so the `alsa-sys` dependency can link successfully
560+
(for example, `libasound2-dev` on Debian/Ubuntu).
558561

559562
## Performance Considerations
560563

@@ -653,6 +656,8 @@ Manual checks
653656

654657
## Changelog
655658

659+
- 2026-01-30 (v0.1.13) — Document Linux system dependencies required by the
660+
default audio backend.
656661
- 2026-01-30 (v0.1.12) — Populate the requirements checklist with file
657662
references matching the implemented surface.
658663
- 2026-01-30 (v0.1.11) — Align examples with the `lambda` crate name, document

0 commit comments

Comments
 (0)