Skip to content

Commit 45dd39f

Browse files
DiasFranciscoADiasFranciscoA
committed
updated documentation
1 parent 3c928ed commit 45dd39f

27 files changed

+1021
-29
lines changed

‎source/fmod_gml/extensions/FMOD/docs/DSP.html

Lines changed: 81 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
</li>
6868
</ul>
6969
<ul class="current">
70-
<li class="toctree-l1 current"><a class="reference internal current" href="DSP.html">DSP</a>
70+
<li class="toctree-l1 current"><a class="reference internal current" href="#">DSP</a>
7171
<ul class="current">
7272
<li class="toctree-l2"><a class="reference internal" href="#functions">Functions</a>
7373
</li>
@@ -257,6 +257,8 @@ <h1 id="fmod_dsp_add_input">fmod_dsp_add_input</h1>
257257
</tbody>
258258
</table>
259259
<p><br></p>
260+
<p><br></p>
261+
<p><br></p>
260262
<p><strong>Returns:</strong></p>
261263
<blockquote>
262264
<p><a href="https://manual.gamemaker.io/monthly/en/GameMaker_Language/GML_Overview/Data_Types.htm">Real</a></p>
@@ -304,6 +306,8 @@ <h1 id="fmod_dsp_get_input">fmod_dsp_get_input</h1>
304306
</tbody>
305307
</table>
306308
<p><br></p>
309+
<p><br></p>
310+
<p><br></p>
307311
<p><strong>Returns:</strong></p>
308312
<blockquote>
309313
<p><a href="structs.html#fmoddspconnectiondata">FmodDSPConnectionData</a></p>
@@ -351,6 +355,8 @@ <h1 id="fmod_dsp_get_output">fmod_dsp_get_output</h1>
351355
</tbody>
352356
</table>
353357
<p><br></p>
358+
<p><br></p>
359+
<p><br></p>
354360
<p><strong>Returns:</strong></p>
355361
<blockquote>
356362
<p><a href="structs.html#fmoddspconnectiondata">FmodDSPConnectionData</a></p>
@@ -392,6 +398,8 @@ <h1 id="fmod_dsp_get_num_inputs">fmod_dsp_get_num_inputs</h1>
392398
</tbody>
393399
</table>
394400
<p><br></p>
401+
<p><br></p>
402+
<p><br></p>
395403
<p><strong>Returns:</strong></p>
396404
<blockquote>
397405
<p><a href="https://manual.gamemaker.io/monthly/en/GameMaker_Language/GML_Overview/Data_Types.htm">Real</a></p>
@@ -433,6 +441,8 @@ <h1 id="fmod_dsp_get_num_outputs">fmod_dsp_get_num_outputs</h1>
433441
</tbody>
434442
</table>
435443
<p><br></p>
444+
<p><br></p>
445+
<p><br></p>
436446
<p><strong>Returns:</strong></p>
437447
<blockquote>
438448
<p><a href="https://manual.gamemaker.io/monthly/en/GameMaker_Language/GML_Overview/Data_Types.htm">Real</a></p>
@@ -481,6 +491,8 @@ <h1 id="fmod_dsp_disconnect_all">fmod_dsp_disconnect_all</h1>
481491
</tbody>
482492
</table>
483493
<p><br></p>
494+
<p><br></p>
495+
<p><br></p>
484496
<p><strong>Returns:</strong></p>
485497
<blockquote>
486498
<p>N/A</p>
@@ -530,6 +542,8 @@ <h1 id="fmod_dsp_disconnect_from">fmod_dsp_disconnect_from</h1>
530542
</tbody>
531543
</table>
532544
<p><br></p>
545+
<p><br></p>
546+
<p><br></p>
533547
<p><strong>Returns:</strong></p>
534548
<blockquote>
535549
<p>N/A</p>
@@ -574,6 +588,8 @@ <h1 id="fmod_dsp_get_data_parameter_index">fmod_dsp_get_data_parameter_index</h1
574588
</tbody>
575589
</table>
576590
<p><br></p>
591+
<p><br></p>
592+
<p><br></p>
577593
<p><strong>Returns:</strong></p>
578594
<blockquote>
579595
<p><a href="https://manual.gamemaker.io/monthly/en/GameMaker_Language/GML_Overview/Data_Types.htm">Real</a></p>
@@ -612,6 +628,8 @@ <h1 id="fmod_dsp_get_num_parameters">fmod_dsp_get_num_parameters</h1>
612628
</tbody>
613629
</table>
614630
<p><br></p>
631+
<p><br></p>
632+
<p><br></p>
615633
<p><strong>Returns:</strong></p>
616634
<blockquote>
617635
<p><a href="https://manual.gamemaker.io/monthly/en/GameMaker_Language/GML_Overview/Data_Types.htm">Real</a></p>
@@ -659,6 +677,8 @@ <h1 id="fmod_dsp_set_parameter_bool">fmod_dsp_set_parameter_bool</h1>
659677
</tbody>
660678
</table>
661679
<p><br></p>
680+
<p><br></p>
681+
<p><br></p>
662682
<p><strong>Returns:</strong></p>
663683
<blockquote>
664684
<p>N/A</p>
@@ -701,6 +721,8 @@ <h1 id="fmod_dsp_get_parameter_bool">fmod_dsp_get_parameter_bool</h1>
701721
</tbody>
702722
</table>
703723
<p><br></p>
724+
<p><br></p>
725+
<p><br></p>
704726
<p><strong>Returns:</strong></p>
705727
<blockquote>
706728
<p><a href="https://manual.gamemaker.io/monthly/en/GameMaker_Language/GML_Overview/Data_Types.htm">Boolean</a></p>
@@ -758,6 +780,8 @@ <h1 id="fmod_dsp_set_parameter_data">fmod_dsp_set_parameter_data</h1>
758780
</tbody>
759781
</table>
760782
<p><br></p>
783+
<p><br></p>
784+
<p><br></p>
761785
<p><strong>Returns:</strong></p>
762786
<blockquote>
763787
<p>N/A</p>
@@ -820,6 +844,8 @@ <h1 id="fmod_dsp_get_parameter_data">fmod_dsp_get_parameter_data</h1>
820844
</tbody>
821845
</table>
822846
<p><br></p>
847+
<p><br></p>
848+
<p><br></p>
823849
<p><strong>Returns:</strong></p>
824850
<blockquote>
825851
<p><a href="https://manual.gamemaker.io/monthly/en/GameMaker_Language/GML_Overview/Data_Types.htm">Real</a></p>
@@ -878,6 +904,8 @@ <h1 id="fmod_dsp_set_parameter_float">fmod_dsp_set_parameter_float</h1>
878904
</tbody>
879905
</table>
880906
<p><br></p>
907+
<p><br></p>
908+
<p><br></p>
881909
<p><strong>Returns:</strong></p>
882910
<blockquote>
883911
<p>N/A</p>
@@ -920,6 +948,8 @@ <h1 id="fmod_dsp_get_parameter_float">fmod_dsp_get_parameter_float</h1>
920948
</tbody>
921949
</table>
922950
<p><br></p>
951+
<p><br></p>
952+
<p><br></p>
923953
<p><strong>Returns:</strong></p>
924954
<blockquote>
925955
<p><a href="https://manual.gamemaker.io/monthly/en/GameMaker_Language/GML_Overview/Data_Types.htm">Real</a></p>
@@ -967,6 +997,8 @@ <h1 id="fmod_dsp_set_parameter_int">fmod_dsp_set_parameter_int</h1>
967997
</tbody>
968998
</table>
969999
<p><br></p>
1000+
<p><br></p>
1001+
<p><br></p>
9701002
<p><strong>Returns:</strong></p>
9711003
<blockquote>
9721004
<p>N/A</p>
@@ -1009,6 +1041,8 @@ <h1 id="fmod_dsp_get_parameter_int">fmod_dsp_get_parameter_int</h1>
10091041
</tbody>
10101042
</table>
10111043
<p><br></p>
1044+
<p><br></p>
1045+
<p><br></p>
10121046
<p><strong>Returns:</strong></p>
10131047
<blockquote>
10141048
<p><a href="https://manual.gamemaker.io/monthly/en/GameMaker_Language/GML_Overview/Data_Types.htm">Real</a></p>
@@ -1046,6 +1080,8 @@ <h1 id="fmod_dsp_get_parameter_info">fmod_dsp_get_parameter_info</h1>
10461080
</tbody>
10471081
</table>
10481082
<p><br></p>
1083+
<p><br></p>
1084+
<p><br></p>
10491085
<p><strong>Returns:</strong></p>
10501086
<blockquote>
10511087
<p><a href="structs.html#fmoddspparameterdesc">FmodDspParameterDesc</a></p>
@@ -1102,6 +1138,8 @@ <h1 id="fmod_dsp_set_channel_format">fmod_dsp_set_channel_format</h1>
11021138
</tbody>
11031139
</table>
11041140
<p><br></p>
1141+
<p><br></p>
1142+
<p><br></p>
11051143
<p><strong>Returns:</strong></p>
11061144
<blockquote>
11071145
<p>N/A</p>
@@ -1139,6 +1177,8 @@ <h1 id="fmod_dsp_get_channel_format">fmod_dsp_get_channel_format</h1>
11391177
</tbody>
11401178
</table>
11411179
<p><br></p>
1180+
<p><br></p>
1181+
<p><br></p>
11421182
<p><strong>Returns:</strong></p>
11431183
<blockquote>
11441184
<p><a href="structs.html#fmoddspchannelformat">FmodDSPChannelFormat</a></p>
@@ -1191,6 +1231,8 @@ <h1 id="fmod_dsp_get_output_channel_format">fmod_dsp_get_output_channel_format</
11911231
</tbody>
11921232
</table>
11931233
<p><br></p>
1234+
<p><br></p>
1235+
<p><br></p>
11941236
<p><strong>Returns:</strong></p>
11951237
<blockquote>
11961238
<p><a href="structs.html#fmoddspchannelformat">FmodDSPChannelFormat</a></p>
@@ -1236,6 +1278,8 @@ <h1 id="fmod_dsp_get_metering_info">fmod_dsp_get_metering_info</h1>
12361278
</tbody>
12371279
</table>
12381280
<p><br></p>
1281+
<p><br></p>
1282+
<p><br></p>
12391283
<p><strong>Returns:</strong></p>
12401284
<blockquote>
12411285
<p><a href="structs.html#fmoddspinoutmeteringinfo">FmodDSPInOutMeteringInfo</a></p>
@@ -1289,6 +1333,8 @@ <h1 id="fmod_dsp_set_metering_enabled">fmod_dsp_set_metering_enabled</h1>
12891333
</tbody>
12901334
</table>
12911335
<p><br></p>
1336+
<p><br></p>
1337+
<p><br></p>
12921338
<p><strong>Returns:</strong></p>
12931339
<blockquote>
12941340
<p>N/A</p>
@@ -1326,6 +1372,8 @@ <h1 id="fmod_dsp_get_metering_enabled">fmod_dsp_get_metering_enabled</h1>
13261372
</tbody>
13271373
</table>
13281374
<p><br></p>
1375+
<p><br></p>
1376+
<p><br></p>
13291377
<p><strong>Returns:</strong></p>
13301378
<blockquote>
13311379
<p><a href="structs.html#fmoddspmeteringenableinfo">FmodDSPMeteringEnableInfo</a></p>
@@ -1373,6 +1421,8 @@ <h1 id="fmod_dsp_set_active">fmod_dsp_set_active</h1>
13731421
</tbody>
13741422
</table>
13751423
<p><br></p>
1424+
<p><br></p>
1425+
<p><br></p>
13761426
<p><strong>Returns:</strong></p>
13771427
<blockquote>
13781428
<p>N/A</p>
@@ -1415,6 +1465,8 @@ <h1 id="fmod_dsp_get_active">fmod_dsp_get_active</h1>
14151465
</tbody>
14161466
</table>
14171467
<p><br></p>
1468+
<p><br></p>
1469+
<p><br></p>
14181470
<p><strong>Returns:</strong></p>
14191471
<blockquote>
14201472
<p><a href="https://manual.gamemaker.io/monthly/en/GameMaker_Language/GML_Overview/Data_Types.htm">Boolean</a></p>
@@ -1458,6 +1510,8 @@ <h1 id="fmod_dsp_set_bypass">fmod_dsp_set_bypass</h1>
14581510
</tbody>
14591511
</table>
14601512
<p><br></p>
1513+
<p><br></p>
1514+
<p><br></p>
14611515
<p><strong>Returns:</strong></p>
14621516
<blockquote>
14631517
<p>N/A</p>
@@ -1496,6 +1550,8 @@ <h1 id="fmod_dsp_get_bypass">fmod_dsp_get_bypass</h1>
14961550
</tbody>
14971551
</table>
14981552
<p><br></p>
1553+
<p><br></p>
1554+
<p><br></p>
14991555
<p><strong>Returns:</strong></p>
15001556
<blockquote>
15011557
<p><a href="https://manual.gamemaker.io/monthly/en/GameMaker_Language/GML_Overview/Data_Types.htm">Boolean</a></p>
@@ -1548,6 +1604,8 @@ <h1 id="fmod_dsp_set_wet_dry_mix">fmod_dsp_set_wet_dry_mix</h1>
15481604
</tbody>
15491605
</table>
15501606
<p><br></p>
1607+
<p><br></p>
1608+
<p><br></p>
15511609
<p><strong>Returns:</strong></p>
15521610
<blockquote>
15531611
<p>N/A</p>
@@ -1585,6 +1643,8 @@ <h1 id="fmod_dsp_get_wet_dry_mix">fmod_dsp_get_wet_dry_mix</h1>
15851643
</tbody>
15861644
</table>
15871645
<p><br></p>
1646+
<p><br></p>
1647+
<p><br></p>
15881648
<p><strong>Returns:</strong></p>
15891649
<blockquote>
15901650
<p><a href="structs.html#fmoddspwetdrymixinfo">FmodDSPWetDryMixInfo</a></p>
@@ -1624,6 +1684,8 @@ <h1 id="fmod_dsp_get_idle">fmod_dsp_get_idle</h1>
16241684
</tbody>
16251685
</table>
16261686
<p><br></p>
1687+
<p><br></p>
1688+
<p><br></p>
16271689
<p><strong>Returns:</strong></p>
16281690
<blockquote>
16291691
<p><a href="https://manual.gamemaker.io/monthly/en/GameMaker_Language/GML_Overview/Data_Types.htm">Boolean</a></p>
@@ -1662,6 +1724,8 @@ <h1 id="fmod_dsp_reset">fmod_dsp_reset</h1>
16621724
</tbody>
16631725
</table>
16641726
<p><br></p>
1727+
<p><br></p>
1728+
<p><br></p>
16651729
<p><strong>Returns:</strong></p>
16661730
<blockquote>
16671731
<p>N/A</p>
@@ -1700,6 +1764,8 @@ <h1 id="fmod_dsp_release">fmod_dsp_release</h1>
17001764
</tbody>
17011765
</table>
17021766
<p><br></p>
1767+
<p><br></p>
1768+
<p><br></p>
17031769
<p><strong>Returns:</strong></p>
17041770
<blockquote>
17051771
<p>N/A</p>
@@ -1738,6 +1804,8 @@ <h1 id="fmod_dsp_get_type">fmod_dsp_get_type</h1>
17381804
</tbody>
17391805
</table>
17401806
<p><br></p>
1807+
<p><br></p>
1808+
<p><br></p>
17411809
<p><strong>Returns:</strong></p>
17421810
<blockquote>
17431811
<p><a href="constants.html#fmod_dsp_type">FMOD_DSP_TYPE</a></p>
@@ -1775,6 +1843,8 @@ <h1 id="fmod_dsp_get_info">fmod_dsp_get_info</h1>
17751843
</tbody>
17761844
</table>
17771845
<p><br></p>
1846+
<p><br></p>
1847+
<p><br></p>
17781848
<p><strong>Returns:</strong></p>
17791849
<blockquote>
17801850
<p><a href="structs.html#fmoddspinfo">FmodDSPInfo</a></p>
@@ -1816,6 +1886,8 @@ <h1 id="fmod_dsp_get_cpu_usage">fmod_dsp_get_cpu_usage</h1>
18161886
</tbody>
18171887
</table>
18181888
<p><br></p>
1889+
<p><br></p>
1890+
<p><br></p>
18191891
<p><strong>Returns:</strong></p>
18201892
<blockquote>
18211893
<p><a href="structs.html#fmodcputimeusage">FmodCPUTimeUsage</a></p>
@@ -1862,6 +1934,8 @@ <h1 id="fmod_dsp_set_user_data">fmod_dsp_set_user_data</h1>
18621934
</tbody>
18631935
</table>
18641936
<p><br></p>
1937+
<p><br></p>
1938+
<p><br></p>
18651939
<p><strong>Returns:</strong></p>
18661940
<blockquote>
18671941
<p>N/A</p>
@@ -1903,6 +1977,8 @@ <h1 id="fmod_dsp_get_user_data">fmod_dsp_get_user_data</h1>
19031977
</tbody>
19041978
</table>
19051979
<p><br></p>
1980+
<p><br></p>
1981+
<p><br></p>
19061982
<p><strong>Returns:</strong></p>
19071983
<blockquote>
19081984
<p><a href="https://manual.gamemaker.io/monthly/en/GameMaker_Language/GML_Overview/Data_Types.htm">Real</a></p>
@@ -1942,6 +2018,8 @@ <h1 id="fmod_dsp_set_callback">fmod_dsp_set_callback</h1>
19422018
</tbody>
19432019
</table>
19442020
<p><br></p>
2021+
<p><br></p>
2022+
<p><br></p>
19452023
<p><strong>Returns:</strong></p>
19462024
<blockquote>
19472025
<p>N/A</p>
@@ -2015,6 +2093,8 @@ <h1 id="fmod_dsp_get_system_object">fmod_dsp_get_system_object</h1>
20152093
</tbody>
20162094
</table>
20172095
<p><br></p>
2096+
<p><br></p>
2097+
<p><br></p>
20182098
<p><strong>Returns:</strong></p>
20192099
<blockquote>
20202100
<p><a href="https://manual.gamemaker.io/monthly/en/GameMaker_Language/GML_Overview/Data_Types.htm">Real</a></p>

‎source/fmod_gml/extensions/FMOD/docs/GeneralInformation.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
</li>
4848
</ul>
4949
<ul class="current">
50-
<li class="toctree-l1 current"><a class="reference internal current" href="GeneralInformation.html">General Information</a>
50+
<li class="toctree-l1 current"><a class="reference internal current" href="#">General Information</a>
5151
<ul class="current">
5252
</ul>
5353
</li>
@@ -240,7 +240,7 @@ <h3 id="fmod_dsp_fft">FMOD_DSP_FFT</h3>
240240
<p>Here, <code>length</code> stores the length of the <code>spectrum</code> array of a single channel (i.e. the number of values included in the spectrum). <code>numchannels</code> stores the number of channels for which there is spectrum data.</p>
241241
<p>If you read these variable definitions line by line, you have:</p>
242242
<p>An <code>int</code> followed by an <code>int</code>, followed by <em>at most</em> 32 times <code>length</code> <code>float</code>s. <code>spectrum</code> is an array of pointers (the asterisk <code>*</code> refers to a pointer), which indicates that the memory for each array is not included in the <code>FMOD_DSP_PARAMETER_FFT</code> struct itself, but rather in the memory that the pointer to that array <em>points to</em>. You don't need to do any buffer copying yourself however, as the extension copies these blocks of data to the buffer one after the other.</p>
243-
<p>Looking at the <a href="#data-type-mapping-table.md">Data Type Mapping Table</a>, you see that this corresponds to 2 times a <code>buffer_s32</code>, followed by <code>numchannels</code> blocks of spectrum data consisting of <code>length</code> <code>buffer_f32</code> values. So the layout of the data in the buffer will be the following:</p>
243+
<p>Looking at the <a href="#data-type-mapping-table">Data Type Mapping Table</a>, you see that this corresponds to 2 times a <code>buffer_s32</code>, followed by <code>numchannels</code> blocks of spectrum data consisting of <code>length</code> <code>buffer_f32</code> values. So the layout of the data in the buffer will be the following:</p>
244244
<pre class="highlight"><code>|Channel | |Channel 0 |Channel 1 | ... |
245245
|FMOD |int |int |float |float | ... |float |float |float | ... |float | ... |
246246
|Buffer |buffer_s32|buffer_s32 |buffer_f32 |buffer_f32 | ... |buffer_f32 |buffer_f32 |buffer_f32 | ... |buffer_f32 | ... |

‎source/fmod_gml/extensions/FMOD/docs/GettingStarted.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
</li>
4444
</ul>
4545
<ul class="current">
46-
<li class="toctree-l1 current"><a class="reference internal current" href="GettingStarted.html">Getting Started with FMOD in GameMaker</a>
46+
<li class="toctree-l1 current"><a class="reference internal current" href="#">Getting Started with FMOD in GameMaker</a>
4747
<ul class="current">
4848
</ul>
4949
</li>

0 commit comments

Comments
 (0)