/usr/share/gtk-doc/html/libgimp/libgimp-gimpbrush.html is in libgimp2.0-doc 2.6.12-1ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpbrush</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-data.html" title="Data Objects">
<link rel="prev" href="libgimp-data.html" title="Data Objects">
<link rel="next" href="libgimp-gimpbrushes.html" title="gimpbrushes">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="libgimp-data.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-data.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">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimpbrushes.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgimp-gimpbrush.synopsis" class="shortcut">Top</a>
|
<a href="#libgimp-gimpbrush.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgimp-gimpbrush"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp-gimpbrush.top_of_page"></a>gimpbrush</span></h2>
<p>gimpbrush — Functions operating on a single brush.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgimp-gimpbrush.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">gchar</span> * <a class="link" href="libgimp-gimpbrush.html#gimp-brush-new" title="gimp_brush_new ()">gimp_brush_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="libgimp-gimpbrush.html#gimp-brush-duplicate" title="gimp_brush_duplicate ()">gimp_brush_duplicate</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="libgimp-gimpbrush.html#gimp-brush-rename" title="gimp_brush_rename ()">gimp_brush_rename</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *new_name</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-delete" title="gimp_brush_delete ()">gimp_brush_delete</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-get-info" title="gimp_brush_get_info ()">gimp_brush_get_info</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> *width</code></em>,
<em class="parameter"><code><span class="type">gint</span> *height</code></em>,
<em class="parameter"><code><span class="type">gint</span> *mask_bpp</code></em>,
<em class="parameter"><code><span class="type">gint</span> *color_bpp</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-get-pixels" title="gimp_brush_get_pixels ()">gimp_brush_get_pixels</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> *width</code></em>,
<em class="parameter"><code><span class="type">gint</span> *height</code></em>,
<em class="parameter"><code><span class="type">gint</span> *mask_bpp</code></em>,
<em class="parameter"><code><span class="type">gint</span> *num_mask_bytes</code></em>,
<em class="parameter"><code><span class="type">guint8</span> **mask_bytes</code></em>,
<em class="parameter"><code><span class="type">gint</span> *color_bpp</code></em>,
<em class="parameter"><code><span class="type">gint</span> *num_color_bytes</code></em>,
<em class="parameter"><code><span class="type">guint8</span> **color_bytes</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-get-spacing" title="gimp_brush_get_spacing ()">gimp_brush_get_spacing</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> *spacing</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-set-spacing" title="gimp_brush_set_spacing ()">gimp_brush_set_spacing</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> spacing</code></em>);
<a class="link" href="libgimp-gimpenums.html#GimpBrushGeneratedShape" title="enum GimpBrushGeneratedShape"><span class="returnvalue">GimpBrushGeneratedShape</span></a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-get-shape" title="gimp_brush_get_shape ()">gimp_brush_get_shape</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<a class="link" href="libgimp-gimpenums.html#GimpBrushGeneratedShape" title="enum GimpBrushGeneratedShape"><span class="returnvalue">GimpBrushGeneratedShape</span></a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-set-shape" title="gimp_brush_set_shape ()">gimp_brush_set_shape</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpBrushGeneratedShape" title="enum GimpBrushGeneratedShape"><span class="type">GimpBrushGeneratedShape</span></a> shape_in</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-get-spikes" title="gimp_brush_get_spikes ()">gimp_brush_get_spikes</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-set-spikes" title="gimp_brush_set_spikes ()">gimp_brush_set_spikes</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> spikes_in</code></em>);
<span class="returnvalue">gdouble</span> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-get-angle" title="gimp_brush_get_angle ()">gimp_brush_get_angle</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">gdouble</span> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-set-angle" title="gimp_brush_set_angle ()">gimp_brush_set_angle</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> angle_in</code></em>);
<span class="returnvalue">gdouble</span> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-get-radius" title="gimp_brush_get_radius ()">gimp_brush_get_radius</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">gdouble</span> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-set-radius" title="gimp_brush_set_radius ()">gimp_brush_set_radius</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> radius_in</code></em>);
<span class="returnvalue">gdouble</span> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-get-aspect-ratio" title="gimp_brush_get_aspect_ratio ()">gimp_brush_get_aspect_ratio</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">gdouble</span> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-set-aspect-ratio" title="gimp_brush_set_aspect_ratio ()">gimp_brush_set_aspect_ratio</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> aspect_ratio_in</code></em>);
<span class="returnvalue">gdouble</span> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-get-hardness" title="gimp_brush_get_hardness ()">gimp_brush_get_hardness</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">gdouble</span> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-set-hardness" title="gimp_brush_set_hardness ()">gimp_brush_set_hardness</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> hardness_in</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-is-generated" title="gimp_brush_is_generated ()">gimp_brush_is_generated</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-is-editable" title="gimp_brush_is_editable ()">gimp_brush_is_editable</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgimp-gimpbrush.description"></a><h2>Description</h2>
<p>
Functions operating on a single brush.
</p>
</div>
<div class="refsect1">
<a name="libgimp-gimpbrush.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gimp-brush-new"></a><h3>gimp_brush_new ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * gimp_brush_new (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Creates a new brush
</p>
<p>
This procedure creates a new, uninitialized brush
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The requested name of the new brush.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The actual new brush name.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-duplicate"></a><h3>gimp_brush_duplicate ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * gimp_brush_duplicate (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Duplicates a brush
</p>
<p>
This procedure creates an identical brush by a different name
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The name of the brush's copy.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-rename"></a><h3>gimp_brush_rename ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * gimp_brush_rename (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *new_name</code></em>);</pre>
<p>
Rename a brush
</p>
<p>
This procedure renames a brush
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_name</code></em> :</span></p></td>
<td>The new name of the brush.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The actual new name of the brush.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-delete"></a><h3>gimp_brush_delete ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_brush_delete (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Deletes a brush
</p>
<p>
This procedure deletes a brush
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-get-info"></a><h3>gimp_brush_get_info ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_brush_get_info (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> *width</code></em>,
<em class="parameter"><code><span class="type">gint</span> *height</code></em>,
<em class="parameter"><code><span class="type">gint</span> *mask_bpp</code></em>,
<em class="parameter"><code><span class="type">gint</span> *color_bpp</code></em>);</pre>
<p>
Retrieve information about the specified brush.
</p>
<p>
This procedure retrieves information about the specified brush. This
includes the brush name, and the brush extents (width and height).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>The brush width.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
<td>The brush height.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mask_bpp</code></em> :</span></p></td>
<td>The brush mask bpp.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>color_bpp</code></em> :</span></p></td>
<td>The brush color bpp.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-get-pixels"></a><h3>gimp_brush_get_pixels ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_brush_get_pixels (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> *width</code></em>,
<em class="parameter"><code><span class="type">gint</span> *height</code></em>,
<em class="parameter"><code><span class="type">gint</span> *mask_bpp</code></em>,
<em class="parameter"><code><span class="type">gint</span> *num_mask_bytes</code></em>,
<em class="parameter"><code><span class="type">guint8</span> **mask_bytes</code></em>,
<em class="parameter"><code><span class="type">gint</span> *color_bpp</code></em>,
<em class="parameter"><code><span class="type">gint</span> *num_color_bytes</code></em>,
<em class="parameter"><code><span class="type">guint8</span> **color_bytes</code></em>);</pre>
<p>
Retrieve information about the specified brush.
</p>
<p>
This procedure retrieves information about the specified brush. This
includes the brush extents (width and height) and its pixels data.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>The brush width.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
<td>The brush height.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mask_bpp</code></em> :</span></p></td>
<td>The brush mask bpp.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num_mask_bytes</code></em> :</span></p></td>
<td>Length of brush mask data.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mask_bytes</code></em> :</span></p></td>
<td>The brush mask data.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>color_bpp</code></em> :</span></p></td>
<td>The brush color bpp.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num_color_bytes</code></em> :</span></p></td>
<td>Length of brush color data.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>color_bytes</code></em> :</span></p></td>
<td>The brush color data.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-get-spacing"></a><h3>gimp_brush_get_spacing ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_brush_get_spacing (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> *spacing</code></em>);</pre>
<p>
Get the brush spacing.
</p>
<p>
This procedure returns the spacing setting for the specified brush.
The return value is an integer between 0 and 1000 which represents
percentage of the maximum of the width and height of the mask.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>spacing</code></em> :</span></p></td>
<td>The brush spacing.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-set-spacing"></a><h3>gimp_brush_set_spacing ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_brush_set_spacing (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> spacing</code></em>);</pre>
<p>
Set the brush spacing.
</p>
<p>
This procedure modifies the spacing setting for the specified brush.
The value should be a integer between 0 and 1000.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>spacing</code></em> :</span></p></td>
<td>The brush spacing.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-get-shape"></a><h3>gimp_brush_get_shape ()</h3>
<pre class="programlisting"><a class="link" href="libgimp-gimpenums.html#GimpBrushGeneratedShape" title="enum GimpBrushGeneratedShape"><span class="returnvalue">GimpBrushGeneratedShape</span></a> gimp_brush_get_shape (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Get the shape of a generated brush.
</p>
<p>
This procedure gets the shape value for a generated brush. If called
for any other type of brush, it does not succeed. The current
possibilities are Circle (GIMP_BRUSH_GENERATED_CIRCLE), Square
(GIMP_BRUSH_GENERATED_SQUARE), and Diamond
(GIMP_BRUSH_GENERATED_DIAMOND). Other shapes are likely to be added
in the future.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The brush shape.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-set-shape"></a><h3>gimp_brush_set_shape ()</h3>
<pre class="programlisting"><a class="link" href="libgimp-gimpenums.html#GimpBrushGeneratedShape" title="enum GimpBrushGeneratedShape"><span class="returnvalue">GimpBrushGeneratedShape</span></a> gimp_brush_set_shape (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpBrushGeneratedShape" title="enum GimpBrushGeneratedShape"><span class="type">GimpBrushGeneratedShape</span></a> shape_in</code></em>);</pre>
<p>
Set the shape of a generated brush.
</p>
<p>
This procedure sets the shape value for a generated brush. If called
for any other type of brush, it does not succeed. The current
possibilities are Circle (GIMP_BRUSH_GENERATED_CIRCLE), Square
(GIMP_BRUSH_GENERATED_SQUARE), and Diamond
(GIMP_BRUSH_GENERATED_DIAMOND). Other shapes are likely to be added
in the future.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>shape_in</code></em> :</span></p></td>
<td>The brush shape.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The brush shape actually assigned.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-get-spikes"></a><h3>gimp_brush_get_spikes ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> gimp_brush_get_spikes (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Get the number of spikes for a generated brush.
</p>
<p>
This procedure gets the number of spikes for a generated brush. If
called for any other type of brush, it does not succeed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of spikes on the brush.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-set-spikes"></a><h3>gimp_brush_set_spikes ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> gimp_brush_set_spikes (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> spikes_in</code></em>);</pre>
<p>
Set the number of spikes for a generated brush.
</p>
<p>
This procedure sets the number of spikes for a generated brush. If
called for any other type of brush, it does not succeed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>spikes_in</code></em> :</span></p></td>
<td>The desired number of spikes.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of spikes actually assigned.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-get-angle"></a><h3>gimp_brush_get_angle ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span> gimp_brush_get_angle (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Get the rotation angle of a generated brush.
</p>
<p>
This procedure gets the angle of rotation for a generated brush. If
called for any other type of brush, it does not succeed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The rotation angle of the brush.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-set-angle"></a><h3>gimp_brush_set_angle ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span> gimp_brush_set_angle (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> angle_in</code></em>);</pre>
<p>
Set the rotation angle of a generated brush.
</p>
<p>
This procedure sets the rotation angle for a generated brush. If
called for any other type of brush, it does not succeed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>angle_in</code></em> :</span></p></td>
<td>The desired brush rotation angle.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The brush rotation angle actually assigned.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-get-radius"></a><h3>gimp_brush_get_radius ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span> gimp_brush_get_radius (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Get the radius of a generated brush.
</p>
<p>
This procedure gets the radius value for a generated brush. If
called for any other type of brush, it does not succeed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The radius of the brush in pixels.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-set-radius"></a><h3>gimp_brush_set_radius ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span> gimp_brush_set_radius (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> radius_in</code></em>);</pre>
<p>
Set the radius of a generated brush.
</p>
<p>
This procedure sets the radius for a generated brush. If called for
any other type of brush, it does not succeed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>radius_in</code></em> :</span></p></td>
<td>The desired brush radius.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The brush radius actually assigned.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-get-aspect-ratio"></a><h3>gimp_brush_get_aspect_ratio ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span> gimp_brush_get_aspect_ratio (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Get the aspect ratio of a generated brush.
</p>
<p>
This procedure gets the aspect ratio of a generated brush. If called
for any other type of brush, it does not succeed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The aspect ratio of the brush.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-set-aspect-ratio"></a><h3>gimp_brush_set_aspect_ratio ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span> gimp_brush_set_aspect_ratio (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> aspect_ratio_in</code></em>);</pre>
<p>
Set the aspect ratio of a generated brush.
</p>
<p>
This procedure sets the aspect ratio for a generated brush. If
called for any other type of brush, it does not succeed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>aspect_ratio_in</code></em> :</span></p></td>
<td>The desired brush aspect ratio.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The brush aspect ratio actually assigned.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-get-hardness"></a><h3>gimp_brush_get_hardness ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span> gimp_brush_get_hardness (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Get the hardness of a generated brush.
</p>
<p>
This procedure gets the hardness of a generated brush. The hardness
of a brush is the amount its intensity fades at the outside edge. If
called for any other type of brush, the function does not succeed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The hardness of the brush.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-set-hardness"></a><h3>gimp_brush_set_hardness ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span> gimp_brush_set_hardness (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> hardness_in</code></em>);</pre>
<p>
Set the hardness of a generated brush.
</p>
<p>
This procedure sets the hardness for a generated brush. If called
for any other type of brush, it does not succeed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>hardness_in</code></em> :</span></p></td>
<td>The desired brush hardness.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The brush hardness actually assigned.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-is-generated"></a><h3>gimp_brush_is_generated ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_brush_is_generated (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Tests if brush is generated
</p>
<p>
Returns TRUE if this brush is parametric, FALSE for other types
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the brush is generated.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-is-editable"></a><h3>gimp_brush_is_editable ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_brush_is_editable (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Tests if brush can be edited
</p>
<p>
Returns TRUE if you have permission to change the brush
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The brush name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the brush can be edited.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|