-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathmod_8h.html
More file actions
690 lines (628 loc) · 47.7 KB
/
mod_8h.html
File metadata and controls
690 lines (628 loc) · 47.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libfluidsynth: mod.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libfluidsynth
 <span id="projectnumber">1.1.11</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_e9d22631e23def53df9d7c08c7c6097f.html">fluidsynth</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">mod.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>SoundFont modulator functions and constants.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__mod__t.html">_fluid_mod_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Modulator structure. <a href="struct__fluid__mod__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a36d07f04a69f257b9a696b7a955b66c7"><td class="memItemLeft" align="right" valign="top"><a id="a36d07f04a69f257b9a696b7a955b66c7"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="mod_8h.html#a36d07f04a69f257b9a696b7a955b66c7">FLUID_NUM_MOD</a>   64</td></tr>
<tr class="memdesc:a36d07f04a69f257b9a696b7a955b66c7"><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of modulators in a voice. <br /></td></tr>
<tr class="separator:a36d07f04a69f257b9a696b7a955b66c7"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a4b2419150b2a167df7807d5020a6e996"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996">fluid_mod_flags</a> { <br />
  <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a915b9287ca1694b748d18e0fb95291bd">FLUID_MOD_POSITIVE</a> = 0,
<a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996ae36b75d882c477b9c708090b8f39ee2e">FLUID_MOD_NEGATIVE</a> = 1,
<a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a55e25d082340bab94f5e76c4942882a6">FLUID_MOD_UNIPOLAR</a> = 0,
<a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996ab4ead04aee2460cc730aa5618e1e190d">FLUID_MOD_BIPOLAR</a> = 2,
<br />
  <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a44ce690ff0d02cbbeb5ff8df71a5f9f0">FLUID_MOD_LINEAR</a> = 0,
<a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996aa7976f44cbfd3c8fea58a3c9e03152a2">FLUID_MOD_CONCAVE</a> = 4,
<a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a9a7d17a249db378442bd24f9ed62113d">FLUID_MOD_CONVEX</a> = 8,
<a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996aea14d1629c4a8dfdf3241b5b61827aec">FLUID_MOD_SWITCH</a> = 12,
<br />
  <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a8705ffb835e7e2e991a74e9827e9409e">FLUID_MOD_GC</a> = 0,
<a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a61e4c4ad391548b2d12764644e6e8a45">FLUID_MOD_CC</a> = 16
<br />
}<tr class="memdesc:a4b2419150b2a167df7807d5020a6e996"><td class="mdescLeft"> </td><td class="mdescRight">Flags defining the polarity, mapping function and type of a modulator source. <a href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a4b2419150b2a167df7807d5020a6e996"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a801993d69390b21a2d0311d44afb1932"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932">fluid_mod_src</a> { <br />
  <a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932af9eebfce95d1bca7d5046612f43764b5">FLUID_MOD_NONE</a> = 0,
<a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932ac93d47a173ddc26568d112b7fc8fb28b">FLUID_MOD_VELOCITY</a> = 2,
<a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932ad708e1755740964c31fb9c368c4a1e97">FLUID_MOD_KEY</a> = 3,
<a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932a1dc8abdda3f6833bbcfe3bce49317796">FLUID_MOD_KEYPRESSURE</a> = 10,
<br />
  <a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932aff8746ab2f8fdba605cbafba4ace1217">FLUID_MOD_CHANNELPRESSURE</a> = 13,
<a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932a72f5b8e63c997525574d15f83a5a2e24">FLUID_MOD_PITCHWHEEL</a> = 14,
<a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932ad5b4a5332b13ad547dacdade2c7c9d16">FLUID_MOD_PITCHWHEELSENS</a> = 16
<br />
}<tr class="memdesc:a801993d69390b21a2d0311d44afb1932"><td class="mdescLeft"> </td><td class="mdescRight">General controller (if <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a8705ffb835e7e2e991a74e9827e9409e" title="General controller source type (fluid_mod_src) ">FLUID_MOD_GC</a> in flags). <a href="mod_8h.html#a801993d69390b21a2d0311d44afb1932">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a801993d69390b21a2d0311d44afb1932"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a90850b9f8b781eda9e722ddf277fe1ea"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API <a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="mod_8h.html#a90850b9f8b781eda9e722ddf277fe1ea">fluid_mod_new</a> (void)</td></tr>
<tr class="memdesc:a90850b9f8b781eda9e722ddf277fe1ea"><td class="mdescLeft"> </td><td class="mdescRight">Create a new uninitialized modulator structure. <a href="#a90850b9f8b781eda9e722ddf277fe1ea">More...</a><br /></td></tr>
<tr class="separator:a90850b9f8b781eda9e722ddf277fe1ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abdfdf8fe1c178656a144d8f40c0d035d"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="mod_8h.html#abdfdf8fe1c178656a144d8f40c0d035d">fluid_mod_delete</a> (<a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> *mod)</td></tr>
<tr class="memdesc:abdfdf8fe1c178656a144d8f40c0d035d"><td class="mdescLeft"> </td><td class="mdescRight">Free a modulator structure. <a href="#abdfdf8fe1c178656a144d8f40c0d035d">More...</a><br /></td></tr>
<tr class="separator:abdfdf8fe1c178656a144d8f40c0d035d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4aadc29ce1f89fbf1357cdf10d44c205"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="mod_8h.html#a4aadc29ce1f89fbf1357cdf10d44c205">fluid_mod_set_source1</a> (<a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> *mod, int src, int flags)</td></tr>
<tr class="memdesc:a4aadc29ce1f89fbf1357cdf10d44c205"><td class="mdescLeft"> </td><td class="mdescRight">Set a modulator's primary source controller and flags. <a href="#a4aadc29ce1f89fbf1357cdf10d44c205">More...</a><br /></td></tr>
<tr class="separator:a4aadc29ce1f89fbf1357cdf10d44c205"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4cb5baa978264deb65eb7d379c3ca64f"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="mod_8h.html#a4cb5baa978264deb65eb7d379c3ca64f">fluid_mod_set_source2</a> (<a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> *mod, int src, int flags)</td></tr>
<tr class="memdesc:a4cb5baa978264deb65eb7d379c3ca64f"><td class="mdescLeft"> </td><td class="mdescRight">Set a modulator's secondary source controller and flags. <a href="#a4cb5baa978264deb65eb7d379c3ca64f">More...</a><br /></td></tr>
<tr class="separator:a4cb5baa978264deb65eb7d379c3ca64f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad766e58fe5e999ad57274ce22faf7109"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="mod_8h.html#ad766e58fe5e999ad57274ce22faf7109">fluid_mod_set_dest</a> (<a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> *mod, int dst)</td></tr>
<tr class="memdesc:ad766e58fe5e999ad57274ce22faf7109"><td class="mdescLeft"> </td><td class="mdescRight">Set the destination effect of a modulator. <a href="#ad766e58fe5e999ad57274ce22faf7109">More...</a><br /></td></tr>
<tr class="separator:ad766e58fe5e999ad57274ce22faf7109"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a63974af70f71ce97d4771addf3b5db08"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="mod_8h.html#a63974af70f71ce97d4771addf3b5db08">fluid_mod_set_amount</a> (<a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> *mod, double amount)</td></tr>
<tr class="memdesc:a63974af70f71ce97d4771addf3b5db08"><td class="mdescLeft"> </td><td class="mdescRight">Set the scale amount of a modulator. <a href="#a63974af70f71ce97d4771addf3b5db08">More...</a><br /></td></tr>
<tr class="separator:a63974af70f71ce97d4771addf3b5db08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a90b77e544bce40a51e5fe3e4ecd73afd"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="mod_8h.html#a90b77e544bce40a51e5fe3e4ecd73afd">fluid_mod_get_source1</a> (<a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> *mod)</td></tr>
<tr class="memdesc:a90b77e544bce40a51e5fe3e4ecd73afd"><td class="mdescLeft"> </td><td class="mdescRight">Get the primary source value from a modulator. <a href="#a90b77e544bce40a51e5fe3e4ecd73afd">More...</a><br /></td></tr>
<tr class="separator:a90b77e544bce40a51e5fe3e4ecd73afd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7363bd6a82161238053d601a039177f"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="mod_8h.html#ad7363bd6a82161238053d601a039177f">fluid_mod_get_flags1</a> (<a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> *mod)</td></tr>
<tr class="memdesc:ad7363bd6a82161238053d601a039177f"><td class="mdescLeft"> </td><td class="mdescRight">Get primary source flags from a modulator. <a href="#ad7363bd6a82161238053d601a039177f">More...</a><br /></td></tr>
<tr class="separator:ad7363bd6a82161238053d601a039177f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab09b912c79dfc5400e8d046d4c0ecf94"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="mod_8h.html#ab09b912c79dfc5400e8d046d4c0ecf94">fluid_mod_get_source2</a> (<a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> *mod)</td></tr>
<tr class="memdesc:ab09b912c79dfc5400e8d046d4c0ecf94"><td class="mdescLeft"> </td><td class="mdescRight">Get the secondary source value from a modulator. <a href="#ab09b912c79dfc5400e8d046d4c0ecf94">More...</a><br /></td></tr>
<tr class="separator:ab09b912c79dfc5400e8d046d4c0ecf94"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2b98e0e37035f85a76985fed46f0edf6"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="mod_8h.html#a2b98e0e37035f85a76985fed46f0edf6">fluid_mod_get_flags2</a> (<a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> *mod)</td></tr>
<tr class="memdesc:a2b98e0e37035f85a76985fed46f0edf6"><td class="mdescLeft"> </td><td class="mdescRight">Get secondary source flags from a modulator. <a href="#a2b98e0e37035f85a76985fed46f0edf6">More...</a><br /></td></tr>
<tr class="separator:a2b98e0e37035f85a76985fed46f0edf6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a557886885c28a5b68505de26a839e99f"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="mod_8h.html#a557886885c28a5b68505de26a839e99f">fluid_mod_get_dest</a> (<a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> *mod)</td></tr>
<tr class="memdesc:a557886885c28a5b68505de26a839e99f"><td class="mdescLeft"> </td><td class="mdescRight">Get destination effect from a modulator. <a href="#a557886885c28a5b68505de26a839e99f">More...</a><br /></td></tr>
<tr class="separator:a557886885c28a5b68505de26a839e99f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f404101c73388fe9aaf6497da1c2b14"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API double </td><td class="memItemRight" valign="bottom"><a class="el" href="mod_8h.html#a5f404101c73388fe9aaf6497da1c2b14">fluid_mod_get_amount</a> (<a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> *mod)</td></tr>
<tr class="memdesc:a5f404101c73388fe9aaf6497da1c2b14"><td class="mdescLeft"> </td><td class="mdescRight">Get the scale amount from a modulator. <a href="#a5f404101c73388fe9aaf6497da1c2b14">More...</a><br /></td></tr>
<tr class="separator:a5f404101c73388fe9aaf6497da1c2b14"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a160458b700d3e902cbbfd69e05e82617"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="mod_8h.html#a160458b700d3e902cbbfd69e05e82617">fluid_mod_test_identity</a> (<a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> *mod1, <a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> *mod2)</td></tr>
<tr class="memdesc:a160458b700d3e902cbbfd69e05e82617"><td class="mdescLeft"> </td><td class="mdescRight">Checks if two modulators are identical in sources, flags and destination. <a href="#a160458b700d3e902cbbfd69e05e82617">More...</a><br /></td></tr>
<tr class="separator:a160458b700d3e902cbbfd69e05e82617"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>SoundFont modulator functions and constants. </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a4b2419150b2a167df7807d5020a6e996"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b2419150b2a167df7807d5020a6e996">◆ </a></span>fluid_mod_flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996">fluid_mod_flags</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flags defining the polarity, mapping function and type of a modulator source. </p>
<p>Compare with SoundFont 2.04 PDF section 8.2.</p>
<p>Note: Bit values do not correspond to the SoundFont spec! Also note that <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a8705ffb835e7e2e991a74e9827e9409e" title="General controller source type (fluid_mod_src) ">FLUID_MOD_GC</a> and <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a61e4c4ad391548b2d12764644e6e8a45" title="MIDI CC controller (source will be a MIDI CC number) ">FLUID_MOD_CC</a> are in the flags field instead of the source field. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a4b2419150b2a167df7807d5020a6e996a915b9287ca1694b748d18e0fb95291bd"></a>FLUID_MOD_POSITIVE </td><td class="fielddoc"><p>Mapping function is positive. </p>
</td></tr>
<tr><td class="fieldname"><a id="a4b2419150b2a167df7807d5020a6e996ae36b75d882c477b9c708090b8f39ee2e"></a>FLUID_MOD_NEGATIVE </td><td class="fielddoc"><p>Mapping function is negative. </p>
</td></tr>
<tr><td class="fieldname"><a id="a4b2419150b2a167df7807d5020a6e996a55e25d082340bab94f5e76c4942882a6"></a>FLUID_MOD_UNIPOLAR </td><td class="fielddoc"><p>Mapping function is unipolar. </p>
</td></tr>
<tr><td class="fieldname"><a id="a4b2419150b2a167df7807d5020a6e996ab4ead04aee2460cc730aa5618e1e190d"></a>FLUID_MOD_BIPOLAR </td><td class="fielddoc"><p>Mapping function is bipolar. </p>
</td></tr>
<tr><td class="fieldname"><a id="a4b2419150b2a167df7807d5020a6e996a44ce690ff0d02cbbeb5ff8df71a5f9f0"></a>FLUID_MOD_LINEAR </td><td class="fielddoc"><p>Linear mapping function. </p>
</td></tr>
<tr><td class="fieldname"><a id="a4b2419150b2a167df7807d5020a6e996aa7976f44cbfd3c8fea58a3c9e03152a2"></a>FLUID_MOD_CONCAVE </td><td class="fielddoc"><p>Concave mapping function. </p>
</td></tr>
<tr><td class="fieldname"><a id="a4b2419150b2a167df7807d5020a6e996a9a7d17a249db378442bd24f9ed62113d"></a>FLUID_MOD_CONVEX </td><td class="fielddoc"><p>Convex mapping function. </p>
</td></tr>
<tr><td class="fieldname"><a id="a4b2419150b2a167df7807d5020a6e996aea14d1629c4a8dfdf3241b5b61827aec"></a>FLUID_MOD_SWITCH </td><td class="fielddoc"><p>Switch (on/off) mapping function. </p>
</td></tr>
<tr><td class="fieldname"><a id="a4b2419150b2a167df7807d5020a6e996a8705ffb835e7e2e991a74e9827e9409e"></a>FLUID_MOD_GC </td><td class="fielddoc"><p>General controller source type (<a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932" title="General controller (if FLUID_MOD_GC in flags). ">fluid_mod_src</a>) </p>
</td></tr>
<tr><td class="fieldname"><a id="a4b2419150b2a167df7807d5020a6e996a61e4c4ad391548b2d12764644e6e8a45"></a>FLUID_MOD_CC </td><td class="fielddoc"><p>MIDI CC controller (source will be a MIDI CC number) </p>
</td></tr>
</table>
</div>
</div>
<a id="a801993d69390b21a2d0311d44afb1932"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a801993d69390b21a2d0311d44afb1932">◆ </a></span>fluid_mod_src</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932">fluid_mod_src</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>General controller (if <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a8705ffb835e7e2e991a74e9827e9409e" title="General controller source type (fluid_mod_src) ">FLUID_MOD_GC</a> in flags). </p>
<p>This corresponds to SoundFont 2.04 PDF section 8.2.1 </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a801993d69390b21a2d0311d44afb1932af9eebfce95d1bca7d5046612f43764b5"></a>FLUID_MOD_NONE </td><td class="fielddoc"><p>No source controller. </p>
</td></tr>
<tr><td class="fieldname"><a id="a801993d69390b21a2d0311d44afb1932ac93d47a173ddc26568d112b7fc8fb28b"></a>FLUID_MOD_VELOCITY </td><td class="fielddoc"><p>MIDI note-on velocity. </p>
</td></tr>
<tr><td class="fieldname"><a id="a801993d69390b21a2d0311d44afb1932ad708e1755740964c31fb9c368c4a1e97"></a>FLUID_MOD_KEY </td><td class="fielddoc"><p>MIDI note-on note number. </p>
</td></tr>
<tr><td class="fieldname"><a id="a801993d69390b21a2d0311d44afb1932a1dc8abdda3f6833bbcfe3bce49317796"></a>FLUID_MOD_KEYPRESSURE </td><td class="fielddoc"><p>MIDI key pressure. </p>
</td></tr>
<tr><td class="fieldname"><a id="a801993d69390b21a2d0311d44afb1932aff8746ab2f8fdba605cbafba4ace1217"></a>FLUID_MOD_CHANNELPRESSURE </td><td class="fielddoc"><p>MIDI channel pressure. </p>
</td></tr>
<tr><td class="fieldname"><a id="a801993d69390b21a2d0311d44afb1932a72f5b8e63c997525574d15f83a5a2e24"></a>FLUID_MOD_PITCHWHEEL </td><td class="fielddoc"><p>Pitch wheel. </p>
</td></tr>
<tr><td class="fieldname"><a id="a801993d69390b21a2d0311d44afb1932ad5b4a5332b13ad547dacdade2c7c9d16"></a>FLUID_MOD_PITCHWHEELSENS </td><td class="fielddoc"><p>Pitch wheel sensitivity. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a90850b9f8b781eda9e722ddf277fe1ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90850b9f8b781eda9e722ddf277fe1ea">◆ </a></span>fluid_mod_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API <a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a>* fluid_mod_new </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new uninitialized modulator structure. </p>
<dl class="section return"><dt>Returns</dt><dd>New allocated modulator or NULL if out of memory </dd></dl>
<p class="reference">References <a class="el" href="log_8h.html#aa341232c15addd9c336131984840ed9eabc0ff48d192b3b0fc721946ccf095d25">FLUID_ERR</a>.</p>
</div>
</div>
<a id="abdfdf8fe1c178656a144d8f40c0d035d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdfdf8fe1c178656a144d8f40c0d035d">◆ </a></span>fluid_mod_delete()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API void fluid_mod_delete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> * </td>
<td class="paramname"><em>mod</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a modulator structure. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mod</td><td>Modulator to free </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4aadc29ce1f89fbf1357cdf10d44c205"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4aadc29ce1f89fbf1357cdf10d44c205">◆ </a></span>fluid_mod_set_source1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API void fluid_mod_set_source1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> * </td>
<td class="paramname"><em>mod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a modulator's primary source controller and flags. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mod</td><td>Modulator </td></tr>
<tr><td class="paramname">src</td><td>Modulator source (<a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932" title="General controller (if FLUID_MOD_GC in flags). ">fluid_mod_src</a> or a MIDI controller number) </td></tr>
<tr><td class="paramname">flags</td><td>Flags determining mapping function and whether the source controller is a general controller (<a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a8705ffb835e7e2e991a74e9827e9409e" title="General controller source type (fluid_mod_src) ">FLUID_MOD_GC</a>) or a MIDI CC controller (<a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a61e4c4ad391548b2d12764644e6e8a45" title="MIDI CC controller (source will be a MIDI CC number) ">FLUID_MOD_CC</a>), see <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996" title="Flags defining the polarity, mapping function and type of a modulator source. ">fluid_mod_flags</a>. </td></tr>
</table>
</dd>
</dl>
<p class="reference">References <a class="el" href="struct__fluid__mod__t.html#adb71cc4a4b81c915f05c1b8d069e3056">_fluid_mod_t::flags1</a>, and <a class="el" href="struct__fluid__mod__t.html#a199e73690c3e5fdb0e073d05f8237196">_fluid_mod_t::src1</a>.</p>
</div>
</div>
<a id="a4cb5baa978264deb65eb7d379c3ca64f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4cb5baa978264deb65eb7d379c3ca64f">◆ </a></span>fluid_mod_set_source2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API void fluid_mod_set_source2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> * </td>
<td class="paramname"><em>mod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a modulator's secondary source controller and flags. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mod</td><td>Modulator </td></tr>
<tr><td class="paramname">src</td><td>Modulator source (<a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932" title="General controller (if FLUID_MOD_GC in flags). ">fluid_mod_src</a> or a MIDI controller number) </td></tr>
<tr><td class="paramname">flags</td><td>Flags determining mapping function and whether the source controller is a general controller (<a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a8705ffb835e7e2e991a74e9827e9409e" title="General controller source type (fluid_mod_src) ">FLUID_MOD_GC</a>) or a MIDI CC controller (<a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a61e4c4ad391548b2d12764644e6e8a45" title="MIDI CC controller (source will be a MIDI CC number) ">FLUID_MOD_CC</a>), see <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996" title="Flags defining the polarity, mapping function and type of a modulator source. ">fluid_mod_flags</a>. </td></tr>
</table>
</dd>
</dl>
<p class="reference">References <a class="el" href="struct__fluid__mod__t.html#a38e059fb4214ab59b5f0895d100dfffa">_fluid_mod_t::flags2</a>, and <a class="el" href="struct__fluid__mod__t.html#a8f83acd72515a3dc6d6d73089b907685">_fluid_mod_t::src2</a>.</p>
</div>
</div>
<a id="ad766e58fe5e999ad57274ce22faf7109"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad766e58fe5e999ad57274ce22faf7109">◆ </a></span>fluid_mod_set_dest()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API void fluid_mod_set_dest </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> * </td>
<td class="paramname"><em>mod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>dest</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the destination effect of a modulator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mod</td><td>Modulator </td></tr>
<tr><td class="paramname">dest</td><td>Destination generator (<a class="el" href="gen_8h.html#ad17a24ae3b25f3b8cc5762f818eef9b4" title="Generator (effect) numbers (Soundfont 2.01 specifications section 8.1.3) ">fluid_gen_type</a>) </td></tr>
</table>
</dd>
</dl>
<p class="reference">References <a class="el" href="struct__fluid__mod__t.html#a1c7d15ae9ad239b578701878b0ffbb08">_fluid_mod_t::dest</a>.</p>
</div>
</div>
<a id="a63974af70f71ce97d4771addf3b5db08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63974af70f71ce97d4771addf3b5db08">◆ </a></span>fluid_mod_set_amount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API void fluid_mod_set_amount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> * </td>
<td class="paramname"><em>mod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>amount</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the scale amount of a modulator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mod</td><td>Modulator </td></tr>
<tr><td class="paramname">amount</td><td>Scale amount to assign </td></tr>
</table>
</dd>
</dl>
<p class="reference">References <a class="el" href="struct__fluid__mod__t.html#a89680a436126f578594c5981d6c4f2ad">_fluid_mod_t::amount</a>.</p>
</div>
</div>
<a id="a90b77e544bce40a51e5fe3e4ecd73afd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90b77e544bce40a51e5fe3e4ecd73afd">◆ </a></span>fluid_mod_get_source1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_mod_get_source1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> * </td>
<td class="paramname"><em>mod</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the primary source value from a modulator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mod</td><td>Modulator </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The primary source value (<a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932" title="General controller (if FLUID_MOD_GC in flags). ">fluid_mod_src</a> or a MIDI CC controller value). </dd></dl>
<p class="reference">References <a class="el" href="struct__fluid__mod__t.html#a199e73690c3e5fdb0e073d05f8237196">_fluid_mod_t::src1</a>.</p>
</div>
</div>
<a id="ad7363bd6a82161238053d601a039177f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7363bd6a82161238053d601a039177f">◆ </a></span>fluid_mod_get_flags1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_mod_get_flags1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> * </td>
<td class="paramname"><em>mod</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get primary source flags from a modulator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mod</td><td>Modulator </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The primary source flags (<a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996" title="Flags defining the polarity, mapping function and type of a modulator source. ">fluid_mod_flags</a>). </dd></dl>
<p class="reference">References <a class="el" href="struct__fluid__mod__t.html#adb71cc4a4b81c915f05c1b8d069e3056">_fluid_mod_t::flags1</a>.</p>
</div>
</div>
<a id="ab09b912c79dfc5400e8d046d4c0ecf94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab09b912c79dfc5400e8d046d4c0ecf94">◆ </a></span>fluid_mod_get_source2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_mod_get_source2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> * </td>
<td class="paramname"><em>mod</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the secondary source value from a modulator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mod</td><td>Modulator </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The secondary source value (<a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932" title="General controller (if FLUID_MOD_GC in flags). ">fluid_mod_src</a> or a MIDI CC controller value). </dd></dl>
<p class="reference">References <a class="el" href="struct__fluid__mod__t.html#a8f83acd72515a3dc6d6d73089b907685">_fluid_mod_t::src2</a>.</p>
</div>
</div>
<a id="a2b98e0e37035f85a76985fed46f0edf6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b98e0e37035f85a76985fed46f0edf6">◆ </a></span>fluid_mod_get_flags2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_mod_get_flags2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> * </td>
<td class="paramname"><em>mod</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get secondary source flags from a modulator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mod</td><td>Modulator </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The secondary source flags (<a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996" title="Flags defining the polarity, mapping function and type of a modulator source. ">fluid_mod_flags</a>). </dd></dl>
<p class="reference">References <a class="el" href="struct__fluid__mod__t.html#a38e059fb4214ab59b5f0895d100dfffa">_fluid_mod_t::flags2</a>.</p>
</div>
</div>
<a id="a557886885c28a5b68505de26a839e99f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a557886885c28a5b68505de26a839e99f">◆ </a></span>fluid_mod_get_dest()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_mod_get_dest </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> * </td>
<td class="paramname"><em>mod</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get destination effect from a modulator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mod</td><td>Modulator </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Destination generator (<a class="el" href="gen_8h.html#ad17a24ae3b25f3b8cc5762f818eef9b4" title="Generator (effect) numbers (Soundfont 2.01 specifications section 8.1.3) ">fluid_gen_type</a>) </dd></dl>
<p class="reference">References <a class="el" href="struct__fluid__mod__t.html#a1c7d15ae9ad239b578701878b0ffbb08">_fluid_mod_t::dest</a>.</p>
<p class="reference">Referenced by <a class="el" href="voice_8h.html#a4d62972ae304910f87e7d63e5470c813">fluid_voice_update_param()</a>.</p>
</div>
</div>
<a id="a5f404101c73388fe9aaf6497da1c2b14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f404101c73388fe9aaf6497da1c2b14">◆ </a></span>fluid_mod_get_amount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API double fluid_mod_get_amount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> * </td>
<td class="paramname"><em>mod</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the scale amount from a modulator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mod</td><td>Modulator </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Scale amount </dd></dl>
<p class="reference">References <a class="el" href="struct__fluid__mod__t.html#a89680a436126f578594c5981d6c4f2ad">_fluid_mod_t::amount</a>, <a class="el" href="struct__fluid__mod__t.html#a1c7d15ae9ad239b578701878b0ffbb08">_fluid_mod_t::dest</a>, <a class="el" href="struct__fluid__mod__t.html#adb71cc4a4b81c915f05c1b8d069e3056">_fluid_mod_t::flags1</a>, <a class="el" href="struct__fluid__mod__t.html#a38e059fb4214ab59b5f0895d100dfffa">_fluid_mod_t::flags2</a>, <a class="el" href="log_8h.html#aa341232c15addd9c336131984840ed9eabc0ff48d192b3b0fc721946ccf095d25">FLUID_ERR</a>, <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996ab4ead04aee2460cc730aa5618e1e190d">FLUID_MOD_BIPOLAR</a>, <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a61e4c4ad391548b2d12764644e6e8a45">FLUID_MOD_CC</a>, <a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932aff8746ab2f8fdba605cbafba4ace1217">FLUID_MOD_CHANNELPRESSURE</a>, <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996aa7976f44cbfd3c8fea58a3c9e03152a2">FLUID_MOD_CONCAVE</a>, <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a9a7d17a249db378442bd24f9ed62113d">FLUID_MOD_CONVEX</a>, <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a8705ffb835e7e2e991a74e9827e9409e">FLUID_MOD_GC</a>, <a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932ad708e1755740964c31fb9c368c4a1e97">FLUID_MOD_KEY</a>, <a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932a1dc8abdda3f6833bbcfe3bce49317796">FLUID_MOD_KEYPRESSURE</a>, <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a44ce690ff0d02cbbeb5ff8df71a5f9f0">FLUID_MOD_LINEAR</a>, <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996ae36b75d882c477b9c708090b8f39ee2e">FLUID_MOD_NEGATIVE</a>, <a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932af9eebfce95d1bca7d5046612f43764b5">FLUID_MOD_NONE</a>, <a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932a72f5b8e63c997525574d15f83a5a2e24">FLUID_MOD_PITCHWHEEL</a>, <a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932ad5b4a5332b13ad547dacdade2c7c9d16">FLUID_MOD_PITCHWHEELSENS</a>, <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a915b9287ca1694b748d18e0fb95291bd">FLUID_MOD_POSITIVE</a>, <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996aea14d1629c4a8dfdf3241b5b61827aec">FLUID_MOD_SWITCH</a>, <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a55e25d082340bab94f5e76c4942882a6">FLUID_MOD_UNIPOLAR</a>, <a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932ac93d47a173ddc26568d112b7fc8fb28b">FLUID_MOD_VELOCITY</a>, <a class="el" href="voice_8h.html#a318a4e5aac732628b28cbafffb936643">fluid_voice_get_actual_key()</a>, <a class="el" href="voice_8h.html#a14b60445ee2d7a7b21b01dbfdeb51356">fluid_voice_get_actual_velocity()</a>, <a class="el" href="gen_8h.html#ad17a24ae3b25f3b8cc5762f818eef9b4ae43e689b0b6349a676d26ea3096ed8d2">GEN_FILTERFC</a>, <a class="el" href="struct__fluid__mod__t.html#a199e73690c3e5fdb0e073d05f8237196">_fluid_mod_t::src1</a>, and <a class="el" href="struct__fluid__mod__t.html#a8f83acd72515a3dc6d6d73089b907685">_fluid_mod_t::src2</a>.</p>
</div>
</div>
<a id="a160458b700d3e902cbbfd69e05e82617"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a160458b700d3e902cbbfd69e05e82617">◆ </a></span>fluid_mod_test_identity()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_mod_test_identity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> * </td>
<td class="paramname"><em>mod1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a6c727efab500d6c0c350d4292e9aa5ef">fluid_mod_t</a> * </td>
<td class="paramname"><em>mod2</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if two modulators are identical in sources, flags and destination. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mod1</td><td>First modulator </td></tr>
<tr><td class="paramname">mod2</td><td>Second modulator </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if identical, FALSE otherwise</dd></dl>
<p>SF2.01 section 9.5.1 page 69, 'bullet' 3 defines 'identical'. </p>
<p class="reference">References <a class="el" href="struct__fluid__mod__t.html#a89680a436126f578594c5981d6c4f2ad">_fluid_mod_t::amount</a>, <a class="el" href="struct__fluid__mod__t.html#a1c7d15ae9ad239b578701878b0ffbb08">_fluid_mod_t::dest</a>, <a class="el" href="struct__fluid__mod__t.html#adb71cc4a4b81c915f05c1b8d069e3056">_fluid_mod_t::flags1</a>, <a class="el" href="struct__fluid__mod__t.html#a38e059fb4214ab59b5f0895d100dfffa">_fluid_mod_t::flags2</a>, <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996ab4ead04aee2460cc730aa5618e1e190d">FLUID_MOD_BIPOLAR</a>, <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996a61e4c4ad391548b2d12764644e6e8a45">FLUID_MOD_CC</a>, <a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932aff8746ab2f8fdba605cbafba4ace1217">FLUID_MOD_CHANNELPRESSURE</a>, <a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932ad708e1755740964c31fb9c368c4a1e97">FLUID_MOD_KEY</a>, <a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932a1dc8abdda3f6833bbcfe3bce49317796">FLUID_MOD_KEYPRESSURE</a>, <a class="el" href="mod_8h.html#a4b2419150b2a167df7807d5020a6e996ae36b75d882c477b9c708090b8f39ee2e">FLUID_MOD_NEGATIVE</a>, <a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932af9eebfce95d1bca7d5046612f43764b5">FLUID_MOD_NONE</a>, <a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932a72f5b8e63c997525574d15f83a5a2e24">FLUID_MOD_PITCHWHEEL</a>, <a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932ad5b4a5332b13ad547dacdade2c7c9d16">FLUID_MOD_PITCHWHEELSENS</a>, <a class="el" href="mod_8h.html#a801993d69390b21a2d0311d44afb1932ac93d47a173ddc26568d112b7fc8fb28b">FLUID_MOD_VELOCITY</a>, <a class="el" href="gen_8h.html#ad17a24ae3b25f3b8cc5762f818eef9b4a2db65ad593aeff4e814f9a7b7324c0df">GEN_ATTENUATION</a>, <a class="el" href="gen_8h.html#ad17a24ae3b25f3b8cc5762f818eef9b4a20dc580d6c53d30eb97efe3e910793b6">GEN_CHORUSSEND</a>, <a class="el" href="gen_8h.html#ad17a24ae3b25f3b8cc5762f818eef9b4ae43e689b0b6349a676d26ea3096ed8d2">GEN_FILTERFC</a>, <a class="el" href="gen_8h.html#ad17a24ae3b25f3b8cc5762f818eef9b4a587a7ca42e99238fca39cdf42496af6e">GEN_FILTERQ</a>, <a class="el" href="gen_8h.html#ad17a24ae3b25f3b8cc5762f818eef9b4ac767cd6d4156318428bcfc9b3a2a087c">GEN_MODENVTOPITCH</a>, <a class="el" href="gen_8h.html#ad17a24ae3b25f3b8cc5762f818eef9b4ab8343028edd99ad0a23585760bdb1b78">GEN_MODLFOTOPITCH</a>, <a class="el" href="gen_8h.html#ad17a24ae3b25f3b8cc5762f818eef9b4a5b713ab8c931017d98f11b5ed5a81fb1">GEN_PAN</a>, <a class="el" href="gen_8h.html#ad17a24ae3b25f3b8cc5762f818eef9b4a8de830acd064933f55e0c1615d1e7f78">GEN_REVERBSEND</a>, <a class="el" href="gen_8h.html#ad17a24ae3b25f3b8cc5762f818eef9b4a99387606556a9024de640b4519f7e559">GEN_VIBLFOTOPITCH</a>, <a class="el" href="struct__fluid__mod__t.html#a199e73690c3e5fdb0e073d05f8237196">_fluid_mod_t::src1</a>, and <a class="el" href="struct__fluid__mod__t.html#a8f83acd72515a3dc6d6d73089b907685">_fluid_mod_t::src2</a>.</p>
<p class="reference">Referenced by <a class="el" href="ramsfont_8h.html#aee8fd1530458fe14fa2d2b019a18fe1d">fluid_ramsfont_izone_set_loop()</a>, and <a class="el" href="voice_8h.html#ac11c3fc60306f620c9f7fe6966c00c61">fluid_voice_add_mod()</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>