6502/cc65
1
0
Fork 0
mirror of https://github.com/cc65/cc65.git synced 2024-11-19 06:31:31 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #1975 from marianodominguez/add_sound_documentation

Browse Source 
add documentation for _sound.
This commit is contained in:
Bob Andrews 2023-01-17 22:41:12 +01:00 committed by GitHub
commit 645fa982af
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 39 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/atari.sgml
View File

@ -332,6 +332,7 @@ See the <url url="funcref.html" name="function reference"> for declaration and u
<item>_scroll
<item>_setcolor
<item>_setcolor_low
<item>_sound
<item>waitvsync
</itemize>

39
doc/funcref.sgml
View File

@ -126,6 +126,7 @@ function.
<!-- <item><ref id="_scroll" name="_scroll"> -->
<!-- <item><ref id="_setcolor" name="_setcolor"> -->
<!-- <item><ref id="_setcolor_low" name="_setcolor_low"> -->
<item><ref id="_sound" name="_sound">
<item><ref id="get_ostype" name="get_ostype">
<!-- <item><ref id="get_tv" name="get_tv"> -->
</itemize>
@ -1108,6 +1109,43 @@ considered random to a certain degree.
</descrip>
</quote>
<sect1>_sound<label id="_sound"><p>
<quote>
<descrip>
<tag/Function/Use the speaker to produce sound in a specified voice. (Atari only)
<tag/Header/<tt/<ref id="atari.h" name="atari.h">/
<tag/Declaration/<tt/void _sound (unsigned char voice, unsigned char pitch, unsigned char distortion, unsigned char volume);/
<tag/Description/The function produces a sound with the specified parameters. using any of the 4 availble oscillators (voices) controlled by POKEY chip. Sound is non cpu-blocking and it keeps oscillating until program sends 0 in all the other parameters.
<tag/Notes/<itemize>
<item>The function is specific to the Atari 8 bit.
<item> Voice can be any of 0-3 different sound channels.
<item> Pitch goes from 0-255 (about 125 Hz to 32 Khz).
<item> Distortion (0-14) uses poly dividers to reshape wave in order to create a noise effect. Use 10 for a "pure" square-wave sound.
<item>Volume (0-15) is the intensity for the wave.
<item>Extra bits in those parameters will be ignored.
</itemize>
<tag/Availability/cc65 (not all platforms)
<tag/Example/
<verb>
#include <stdio.h>
int main(void)
{
int i=0;
unsigned char j;
printf("playing sound \n");
for (j=0; j<144; j++) {
_sound(1,144-j,10,8); //change the pitch for voice 1
for (i=0; i<50; i++); //pause for sound duration
}
_sound(1,0,0,0); //use zero in other parameters to stop the sound
return 0;
}
</verb>
</descrip>
</quote>
<sect1>_stroserror<label id="_stroserror"><p>
@ -6908,7 +6946,6 @@ switching the CPU into single clock mode.
</descrip>
</quote>
<sect1>srand<label id="srand"><p>
<quote>