Skip to content

Commit

Permalink
Update documentation to d1470db.
Browse files Browse the repository at this point in the history
  • Loading branch information
@Kode-Robbot
Kode-Robbot committed Feb 2, 2025
1 parent 7effca5 commit 91d08cb
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 22 deletions.
8 changes: 4 additions & 4 deletions api/sound_8c_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span>}</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="foldopen" id="foldopen00107" data-start="{" data-end="}">
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="sound_8h.html#abfc6940b52c173930e651e82e3efe29f"> 107</a></span><a class="code hl_struct" href="structkinc__a1__sound.html">kinc_a1_sound_t</a> *kinc_a1_sound_create_from_buffer(uint8_t* audio_data, <span class="keyword">const</span> uint32_t size, kinc_a1_audioformat_t format){</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="sound_8h.html#abfc6940b52c173930e651e82e3efe29f"> 107</a></span><a class="code hl_struct" href="structkinc__a1__sound.html">kinc_a1_sound_t</a> *kinc_a1_sound_create_from_buffer(uint8_t *audio_data, <span class="keyword">const</span> uint32_t size, kinc_a1_audioformat_t format) {</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <a class="code hl_struct" href="structkinc__a1__sound.html">kinc_a1_sound_t</a> *sound = find_sound();</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> assert(sound != NULL);</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> sound-&gt;in_use = <span class="keyword">true</span>;</div>
Expand All @@ -201,15 +201,15 @@
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="comment">// size_t filenameLength = strlen(filename);</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> uint8_t *data = NULL;</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <span class="keywordflow">if</span> (format == KINC_A1_AUDIOFORMAT_OGG){</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <span class="keywordflow">if</span> (format == KINC_A1_AUDIOFORMAT_OGG) {</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> <span class="keywordtype">int</span> channels, sample_rate;</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <span class="keywordtype">int</span> samples = stb_vorbis_decode_memory(audio_data, size, &amp;channels, &amp;sample_rate, (<span class="keywordtype">short</span> **)&amp;data);</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> <a class="code hl_function" href="error_8h.html#a2d847867382dad8cec8995ea337766c9">kinc_affirm</a>(samples &gt; 0);</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> sound-&gt;channel_count = (uint8_t)channels;</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> sound-&gt;samples_per_second = (uint32_t)sample_rate;</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> sound-&gt;size = samples * 2 * sound-&gt;channel_count;</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> sound-&gt;bits_per_sample = 16;</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> } </div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> }</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (format == KINC_A1_AUDIOFORMAT_WAV) {</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_wave_data.html">WaveData</a> wave = {0};</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> {</div>
Expand Down Expand Up @@ -300,7 +300,7 @@
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> <a class="code hl_function" href="filereader_8h.html#a9c505ccfa41e48e8f087ad055bab335a">kinc_file_reader_close</a>(&amp;file);</div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span> <span class="keywordtype">size_t</span> filesize = <a class="code hl_function" href="filereader_8h.html#a72da9b6963f48433a7e89cf73e1c6f45">kinc_file_reader_size</a>(&amp;file);</div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> </div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> <a class="code hl_struct" href="structkinc__a1__sound.html">kinc_a1_sound_t</a>* sound = kinc_a1_sound_create_from_buffer(filedata, (uint32_t)filesize, fileformat);</div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> <a class="code hl_struct" href="structkinc__a1__sound.html">kinc_a1_sound_t</a> *sound = kinc_a1_sound_create_from_buffer(filedata, (uint32_t)filesize, fileformat);</div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span> </div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno"> 217</span> free(filedata);</div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno"> 218</span> </div>
Expand Down
33 changes: 15 additions & 18 deletions api/sound_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,24 +107,21 @@
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span>} <a class="code hl_struct" href="structkinc__a1__sound.html">kinc_a1_sound_t</a>;</div>
</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> KINC_A1_AUDIOFORMAT_WAV,</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> KINC_A1_AUDIOFORMAT_OGG</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span>} kinc_a1_audioformat_t;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span>KINC_FUNC <a class="code hl_struct" href="structkinc__a1__sound.html">kinc_a1_sound_t</a> *<a class="code hl_function" href="sound_8h.html#ae31aed948f98ce67385b75c3f866f5dd">kinc_a1_sound_create</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span>KINC_FUNC <a class="code hl_struct" href="structkinc__a1__sound.html">kinc_a1_sound_t</a> *<a class="code hl_function" href="sound_8h.html#abfc6940b52c173930e651e82e3efe29f">kinc_a1_sound_create_from_buffer</a>(uint8_t* audio_data, <span class="keyword">const</span> uint32_t size, kinc_a1_audioformat_t format);</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span>KINC_FUNC <span class="keywordtype">void</span> <a class="code hl_function" href="sound_8h.html#a6e0d312f14fa90e3a33deee3d529588d">kinc_a1_sound_destroy</a>(<a class="code hl_struct" href="structkinc__a1__sound.html">kinc_a1_sound_t</a> *sound);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span>KINC_FUNC <span class="keywordtype">float</span> <a class="code hl_function" href="sound_8h.html#a9aa2be2aca35d4a0bf7a0effb110c0d5">kinc_a1_sound_volume</a>(<a class="code hl_struct" href="structkinc__a1__sound.html">kinc_a1_sound_t</a> *sound);</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span>KINC_FUNC <span class="keywordtype">void</span> <a class="code hl_function" href="sound_8h.html#a7ce60a6ebdcabe19338adcda9ba5b785">kinc_a1_sound_set_volume</a>(<a class="code hl_struct" href="structkinc__a1__sound.html">kinc_a1_sound_t</a> *sound, <span class="keywordtype">float</span> value);</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span>}</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">typedef</span> <span class="keyword">enum</span> { KINC_A1_AUDIOFORMAT_WAV, KINC_A1_AUDIOFORMAT_OGG } kinc_a1_audioformat_t;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>KINC_FUNC <a class="code hl_struct" href="structkinc__a1__sound.html">kinc_a1_sound_t</a> *<a class="code hl_function" href="sound_8h.html#ae31aed948f98ce67385b75c3f866f5dd">kinc_a1_sound_create</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span>KINC_FUNC <a class="code hl_struct" href="structkinc__a1__sound.html">kinc_a1_sound_t</a> *<a class="code hl_function" href="sound_8h.html#abfc6940b52c173930e651e82e3efe29f">kinc_a1_sound_create_from_buffer</a>(uint8_t *audio_data, <span class="keyword">const</span> uint32_t size, kinc_a1_audioformat_t format);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>KINC_FUNC <span class="keywordtype">void</span> <a class="code hl_function" href="sound_8h.html#a6e0d312f14fa90e3a33deee3d529588d">kinc_a1_sound_destroy</a>(<a class="code hl_struct" href="structkinc__a1__sound.html">kinc_a1_sound_t</a> *sound);</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span>KINC_FUNC <span class="keywordtype">float</span> <a class="code hl_function" href="sound_8h.html#a9aa2be2aca35d4a0bf7a0effb110c0d5">kinc_a1_sound_volume</a>(<a class="code hl_struct" href="structkinc__a1__sound.html">kinc_a1_sound_t</a> *sound);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span>KINC_FUNC <span class="keywordtype">void</span> <a class="code hl_function" href="sound_8h.html#a7ce60a6ebdcabe19338adcda9ba5b785">kinc_a1_sound_set_volume</a>(<a class="code hl_struct" href="structkinc__a1__sound.html">kinc_a1_sound_t</a> *sound, <span class="keywordtype">float</span> value);</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span>}</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aaudio2_2audio_8h_html"><div class="ttname"><a href="audio2_2audio_8h.html">audio.h</a></div><div class="ttdoc">Audio2 is a low-level audio-API that allows you to directly provide a stream of audio-samples.</div></div>
<div class="ttc" id="aglobal_8h_html"><div class="ttname"><a href="global_8h.html">global.h</a></div><div class="ttdoc">Provides basic functionality that's used all over the place. There's usually no need to manually incl...</div></div>
<div class="ttc" id="asound_8h_html_a6e0d312f14fa90e3a33deee3d529588d"><div class="ttname"><a href="sound_8h.html#a6e0d312f14fa90e3a33deee3d529588d">kinc_a1_sound_destroy</a></div><div class="ttdeci">KINC_FUNC void kinc_a1_sound_destroy(kinc_a1_sound_t *sound)</div><div class="ttdoc">Destroy a sound.</div><div class="ttdef"><b>Definition</b> sound.c.h:222</div></div>
Expand Down

0 comments on commit 91d08cb

Please sign in to comment.