otomatalabs/furnace
7
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Docs: Small additions.

Browse source 
"Bit depth" to the glossary, "Song Comments > Wrap text" to the settings, and a groove calculator link to grooves.
This commit is contained in:
Electric Keet 2024-12-07 18:51:59 -08:00 committed by tildearrow
parent 267061a7f3
commit 6e3c8273be
3 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/1-intro/glossary.md
View file

@ -16,6 +16,9 @@
**bitbang**: to achieve PCM sound by sending a rapid stream of volume commands to a non-PCM channel.
**bit depth**: the number of bits used for each sample in a PCM stream. 16-bit is considered high quality; lower bit depths introduce more noise and distortion, especially for quieter samples.
- the "1-bit DPCM" sample type has 6-bit amplitude resolution, but each sample is represented by only 1 bit indicating whether its amplitude differs from the previous sample by one step up or down.
**bitmask**: a set of bits which represent individual single-bit toggles or groups representing small numbers. these are explained fully in the [hexadecimal primer](hex.md).
**BRR**: a lossy sample format used by the SNES. it has a fixed compression ratio; groups of 32 bytes (16 samples) are encoded in 9 bytes each.

4
doc/2-interface/settings.md
View file

@ -558,6 +558,10 @@ below all the binds, select a key from the dropdown list to add it. it will appe
- **Fill entire window**: removes the gap between the waveform and the edge of the window.
- **Waveform goes out of bounds**: allows the waveform to draw past the top and bottom of the oscilloscope.
### Song Comments
- **Wrap text**: visually breaks long lines at the width of the text box. does not affect the text itself.
### Windows
- **Rounded window corners**

4
doc/8-advanced/grooves.md
View file

@ -20,9 +20,7 @@ a single `09xx` command will switch to the matching numbered groove pattern.
## tempo
this is a non-exhaustive list of grooves and their equivalent tempo in BPM.
note: this table assumes a song's tick rate setting is left at its default value for the chosen engine speed: 60 for NTSC, or 50 for PAL.
this is a non-exhaustive list of grooves and their equivalent tempo in BPM when using NTSC or PAL tick rates (60 or 50) and row highlight values of 4 and 16. for more accurate tempos, differing tick rates, or differing row highlight values, use the [groove calculator](https://pineight.com/ft/calcgroove.html) (courtesy of Damian Yerrick).
BPM NTSC | BPM PAL | groove | | BPM NTSC | BPM PAL | groove
--------:|--------:|:-----------------------|-|---------:|--------:|:----------------------