/usr/share/doc/libjuce/apiref/classImage.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 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 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 | <!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: Image 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="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classImage-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Image Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Holds a fixed-size bitmap.
<a href="classImage.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage_1_1BitmapData.html">BitmapData</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a section of an image as raw pixel data, so it can be read or written to. <a href="classImage_1_1BitmapData.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ab47b5746d2df286ae6f8da6af5463c01"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#ab47b5746d2df286ae6f8da6af5463c01">PixelFormat</a> { <a class="el" href="classImage.html#ab47b5746d2df286ae6f8da6af5463c01a54eec5e1c5371ae7ad7242c6a2be067d">UnknownFormat</a>,
<a class="el" href="classImage.html#ab47b5746d2df286ae6f8da6af5463c01a03a8b8bb3246ef72c98b01e711d61425">RGB</a>,
<a class="el" href="classImage.html#ab47b5746d2df286ae6f8da6af5463c01a9adefc17fe4663de8e3fc9621c891b8b">ARGB</a>,
<a class="el" href="classImage.html#ab47b5746d2df286ae6f8da6af5463c01ab8bd2ed5df42fd15bd349195d81b64b4">SingleChannel</a>
}</td></tr>
<tr class="separator:ab47b5746d2df286ae6f8da6af5463c01"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a5d47b71f7afd9f5df61145abb857455c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a5d47b71f7afd9f5df61145abb857455c">Image</a> () noexcept</td></tr>
<tr class="memdesc:a5d47b71f7afd9f5df61145abb857455c"><td class="mdescLeft"> </td><td class="mdescRight">Creates a null image. <a href="#a5d47b71f7afd9f5df61145abb857455c">More...</a><br /></td></tr>
<tr class="separator:a5d47b71f7afd9f5df61145abb857455c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa51549669248091773ee494737abdc24"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#aa51549669248091773ee494737abdc24">Image</a> (<a class="el" href="classImage.html#ab47b5746d2df286ae6f8da6af5463c01">PixelFormat</a> format, int imageWidth, int imageHeight, bool clearImage)</td></tr>
<tr class="memdesc:aa51549669248091773ee494737abdc24"><td class="mdescLeft"> </td><td class="mdescRight">Creates an image with a specified size and format. <a href="#aa51549669248091773ee494737abdc24">More...</a><br /></td></tr>
<tr class="separator:aa51549669248091773ee494737abdc24"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9e7f47996c7b81190e6cf151bc31fa0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#ac9e7f47996c7b81190e6cf151bc31fa0">Image</a> (<a class="el" href="classImage.html#ab47b5746d2df286ae6f8da6af5463c01">PixelFormat</a> format, int imageWidth, int imageHeight, bool clearImage, const <a class="el" href="classImageType.html">ImageType</a> &type)</td></tr>
<tr class="memdesc:ac9e7f47996c7b81190e6cf151bc31fa0"><td class="mdescLeft"> </td><td class="mdescRight">Creates an image with a specified size and format. <a href="#ac9e7f47996c7b81190e6cf151bc31fa0">More...</a><br /></td></tr>
<tr class="separator:ac9e7f47996c7b81190e6cf151bc31fa0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5333c440b8f5637a3c7878e9b8d1ad21"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a5333c440b8f5637a3c7878e9b8d1ad21">Image</a> (const <a class="el" href="classImage.html">Image</a> &) noexcept</td></tr>
<tr class="memdesc:a5333c440b8f5637a3c7878e9b8d1ad21"><td class="mdescLeft"> </td><td class="mdescRight">Creates a shared reference to another image. <a href="#a5333c440b8f5637a3c7878e9b8d1ad21">More...</a><br /></td></tr>
<tr class="separator:a5333c440b8f5637a3c7878e9b8d1ad21"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a50d3d1da8a95f7c74af4ef8d4eda6f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classImage.html">Image</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a1a50d3d1da8a95f7c74af4ef8d4eda6f">operator=</a> (const <a class="el" href="classImage.html">Image</a> &)</td></tr>
<tr class="memdesc:a1a50d3d1da8a95f7c74af4ef8d4eda6f"><td class="mdescLeft"> </td><td class="mdescRight">Makes this image refer to the same underlying image as another object. <a href="#a1a50d3d1da8a95f7c74af4ef8d4eda6f">More...</a><br /></td></tr>
<tr class="separator:a1a50d3d1da8a95f7c74af4ef8d4eda6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a02801f5341319e941b10a9a291b30a62"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a02801f5341319e941b10a9a291b30a62">Image</a> (<a class="el" href="classImage.html">Image</a> &&) noexcept</td></tr>
<tr class="separator:a02801f5341319e941b10a9a291b30a62"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad111c269be3c7915306645b1eb46a3a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classImage.html">Image</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#ad111c269be3c7915306645b1eb46a3a8">operator=</a> (<a class="el" href="classImage.html">Image</a> &&) noexcept</td></tr>
<tr class="separator:ad111c269be3c7915306645b1eb46a3a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0294f63700543e11c0f0da85601c7ae5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a0294f63700543e11c0f0da85601c7ae5">~Image</a> ()</td></tr>
<tr class="memdesc:a0294f63700543e11c0f0da85601c7ae5"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a0294f63700543e11c0f0da85601c7ae5">More...</a><br /></td></tr>
<tr class="separator:a0294f63700543e11c0f0da85601c7ae5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa0b558cf4f55b47b15f11094f4fa84cc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#aa0b558cf4f55b47b15f11094f4fa84cc">operator==</a> (const <a class="el" href="classImage.html">Image</a> &other) const noexcept</td></tr>
<tr class="memdesc:aa0b558cf4f55b47b15f11094f4fa84cc"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the two images are referring to the same internal, shared image. <a href="#aa0b558cf4f55b47b15f11094f4fa84cc">More...</a><br /></td></tr>
<tr class="separator:aa0b558cf4f55b47b15f11094f4fa84cc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f6d8eea11bc8e8129e313e63f312802"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a9f6d8eea11bc8e8129e313e63f312802">operator!=</a> (const <a class="el" href="classImage.html">Image</a> &other) const noexcept</td></tr>
<tr class="memdesc:a9f6d8eea11bc8e8129e313e63f312802"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the two images are not referring to the same internal, shared image. <a href="#a9f6d8eea11bc8e8129e313e63f312802">More...</a><br /></td></tr>
<tr class="separator:a9f6d8eea11bc8e8129e313e63f312802"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a761214d2fa016e3e793b5a2d6b8b85ec"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a761214d2fa016e3e793b5a2d6b8b85ec">isValid</a> () const noexcept</td></tr>
<tr class="memdesc:a761214d2fa016e3e793b5a2d6b8b85ec"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this image isn't null. <a href="#a761214d2fa016e3e793b5a2d6b8b85ec">More...</a><br /></td></tr>
<tr class="separator:a761214d2fa016e3e793b5a2d6b8b85ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4084a24d1034249f29a7781ef44159d8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a4084a24d1034249f29a7781ef44159d8">isNull</a> () const noexcept</td></tr>
<tr class="memdesc:a4084a24d1034249f29a7781ef44159d8"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this image is not valid. <a href="#a4084a24d1034249f29a7781ef44159d8">More...</a><br /></td></tr>
<tr class="separator:a4084a24d1034249f29a7781ef44159d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3c540187e754adb5beac244b64df70af"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a3c540187e754adb5beac244b64df70af">getWidth</a> () const noexcept</td></tr>
<tr class="memdesc:a3c540187e754adb5beac244b64df70af"><td class="mdescLeft"> </td><td class="mdescRight">Returns the image's width (in pixels). <a href="#a3c540187e754adb5beac244b64df70af">More...</a><br /></td></tr>
<tr class="separator:a3c540187e754adb5beac244b64df70af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a717b9cde54f44af0ea68e87729c1365f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a717b9cde54f44af0ea68e87729c1365f">getHeight</a> () const noexcept</td></tr>
<tr class="memdesc:a717b9cde54f44af0ea68e87729c1365f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the image's height (in pixels). <a href="#a717b9cde54f44af0ea68e87729c1365f">More...</a><br /></td></tr>
<tr class="separator:a717b9cde54f44af0ea68e87729c1365f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b9f151177766fae7679c7994161ceba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRectangle.html">Rectangle</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a6b9f151177766fae7679c7994161ceba">getBounds</a> () const noexcept</td></tr>
<tr class="memdesc:a6b9f151177766fae7679c7994161ceba"><td class="mdescLeft"> </td><td class="mdescRight">Returns a rectangle with the same size as this image. <a href="#a6b9f151177766fae7679c7994161ceba">More...</a><br /></td></tr>
<tr class="separator:a6b9f151177766fae7679c7994161ceba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73ceedb27674d0ad6611356147344677"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classImage.html#ab47b5746d2df286ae6f8da6af5463c01">PixelFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a73ceedb27674d0ad6611356147344677">getFormat</a> () const noexcept</td></tr>
<tr class="memdesc:a73ceedb27674d0ad6611356147344677"><td class="mdescLeft"> </td><td class="mdescRight">Returns the image's pixel format. <a href="#a73ceedb27674d0ad6611356147344677">More...</a><br /></td></tr>
<tr class="separator:a73ceedb27674d0ad6611356147344677"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a14441f64b47e4d881c399e07a2718de1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a14441f64b47e4d881c399e07a2718de1">isARGB</a> () const noexcept</td></tr>
<tr class="memdesc:a14441f64b47e4d881c399e07a2718de1"><td class="mdescLeft"> </td><td class="mdescRight">True if the image's format is ARGB. <a href="#a14441f64b47e4d881c399e07a2718de1">More...</a><br /></td></tr>
<tr class="separator:a14441f64b47e4d881c399e07a2718de1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a53b8b72f6cf08ce6d6179666250aedc7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a53b8b72f6cf08ce6d6179666250aedc7">isRGB</a> () const noexcept</td></tr>
<tr class="memdesc:a53b8b72f6cf08ce6d6179666250aedc7"><td class="mdescLeft"> </td><td class="mdescRight">True if the image's format is RGB. <a href="#a53b8b72f6cf08ce6d6179666250aedc7">More...</a><br /></td></tr>
<tr class="separator:a53b8b72f6cf08ce6d6179666250aedc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1176ae108a31a0f4b7b4be6b86bc6181"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a1176ae108a31a0f4b7b4be6b86bc6181">isSingleChannel</a> () const noexcept</td></tr>
<tr class="memdesc:a1176ae108a31a0f4b7b4be6b86bc6181"><td class="mdescLeft"> </td><td class="mdescRight">True if the image's format is a single-channel alpha map. <a href="#a1176ae108a31a0f4b7b4be6b86bc6181">More...</a><br /></td></tr>
<tr class="separator:a1176ae108a31a0f4b7b4be6b86bc6181"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb862a4402074ef0dc0382e2c6267a32"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#abb862a4402074ef0dc0382e2c6267a32">hasAlphaChannel</a> () const noexcept</td></tr>
<tr class="memdesc:abb862a4402074ef0dc0382e2c6267a32"><td class="mdescLeft"> </td><td class="mdescRight">True if the image contains an alpha-channel. <a href="#abb862a4402074ef0dc0382e2c6267a32">More...</a><br /></td></tr>
<tr class="separator:abb862a4402074ef0dc0382e2c6267a32"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e8dc6de9ca6b4181658d0144579fb2f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a2e8dc6de9ca6b4181658d0144579fb2f">clear</a> (const <a class="el" href="classRectangle.html">Rectangle</a>< int > &area, <a class="el" href="classColour.html">Colour</a> colourToClearTo=<a class="el" href="classColour.html">Colour</a>(0x00000000))</td></tr>
<tr class="memdesc:a2e8dc6de9ca6b4181658d0144579fb2f"><td class="mdescLeft"> </td><td class="mdescRight">Clears a section of the image with a given colour. <a href="#a2e8dc6de9ca6b4181658d0144579fb2f">More...</a><br /></td></tr>
<tr class="separator:a2e8dc6de9ca6b4181658d0144579fb2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad75852120adf4e3cc3a9843d1abcf586"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classImage.html">Image</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#ad75852120adf4e3cc3a9843d1abcf586">rescaled</a> (int newWidth, int newHeight, <a class="el" href="classGraphics.html#a5da218e649d1b5ac3d67443ae77caf87">Graphics::ResamplingQuality</a> quality=<a class="el" href="classGraphics.html#a5da218e649d1b5ac3d67443ae77caf87a5d8dfbf84457e91eb309b1402562f2af">Graphics::mediumResamplingQuality</a>) const</td></tr>
<tr class="memdesc:ad75852120adf4e3cc3a9843d1abcf586"><td class="mdescLeft"> </td><td class="mdescRight">Returns a rescaled version of this image. <a href="#ad75852120adf4e3cc3a9843d1abcf586">More...</a><br /></td></tr>
<tr class="separator:ad75852120adf4e3cc3a9843d1abcf586"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab01ea9a3ee0fdf41398542859685c9af"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classImage.html">Image</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#ab01ea9a3ee0fdf41398542859685c9af">createCopy</a> () const</td></tr>
<tr class="memdesc:ab01ea9a3ee0fdf41398542859685c9af"><td class="mdescLeft"> </td><td class="mdescRight">Creates a copy of this image. <a href="#ab01ea9a3ee0fdf41398542859685c9af">More...</a><br /></td></tr>
<tr class="separator:ab01ea9a3ee0fdf41398542859685c9af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa6b6141148fd128b037670e06f95e7ef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classImage.html">Image</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#aa6b6141148fd128b037670e06f95e7ef">convertedToFormat</a> (<a class="el" href="classImage.html#ab47b5746d2df286ae6f8da6af5463c01">PixelFormat</a> newFormat) const</td></tr>
<tr class="memdesc:aa6b6141148fd128b037670e06f95e7ef"><td class="mdescLeft"> </td><td class="mdescRight">Returns a version of this image with a different image format. <a href="#aa6b6141148fd128b037670e06f95e7ef">More...</a><br /></td></tr>
<tr class="separator:aa6b6141148fd128b037670e06f95e7ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad995cd253234063d22b604984e83489d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#ad995cd253234063d22b604984e83489d">duplicateIfShared</a> ()</td></tr>
<tr class="memdesc:ad995cd253234063d22b604984e83489d"><td class="mdescLeft"> </td><td class="mdescRight">Makes sure that no other <a class="el" href="classImage.html" title="Holds a fixed-size bitmap. ">Image</a> objects share the same underlying data as this one. <a href="#ad995cd253234063d22b604984e83489d">More...</a><br /></td></tr>
<tr class="separator:ad995cd253234063d22b604984e83489d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f1e8e0a7e0abf650911df14bbf7e701"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classImage.html">Image</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a0f1e8e0a7e0abf650911df14bbf7e701">getClippedImage</a> (const <a class="el" href="classRectangle.html">Rectangle</a>< int > &area) const</td></tr>
<tr class="memdesc:a0f1e8e0a7e0abf650911df14bbf7e701"><td class="mdescLeft"> </td><td class="mdescRight">Returns an image which refers to a subsection of this image. <a href="#a0f1e8e0a7e0abf650911df14bbf7e701">More...</a><br /></td></tr>
<tr class="separator:a0f1e8e0a7e0abf650911df14bbf7e701"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac476d1ab705f7ee86d424825c0705466"><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="classImage.html#ac476d1ab705f7ee86d424825c0705466">getPixelAt</a> (int x, int y) const</td></tr>
<tr class="memdesc:ac476d1ab705f7ee86d424825c0705466"><td class="mdescLeft"> </td><td class="mdescRight">Returns the colour of one of the pixels in the image. <a href="#ac476d1ab705f7ee86d424825c0705466">More...</a><br /></td></tr>
<tr class="separator:ac476d1ab705f7ee86d424825c0705466"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1521d7dd860ccdecc9a1ba27952d5f88"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a1521d7dd860ccdecc9a1ba27952d5f88">setPixelAt</a> (int x, int y, <a class="el" href="classColour.html">Colour</a> colour)</td></tr>
<tr class="memdesc:a1521d7dd860ccdecc9a1ba27952d5f88"><td class="mdescLeft"> </td><td class="mdescRight">Sets the colour of one of the image's pixels. <a href="#a1521d7dd860ccdecc9a1ba27952d5f88">More...</a><br /></td></tr>
<tr class="separator:a1521d7dd860ccdecc9a1ba27952d5f88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a795ef04008dc17e60231eb6bf0618946"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a795ef04008dc17e60231eb6bf0618946">multiplyAlphaAt</a> (int x, int y, float multiplier)</td></tr>
<tr class="memdesc:a795ef04008dc17e60231eb6bf0618946"><td class="mdescLeft"> </td><td class="mdescRight">Changes the opacity of a pixel. <a href="#a795ef04008dc17e60231eb6bf0618946">More...</a><br /></td></tr>
<tr class="separator:a795ef04008dc17e60231eb6bf0618946"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9d1febd93213f92b50af58ce731cdabf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a9d1febd93213f92b50af58ce731cdabf">multiplyAllAlphas</a> (float amountToMultiplyBy)</td></tr>
<tr class="memdesc:a9d1febd93213f92b50af58ce731cdabf"><td class="mdescLeft"> </td><td class="mdescRight">Changes the overall opacity of the image. <a href="#a9d1febd93213f92b50af58ce731cdabf">More...</a><br /></td></tr>
<tr class="separator:a9d1febd93213f92b50af58ce731cdabf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a038f9f882f1829362c23c22a9577e22d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a038f9f882f1829362c23c22a9577e22d">desaturate</a> ()</td></tr>
<tr class="memdesc:a038f9f882f1829362c23c22a9577e22d"><td class="mdescLeft"> </td><td class="mdescRight">Changes all the colours to be shades of grey, based on their current luminosity. <a href="#a038f9f882f1829362c23c22a9577e22d">More...</a><br /></td></tr>
<tr class="separator:a038f9f882f1829362c23c22a9577e22d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e90b1777a505f16e3f9d2a6da674a36"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a5e90b1777a505f16e3f9d2a6da674a36">moveImageSection</a> (int destX, int destY, int sourceX, int sourceY, int width, int height)</td></tr>
<tr class="memdesc:a5e90b1777a505f16e3f9d2a6da674a36"><td class="mdescLeft"> </td><td class="mdescRight">Copies a section of the image to somewhere else within itself. <a href="#a5e90b1777a505f16e3f9d2a6da674a36">More...</a><br /></td></tr>
<tr class="separator:a5e90b1777a505f16e3f9d2a6da674a36"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa25893460c7c9df334b0207b2216e83d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#aa25893460c7c9df334b0207b2216e83d">createSolidAreaMask</a> (<a class="el" href="classRectangleList.html">RectangleList</a>< int > &result, float alphaThreshold) const</td></tr>
<tr class="memdesc:aa25893460c7c9df334b0207b2216e83d"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classRectangleList.html" title="Maintains a set of rectangles as a complex region. ">RectangleList</a> containing rectangles for all non-transparent pixels of the image. <a href="#aa25893460c7c9df334b0207b2216e83d">More...</a><br /></td></tr>
<tr class="separator:aa25893460c7c9df334b0207b2216e83d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0720c42268609dd3063327876e558763"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classNamedValueSet.html">NamedValueSet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a0720c42268609dd3063327876e558763">getProperties</a> () const</td></tr>
<tr class="memdesc:a0720c42268609dd3063327876e558763"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="classNamedValueSet.html" title="Holds a set of named var objects. ">NamedValueSet</a> that is attached to the image and which can be used for associating custom values with it. <a href="#a0720c42268609dd3063327876e558763">More...</a><br /></td></tr>
<tr class="separator:a0720c42268609dd3063327876e558763"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d1ebdd542ddf605acbd52b2182c7e08"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classLowLevelGraphicsContext.html">LowLevelGraphicsContext</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a4d1ebdd542ddf605acbd52b2182c7e08">createLowLevelContext</a> () const</td></tr>
<tr class="memdesc:a4d1ebdd542ddf605acbd52b2182c7e08"><td class="mdescLeft"> </td><td class="mdescRight">Creates a context suitable for drawing onto this image. <a href="#a4d1ebdd542ddf605acbd52b2182c7e08">More...</a><br /></td></tr>
<tr class="separator:a4d1ebdd542ddf605acbd52b2182c7e08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abd88aa52bedce6d7def13d4b39e7f954"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#abd88aa52bedce6d7def13d4b39e7f954">getReferenceCount</a> () const noexcept</td></tr>
<tr class="memdesc:abd88aa52bedce6d7def13d4b39e7f954"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of <a class="el" href="classImage.html" title="Holds a fixed-size bitmap. ">Image</a> objects which are currently referring to the same internal shared image data. <a href="#abd88aa52bedce6d7def13d4b39e7f954">More...</a><br /></td></tr>
<tr class="separator:abd88aa52bedce6d7def13d4b39e7f954"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b47b5735561b3949f462ecc0a9fe7ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classImagePixelData.html">ImagePixelData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a8b47b5735561b3949f462ecc0a9fe7ca">getPixelData</a> () const noexcept</td></tr>
<tr class="separator:a8b47b5735561b3949f462ecc0a9fe7ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3eee6d546718138b39186c50de6704f9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a3eee6d546718138b39186c50de6704f9">Image</a> (<a class="el" href="classImagePixelData.html">ImagePixelData</a> *) noexcept</td></tr>
<tr class="separator:a3eee6d546718138b39186c50de6704f9"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Holds a fixed-size bitmap. </p>
<p>The image is stored in either 24-bit RGB or 32-bit premultiplied-ARGB format.</p>
<p>To draw into an image, create a <a class="el" href="classGraphics.html" title="A graphics context, used for drawing a component or image. ">Graphics</a> object for it. e.g.</p><div class="fragment"><div class="line"><span class="comment">// create a transparent 500x500 image..</span></div><div class="line"><a class="code" href="classImage.html">Image</a> myImage (<a class="code" href="classImage.html#ab47b5746d2df286ae6f8da6af5463c01a03a8b8bb3246ef72c98b01e711d61425">Image::RGB</a>, 500, 500, <span class="keyword">true</span>);</div><div class="line"></div><div class="line"><a class="code" href="classGraphics.html">Graphics</a> g (myImage);</div><div class="line">g.setColour (<a class="code" href="classColours.html#a5056e7857f2bc211569dfc89512244dd">Colours::red</a>);</div><div class="line">g.fillEllipse (20, 20, 300, 200); <span class="comment">// draws a red ellipse in our image.</span></div></div><!-- fragment --><p>Other useful ways to create an image are with the <a class="el" href="classImageCache.html" title="A global cache of images that have been loaded from files or memory. ">ImageCache</a> class, or the <a class="el" href="classImageFileFormat.html" title="Base-class for codecs that can read and write image file formats such as PNG, JPEG, etc. ">ImageFileFormat</a>, which provides a way to load common image files.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classGraphics.html" title="A graphics context, used for drawing a component or image. ">Graphics</a>, <a class="el" href="classImageFileFormat.html" title="Base-class for codecs that can read and write image file formats such as PNG, JPEG, etc. ">ImageFileFormat</a>, <a class="el" href="classImageCache.html" title="A global cache of images that have been loaded from files or memory. ">ImageCache</a>, <a class="el" href="classImageConvolutionKernel.html" title="Represents a filter kernel to use in convoluting an image. ">ImageConvolutionKernel</a> </dd></dl>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="ab47b5746d2df286ae6f8da6af5463c01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab47b5746d2df286ae6f8da6af5463c01">§ </a></span>PixelFormat</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classImage.html#ab47b5746d2df286ae6f8da6af5463c01">Image::PixelFormat</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab47b5746d2df286ae6f8da6af5463c01a54eec5e1c5371ae7ad7242c6a2be067d"></a>UnknownFormat </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab47b5746d2df286ae6f8da6af5463c01a03a8b8bb3246ef72c98b01e711d61425"></a>RGB </td><td class="fielddoc"><p>< each pixel is a 3-byte packed RGB colour value. </p>
<p>For byte order, see the <a class="el" href="classPixelRGB.html" title="Represents a 24-bit RGB pixel, and can perform compositing operations on it. ">PixelRGB</a> class. </p>
</td></tr>
<tr><td class="fieldname"><a id="ab47b5746d2df286ae6f8da6af5463c01a9adefc17fe4663de8e3fc9621c891b8b"></a>ARGB </td><td class="fielddoc"><p>< each pixel is a 4-byte ARGB premultiplied colour value. </p>
<p>For byte order, see the <a class="el" href="classPixelARGB.html" title="Represents a 32-bit INTERNAL pixel with premultiplied alpha, and can perform compositing operations w...">PixelARGB</a> class. </p>
</td></tr>
<tr><td class="fieldname"><a id="ab47b5746d2df286ae6f8da6af5463c01ab8bd2ed5df42fd15bd349195d81b64b4"></a>SingleChannel </td><td class="fielddoc"><p>< each pixel is a 1-byte alpha channel value. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a5d47b71f7afd9f5df61145abb857455c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d47b71f7afd9f5df61145abb857455c">§ </a></span>Image() <span class="overload">[1/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Image::Image </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 a null image. </p>
</div>
</div>
<a id="aa51549669248091773ee494737abdc24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa51549669248091773ee494737abdc24">§ </a></span>Image() <span class="overload">[2/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Image::Image </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classImage.html#ab47b5746d2df286ae6f8da6af5463c01">PixelFormat</a> </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>imageWidth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>imageHeight</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>clearImage</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an image with a specified size and format. </p>
<p>The image's internal type will be of the <a class="el" href="classNativeImageType.html" title="An image storage type which holds the pixels using whatever is the default storage format on the curr...">NativeImageType</a> class - to specify a different type, use the other constructor, which takes an <a class="el" href="classImageType.html" title="This base class is for handlers that control a type of image manipulation format, e...">ImageType</a> to use.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>the number of colour channels in the image </td></tr>
<tr><td class="paramname">imageWidth</td><td>the desired width of the image, in pixels - this value must be greater than zero (otherwise a width of 1 will be used) </td></tr>
<tr><td class="paramname">imageHeight</td><td>the desired width of the image, in pixels - this value must be greater than zero (otherwise a height of 1 will be used) </td></tr>
<tr><td class="paramname">clearImage</td><td>if true, the image will initially be cleared to black (if it's RGB) or transparent black (if it's ARGB). If false, the image may contain junk initially, so you need to make sure you overwrite it thoroughly. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac9e7f47996c7b81190e6cf151bc31fa0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9e7f47996c7b81190e6cf151bc31fa0">§ </a></span>Image() <span class="overload">[3/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Image::Image </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classImage.html#ab47b5746d2df286ae6f8da6af5463c01">PixelFormat</a> </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>imageWidth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>imageHeight</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>clearImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classImageType.html">ImageType</a> & </td>
<td class="paramname"><em>type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an image with a specified size and format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>the number of colour channels in the image </td></tr>
<tr><td class="paramname">imageWidth</td><td>the desired width of the image, in pixels - this value must be greater than zero (otherwise a width of 1 will be used) </td></tr>
<tr><td class="paramname">imageHeight</td><td>the desired width of the image, in pixels - this value must be greater than zero (otherwise a height of 1 will be used) </td></tr>
<tr><td class="paramname">clearImage</td><td>if true, the image will initially be cleared to black (if it's RGB) or transparent black (if it's ARGB). If false, the image may contain junk initially, so you need to make sure you overwrite it thoroughly. </td></tr>
<tr><td class="paramname">type</td><td>the type of image - this lets you specify the internal format that will be used to allocate and manage the image data. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5333c440b8f5637a3c7878e9b8d1ad21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5333c440b8f5637a3c7878e9b8d1ad21">§ </a></span>Image() <span class="overload">[4/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Image::Image </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classImage.html">Image</a> & </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 a shared reference to another image. </p>
<p>This won't create a duplicate of the image - when <a class="el" href="classImage.html" title="Holds a fixed-size bitmap. ">Image</a> objects are copied, they simply point to the same shared image data. To make sure that an <a class="el" href="classImage.html" title="Holds a fixed-size bitmap. ">Image</a> object has its own unique, unshared internal data, call <a class="el" href="classImage.html#ad995cd253234063d22b604984e83489d" title="Makes sure that no other Image objects share the same underlying data as this one. ">duplicateIfShared()</a>. </p>
</div>
</div>
<a id="a02801f5341319e941b10a9a291b30a62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02801f5341319e941b10a9a291b30a62">§ </a></span>Image() <span class="overload">[5/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Image::Image </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classImage.html">Image</a> && </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">
</div>
</div>
<a id="a0294f63700543e11c0f0da85601c7ae5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0294f63700543e11c0f0da85601c7ae5">§ </a></span>~Image()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Image::~Image </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<a id="a3eee6d546718138b39186c50de6704f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3eee6d546718138b39186c50de6704f9">§ </a></span>Image() <span class="overload">[6/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Image::Image </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classImagePixelData.html">ImagePixelData</a> * </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1a50d3d1da8a95f7c74af4ef8d4eda6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a50d3d1da8a95f7c74af4ef8d4eda6f">§ </a></span>operator=() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classImage.html">Image</a>& Image::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classImage.html">Image</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Makes this image refer to the same underlying image as another object. </p>
<p>This won't create a duplicate of the image - when <a class="el" href="classImage.html" title="Holds a fixed-size bitmap. ">Image</a> objects are copied, they simply point to the same shared image data. To make sure that an <a class="el" href="classImage.html" title="Holds a fixed-size bitmap. ">Image</a> object has its own unique, unshared internal data, call <a class="el" href="classImage.html#ad995cd253234063d22b604984e83489d" title="Makes sure that no other Image objects share the same underlying data as this one. ">duplicateIfShared()</a>. </p>
</div>
</div>
<a id="ad111c269be3c7915306645b1eb46a3a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad111c269be3c7915306645b1eb46a3a8">§ </a></span>operator=() <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"><a class="el" href="classImage.html">Image</a>& Image::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classImage.html">Image</a> && </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">
</div>
</div>
<a id="aa0b558cf4f55b47b15f11094f4fa84cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0b558cf4f55b47b15f11094f4fa84cc">§ </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 Image::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classImage.html">Image</a> & </td>
<td class="paramname"><em>other</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 true if the two images are referring to the same internal, shared image. </p>
</div>
</div>
<a id="a9f6d8eea11bc8e8129e313e63f312802"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f6d8eea11bc8e8129e313e63f312802">§ </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 Image::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classImage.html">Image</a> & </td>
<td class="paramname"><em>other</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 true if the two images are not referring to the same internal, shared image. </p>
</div>
</div>
<a id="a761214d2fa016e3e793b5a2d6b8b85ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a761214d2fa016e3e793b5a2d6b8b85ec">§ </a></span>isValid()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Image::isValid </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 this image isn't null. </p>
<p>If you create an <a class="el" href="classImage.html" title="Holds a fixed-size bitmap. ">Image</a> with the default constructor, it has no size or content, and is null until you reassign it to an <a class="el" href="classImage.html" title="Holds a fixed-size bitmap. ">Image</a> which contains some actual data. The <a class="el" href="classImage.html#a4084a24d1034249f29a7781ef44159d8" title="Returns true if this image is not valid. ">isNull()</a> method is the opposite of <a class="el" href="classImage.html#a761214d2fa016e3e793b5a2d6b8b85ec" title="Returns true if this image isn't null. ">isValid()</a>. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classImage.html#a4084a24d1034249f29a7781ef44159d8" title="Returns true if this image is not valid. ">isNull</a> </dd></dl>
<p>Referenced by <a class="el" href="classFillType.html#aaaee9279ba52466501e9a231e02b3358">FillType::isTiledImage()</a>.</p>
</div>
</div>
<a id="a4084a24d1034249f29a7781ef44159d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4084a24d1034249f29a7781ef44159d8">§ </a></span>isNull()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Image::isNull </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 this image is not valid. </p>
<p>If you create an <a class="el" href="classImage.html" title="Holds a fixed-size bitmap. ">Image</a> with the default constructor, it has no size or content, and is null until you reassign it to an <a class="el" href="classImage.html" title="Holds a fixed-size bitmap. ">Image</a> which contains some actual data. The <a class="el" href="classImage.html#a4084a24d1034249f29a7781ef44159d8" title="Returns true if this image is not valid. ">isNull()</a> method is the opposite of <a class="el" href="classImage.html#a761214d2fa016e3e793b5a2d6b8b85ec" title="Returns true if this image isn't null. ">isValid()</a>. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classImage.html#a761214d2fa016e3e793b5a2d6b8b85ec" title="Returns true if this image isn't null. ">isValid</a> </dd></dl>
<p>References <a class="el" href="classGraphics.html#a5da218e649d1b5ac3d67443ae77caf87a5d8dfbf84457e91eb309b1402562f2af">Graphics::mediumResamplingQuality</a>.</p>
<p>Referenced by <a class="el" href="classFillType.html#ae816ef1788db62d88a9ea251fd7abdf4">FillType::isColour()</a>.</p>
</div>
</div>
<a id="a3c540187e754adb5beac244b64df70af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c540187e754adb5beac244b64df70af">§ </a></span>getWidth()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Image::getWidth </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 image's width (in pixels). </p>
</div>
</div>
<a id="a717b9cde54f44af0ea68e87729c1365f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a717b9cde54f44af0ea68e87729c1365f">§ </a></span>getHeight()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Image::getHeight </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 image's height (in pixels). </p>
</div>
</div>
<a id="a6b9f151177766fae7679c7994161ceba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b9f151177766fae7679c7994161ceba">§ </a></span>getBounds()</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="classRectangle.html">Rectangle</a><int> Image::getBounds </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 a rectangle with the same size as this image. </p>
<p>The rectangle's origin is always (0, 0). </p>
</div>
</div>
<a id="a73ceedb27674d0ad6611356147344677"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73ceedb27674d0ad6611356147344677">§ </a></span>getFormat()</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="classImage.html#ab47b5746d2df286ae6f8da6af5463c01">PixelFormat</a> Image::getFormat </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 image's pixel format. </p>
</div>
</div>
<a id="a14441f64b47e4d881c399e07a2718de1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14441f64b47e4d881c399e07a2718de1">§ </a></span>isARGB()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Image::isARGB </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>True if the image's format is ARGB. </p>
</div>
</div>
<a id="a53b8b72f6cf08ce6d6179666250aedc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53b8b72f6cf08ce6d6179666250aedc7">§ </a></span>isRGB()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Image::isRGB </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>True if the image's format is RGB. </p>
</div>
</div>
<a id="a1176ae108a31a0f4b7b4be6b86bc6181"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1176ae108a31a0f4b7b4be6b86bc6181">§ </a></span>isSingleChannel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Image::isSingleChannel </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>True if the image's format is a single-channel alpha map. </p>
</div>
</div>
<a id="abb862a4402074ef0dc0382e2c6267a32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb862a4402074ef0dc0382e2c6267a32">§ </a></span>hasAlphaChannel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Image::hasAlphaChannel </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>True if the image contains an alpha-channel. </p>
</div>
</div>
<a id="a2e8dc6de9ca6b4181658d0144579fb2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e8dc6de9ca6b4181658d0144579fb2f">§ </a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Image::clear </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classRectangle.html">Rectangle</a>< int > & </td>
<td class="paramname"><em>area</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>colourToClearTo</em> = <code><a class="el" href="classColour.html">Colour</a>(0x00000000)</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears a section of the image with a given colour. </p>
<p>This won't do any alpha-blending - it just sets all pixels in the image to the given colour (which may be non-opaque if the image has an alpha channel). </p>
</div>
</div>
<a id="ad75852120adf4e3cc3a9843d1abcf586"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad75852120adf4e3cc3a9843d1abcf586">§ </a></span>rescaled()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classImage.html">Image</a> Image::rescaled </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>newWidth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>newHeight</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classGraphics.html#a5da218e649d1b5ac3d67443ae77caf87">Graphics::ResamplingQuality</a> </td>
<td class="paramname"><em>quality</em> = <code><a class="el" href="classGraphics.html#a5da218e649d1b5ac3d67443ae77caf87a5d8dfbf84457e91eb309b1402562f2af">Graphics::mediumResamplingQuality</a></code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a rescaled version of this image. </p>
<p>A new image is returned which is a copy of this one, rescaled to the given size.</p>
<p>Note that if the new size is identical to the existing image, this will just return a reference to the original image, and won't actually create a duplicate. </p>
</div>
</div>
<a id="ab01ea9a3ee0fdf41398542859685c9af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab01ea9a3ee0fdf41398542859685c9af">§ </a></span>createCopy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classImage.html">Image</a> Image::createCopy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a copy of this image. </p>
<p>Note that it's usually more efficient to use <a class="el" href="classImage.html#ad995cd253234063d22b604984e83489d" title="Makes sure that no other Image objects share the same underlying data as this one. ">duplicateIfShared()</a>, because it may not be necessary to copy an image if nothing else is using it. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classImage.html#abd88aa52bedce6d7def13d4b39e7f954" title="Returns the number of Image objects which are currently referring to the same internal shared image d...">getReferenceCount</a> </dd></dl>
</div>
</div>
<a id="aa6b6141148fd128b037670e06f95e7ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6b6141148fd128b037670e06f95e7ef">§ </a></span>convertedToFormat()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classImage.html">Image</a> Image::convertedToFormat </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classImage.html#ab47b5746d2df286ae6f8da6af5463c01">PixelFormat</a> </td>
<td class="paramname"><em>newFormat</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a version of this image with a different image format. </p>
<p>A new image is returned which has been converted to the specified format.</p>
<p>Note that if the new format is no different to the current one, this will just return a reference to the original image, and won't actually create a copy. </p>
</div>
</div>
<a id="ad995cd253234063d22b604984e83489d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad995cd253234063d22b604984e83489d">§ </a></span>duplicateIfShared()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Image::duplicateIfShared </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Makes sure that no other <a class="el" href="classImage.html" title="Holds a fixed-size bitmap. ">Image</a> objects share the same underlying data as this one. </p>
<p>If no other <a class="el" href="classImage.html" title="Holds a fixed-size bitmap. ">Image</a> objects refer to the same shared data as this one, this method has no effect. But if there are other references to the data, this will create a new copy of the data internally.</p>
<p>Call this if you want to draw onto the image, but want to make sure that this doesn't affect any other code that may be sharing the same data.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classImage.html#abd88aa52bedce6d7def13d4b39e7f954" title="Returns the number of Image objects which are currently referring to the same internal shared image d...">getReferenceCount</a> </dd></dl>
</div>
</div>
<a id="a0f1e8e0a7e0abf650911df14bbf7e701"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f1e8e0a7e0abf650911df14bbf7e701">§ </a></span>getClippedImage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classImage.html">Image</a> Image::getClippedImage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classRectangle.html">Rectangle</a>< int > & </td>
<td class="paramname"><em>area</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an image which refers to a subsection of this image. </p>
<p>This will not make a copy of the original - the new image will keep a reference to it, so that if the original image is changed, the contents of the subsection will also change. Likewise if you draw into the subimage, you'll also be drawing onto that area of the original image. Note that if you use operator= to make the original <a class="el" href="classImage.html" title="Holds a fixed-size bitmap. ">Image</a> object refer to something else, the subsection image won't pick up this change, it'll remain pointing at the original.</p>
<p>The area passed-in will be clipped to the bounds of this image, so this may return a smaller image than the area you asked for, or even a null image if the area was out-of-bounds. </p>
</div>
</div>
<a id="ac476d1ab705f7ee86d424825c0705466"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac476d1ab705f7ee86d424825c0705466">§ </a></span>getPixelAt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classColour.html">Colour</a> Image::getPixelAt </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>y</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the colour of one of the pixels in the image. </p>
<p>If the coordinates given are beyond the image's boundaries, this will return <a class="el" href="classColours.html#a0ce54d7a6cbbce207c29165102d3a35f" title="ARGB = 0x00000000. ">Colours::transparentBlack</a>.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classImage.html#a1521d7dd860ccdecc9a1ba27952d5f88" title="Sets the colour of one of the image's pixels. ">setPixelAt</a>, <a class="el" href="classImage_1_1BitmapData.html#ae2a2c5b5c9aeb01e0098da19c5057d48" title="Returns the colour of a given pixel. ">Image::BitmapData::getPixelColour</a> </dd></dl>
</div>
</div>
<a id="a1521d7dd860ccdecc9a1ba27952d5f88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1521d7dd860ccdecc9a1ba27952d5f88">§ </a></span>setPixelAt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Image::setPixelAt </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>y</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>Sets the colour of one of the image's pixels. </p>
<p>If the coordinates are beyond the image's boundaries, then nothing will happen.</p>
<p>Note that this won't do any alpha-blending, it'll just replace the existing pixel with the given one. The colour's opacity will be ignored if this image doesn't have an alpha-channel.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classImage.html#ac476d1ab705f7ee86d424825c0705466" title="Returns the colour of one of the pixels in the image. ">getPixelAt</a>, <a class="el" href="classImage_1_1BitmapData.html#ad76af08dda45202751c3a6103cd42030" title="Sets the colour of a given pixel. ">Image::BitmapData::setPixelColour</a> </dd></dl>
</div>
</div>
<a id="a795ef04008dc17e60231eb6bf0618946"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a795ef04008dc17e60231eb6bf0618946">§ </a></span>multiplyAlphaAt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Image::multiplyAlphaAt </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>multiplier</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes the opacity of a pixel. </p>
<p>This only has an effect if the image has an alpha channel and if the given coordinates are inside the image's boundary.</p>
<p>The multiplier must be in the range 0 to 1.0, and the current alpha at the given coordinates will be multiplied by this value.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classImage.html#a1521d7dd860ccdecc9a1ba27952d5f88" title="Sets the colour of one of the image's pixels. ">setPixelAt</a> </dd></dl>
</div>
</div>
<a id="a9d1febd93213f92b50af58ce731cdabf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d1febd93213f92b50af58ce731cdabf">§ </a></span>multiplyAllAlphas()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Image::multiplyAllAlphas </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>amountToMultiplyBy</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes the overall opacity of the image. </p>
<p>This will multiply the alpha value of each pixel in the image by the given amount (limiting the resulting alpha values between 0 and 255). This allows you to make an image more or less transparent.</p>
<p>If the image doesn't have an alpha channel, this won't have any effect. </p>
</div>
</div>
<a id="a038f9f882f1829362c23c22a9577e22d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a038f9f882f1829362c23c22a9577e22d">§ </a></span>desaturate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Image::desaturate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes all the colours to be shades of grey, based on their current luminosity. </p>
</div>
</div>
<a id="a5e90b1777a505f16e3f9d2a6da674a36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e90b1777a505f16e3f9d2a6da674a36">§ </a></span>moveImageSection()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Image::moveImageSection </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>destX</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>destY</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>sourceX</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>sourceY</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>height</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copies a section of the image to somewhere else within itself. </p>
</div>
</div>
<a id="aa25893460c7c9df334b0207b2216e83d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa25893460c7c9df334b0207b2216e83d">§ </a></span>createSolidAreaMask()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Image::createSolidAreaMask </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classRectangleList.html">RectangleList</a>< int > & </td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>alphaThreshold</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classRectangleList.html" title="Maintains a set of rectangles as a complex region. ">RectangleList</a> containing rectangles for all non-transparent pixels of the image. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">result</td><td>the list that will have the area added to it </td></tr>
<tr><td class="paramname">alphaThreshold</td><td>for a semi-transparent image, any pixels whose alpha is above this level will be considered opaque </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0720c42268609dd3063327876e558763"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0720c42268609dd3063327876e558763">§ </a></span>getProperties()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classNamedValueSet.html">NamedValueSet</a>* Image::getProperties </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a <a class="el" href="classNamedValueSet.html" title="Holds a set of named var objects. ">NamedValueSet</a> that is attached to the image and which can be used for associating custom values with it. </p>
<p>If this is a null image, this will return a null pointer. </p>
</div>
</div>
<a id="a4d1ebdd542ddf605acbd52b2182c7e08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d1ebdd542ddf605acbd52b2182c7e08">§ </a></span>createLowLevelContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classLowLevelGraphicsContext.html">LowLevelGraphicsContext</a>* Image::createLowLevelContext </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a context suitable for drawing onto this image. </p>
<p>Don't call this method directly! It's used internally by the <a class="el" href="classGraphics.html" title="A graphics context, used for drawing a component or image. ">Graphics</a> class. </p>
</div>
</div>
<a id="abd88aa52bedce6d7def13d4b39e7f954"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd88aa52bedce6d7def13d4b39e7f954">§ </a></span>getReferenceCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Image::getReferenceCount </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 <a class="el" href="classImage.html" title="Holds a fixed-size bitmap. ">Image</a> objects which are currently referring to the same internal shared image data. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classImage.html#ad995cd253234063d22b604984e83489d" title="Makes sure that no other Image objects share the same underlying data as this one. ">duplicateIfShared</a> </dd></dl>
</div>
</div>
<a id="a8b47b5735561b3949f462ecc0a9fe7ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b47b5735561b3949f462ecc0a9fe7ca">§ </a></span>getPixelData()</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="classImagePixelData.html">ImagePixelData</a>* Image::getPixelData </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>References <a class="el" href="juce__LeakedObjectDetector_8h.html#ab3639a79598b35f2116f4572af0d93f1">JUCE_LEAK_DETECTOR</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__Image_8h.html">juce_Image.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|