/usr/share/gtk-doc/html/libinstpatch/libinstpatch-IpatchSF2GenItem.html is in libinstpatch-doc 1.0.0-6.
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 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 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchSF2GenItem</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="ch05.html" title="SoundFont patches">
<link rel="prev" href="libinstpatch-IpatchSF2Gen.html" title="IpatchSF2Gen">
<link rel="next" href="libinstpatch-IpatchSF2Mod.html" title="IpatchSF2Mod">
<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="libinstpatch-IpatchSF2Gen.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch05.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="libinstpatch-IpatchSF2Mod.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libinstpatch-IpatchSF2GenItem.synopsis" class="shortcut">Top</a>
|
<a href="#libinstpatch-IpatchSF2GenItem.description" class="shortcut">Description</a>
|
<a href="#libinstpatch-IpatchSF2GenItem.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#libinstpatch-IpatchSF2GenItem.prerequisites" class="shortcut">Prerequisites</a>
|
<a href="#libinstpatch-IpatchSF2GenItem.implementations" class="shortcut">Known Implementations</a>
</td></tr>
</table>
<div class="refentry" title="IpatchSF2GenItem">
<a name="libinstpatch-IpatchSF2GenItem"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libinstpatch-IpatchSF2GenItem.top_of_page"></a>IpatchSF2GenItem</span></h2>
<p>IpatchSF2GenItem — SoundFont generator item interface</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="libinstpatch-IpatchSF2GenItem.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libinstpatch-IpatchSF2GenItem.synopsis"></a><h2>Synopsis</h2>
<a name="IpatchSF2GenItemIface"></a><pre class="synopsis">
#define <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IPATCH-SF2-GEN-ITEM-FIRST-PROP-ID--CAPS"
>IPATCH_SF2_GEN_ITEM_FIRST_PROP_ID</a>
#define <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IPATCH-SF2-GEN-ITEM-FIRST-PROP-SET-ID--CAPS"
>IPATCH_SF2_GEN_ITEM_FIRST_PROP_SET_ID</a>
#define <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IPATCH-SF2-GEN-ITEM-FIRST-PROP-USER-ID--CAPS"
>IPATCH_SF2_GEN_ITEM_FIRST_PROP_USER_ID</a>
typedef <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a>;
<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItemIface-struct"
>IpatchSF2GenItemIface</a>;
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#ipatch-sf2-gen-item-get-amount"
>ipatch_sf2_gen_item_get_amount</a> (<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid,
<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *out_amt);
void <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#ipatch-sf2-gen-item-set-amount"
>ipatch_sf2_gen_item_set_amount</a> (<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid,
<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *amt);
void <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#ipatch-sf2-gen-item-set-gen-flag"
>ipatch_sf2_gen_item_set_gen_flag</a> (<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> setflag);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#ipatch-sf2-gen-item-count-set"
>ipatch_sf2_gen_item_count_set</a> (<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item);
void <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#ipatch-sf2-gen-item-copy-all"
>ipatch_sf2_gen_item_copy_all</a> (<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *array);
void <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#ipatch-sf2-gen-item-copy-set"
>ipatch_sf2_gen_item_copy_set</a> (<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *array);
void <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#ipatch-sf2-gen-item-set-note-range"
>ipatch_sf2_gen_item_set_note_range</a> (<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
int low,
int high);
void <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#ipatch-sf2-gen-item-set-velocity-range"
>ipatch_sf2_gen_item_set_velocity_range</a>
(<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
int low,
int high);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#ipatch-sf2-gen-item-in-range"
>ipatch_sf2_gen_item_in_range</a> (<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
int note,
int velocity);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#ipatch-sf2-gen-item-intersect-test"
>ipatch_sf2_gen_item_intersect_test</a> (<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *genarray);
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> * <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#ipatch-sf2-gen-item-class-get-pspec"
>ipatch_sf2_gen_item_class_get_pspec</a> (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"
>GObjectClass</a> *klass,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid);
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> * <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#ipatch-sf2-gen-item-class-get-pspec-set"
>ipatch_sf2_gen_item_class_get_pspec_set</a>
(<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"
>GObjectClass</a> *klass,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid);
void <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#ipatch-sf2-gen-item-iface-install-properties"
>ipatch_sf2_gen_item_iface_install_properties</a>
(<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"
>GObjectClass</a> *klass,
<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenPropsType"
>IpatchSF2GenPropsType</a> propstype,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> ***specs,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> ***setspecs);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#ipatch-sf2-gen-item-iface-set-property"
>ipatch_sf2_gen_item_iface_set_property</a>
(<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> property_id,
const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#ipatch-sf2-gen-item-iface-get-property"
>ipatch_sf2_gen_item_iface_get_property</a>
(<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> property_id,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="libinstpatch-IpatchSF2GenItem.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----IpatchSF2GenItemIface
</pre>
</div>
<div class="refsect1" title="Prerequisites">
<a name="libinstpatch-IpatchSF2GenItem.prerequisites"></a><h2>Prerequisites</h2>
<p>
IpatchSF2GenItemIface requires
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a>.</p>
</div>
<div class="refsect1" title="Known Implementations">
<a name="libinstpatch-IpatchSF2GenItem.implementations"></a><h2>Known Implementations</h2>
<p>
IpatchSF2GenItemIface is implemented by
<a
href="../libinstpatch/IpatchSF2Inst.html"
>IpatchSF2Inst</a>, <a
href="../libinstpatch/IpatchSF2PZone.html"
>IpatchSF2PZone</a>, <a
href="../libinstpatch/IpatchSF2IZone.html"
>IpatchSF2IZone</a> and <a
href="../libinstpatch/IpatchSF2Preset.html"
>IpatchSF2Preset</a>.</p>
</div>
<div class="refsect1" title="Description">
<a name="libinstpatch-IpatchSF2GenItem.description"></a><h2>Description</h2>
<p>
Provides an interface for items which have SoundFont generator properties.
SoundFont generators are synthesis parameters used by <a
href="../libinstpatch/IpatchSF2Preset.html"
><span class="type">IpatchSF2Preset</span></a>,
<a
href="../libinstpatch/IpatchSF2Inst.html"
><span class="type">IpatchSF2Inst</span></a>, <a
href="../libinstpatch/IpatchSF2PZone.html"
><span class="type">IpatchSF2PZone</span></a> and <a
href="../libinstpatch/IpatchSF2IZone.html"
><span class="type">IpatchSF2IZone</span></a> objects.</p>
</div>
<div class="refsect1" title="Details">
<a name="libinstpatch-IpatchSF2GenItem.details"></a><h2>Details</h2>
<div class="refsect2" title="IPATCH_SF2_GEN_ITEM_FIRST_PROP_ID">
<a name="IPATCH-SF2-GEN-ITEM-FIRST-PROP-ID--CAPS"></a><h3>IPATCH_SF2_GEN_ITEM_FIRST_PROP_ID</h3>
<pre class="programlisting">#define IPATCH_SF2_GEN_ITEM_FIRST_PROP_ID 1 /* first gen prop */
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SF2_GEN_ITEM_FIRST_PROP_SET_ID">
<a name="IPATCH-SF2-GEN-ITEM-FIRST-PROP-SET-ID--CAPS"></a><h3>IPATCH_SF2_GEN_ITEM_FIRST_PROP_SET_ID</h3>
<pre class="programlisting">#define IPATCH_SF2_GEN_ITEM_FIRST_PROP_SET_ID 80 /* first gen-set prop */
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SF2_GEN_ITEM_FIRST_PROP_USER_ID">
<a name="IPATCH-SF2-GEN-ITEM-FIRST-PROP-USER-ID--CAPS"></a><h3>IPATCH_SF2_GEN_ITEM_FIRST_PROP_USER_ID</h3>
<pre class="programlisting">#define IPATCH_SF2_GEN_ITEM_FIRST_PROP_USER_ID 160 /* first ID usable for other properties */
</pre>
</div>
<hr>
<div class="refsect2" title="IpatchSF2GenItem">
<a name="IpatchSF2GenItem"></a><h3>IpatchSF2GenItem</h3>
<pre class="programlisting">typedef IpatchItem IpatchSF2GenItem;
</pre>
</div>
<hr>
<div class="refsect2" title="IpatchSF2GenItemIface">
<a name="IpatchSF2GenItemIface-struct"></a><h3>IpatchSF2GenItemIface</h3>
<pre class="programlisting">typedef struct {
IpatchSF2GenPropsType propstype; /* gen properties type for this class */
guint genarray_ofs; /* offset in item instance to generator array pointer */
GParamSpec *specs[IPATCH_SF2_GEN_COUNT]; /* genid -> prop pspec array */
GParamSpec *setspecs[IPATCH_SF2_GEN_COUNT]; /* genid -> "-set" prop pspec array */
} IpatchSF2GenItemIface;
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_item_get_amount ()">
<a name="ipatch-sf2-gen-item-get-amount"></a><h3>ipatch_sf2_gen_item_get_amount ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_sf2_gen_item_get_amount (<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid,
<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *out_amt);</pre>
<p>
Get a generator amount from an item with generator properties.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item with generators to get value from
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>genid</code></em> :</span></p></td>
<td> Generator ID (<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenType"
><span class="type">IpatchSF2GenType</span></a>) of value to get
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>out_amt</code></em> :</span></p></td>
<td> Output: Pointer to store generator amount to
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if generator value is set, <code class="literal">FALSE</code> if not set, in which case
the value stored to output_amt is the default value for the given generator
ID.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_item_set_amount ()">
<a name="ipatch-sf2-gen-item-set-amount"></a><h3>ipatch_sf2_gen_item_set_amount ()</h3>
<pre class="programlisting">void ipatch_sf2_gen_item_set_amount (<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid,
<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *amt);</pre>
<p>
Set a generator amount for an item with generators.
</p>
<p>
<a
href="../libinstpatch/IpatchItem.html"
><span class="type">IpatchItem</span></a> property notify is done for the property and possibly the "-set"
property if it was unset before.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item with generators to set value in
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>genid</code></em> :</span></p></td>
<td> Generator ID (<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenType"
><span class="type">IpatchSF2GenType</span></a>) of generator to set
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>amt</code></em> :</span></p></td>
<td> Value to set generator to
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_item_set_gen_flag ()">
<a name="ipatch-sf2-gen-item-set-gen-flag"></a><h3>ipatch_sf2_gen_item_set_gen_flag ()</h3>
<pre class="programlisting">void ipatch_sf2_gen_item_set_gen_flag (<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> setflag);</pre>
<p>
Sets the value of a generator "set" flag in an item with generators.
</p>
<p>
<a
href="../libinstpatch/IpatchItem.html"
><span class="type">IpatchItem</span></a> property notify is done for the property and possibly the "-set"
property if it was set before.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item with generator properties to set value of a gen "set" flag of
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>genid</code></em> :</span></p></td>
<td> Generator ID (<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenType"
><span class="type">IpatchSF2GenType</span></a>) of generator to set "set" flag value of
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>setflag</code></em> :</span></p></td>
<td> If <code class="literal">TRUE</code> then generatore amount is assigned, FALSE will cause the
amount to be unset (and revert to its default value)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_item_count_set ()">
<a name="ipatch-sf2-gen-item-count-set"></a><h3>ipatch_sf2_gen_item_count_set ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> ipatch_sf2_gen_item_count_set (<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item);</pre>
<p>
Get count of "set" generators in an item with generators.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item with generators
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Count of "set" generators.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_item_copy_all ()">
<a name="ipatch-sf2-gen-item-copy-all"></a><h3>ipatch_sf2_gen_item_copy_all ()</h3>
<pre class="programlisting">void ipatch_sf2_gen_item_copy_all (<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *array);</pre>
<p>
Copies an item's generators to a caller supplied generator array.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item with generators
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
<td> Destination generator array to store to
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_item_copy_set ()">
<a name="ipatch-sf2-gen-item-copy-set"></a><h3>ipatch_sf2_gen_item_copy_set ()</h3>
<pre class="programlisting">void ipatch_sf2_gen_item_copy_set (<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *array);</pre>
<p>
Copies a item's "set" generators to a caller supplied generator array.
This function differs from <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#ipatch-sf2-gen-item-copy-all"
><code class="function">ipatch_sf2_gen_item_copy_all()</code></a> in that it
only copies generators that are set. It can be used to override values
in one array with set values in another. Note that this doesn't change
any generators in <em class="parameter"><code>item</code></em>, despite "set" being in the name.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item with generators
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
<td> Destination generator array to store to
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_item_set_note_range ()">
<a name="ipatch-sf2-gen-item-set-note-range"></a><h3>ipatch_sf2_gen_item_set_note_range ()</h3>
<pre class="programlisting">void ipatch_sf2_gen_item_set_note_range (<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
int low,
int high);</pre>
<p>
Set the MIDI note range that an item with generators is active on.
Only a convenience function really.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item with generators
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>low</code></em> :</span></p></td>
<td> Low value of range (MIDI note # between 0 and 127)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>high</code></em> :</span></p></td>
<td> High value of range (MIDI note # between 0 and 127)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_item_set_velocity_range ()">
<a name="ipatch-sf2-gen-item-set-velocity-range"></a><h3>ipatch_sf2_gen_item_set_velocity_range ()</h3>
<pre class="programlisting">void ipatch_sf2_gen_item_set_velocity_range
(<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
int low,
int high);</pre>
<p>
Set the MIDI velocity range that an item with generators is active on.
Only a convenience function really.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item with generators
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>low</code></em> :</span></p></td>
<td> Low value of range (MIDI velocity # between 0 and 127)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>high</code></em> :</span></p></td>
<td> High value of range (MIDI velocity # between 0 and 127)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_item_in_range ()">
<a name="ipatch-sf2-gen-item-in-range"></a><h3>ipatch_sf2_gen_item_in_range ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_sf2_gen_item_in_range (<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
int note,
int velocity);</pre>
<p>
Check if a note and velocity falls in the ranges of an item with generators</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item with generators
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>note</code></em> :</span></p></td>
<td> MIDI note number or -1 for wildcard
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>velocity</code></em> :</span></p></td>
<td> MIDI velocity or -1 for wildcard
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>item</code></em> is in <em class="parameter"><code>note</code></em> and <em class="parameter"><code>velocity</code></em> range, <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_item_intersect_test ()">
<a name="ipatch-sf2-gen-item-intersect-test"></a><h3>ipatch_sf2_gen_item_intersect_test ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_sf2_gen_item_intersect_test (<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *genarray);</pre>
<p>
Check if a given item's note and velocity ranges intersect with those in a
generator array.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item with generators
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>genarray</code></em> :</span></p></td>
<td> Generator array to test note and velocity ranges against
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if both note and velocity ranges intersect, <code class="literal">FALSE</code> if one or
both do not.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_item_class_get_pspec ()">
<a name="ipatch-sf2-gen-item-class-get-pspec"></a><h3>ipatch_sf2_gen_item_class_get_pspec ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> * ipatch_sf2_gen_item_class_get_pspec (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"
>GObjectClass</a> *klass,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid);</pre>
<p>
Get the parameter specification for a given generator ID and object class.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>genid</code></em> :</span></p></td>
<td> Generator ID
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td> Class with an <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
><span class="type">IpatchSF2GenItem</span></a> interface
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The parameter specification for the generator or <code class="literal">NULL</code> if
the given <em class="parameter"><code>genid</code></em> for <em class="parameter"><code>klass</code></em> is not valid.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_item_class_get_pspec_set ()">
<a name="ipatch-sf2-gen-item-class-get-pspec-set"></a><h3>ipatch_sf2_gen_item_class_get_pspec_set ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> * ipatch_sf2_gen_item_class_get_pspec_set
(<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"
>GObjectClass</a> *klass,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid);</pre>
<p>
Get a "-set" property parameter specification for a given generator ID and
object class.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>genid</code></em> :</span></p></td>
<td> Generator ID
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td> Class with an <a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
><span class="type">IpatchSF2GenItem</span></a> interface
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The "-set" property parameter specification for the generator or
<code class="literal">NULL</code> if the given <em class="parameter"><code>genid</code></em> or <em class="parameter"><code>klass</code></em> are not valid.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_item_iface_install_properties ()">
<a name="ipatch-sf2-gen-item-iface-install-properties"></a><h3>ipatch_sf2_gen_item_iface_install_properties ()</h3>
<pre class="programlisting">void ipatch_sf2_gen_item_iface_install_properties
(<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"
>GObjectClass</a> *klass,
<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenPropsType"
>IpatchSF2GenPropsType</a> propstype,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> ***specs,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> ***setspecs);</pre>
<p>
Installs generator item properties on the provided <em class="parameter"><code>klass</code></em>.
Used internally in IpatchSF2GenItemIface init functions.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td> Object class to install properties on
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>propstype</code></em> :</span></p></td>
<td> Type of properties to install (instrument/preset)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>specs</code></em> :</span></p></td>
<td> Location to store a pointer to an allocated array of parameter
specs which should get copied to the interface's specs field and then freed
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>setspecs</code></em> :</span></p></td>
<td> Location to store a pointer to an allocated array of parameter
specs which should get copied to the interface's setspecs field and then freed
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_item_iface_set_property ()">
<a name="ipatch-sf2-gen-item-iface-set-property"></a><h3>ipatch_sf2_gen_item_iface_set_property ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_sf2_gen_item_iface_set_property
(<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> property_id,
const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value);</pre>
<p>
Used internally for classes with generators, to set values thereof.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> IpatchItem instance with generator properties
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>property_id</code></em> :</span></p></td>
<td> Property id to set
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td> Value to set property to
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>property_id</code></em> handled, <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_item_iface_get_property ()">
<a name="ipatch-sf2-gen-item-iface-get-property"></a><h3>ipatch_sf2_gen_item_iface_get_property ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_sf2_gen_item_iface_get_property
(<a
href="../libinstpatch/libinstpatch-IpatchSF2GenItem.html#IpatchSF2GenItem"
>IpatchSF2GenItem</a> *item,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> property_id,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value);</pre>
<p>
Used internally for classes with generator properties, to get values thereof.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> IpatchItem instance with generators
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>property_id</code></em> :</span></p></td>
<td> Property id to set
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td> Value to set property to
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>property_id</code></em> handled, <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="See Also">
<a name="libinstpatch-IpatchSF2GenItem.see-also"></a><h2>See Also</h2>
#IpatchSF2Preset, <a
href="../libinstpatch/IpatchSF2Inst.html"
><span class="type">IpatchSF2Inst</span></a>, <a
href="../libinstpatch/IpatchSF2PZone.html"
><span class="type">IpatchSF2PZone</span></a>, <a
href="../libinstpatch/IpatchSF2IZone.html"
><span class="type">IpatchSF2IZone</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|