firewheel 0.12.0

An open source audio graph engine for games and other applications
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

name: PR

on:
    push:
        branches: [main]
    pull_request:
        branches: [main]

env:
    CARGO_TERM_COLOR: always
    RUSTFLAGS: --deny warnings
    RUSTDOCFLAGS: --deny warnings

jobs:
    # Run tests.
    test:
        name: Tests
        runs-on: ubuntu-latest
        timeout-minutes: 30
        steps:
            - name: Checkout repository
              uses: actions/checkout@v4

            - name: Install Rust toolchain
              uses: dtolnay/rust-toolchain@stable

            - name: Install dependencies
              run: sudo apt-get update; sudo apt-get install -y --no-install-recommends libasound2-dev libudev-dev libwayland-dev libxkbcommon-dev cmake libpulse-dev

            - name: Populate target directory from cache
              uses: Leafwing-Studios/cargo-cache@v2
              with:
                  sweep-cache: true

            - name: Run tests
              run: |
                  cargo test --locked --workspace --all-features --all-targets

            - name: Test realtime audio garbage collector
              run: |
                  cd crates/firewheel-core && cargo test --locked -- --ignored && cd ../../

            - name: Check no_std build
              run: |
                  cargo build --locked --no-default-features --features "libm, scheduled_events, musical_transport, all_nodes_no_std, node_profiling, glam-29, glam-30, glam-31"

    # Check formatting.
    format:
        name: Format
        runs-on: ubuntu-latest
        timeout-minutes: 30
        steps:
            - name: Checkout repository
              uses: actions/checkout@v4

            - name: Install Rust toolchain
              uses: dtolnay/rust-toolchain@stable
              with:
                  components: rustfmt

            - name: Run cargo fmt
              run: cargo fmt --all -- --check

    # Check documentation.
    doc:
        name: Docs
        runs-on: ubuntu-latest
        timeout-minutes: 30
        steps:
            - name: Checkout repository
              uses: actions/checkout@v4

            - name: Install Rust toolchain
              uses: dtolnay/rust-toolchain@stable

            - name: Install dependencies
              run: sudo apt-get update; sudo apt-get install -y --no-install-recommends libasound2-dev libudev-dev libwayland-dev libxkbcommon-dev cmake libpulse-dev

            - name: Populate target directory from cache
              uses: Leafwing-Studios/cargo-cache@v2
              with:
                  sweep-cache: true

            - name: Check documentation
              run: cargo doc --locked --workspace --all-features --no-deps