/usr/share/doc/libjuce/apiref/classColourGradient.html is in libjuce-doc 4.3.0~repack-1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: ColourGradient Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="classColourGradient-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ColourGradient Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Describes the layout and colours that should be used to paint a colour gradient.
<a href="classColourGradient.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a837b0054a74938bf8ea783d5cdd53897"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#a837b0054a74938bf8ea783d5cdd53897">ColourGradient</a> (<a class="el" href="classColour.html">Colour</a> colour1, float x1, float y1, <a class="el" href="classColour.html">Colour</a> colour2, float x2, float y2, bool <a class="el" href="classColourGradient.html#a42c5382b7e7bda2b7efdb7b1a9258a44">isRadial</a>)</td></tr>
<tr class="memdesc:a837b0054a74938bf8ea783d5cdd53897"><td class="mdescLeft"> </td><td class="mdescRight">Creates a gradient object. <a href="#a837b0054a74938bf8ea783d5cdd53897">More...</a><br /></td></tr>
<tr class="separator:a837b0054a74938bf8ea783d5cdd53897"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73556e9dd8b02b0d10e4f5ec9e0edec1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#a73556e9dd8b02b0d10e4f5ec9e0edec1">ColourGradient</a> () noexcept</td></tr>
<tr class="memdesc:a73556e9dd8b02b0d10e4f5ec9e0edec1"><td class="mdescLeft"> </td><td class="mdescRight">Creates an uninitialised gradient. <a href="#a73556e9dd8b02b0d10e4f5ec9e0edec1">More...</a><br /></td></tr>
<tr class="separator:a73556e9dd8b02b0d10e4f5ec9e0edec1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ab7aff1c3f8b6faf82bebf3ff9b4a5a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#a0ab7aff1c3f8b6faf82bebf3ff9b4a5a">~ColourGradient</a> ()</td></tr>
<tr class="memdesc:a0ab7aff1c3f8b6faf82bebf3ff9b4a5a"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a0ab7aff1c3f8b6faf82bebf3ff9b4a5a">More...</a><br /></td></tr>
<tr class="separator:a0ab7aff1c3f8b6faf82bebf3ff9b4a5a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a634055607de82695189730cf409e3ecd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#a634055607de82695189730cf409e3ecd">clearColours</a> ()</td></tr>
<tr class="memdesc:a634055607de82695189730cf409e3ecd"><td class="mdescLeft"> </td><td class="mdescRight">Removes any colours that have been added. <a href="#a634055607de82695189730cf409e3ecd">More...</a><br /></td></tr>
<tr class="separator:a634055607de82695189730cf409e3ecd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab220584b1725993c9a7eee42739f8353"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#ab220584b1725993c9a7eee42739f8353">addColour</a> (double proportionAlongGradient, <a class="el" href="classColour.html">Colour</a> colour)</td></tr>
<tr class="memdesc:ab220584b1725993c9a7eee42739f8353"><td class="mdescLeft"> </td><td class="mdescRight">Adds a colour at a point along the length of the gradient. <a href="#ab220584b1725993c9a7eee42739f8353">More...</a><br /></td></tr>
<tr class="separator:ab220584b1725993c9a7eee42739f8353"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55bbee0ea470af294d36d19256e7d419"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#a55bbee0ea470af294d36d19256e7d419">removeColour</a> (int index)</td></tr>
<tr class="memdesc:a55bbee0ea470af294d36d19256e7d419"><td class="mdescLeft"> </td><td class="mdescRight">Removes one of the colours from the gradient. <a href="#a55bbee0ea470af294d36d19256e7d419">More...</a><br /></td></tr>
<tr class="separator:a55bbee0ea470af294d36d19256e7d419"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c5cef5beaeca40e429f5a3b661983cb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#a7c5cef5beaeca40e429f5a3b661983cb">multiplyOpacity</a> (float multiplier) noexcept</td></tr>
<tr class="memdesc:a7c5cef5beaeca40e429f5a3b661983cb"><td class="mdescLeft"> </td><td class="mdescRight">Multiplies the alpha value of all the colours by the given scale factor. <a href="#a7c5cef5beaeca40e429f5a3b661983cb">More...</a><br /></td></tr>
<tr class="separator:a7c5cef5beaeca40e429f5a3b661983cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5520e46c4cee46a10e4c4f63e3cb3e46"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#a5520e46c4cee46a10e4c4f63e3cb3e46">getNumColours</a> () const noexcept</td></tr>
<tr class="memdesc:a5520e46c4cee46a10e4c4f63e3cb3e46"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of colour-stops that have been added. <a href="#a5520e46c4cee46a10e4c4f63e3cb3e46">More...</a><br /></td></tr>
<tr class="separator:a5520e46c4cee46a10e4c4f63e3cb3e46"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab43972e13c701166d7cd268251ddbe67"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#ab43972e13c701166d7cd268251ddbe67">getColourPosition</a> (int index) const noexcept</td></tr>
<tr class="memdesc:ab43972e13c701166d7cd268251ddbe67"><td class="mdescLeft"> </td><td class="mdescRight">Returns the position along the length of the gradient of the colour with this index. <a href="#ab43972e13c701166d7cd268251ddbe67">More...</a><br /></td></tr>
<tr class="separator:ab43972e13c701166d7cd268251ddbe67"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c9bbbf99f789034a7f527a381389042"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classColour.html">Colour</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#a9c9bbbf99f789034a7f527a381389042">getColour</a> (int index) const noexcept</td></tr>
<tr class="memdesc:a9c9bbbf99f789034a7f527a381389042"><td class="mdescLeft"> </td><td class="mdescRight">Returns the colour that was added with a given index. <a href="#a9c9bbbf99f789034a7f527a381389042">More...</a><br /></td></tr>
<tr class="separator:a9c9bbbf99f789034a7f527a381389042"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae16d321cfe4706a4be8c875fadc78afa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#ae16d321cfe4706a4be8c875fadc78afa">setColour</a> (int index, <a class="el" href="classColour.html">Colour</a> newColour) noexcept</td></tr>
<tr class="memdesc:ae16d321cfe4706a4be8c875fadc78afa"><td class="mdescLeft"> </td><td class="mdescRight">Changes the colour at a given index. <a href="#ae16d321cfe4706a4be8c875fadc78afa">More...</a><br /></td></tr>
<tr class="separator:ae16d321cfe4706a4be8c875fadc78afa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a679196f0e731d1306ca484909a6fccdb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classColour.html">Colour</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#a679196f0e731d1306ca484909a6fccdb">getColourAtPosition</a> (double position) const noexcept</td></tr>
<tr class="memdesc:a679196f0e731d1306ca484909a6fccdb"><td class="mdescLeft"> </td><td class="mdescRight">Returns the an interpolated colour at any position along the gradient. <a href="#a679196f0e731d1306ca484909a6fccdb">More...</a><br /></td></tr>
<tr class="separator:a679196f0e731d1306ca484909a6fccdb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afcddd87cea82a9d6e67577e7d7302bba"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#afcddd87cea82a9d6e67577e7d7302bba">createLookupTable</a> (const <a class="el" href="classAffineTransform.html">AffineTransform</a> &transform, <a class="el" href="classHeapBlock.html">HeapBlock</a>< <a class="el" href="classPixelARGB.html">PixelARGB</a> > &resultLookupTable) const</td></tr>
<tr class="memdesc:afcddd87cea82a9d6e67577e7d7302bba"><td class="mdescLeft"> </td><td class="mdescRight">Creates a set of interpolated premultiplied ARGB values. <a href="#afcddd87cea82a9d6e67577e7d7302bba">More...</a><br /></td></tr>
<tr class="separator:afcddd87cea82a9d6e67577e7d7302bba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95b9ca19c7d38e65b9525b1fa05d20ed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#a95b9ca19c7d38e65b9525b1fa05d20ed">createLookupTable</a> (<a class="el" href="classPixelARGB.html">PixelARGB</a> *resultLookupTable, int numEntries) const noexcept</td></tr>
<tr class="memdesc:a95b9ca19c7d38e65b9525b1fa05d20ed"><td class="mdescLeft"> </td><td class="mdescRight">Creates a set of interpolated premultiplied ARGB values. <a href="#a95b9ca19c7d38e65b9525b1fa05d20ed">More...</a><br /></td></tr>
<tr class="separator:a95b9ca19c7d38e65b9525b1fa05d20ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab2aa475450033278b052126609416303"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#ab2aa475450033278b052126609416303">isOpaque</a> () const noexcept</td></tr>
<tr class="memdesc:ab2aa475450033278b052126609416303"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if all colours are opaque. <a href="#ab2aa475450033278b052126609416303">More...</a><br /></td></tr>
<tr class="separator:ab2aa475450033278b052126609416303"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af335e4b881ef05022440d15a16f681da"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#af335e4b881ef05022440d15a16f681da">isInvisible</a> () const noexcept</td></tr>
<tr class="memdesc:af335e4b881ef05022440d15a16f681da"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if all colours are completely transparent. <a href="#af335e4b881ef05022440d15a16f681da">More...</a><br /></td></tr>
<tr class="separator:af335e4b881ef05022440d15a16f681da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1eec4cedae0908b58163f14b202ab19d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#a1eec4cedae0908b58163f14b202ab19d">operator==</a> (const <a class="el" href="classColourGradient.html">ColourGradient</a> &) const noexcept</td></tr>
<tr class="separator:a1eec4cedae0908b58163f14b202ab19d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb3da1ad163d9892745dcf490c933d4e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#abb3da1ad163d9892745dcf490c933d4e">operator!=</a> (const <a class="el" href="classColourGradient.html">ColourGradient</a> &) const noexcept</td></tr>
<tr class="separator:abb3da1ad163d9892745dcf490c933d4e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ac016d8472f6ce47c16d1df1e49c39dfc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPoint.html">Point</a>< float > </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#ac016d8472f6ce47c16d1df1e49c39dfc">point1</a></td></tr>
<tr class="separator:ac016d8472f6ce47c16d1df1e49c39dfc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a218351e8768cb2f956d2186d85710787"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPoint.html">Point</a>< float > </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#a218351e8768cb2f956d2186d85710787">point2</a></td></tr>
<tr class="separator:a218351e8768cb2f956d2186d85710787"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a42c5382b7e7bda2b7efdb7b1a9258a44"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classColourGradient.html#a42c5382b7e7bda2b7efdb7b1a9258a44">isRadial</a></td></tr>
<tr class="memdesc:a42c5382b7e7bda2b7efdb7b1a9258a44"><td class="mdescLeft"> </td><td class="mdescRight">If true, the gradient should be filled circularly, centred around point1, with point2 defining a point on the circumference. <a href="#a42c5382b7e7bda2b7efdb7b1a9258a44">More...</a><br /></td></tr>
<tr class="separator:a42c5382b7e7bda2b7efdb7b1a9258a44"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Describes the layout and colours that should be used to paint a colour gradient. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classGraphics.html#a57478bc2496ebb84696e5ba64b455965" title="Sets the context to use a gradient for its fill pattern. ">Graphics::setGradientFill</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a837b0054a74938bf8ea783d5cdd53897"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a837b0054a74938bf8ea783d5cdd53897">§ </a></span>ColourGradient() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ColourGradient::ColourGradient </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classColour.html">Colour</a> </td>
<td class="paramname"><em>colour1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>x1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>y1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classColour.html">Colour</a> </td>
<td class="paramname"><em>colour2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>x2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>y2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isRadial</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a gradient object. </p>
<p>(x1, y1) is the location to draw with colour1. Likewise (x2, y2) is where colour2 should be. In between them there's a gradient.</p>
<p>If isRadial is true, the colours form a circular gradient with (x1, y1) at its centre.</p>
<p>The alpha transparencies of the colours are used, so note that if you blend from transparent to a solid colour, the RGB of the transparent colour will become visible in parts of the gradient. e.g. blending from Colour::transparentBlack to <a class="el" href="classColours.html#a9e57055bbdf8261e776d2ea8bb44514a" title="ARGB = 0xffffffff. ">Colours::white</a> will produce a muddy grey colour midway, but Colour::transparentWhite to <a class="el" href="classColours.html#a9e57055bbdf8261e776d2ea8bb44514a" title="ARGB = 0xffffffff. ">Colours::white</a> will be white all the way across.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classColourGradient.html" title="Describes the layout and colours that should be used to paint a colour gradient. ">ColourGradient</a> </dd></dl>
</div>
</div>
<a id="a73556e9dd8b02b0d10e4f5ec9e0edec1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73556e9dd8b02b0d10e4f5ec9e0edec1">§ </a></span>ColourGradient() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ColourGradient::ColourGradient </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an uninitialised gradient. </p>
<p>If you use this constructor instead of the other one, be sure to set all the object's public member variables before using it! </p>
</div>
</div>
<a id="a0ab7aff1c3f8b6faf82bebf3ff9b4a5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ab7aff1c3f8b6faf82bebf3ff9b4a5a">§ </a></span>~ColourGradient()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ColourGradient::~ColourGradient </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a634055607de82695189730cf409e3ecd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a634055607de82695189730cf409e3ecd">§ </a></span>clearColours()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ColourGradient::clearColours </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes any colours that have been added. </p>
<p>This will also remove any start and end colours, so the gradient won't work. You'll need to add more colours with <a class="el" href="classColourGradient.html#ab220584b1725993c9a7eee42739f8353" title="Adds a colour at a point along the length of the gradient. ">addColour()</a>. </p>
</div>
</div>
<a id="ab220584b1725993c9a7eee42739f8353"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab220584b1725993c9a7eee42739f8353">§ </a></span>addColour()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ColourGradient::addColour </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>proportionAlongGradient</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classColour.html">Colour</a> </td>
<td class="paramname"><em>colour</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a colour at a point along the length of the gradient. </p>
<p>This allows the gradient to go through a spectrum of colours, instead of just a start and end colour.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">proportionAlongGradient</td><td>a value between 0 and 1.0, which is the proportion of the distance along the line between the two points at which the colour should occur. </td></tr>
<tr><td class="paramname">colour</td><td>the colour that should be used at this point </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the index at which the new point was added </dd></dl>
</div>
</div>
<a id="a55bbee0ea470af294d36d19256e7d419"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55bbee0ea470af294d36d19256e7d419">§ </a></span>removeColour()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ColourGradient::removeColour </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes one of the colours from the gradient. </p>
</div>
</div>
<a id="a7c5cef5beaeca40e429f5a3b661983cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c5cef5beaeca40e429f5a3b661983cb">§ </a></span>multiplyOpacity()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ColourGradient::multiplyOpacity </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>multiplier</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Multiplies the alpha value of all the colours by the given scale factor. </p>
</div>
</div>
<a id="a5520e46c4cee46a10e4c4f63e3cb3e46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5520e46c4cee46a10e4c4f63e3cb3e46">§ </a></span>getNumColours()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ColourGradient::getNumColours </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of colour-stops that have been added. </p>
</div>
</div>
<a id="ab43972e13c701166d7cd268251ddbe67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab43972e13c701166d7cd268251ddbe67">§ </a></span>getColourPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double ColourGradient::getColourPosition </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the position along the length of the gradient of the colour with this index. </p>
<p>The index is from 0 to <a class="el" href="classColourGradient.html#a5520e46c4cee46a10e4c4f63e3cb3e46" title="Returns the number of colour-stops that have been added. ">getNumColours()</a> - 1. The return value will be between 0.0 and 1.0 </p>
</div>
</div>
<a id="a9c9bbbf99f789034a7f527a381389042"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c9bbbf99f789034a7f527a381389042">§ </a></span>getColour()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classColour.html">Colour</a> ColourGradient::getColour </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the colour that was added with a given index. </p>
<p>The index is from 0 to <a class="el" href="classColourGradient.html#a5520e46c4cee46a10e4c4f63e3cb3e46" title="Returns the number of colour-stops that have been added. ">getNumColours()</a> - 1. </p>
</div>
</div>
<a id="ae16d321cfe4706a4be8c875fadc78afa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae16d321cfe4706a4be8c875fadc78afa">§ </a></span>setColour()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ColourGradient::setColour </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classColour.html">Colour</a> </td>
<td class="paramname"><em>newColour</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes the colour at a given index. </p>
<p>The index is from 0 to <a class="el" href="classColourGradient.html#a5520e46c4cee46a10e4c4f63e3cb3e46" title="Returns the number of colour-stops that have been added. ">getNumColours()</a> - 1. </p>
</div>
</div>
<a id="a679196f0e731d1306ca484909a6fccdb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a679196f0e731d1306ca484909a6fccdb">§ </a></span>getColourAtPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classColour.html">Colour</a> ColourGradient::getColourAtPosition </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>position</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the an interpolated colour at any position along the gradient. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>the position along the gradient, between 0 and 1 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afcddd87cea82a9d6e67577e7d7302bba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afcddd87cea82a9d6e67577e7d7302bba">§ </a></span>createLookupTable() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ColourGradient::createLookupTable </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classAffineTransform.html">AffineTransform</a> & </td>
<td class="paramname"><em>transform</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classHeapBlock.html">HeapBlock</a>< <a class="el" href="classPixelARGB.html">PixelARGB</a> > & </td>
<td class="paramname"><em>resultLookupTable</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a set of interpolated premultiplied ARGB values. </p>
<p>This will resize the <a class="el" href="classHeapBlock.html" title="Very simple container class to hold a pointer to some data on the heap. ">HeapBlock</a>, fill it with the colours, and will return the number of colours that it added. When calling this, the <a class="el" href="classColourGradient.html" title="Describes the layout and colours that should be used to paint a colour gradient. ">ColourGradient</a> must have at least 2 colour stops specified. </p>
</div>
</div>
<a id="a95b9ca19c7d38e65b9525b1fa05d20ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95b9ca19c7d38e65b9525b1fa05d20ed">§ </a></span>createLookupTable() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ColourGradient::createLookupTable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPixelARGB.html">PixelARGB</a> * </td>
<td class="paramname"><em>resultLookupTable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>numEntries</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a set of interpolated premultiplied ARGB values. </p>
<p>This will fill an array of a user-specified size with the gradient, interpolating to fit. The numEntries argument specifies the size of the array, and this size must be greater than zero. When calling this, the <a class="el" href="classColourGradient.html" title="Describes the layout and colours that should be used to paint a colour gradient. ">ColourGradient</a> must have at least 2 colour stops specified. </p>
</div>
</div>
<a id="ab2aa475450033278b052126609416303"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2aa475450033278b052126609416303">§ </a></span>isOpaque()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ColourGradient::isOpaque </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if all colours are opaque. </p>
</div>
</div>
<a id="af335e4b881ef05022440d15a16f681da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af335e4b881ef05022440d15a16f681da">§ </a></span>isInvisible()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ColourGradient::isInvisible </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if all colours are completely transparent. </p>
</div>
</div>
<a id="a1eec4cedae0908b58163f14b202ab19d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1eec4cedae0908b58163f14b202ab19d">§ </a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ColourGradient::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classColourGradient.html">ColourGradient</a> & </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="abb3da1ad163d9892745dcf490c933d4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb3da1ad163d9892745dcf490c933d4e">§ </a></span>operator!=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ColourGradient::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classColourGradient.html">ColourGradient</a> & </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ac016d8472f6ce47c16d1df1e49c39dfc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac016d8472f6ce47c16d1df1e49c39dfc">§ </a></span>point1</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classPoint.html">Point</a><float> ColourGradient::point1</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a218351e8768cb2f956d2186d85710787"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a218351e8768cb2f956d2186d85710787">§ </a></span>point2</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classPoint.html">Point</a><float> ColourGradient::point2</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a42c5382b7e7bda2b7efdb7b1a9258a44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42c5382b7e7bda2b7efdb7b1a9258a44">§ </a></span>isRadial</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ColourGradient::isRadial</td>
</tr>
</table>
</div><div class="memdoc">
<p>If true, the gradient should be filled circularly, centred around point1, with point2 defining a point on the circumference. </p>
<p>If false, the gradient is linear between the two points. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__ColourGradient_8h.html">juce_ColourGradient.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|