← Back to branch summary

~ubuntu-branches/debian/squeeze/fluidsynth/squeeze

« back to all changes in this revision

Viewing changes to doc/api/html/struct__fluid__sfont__t.html

  • Committer: Bazaar Package Importer
  • Author(s): Peter Eisentraut
  • Date: 2008-05-26 16:43:17 UTC
  • mfrom: (3.1.4 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080526164317-1j2op08lmr7a6y8j
Tags: 1.0.8-1.1
http://bugs.debian.org/478380
* Non-maintainer upload.
* Fix bashism in debian/rules (closes: #478380)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/html/struct__fluid__sfont__t.html
1
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3
3
<title>libfluidsynth: _fluid_sfont_t Struct Reference</title>
4
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
5
<link href="tabs.css" rel="stylesheet" type="text/css">
5
6
</head><body>
6
 
<!-- Generated by Doxygen 1.4.4 -->
7
 
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a></div>
 
7
<!-- Generated by Doxygen 1.5.3 -->
 
8
<div class="tabs">
 
9
  <ul>
 
10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
 
11
    <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
 
12
    <li><a href="files.html"><span>Files</span></a></li>
 
13
  </ul>
 
14
</div>
 
15
<div class="tabs">
 
16
  <ul>
 
17
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
 
18
    <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
 
19
  </ul>
 
20
</div>
8
21
<h1>_fluid_sfont_t Struct Reference</h1><!-- doxytag: class="_fluid_sfont_t" --><table border="0" cellpadding="0" cellspacing="0">
9
22
<tr><td></td></tr>
10
23
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
11
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfont__t.html#o0">data</a></td></tr>
12
 
 
13
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfont__t.html#o1">id</a></td></tr>
14
 
 
15
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfont__t.html#o2">free</a> )(<a class="el" href="struct__fluid__sfont__t.html">fluid_sfont_t</a> *sfont)</td></tr>
16
 
 
17
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The 'free' callback function should return 0 when it was able to free all resources.  <a href="#o2"></a><br></td></tr>
18
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">char *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfont__t.html#o3">get_name</a> )(<a class="el" href="struct__fluid__sfont__t.html">fluid_sfont_t</a> *sfont)</td></tr>
19
 
 
20
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the name of the sfont.  <a href="#o3"></a><br></td></tr>
21
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct__fluid__preset__t.html">fluid_preset_t</a> *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfont__t.html#o4">get_preset</a> )(<a class="el" href="struct__fluid__sfont__t.html">fluid_sfont_t</a> *sfont, unsigned int bank, unsigned int prenum)</td></tr>
22
 
 
23
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the preset with the specified bank and preset number.  <a href="#o4"></a><br></td></tr>
24
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfont__t.html#o5">iteration_start</a> )(<a class="el" href="struct__fluid__sfont__t.html">fluid_sfont_t</a> *sfont)</td></tr>
25
 
 
26
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfont__t.html#o6">iteration_next</a> )(<a class="el" href="struct__fluid__sfont__t.html">fluid_sfont_t</a> *sfont, <a class="el" href="struct__fluid__preset__t.html">fluid_preset_t</a> *preset)</td></tr>
27
 
 
 
24
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a79644021fa078479da5273c4ebfbbc"></a><!-- doxytag: member="_fluid_sfont_t::data" ref="5a79644021fa078479da5273c4ebfbbc" args="" -->
 
25
void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfont__t.html#5a79644021fa078479da5273c4ebfbbc">data</a></td></tr>
 
26
 
 
27
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e955816cff10890c6369ac04733d37fb"></a><!-- doxytag: member="_fluid_sfont_t::id" ref="e955816cff10890c6369ac04733d37fb" args="" -->
 
28
unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfont__t.html#e955816cff10890c6369ac04733d37fb">id</a></td></tr>
 
29
 
 
30
<tr><td class="memItemLeft" nowrap align="right" valign="top">int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfont__t.html#7e57ed204828e112df6ac3b6fe0285f3">free</a> )(<a class="el" href="struct__fluid__sfont__t.html">fluid_sfont_t</a> *sfont)</td></tr>
 
31
 
 
32
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The 'free' callback function should return 0 when it was able to free all resources.  <a href="#7e57ed204828e112df6ac3b6fe0285f3"></a><br></td></tr>
 
33
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05299d68a39b2084a16c54f6c86c0561"></a><!-- doxytag: member="_fluid_sfont_t::get_name" ref="05299d68a39b2084a16c54f6c86c0561" args=")(fluid_sfont_t *sfont)" -->
 
34
char *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfont__t.html#05299d68a39b2084a16c54f6c86c0561">get_name</a> )(<a class="el" href="struct__fluid__sfont__t.html">fluid_sfont_t</a> *sfont)</td></tr>
 
35
 
 
36
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the name of the sfont. <br></td></tr>
 
37
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct__fluid__preset__t.html">fluid_preset_t</a> *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfont__t.html#115f22a8b4cd766d38b223e785b8e983">get_preset</a> )(<a class="el" href="struct__fluid__sfont__t.html">fluid_sfont_t</a> *sfont, unsigned int bank, unsigned int prenum)</td></tr>
 
38
 
 
39
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the preset with the specified bank and preset number.  <a href="#115f22a8b4cd766d38b223e785b8e983"></a><br></td></tr>
28
40
</table>
29
41
<hr><a name="_details"></a><h2>Detailed Description</h2>
30
42
 
31
 
<p>
32
 
 
33
 
<p>
34
 
Definition at line <a class="el" href="sfont_8h-source.html#l00092">92</a> of file <a class="el" href="sfont_8h-source.html">sfont.h</a>.<hr><h2>Field Documentation</h2>
35
 
<a class="anchor" name="o0"></a><!-- doxytag: member="_fluid_sfont_t::data" ref="o0" args="" --><p>
36
 
<table class="mdTable" cellpadding="2" cellspacing="0">
37
 
  <tr>
38
 
    <td class="mdRow">
39
 
      <table cellpadding="0" cellspacing="0" border="0">
40
 
        <tr>
41
 
          <td class="md" nowrap valign="top">void* <a class="el" href="struct__fluid__sfont__t.html#o0">_fluid_sfont_t::data</a>          </td>
42
 
        </tr>
43
 
      </table>
44
 
    </td>
45
 
  </tr>
46
 
</table>
47
 
<table cellspacing="5" cellpadding="0" border="0">
48
 
  <tr>
49
 
    <td>
50
 
      &nbsp;
51
 
    </td>
52
 
    <td>
53
 
 
54
 
<p>
55
 
 
56
 
<p>
57
 
Definition at line <a class="el" href="sfont_8h-source.html#l00093">93</a> of file <a class="el" href="sfont_8h-source.html">sfont.h</a>.    </td>
58
 
  </tr>
59
 
</table>
60
 
<a class="anchor" name="o2"></a><!-- doxytag: member="_fluid_sfont_t::free" ref="o2" args=")(fluid_sfont_t *sfont)" --><p>
61
 
<table class="mdTable" cellpadding="2" cellspacing="0">
62
 
  <tr>
63
 
    <td class="mdRow">
64
 
      <table cellpadding="0" cellspacing="0" border="0">
65
 
        <tr>
66
 
          <td class="md" nowrap valign="top">int(* <a class="el" href="struct__fluid__sfont__t.html#o2">_fluid_sfont_t::free</a>)(<a class="el" href="struct__fluid__sfont__t.html">fluid_sfont_t</a> *sfont)          </td>
67
 
        </tr>
68
 
      </table>
69
 
    </td>
70
 
  </tr>
71
 
</table>
72
 
<table cellspacing="5" cellpadding="0" border="0">
73
 
  <tr>
74
 
    <td>
75
 
      &nbsp;
76
 
    </td>
77
 
    <td>
 
43
<p>Definition at line <a class="el" href="sfont_8h-source.html#l00092">92</a> of file <a class="el" href="sfont_8h-source.html">sfont.h</a>.</p>
 
44
<hr><h2>Field Documentation</h2>
 
45
<a class="anchor" name="7e57ed204828e112df6ac3b6fe0285f3"></a><!-- doxytag: member="_fluid_sfont_t::free" ref="7e57ed204828e112df6ac3b6fe0285f3" args=")(fluid_sfont_t *sfont)" -->
 
46
<div class="memitem">
 
47
<div class="memproto">
 
48
      <table class="memname">
 
49
        <tr>
 
50
          <td class="memname">int(* <a class="el" href="struct__fluid__sfont__t.html#7e57ed204828e112df6ac3b6fe0285f3">_fluid_sfont_t::free</a>)(<a class="el" href="struct__fluid__sfont__t.html">fluid_sfont_t</a> *sfont)          </td>
 
51
        </tr>
 
52
      </table>
 
53
</div>
 
54
<div class="memdoc">
78
55
 
79
56
<p>
80
57
The 'free' callback function should return 0 when it was able to free all resources. 
81
58
<p>
82
 
It should return a non-zero value if some of the samples could not be freed because they are still in use.     </td>
83
 
  </tr>
84
 
</table>
85
 
<a class="anchor" name="o3"></a><!-- doxytag: member="_fluid_sfont_t::get_name" ref="o3" args=")(fluid_sfont_t *sfont)" --><p>
86
 
<table class="mdTable" cellpadding="2" cellspacing="0">
87
 
  <tr>
88
 
    <td class="mdRow">
89
 
      <table cellpadding="0" cellspacing="0" border="0">
90
 
        <tr>
91
 
          <td class="md" nowrap valign="top">char*(* <a class="el" href="struct__fluid__sfont__t.html#o3">_fluid_sfont_t::get_name</a>)(<a class="el" href="struct__fluid__sfont__t.html">fluid_sfont_t</a> *sfont)          </td>
92
 
        </tr>
93
 
      </table>
94
 
    </td>
95
 
  </tr>
96
 
</table>
97
 
<table cellspacing="5" cellpadding="0" border="0">
98
 
  <tr>
99
 
    <td>
100
 
      &nbsp;
101
 
    </td>
102
 
    <td>
103
 
 
104
 
<p>
105
 
Return the name of the sfont. 
106
 
<p>
107
 
    </td>
108
 
  </tr>
109
 
</table>
110
 
<a class="anchor" name="o4"></a><!-- doxytag: member="_fluid_sfont_t::get_preset" ref="o4" args=")(fluid_sfont_t *sfont, unsigned int bank, unsigned int prenum)" --><p>
111
 
<table class="mdTable" cellpadding="2" cellspacing="0">
112
 
  <tr>
113
 
    <td class="mdRow">
114
 
      <table cellpadding="0" cellspacing="0" border="0">
115
 
        <tr>
116
 
          <td class="md" nowrap valign="top"><a class="el" href="struct__fluid__preset__t.html">fluid_preset_t</a>*(* <a class="el" href="struct__fluid__sfont__t.html#o4">_fluid_sfont_t::get_preset</a>)(<a class="el" href="struct__fluid__sfont__t.html">fluid_sfont_t</a> *sfont, unsigned int bank, unsigned int prenum)          </td>
117
 
        </tr>
118
 
      </table>
119
 
    </td>
120
 
  </tr>
121
 
</table>
122
 
<table cellspacing="5" cellpadding="0" border="0">
123
 
  <tr>
124
 
    <td>
125
 
      &nbsp;
126
 
    </td>
127
 
    <td>
 
59
It should return a non-zero value if some of the samples could not be freed because they are still in use. 
 
60
</div>
 
61
</div><p>
 
62
<a class="anchor" name="115f22a8b4cd766d38b223e785b8e983"></a><!-- doxytag: member="_fluid_sfont_t::get_preset" ref="115f22a8b4cd766d38b223e785b8e983" args=")(fluid_sfont_t *sfont, unsigned int bank, unsigned int prenum)" -->
 
63
<div class="memitem">
 
64
<div class="memproto">
 
65
      <table class="memname">
 
66
        <tr>
 
67
          <td class="memname"><a class="el" href="struct__fluid__preset__t.html">fluid_preset_t</a>*(* <a class="el" href="struct__fluid__sfont__t.html#115f22a8b4cd766d38b223e785b8e983">_fluid_sfont_t::get_preset</a>)(<a class="el" href="struct__fluid__sfont__t.html">fluid_sfont_t</a> *sfont, unsigned int bank, unsigned int prenum)          </td>
 
68
        </tr>
 
69
      </table>
 
70
</div>
 
71
<div class="memdoc">
128
72
 
129
73
<p>
130
74
Return the preset with the specified bank and preset number. 
131
75
<p>
132
 
All the fields, including the 'sfont' field, should * be filled in. If the preset cannot be found, the function returns NULL.     </td>
133
 
  </tr>
134
 
</table>
135
 
<a class="anchor" name="o1"></a><!-- doxytag: member="_fluid_sfont_t::id" ref="o1" args="" --><p>
136
 
<table class="mdTable" cellpadding="2" cellspacing="0">
137
 
  <tr>
138
 
    <td class="mdRow">
139
 
      <table cellpadding="0" cellspacing="0" border="0">
140
 
        <tr>
141
 
          <td class="md" nowrap valign="top">unsigned int <a class="el" href="struct__fluid__sfont__t.html#o1">_fluid_sfont_t::id</a>          </td>
142
 
        </tr>
143
 
      </table>
144
 
    </td>
145
 
  </tr>
146
 
</table>
147
 
<table cellspacing="5" cellpadding="0" border="0">
148
 
  <tr>
149
 
    <td>
150
 
      &nbsp;
151
 
    </td>
152
 
    <td>
153
 
 
154
 
<p>
155
 
 
156
 
<p>
157
 
Definition at line <a class="el" href="sfont_8h-source.html#l00094">94</a> of file <a class="el" href="sfont_8h-source.html">sfont.h</a>.    </td>
158
 
  </tr>
159
 
</table>
160
 
<a class="anchor" name="o6"></a><!-- doxytag: member="_fluid_sfont_t::iteration_next" ref="o6" args=")(fluid_sfont_t *sfont, fluid_preset_t *preset)" --><p>
161
 
<table class="mdTable" cellpadding="2" cellspacing="0">
162
 
  <tr>
163
 
    <td class="mdRow">
164
 
      <table cellpadding="0" cellspacing="0" border="0">
165
 
        <tr>
166
 
          <td class="md" nowrap valign="top">int(* <a class="el" href="struct__fluid__sfont__t.html#o6">_fluid_sfont_t::iteration_next</a>)(<a class="el" href="struct__fluid__sfont__t.html">fluid_sfont_t</a> *sfont, <a class="el" href="struct__fluid__preset__t.html">fluid_preset_t</a> *preset)          </td>
167
 
        </tr>
168
 
      </table>
169
 
    </td>
170
 
  </tr>
171
 
</table>
172
 
<table cellspacing="5" cellpadding="0" border="0">
173
 
  <tr>
174
 
    <td>
175
 
      &nbsp;
176
 
    </td>
177
 
    <td>
178
 
 
179
 
<p>
180
 
    </td>
181
 
  </tr>
182
 
</table>
183
 
<a class="anchor" name="o5"></a><!-- doxytag: member="_fluid_sfont_t::iteration_start" ref="o5" args=")(fluid_sfont_t *sfont)" --><p>
184
 
<table class="mdTable" cellpadding="2" cellspacing="0">
185
 
  <tr>
186
 
    <td class="mdRow">
187
 
      <table cellpadding="0" cellspacing="0" border="0">
188
 
        <tr>
189
 
          <td class="md" nowrap valign="top">void(* <a class="el" href="struct__fluid__sfont__t.html#o5">_fluid_sfont_t::iteration_start</a>)(<a class="el" href="struct__fluid__sfont__t.html">fluid_sfont_t</a> *sfont)          </td>
190
 
        </tr>
191
 
      </table>
192
 
    </td>
193
 
  </tr>
194
 
</table>
195
 
<table cellspacing="5" cellpadding="0" border="0">
196
 
  <tr>
197
 
    <td>
198
 
      &nbsp;
199
 
    </td>
200
 
    <td>
201
 
 
202
 
<p>
203
 
    </td>
204
 
  </tr>
205
 
</table>
 
76
All the fields, including the 'sfont' field, should * be filled in. If the preset cannot be found, the function returns NULL. 
 
77
</div>
 
78
</div><p>
206
79
<hr>The documentation for this struct was generated from the following file:<ul>
207
 
<li><a class="el" href="sfont_8h-source.html">sfont.h</a></ul>
208
 
<hr size="1"><address style="align: right;"><small>Generated on Sun Feb 19 02:34:30 2006 for libfluidsynth by&nbsp;
 
80
<li>include/fluidsynth/<a class="el" href="sfont_8h-source.html">sfont.h</a></ul>
 
81
<hr size="1"><address style="text-align: right;"><small>Generated on Sat Nov 17 13:40:24 2007 for libfluidsynth by&nbsp;
209
82
<a href="http://www.doxygen.org/index.html">
210
 
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4 </small></address>
 
83
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
211
84
</body>
212
85
</html>