libinstpatch-doc 1.0.0-4 / usr / share / gtk-doc / html / libinstpatch / IpatchGigDimension.html

This file is indexed.

/usr/share/gtk-doc/html/libinstpatch/IpatchGigDimension.html is in libinstpatch-doc 1.0.0-4.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchGigDimension</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="index.html" title="libinstpatch Reference Manual">
<link rel="up" href="ch06.html" title="GigaSampler patches">
<link rel="prev" href="IpatchGigRegion.html" title="IpatchGigRegion">
<link rel="next" href="IpatchGigSubRegion.html" title="IpatchGigSubRegion">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Base objects and functions">
<link rel="chapter" href="ch02.html" title="Utility objects and functions">
<link rel="chapter" href="ch03.html" title="Sample data objects and functions">
<link rel="chapter" href="ch04.html" title="DLS patches">
<link rel="chapter" href="ch05.html" title="SoundFont patches">
<link rel="chapter" href="ch06.html" title="GigaSampler patches">
<link rel="chapter" href="ch07.html" title="Virtual banks">
<link rel="chapter" href="object-tree.html" title="Object Hierarchy">
<link rel="index" href="api-index-full.html" title="API Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="IpatchGigRegion.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinstpatch Reference Manual</th>
<td><a accesskey="n" href="IpatchGigSubRegion.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchGigDimension.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#IpatchGigDimension.description" class="shortcut">Description</a>
                 | 
                <a href="#IpatchGigDimension.object-hierarchy" class="shortcut">Object Hierarchy</a>
                 | 
                <a href="#IpatchGigDimension.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="IpatchGigDimension">
<a name="IpatchGigDimension"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchGigDimension.top_of_page"></a>IpatchGigDimension</span></h2>
<p>IpatchGigDimension — GigaSampler dimension object</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchGigDimension.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchGigDimension.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
enum                <a
href="../libinstpatch/IpatchGigDimension.html#IpatchGigDimensionType"
>IpatchGigDimensionType</a>;
#define             <a
href="../libinstpatch/IpatchGigDimension.html#IPATCH-GIG-DIMENSION-TYPE-MAX--CAPS"
>IPATCH_GIG_DIMENSION_TYPE_MAX</a>
                    <a
href="../libinstpatch/IpatchGigDimension.html#IpatchGigDimension-struct"
>IpatchGigDimension</a>;
<a
href="../libinstpatch/IpatchGigDimension.html"
>IpatchGigDimension</a> * <a
href="../libinstpatch/IpatchGigDimension.html#ipatch-gig-dimension-new"
>ipatch_gig_dimension_new</a>           (void);
<a
href="../libinstpatch/IpatchGigDimension.html"
>IpatchGigDimension</a> * <a
href="../libinstpatch/IpatchGigDimension.html#ipatch-gig-dimension-first"
>ipatch_gig_dimension_first</a>         (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);
<a
href="../libinstpatch/IpatchGigDimension.html"
>IpatchGigDimension</a> * <a
href="../libinstpatch/IpatchGigDimension.html#ipatch-gig-dimension-next"
>ipatch_gig_dimension_next</a>          (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchGigDimension.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
   +----<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a>
         +----IpatchGigDimension
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="IpatchGigDimension.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a
href="../libinstpatch/IpatchGigDimension.html#IpatchGigDimension--name"
>name</a>"                     <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a>*                : Read / Write
  "<a
href="../libinstpatch/IpatchGigDimension.html#IpatchGigDimension--split-count"
>split-count</a>"              <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a>                  : Read / Write
  "<a
href="../libinstpatch/IpatchGigDimension.html#IpatchGigDimension--type"
>type</a>"                     <a
href="../libinstpatch/IpatchGigDimension.html#IpatchGigDimensionType"
>IpatchGigDimensionType</a>  : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchGigDimension.description"></a><h2>Description</h2>
<p>
Defines a GigaSampler dimension object which are the children of
<a
href="../libinstpatch/IpatchGigInst.html"
><span class="type">IpatchGigInst</span></a> objects.</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchGigDimension.details"></a><h2>Details</h2>
<div class="refsect2" title="enum IpatchGigDimensionType">
<a name="IpatchGigDimensionType"></a><h3>enum IpatchGigDimensionType</h3>
<pre class="programlisting">typedef enum
{
  IPATCH_GIG_DIMENSION_NONE            = 0x00, /* not in use (is this in files?) */

  /* MIDI controllers - see IpatchGigControlType (IpatchGigEffects.h) */

  IPATCH_GIG_DIMENSION_MOD_WHEEL       = 0x01,
  IPATCH_GIG_DIMENSION_BREATH          = 0x02,
  IPATCH_GIG_DIMENSION_FOOT            = 0x04,
  IPATCH_GIG_DIMENSION_PORTAMENTO_TIME = 0x05,
  IPATCH_GIG_DIMENSION_EFFECT_1        = 0x0C,
  IPATCH_GIG_DIMENSION_EFFECT_2        = 0x0D,
  IPATCH_GIG_DIMENSION_GEN_PURPOSE_1   = 0x10,
  IPATCH_GIG_DIMENSION_GEN_PURPOSE_2   = 0x11,
  IPATCH_GIG_DIMENSION_GEN_PURPOSE_3   = 0x12,
  IPATCH_GIG_DIMENSION_GEN_PURPOSE_4   = 0x13,
  IPATCH_GIG_DIMENSION_SUSTAIN_PEDAL   = 0x40,
  IPATCH_GIG_DIMENSION_PORTAMENTO      = 0x41,
  IPATCH_GIG_DIMENSION_SOSTENUTO       = 0x42,
  IPATCH_GIG_DIMENSION_SOFT_PEDAL      = 0x43,
  IPATCH_GIG_DIMENSION_GEN_PURPOSE_5   = 0x50,
  IPATCH_GIG_DIMENSION_GEN_PURPOSE_6   = 0x51,
  IPATCH_GIG_DIMENSION_GEN_PURPOSE_7   = 0x52,
  IPATCH_GIG_DIMENSION_GEN_PURPOSE_8   = 0x53,
  IPATCH_GIG_DIMENSION_EFFECT_DEPTH_1  = 0x5B,
  IPATCH_GIG_DIMENSION_EFFECT_DEPTH_2  = 0x5C,
  IPATCH_GIG_DIMENSION_EFFECT_DEPTH_3  = 0x5D,
  IPATCH_GIG_DIMENSION_EFFECT_DEPTH_4  = 0x5E,
  IPATCH_GIG_DIMENSION_EFFECT_DEPTH_5  = 0x5F,

  IPATCH_GIG_DIMENSION_CHANNEL         = 0x80, /* sample has more than 1 channel */
  IPATCH_GIG_DIMENSION_LAYER           = 0x81, /* layer up to 8 zones (cross fade 2 or 4) */
  IPATCH_GIG_DIMENSION_VELOCITY        = 0x82, /* key velocity (only type that allows specific ranges) */
  IPATCH_GIG_DIMENSION_AFTER_TOUCH     = 0x83, /* channel MIDI after touch */
  IPATCH_GIG_DIMENSION_RELEASE_TRIG    = 0x84, /* trigger on key release */
  IPATCH_GIG_DIMENSION_KEYBOARD        = 0x85, /* key switching (FIXME WTF?) */
  IPATCH_GIG_DIMENSION_ROUND_ROBIN     = 0x86, /* selects zones in sequence */
  IPATCH_GIG_DIMENSION_RANDOM          = 0x87  /* selects random zone */
} IpatchGigDimensionType;
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_GIG_DIMENSION_TYPE_MAX">
<a name="IPATCH-GIG-DIMENSION-TYPE-MAX--CAPS"></a><h3>IPATCH_GIG_DIMENSION_TYPE_MAX</h3>
<pre class="programlisting">#define IPATCH_GIG_DIMENSION_TYPE_MAX   IPATCH_GIG_DIMENSION_RANDOM
</pre>
</div>
<hr>
<div class="refsect2" title="IpatchGigDimension">
<a name="IpatchGigDimension-struct"></a><h3>IpatchGigDimension</h3>
<pre class="programlisting">typedef struct _IpatchGigDimension IpatchGigDimension;</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_gig_dimension_new ()">
<a name="ipatch-gig-dimension-new"></a><h3>ipatch_gig_dimension_new ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchGigDimension.html"
>IpatchGigDimension</a> * ipatch_gig_dimension_new           (void);</pre>
<p>
Create a new GigaSampler instrument dimension.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New GigaSampler dimension with a ref count of 1 which the caller
owns.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_gig_dimension_first ()">
<a name="ipatch-gig-dimension-first"></a><h3>ipatch_gig_dimension_first ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchGigDimension.html"
>IpatchGigDimension</a> * ipatch_gig_dimension_first         (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);</pre>
<p>
Gets the first item in a dimension iterator. A convenience
wrapper for <a
href="../libinstpatch/libinstpatch-IpatchIter.html#ipatch-iter-first"
><code class="function">ipatch_iter_first()</code></a>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td> Patch item iterator containing <a
href="../libinstpatch/IpatchGigDimension.html"
><span class="type">IpatchGigDimension</span></a> items
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The first dimension in <em class="parameter"><code>iter</code></em> or <code class="literal">NULL</code> if empty.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_gig_dimension_next ()">
<a name="ipatch-gig-dimension-next"></a><h3>ipatch_gig_dimension_next ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchGigDimension.html"
>IpatchGigDimension</a> * ipatch_gig_dimension_next          (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);</pre>
<p>
Gets the next item in a dimension iterator. A convenience wrapper
for <a
href="../libinstpatch/libinstpatch-IpatchIter.html#ipatch-iter-next"
><code class="function">ipatch_iter_next()</code></a>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td> Patch item iterator containing <a
href="../libinstpatch/IpatchGigDimension.html"
><span class="type">IpatchGigDimension</span></a> items
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The next dimension in <em class="parameter"><code>iter</code></em> or <code class="literal">NULL</code> if at the end of
  the list.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="IpatchGigDimension.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "name" property'>
<a name="IpatchGigDimension--name"></a><h3>The <code class="literal">"name"</code> property</h3>
<pre class="programlisting">  "name"                     <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a>*                : Read / Write</pre>
<p>Dimension name.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" title='The "split-count" property'>
<a name="IpatchGigDimension--split-count"></a><h3>The <code class="literal">"split-count"</code> property</h3>
<pre class="programlisting">  "split-count"              <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a>                  : Read / Write</pre>
<p>Number of split bits.</p>
<p>Allowed values: [1,5]</p>
<p>Default value: 1</p>
</div>
<hr>
<div class="refsect2" title='The "type" property'>
<a name="IpatchGigDimension--type"></a><h3>The <code class="literal">"type"</code> property</h3>
<pre class="programlisting">  "type"                     <a
href="../libinstpatch/IpatchGigDimension.html#IpatchGigDimensionType"
>IpatchGigDimensionType</a>  : Read / Write</pre>
<p>Dimension type.</p>
<p>Default value: IPATCH_GIG_DIMENSION_NONE</p>
</div>
</div>
<div class="refsect1" title="See Also">
<a name="IpatchGigDimension.see-also"></a><h2>See Also</h2>
#IpatchGigInst
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.