tuxmain/HexoDSP
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Slight documentation improvement

Browse source
This commit is contained in:
Weird Constructor 2022-07-25 05:09:06 +02:00
parent 5ec75c3062
commit e7507b2dd0
2 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -101,9 +101,9 @@ This is a short overview of the API provided by the
hexagonal Matrix API, which is the primary API used hexagonal Matrix API, which is the primary API used
inside [HexoSynth](https://github.com/WeirdConstructor/HexoSynth). inside [HexoSynth](https://github.com/WeirdConstructor/HexoSynth).
This only showcases the non-realtime generation of audio This only showcases the direct generation of audio samples, without any audio
samples. For a real time application of this library please device playing it. For a real time application of this library please refer to
refer to the examples that come with this library. the examples that come with this library.
```rust ```rust
use hexodsp::*; use hexodsp::*;
@ -131,6 +131,8 @@ let (out_l, out_r) = node_exec.test_run(0.11, true);
// samples now. // samples now.
``` ```
#### Simplified Hexagonal Matrix API
There is also a simplified version for easier setup of DSP chains There is also a simplified version for easier setup of DSP chains
on the hexagonal grid, using the [crate::MatrixCellChain] abstraction: on the hexagonal grid, using the [crate::MatrixCellChain] abstraction:

8
src/lib.rs
View file

@ -103,9 +103,9 @@ This is a short overview of the API provided by the
hexagonal Matrix API, which is the primary API used hexagonal Matrix API, which is the primary API used
inside [HexoSynth](https://github.com/WeirdConstructor/HexoSynth). inside [HexoSynth](https://github.com/WeirdConstructor/HexoSynth).
This only showcases the non-realtime generation of audio This only showcases the direct generation of audio samples, without any audio
samples. For a real time application of this library please device playing it. For a real time application of this library please refer to
refer to the examples that come with this library. the examples that come with this library.
```rust ```rust
use hexodsp::*; use hexodsp::*;
@ -133,6 +133,8 @@ let (out_l, out_r) = node_exec.test_run(0.11, true);
// samples now. // samples now.
``` ```
### Simplified Hexagonal Matrix API
There is also a simplified version for easier setup of DSP chains There is also a simplified version for easier setup of DSP chains
on the hexagonal grid, using the [crate::MatrixCellChain] abstraction: on the hexagonal grid, using the [crate::MatrixCellChain] abstraction: