-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathstruct__fluid__sfloader__t.html
More file actions
146 lines (137 loc) · 7.72 KB
/
struct__fluid__sfloader__t.html
File metadata and controls
146 lines (137 loc) · 7.72 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
<!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: _fluid_sfloader_t Struct 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">_fluid_sfloader_t Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>SoundFont loader structure.
<a href="struct__fluid__sfloader__t.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a128547f2341db8c9f5ddb0158d1d4235"><td class="memItemLeft" align="right" valign="top"><a id="a128547f2341db8c9f5ddb0158d1d4235"></a>
void * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfloader__t.html#a128547f2341db8c9f5ddb0158d1d4235">data</a></td></tr>
<tr class="memdesc:a128547f2341db8c9f5ddb0158d1d4235"><td class="mdescLeft"> </td><td class="mdescRight">User defined data pointer used by <a class="el" href="struct__fluid__sfloader__t.html#a07df5351c8af6beabf7b2199fae73b01" title="Method to load an instrument file (does not actually need to be a real file name, could be another ty...">_fluid_sfloader_t::load()</a> <br /></td></tr>
<tr class="separator:a128547f2341db8c9f5ddb0158d1d4235"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeff9e200597cdfef71685161bfa3f1a1"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfloader__t.html#aeff9e200597cdfef71685161bfa3f1a1">free</a> )(<a class="el" href="types_8h.html#ad3e880056d2262e48468719757b3f5e6">fluid_sfloader_t</a> *loader)</td></tr>
<tr class="memdesc:aeff9e200597cdfef71685161bfa3f1a1"><td class="mdescLeft"> </td><td class="mdescRight">The free method should free the memory allocated for the loader in addition to any private data. <a href="#aeff9e200597cdfef71685161bfa3f1a1">More...</a><br /></td></tr>
<tr class="separator:aeff9e200597cdfef71685161bfa3f1a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a07df5351c8af6beabf7b2199fae73b01"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#aa6c18288f76608acbb10b80a153f4ab8">fluid_sfont_t</a> *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfloader__t.html#a07df5351c8af6beabf7b2199fae73b01">load</a> )(<a class="el" href="types_8h.html#ad3e880056d2262e48468719757b3f5e6">fluid_sfloader_t</a> *loader, const char *filename)</td></tr>
<tr class="memdesc:a07df5351c8af6beabf7b2199fae73b01"><td class="mdescLeft"> </td><td class="mdescRight">Method to load an instrument file (does not actually need to be a real file name, could be another type of string identifier that the <em>loader</em> understands). <a href="#a07df5351c8af6beabf7b2199fae73b01">More...</a><br /></td></tr>
<tr class="separator:a07df5351c8af6beabf7b2199fae73b01"><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 loader structure. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="aeff9e200597cdfef71685161bfa3f1a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeff9e200597cdfef71685161bfa3f1a1">◆ </a></span>free</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* _fluid_sfloader_t::free) (<a class="el" href="types_8h.html#ad3e880056d2262e48468719757b3f5e6">fluid_sfloader_t</a> *loader)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The free method should free the memory allocated for the loader in addition to any private data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">loader</td><td>SoundFont loader </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Should return 0 if no error occured, non-zero otherwise </dd></dl>
</div>
</div>
<a id="a07df5351c8af6beabf7b2199fae73b01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07df5351c8af6beabf7b2199fae73b01">◆ </a></span>load</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#aa6c18288f76608acbb10b80a153f4ab8">fluid_sfont_t</a>*(* _fluid_sfloader_t::load) (<a class="el" href="types_8h.html#ad3e880056d2262e48468719757b3f5e6">fluid_sfloader_t</a> *loader, const char *filename)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Method to load an instrument file (does not actually need to be a real file name, could be another type of string identifier that the <em>loader</em> understands). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">loader</td><td>SoundFont loader </td></tr>
<tr><td class="paramname">filename</td><td>File name or other string identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The loaded instrument file (SoundFont) or NULL if an error occured. </dd></dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="sfont_8h.html">sfont.h</a></li>
</ul>
</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>