/usr/share/doc/libsfml-doc/html/classsf_1_1Image.htm is in libsfml-doc 1.6+dfsg1-2ubuntu2.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>SFML - Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="tabs.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="logo">
<img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" />
</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.htm"><span>Main Page</span></a></li>
<li><a href="namespaces.htm"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.htm"><span>Classes</span></a></li>
<li><a href="files.htm"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.htm"><span>Class List</span></a></li>
<li><a href="classes.htm"><span>Class Index</span></a></li>
<li><a href="hierarchy.htm"><span>Class Hierarchy</span></a></li>
<li><a href="functions.htm"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><b>sf</b>::<a class="el" href="classsf_1_1Image.htm">Image</a>
</div>
</div>
<div class="contents">
<h1>sf::Image Class Reference</h1><!-- doxytag: class="sf::Image" --><!-- doxytag: inherits="Resource< Image >" --><a class="el" href="classsf_1_1Image.htm" title="Image is the low-level class for loading and manipulating images.">Image</a> is the low-level class for loading and manipulating images.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="Image_8hpp-source.htm">Image.hpp</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for sf::Image:</div>
<div class="dynsection">
<p><center><img src="classsf_1_1Image.png" usemap="#sf::Image_map" border="0" alt=""></center>
<map name="sf::Image_map">
<area href="classsf_1_1Resource.htm" alt="sf::Resource< Image >" shape="rect" coords="0,0,139,24">
</map>
</div>
<p>
<a href="classsf_1_1Image-members.htm">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#bb4caf3cb167b613345ebe36fc883f12">Image</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#bb4caf3cb167b613345ebe36fc883f12"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#a38cae7c1c704aa0175b9e73645cb210">Image</a> (const <a class="el" href="classsf_1_1Image.htm">Image</a> &Copy)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a38cae7c1c704aa0175b9e73645cb210"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#2a4c0ec448863784f83e9931d25dada2">Image</a> (unsigned int Width, unsigned int Height, const <a class="el" href="classsf_1_1Color.htm">Color</a> &Col=<a class="el" href="classsf_1_1Color.htm">Color</a>(0, 0, 0, 255))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an empty image. <a href="#2a4c0ec448863784f83e9931d25dada2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#7092ba80cc19c053bf356e98a4743acb">Image</a> (unsigned int Width, unsigned int Height, const Uint8 *Data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct the image from pixels in memory. <a href="#7092ba80cc19c053bf356e98a4743acb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#0ba22a38e6c96e3b37dd88198046de83">~Image</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#0ba22a38e6c96e3b37dd88198046de83"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#7cf6316aa5d022e0bdd95f1e79c9f50b">LoadFromFile</a> (const std::string &Filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load the image from a file. <a href="#7cf6316aa5d022e0bdd95f1e79c9f50b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#72565ffabe12dfb2602e209c2e6f0486">LoadFromMemory</a> (const char *Data, std::size_t SizeInBytes)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load the image from a file in memory. <a href="#72565ffabe12dfb2602e209c2e6f0486"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#67d65c552c9bcba989a061e9c5b5d10c">LoadFromPixels</a> (unsigned int Width, unsigned int Height, const Uint8 *Data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load the image directly from an array of pixels. <a href="#67d65c552c9bcba989a061e9c5b5d10c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#50eed54ef8e9f3aeef5bb7f19144aa08">SaveToFile</a> (const std::string &Filename) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save the content of the image to a file. <a href="#50eed54ef8e9f3aeef5bb7f19144aa08"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#4e2ce8821e8de36462604bbf99f39cde">Create</a> (unsigned int Width, unsigned int Height, <a class="el" href="classsf_1_1Color.htm">Color</a> Col=<a class="el" href="classsf_1_1Color.htm">Color</a>(0, 0, 0, 255))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an empty image. <a href="#4e2ce8821e8de36462604bbf99f39cde"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#e9a15fe9a4750295845b5ae081c2ec50">CreateMaskFromColor</a> (<a class="el" href="classsf_1_1Color.htm">Color</a> ColorKey, Uint8 Alpha=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create transparency mask from a specified colorkey. <a href="#e9a15fe9a4750295845b5ae081c2ec50"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#408c40c8675363adfa96a8b9a9576bc2">Copy</a> (const <a class="el" href="classsf_1_1Image.htm">Image</a> &Source, unsigned int DestX, unsigned int DestY, const <a class="el" href="classsf_1_1Rect.htm">IntRect</a> &SourceRect=<a class="el" href="classsf_1_1Rect.htm">IntRect</a>(0, 0, 0, 0), bool ApplyAlpha=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy pixels from another image onto this one. <a href="#408c40c8675363adfa96a8b9a9576bc2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#96597746f70ce1925ec82d2df8ae6974">CopyScreen</a> (<a class="el" href="classsf_1_1RenderWindow.htm">RenderWindow</a> &<a class="el" href="classsf_1_1Window.htm">Window</a>, const <a class="el" href="classsf_1_1Rect.htm">IntRect</a> &SourceRect=<a class="el" href="classsf_1_1Rect.htm">IntRect</a>(0, 0, 0, 0))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create the image from the current contents of the given window. <a href="#96597746f70ce1925ec82d2df8ae6974"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#623f2379b30307b4ee4eb08d517d9584">SetPixel</a> (unsigned int X, unsigned int Y, const <a class="el" href="classsf_1_1Color.htm">Color</a> &Col)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the color of a pixel. <a href="#623f2379b30307b4ee4eb08d517d9584"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classsf_1_1Color.htm">Color</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#b7590e372a153ace848cf8a6081c8bc4">GetPixel</a> (unsigned int X, unsigned int Y) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pixel from the image. <a href="#b7590e372a153ace848cf8a6081c8bc4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const Uint8 * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#85355b09f946aa4b985f9d2a1d620022">GetPixelsPtr</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a read-only pointer to the array of pixels (RGBA 8 bits integers components) Array size is <a class="el" href="classsf_1_1Image.htm#896f09a4eb769b5b866b6dde9c1a25e7" title="Return the width of the image.">GetWidth()</a> x <a class="el" href="classsf_1_1Image.htm#f2131512b6290fd96fd10c539723fe89" title="Return the height of the image.">GetHeight()</a> x 4 This pointer becomes invalid if you reload or resize the image. <a href="#85355b09f946aa4b985f9d2a1d620022"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#74bda6dc927849ff25f8fce5143918e7">Bind</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Bind the image for rendering. <a href="#74bda6dc927849ff25f8fce5143918e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#d167422fd331cd069674391fb16e8452">SetSmooth</a> (bool Smooth)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable image smooth filter. <a href="#d167422fd331cd069674391fb16e8452"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#896f09a4eb769b5b866b6dde9c1a25e7">GetWidth</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the width of the image. <a href="#896f09a4eb769b5b866b6dde9c1a25e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#f2131512b6290fd96fd10c539723fe89">GetHeight</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the height of the image. <a href="#f2131512b6290fd96fd10c539723fe89"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#d175b4c9110549c5df324ba61c580ce3">IsSmooth</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tells whether the smooth filtering is enabled or not. <a href="#d175b4c9110549c5df324ba61c580ce3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Rect.htm">FloatRect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#066704507bcaabe27db17170bf02bd56">GetTexCoords</a> (const <a class="el" href="classsf_1_1Rect.htm">IntRect</a> &<a class="el" href="classsf_1_1Rect.htm">Rect</a>) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a subrect expressed in pixels, into float texture coordinates. <a href="#066704507bcaabe27db17170bf02bd56"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Image.htm">Image</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#5f9927e407bbe34172553ecfff2f54f3">operator=</a> (const <a class="el" href="classsf_1_1Image.htm">Image</a> &Other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#5f9927e407bbe34172553ecfff2f54f3"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Image.htm#b41056600a1a4848833cc8b5239a9488">GetValidTextureSize</a> (unsigned int Size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a valid texture size according to hardware support. <a href="#b41056600a1a4848833cc8b5239a9488"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classsf_1_1Image.htm" title="Image is the low-level class for loading and manipulating images.">Image</a> is the low-level class for loading and manipulating images.
<p>Definition at line <a class="el" href="Image_8hpp-source.htm#l00046">46</a> of file <a class="el" href="Image_8hpp-source.htm">Image.hpp</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="bb4caf3cb167b613345ebe36fc883f12"></a><!-- doxytag: member="sf::Image::Image" ref="bb4caf3cb167b613345ebe36fc883f12" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::Image::Image </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor.
<p>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00043">43</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="a38cae7c1c704aa0175b9e73645cb210"></a><!-- doxytag: member="sf::Image::Image" ref="a38cae7c1c704aa0175b9e73645cb210" args="(const Image &Copy)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::Image::Image </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1Image.htm">Image</a> & </td>
<td class="paramname"> <em>Copy</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy constructor.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Copy</em> </td><td>: instance to copy </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00060">60</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="2a4c0ec448863784f83e9931d25dada2"></a><!-- doxytag: member="sf::Image::Image" ref="2a4c0ec448863784f83e9931d25dada2" args="(unsigned int Width, unsigned int Height, const Color &Col=Color(0, 0, 0, 255))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::Image::Image </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>Width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>Height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsf_1_1Color.htm">Color</a> & </td>
<td class="paramname"> <em>Col</em> = <code><a class="el" href="classsf_1_1Color.htm">Color</a>(0, 0, 0, 255)</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct an empty image.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Width</em> </td><td>: <a class="el" href="classsf_1_1Image.htm" title="Image is the low-level class for loading and manipulating images.">Image</a> width </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Height</em> </td><td>: <a class="el" href="classsf_1_1Image.htm" title="Image is the low-level class for loading and manipulating images.">Image</a> height </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Col</em> </td><td>: <a class="el" href="classsf_1_1Image.htm" title="Image is the low-level class for loading and manipulating images.">Image</a> color (black by default) </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00079">79</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="7092ba80cc19c053bf356e98a4743acb"></a><!-- doxytag: member="sf::Image::Image" ref="7092ba80cc19c053bf356e98a4743acb" args="(unsigned int Width, unsigned int Height, const Uint8 *Data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::Image::Image </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>Width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>Height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Uint8 * </td>
<td class="paramname"> <em>Data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct the image from pixels in memory.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Width</em> </td><td>: <a class="el" href="classsf_1_1Image.htm" title="Image is the low-level class for loading and manipulating images.">Image</a> width </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Height</em> </td><td>: <a class="el" href="classsf_1_1Image.htm" title="Image is the low-level class for loading and manipulating images.">Image</a> height </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Data</em> </td><td>: Pointer to the pixels in memory (assumed format is RGBA) </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00096">96</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="0ba22a38e6c96e3b37dd88198046de83"></a><!-- doxytag: member="sf::Image::~Image" ref="0ba22a38e6c96e3b37dd88198046de83" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::Image::~Image </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00113">113</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="74bda6dc927849ff25f8fce5143918e7"></a><!-- doxytag: member="sf::Image::Bind" ref="74bda6dc927849ff25f8fce5143918e7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Image::Bind </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Bind the image for rendering.
<p>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00473">473</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="408c40c8675363adfa96a8b9a9576bc2"></a><!-- doxytag: member="sf::Image::Copy" ref="408c40c8675363adfa96a8b9a9576bc2" args="(const Image &Source, unsigned int DestX, unsigned int DestY, const IntRect &SourceRect=IntRect(0, 0, 0, 0), bool ApplyAlpha=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Image::Copy </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1Image.htm">Image</a> & </td>
<td class="paramname"> <em>Source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>DestX</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>DestY</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsf_1_1Rect.htm">IntRect</a> & </td>
<td class="paramname"> <em>SourceRect</em> = <code><a class="el" href="classsf_1_1Rect.htm">IntRect</a>(0, 0, 0, 0)</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>ApplyAlpha</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy pixels from another image onto this one.
<p>
This function does a slow pixel copy and should only be used at initialization time<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Source</em> </td><td>: Source image to copy </td></tr>
<tr><td valign="top"></td><td valign="top"><em>DestX</em> </td><td>: X coordinate of the destination position </td></tr>
<tr><td valign="top"></td><td valign="top"><em>DestY</em> </td><td>: Y coordinate of the destination position </td></tr>
<tr><td valign="top"></td><td valign="top"><em>SourceRect</em> </td><td>: Sub-rectangle of the source image to copy (empty by default - entire image) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ApplyAlpha</em> </td><td>: Should the copy take in account the source transparency? (false by default)</td></tr>
</table>
</dl>
This function does a slow pixel copy and should only be used at initialization time
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00270">270</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="96597746f70ce1925ec82d2df8ae6974"></a><!-- doxytag: member="sf::Image::CopyScreen" ref="96597746f70ce1925ec82d2df8ae6974" args="(RenderWindow &Window, const IntRect &SourceRect=IntRect(0, 0, 0, 0))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool sf::Image::CopyScreen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsf_1_1RenderWindow.htm">RenderWindow</a> & </td>
<td class="paramname"> <em>Window</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsf_1_1Rect.htm">IntRect</a> & </td>
<td class="paramname"> <em>SourceRect</em> = <code><a class="el" href="classsf_1_1Rect.htm">IntRect</a>(0, 0, 0, 0)</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create the image from the current contents of the given window.
<p>
Create the image from the current contents of the given window.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classsf_1_1Window.htm" title="Window is a rendering window ; it can create a new window or connect to an existing...">Window</a></em> </td><td>: <a class="el" href="classsf_1_1Window.htm" title="Window is a rendering window ; it can create a new window or connect to an existing...">Window</a> to capture </td></tr>
<tr><td valign="top"></td><td valign="top"><em>SourceRect</em> </td><td>: Sub-rectangle of the screen to copy (empty by default - entire image)</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if copy was successful </dd></dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00358">358</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="4e2ce8821e8de36462604bbf99f39cde"></a><!-- doxytag: member="sf::Image::Create" ref="4e2ce8821e8de36462604bbf99f39cde" args="(unsigned int Width, unsigned int Height, Color Col=Color(0, 0, 0, 255))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool sf::Image::Create </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>Width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>Height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classsf_1_1Color.htm">Color</a> </td>
<td class="paramname"> <em>Col</em> = <code><a class="el" href="classsf_1_1Color.htm">Color</a>(0, 0, 0, 255)</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an empty image.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Width</em> </td><td>: <a class="el" href="classsf_1_1Image.htm" title="Image is the low-level class for loading and manipulating images.">Image</a> width </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Height</em> </td><td>: <a class="el" href="classsf_1_1Image.htm" title="Image is the low-level class for loading and manipulating images.">Image</a> height </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Col</em> </td><td>: <a class="el" href="classsf_1_1Image.htm" title="Image is the low-level class for loading and manipulating images.">Image</a> color (black by default)</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if creation was successful </dd></dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00222">222</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="e9a15fe9a4750295845b5ae081c2ec50"></a><!-- doxytag: member="sf::Image::CreateMaskFromColor" ref="e9a15fe9a4750295845b5ae081c2ec50" args="(Color ColorKey, Uint8 Alpha=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Image::CreateMaskFromColor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsf_1_1Color.htm">Color</a> </td>
<td class="paramname"> <em>ColorKey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Uint8 </td>
<td class="paramname"> <em>Alpha</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create transparency mask from a specified colorkey.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ColorKey</em> </td><td>: <a class="el" href="classsf_1_1Color.htm" title="Color is an utility class for manipulating 32-bits RGBA colors.">Color</a> to become transparent </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Alpha</em> </td><td>: Alpha value to use for transparent pixels (0 by default) </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00249">249</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="f2131512b6290fd96fd10c539723fe89"></a><!-- doxytag: member="sf::Image::GetHeight" ref="f2131512b6290fd96fd10c539723fe89" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int sf::Image::GetHeight </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the height of the image.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Height in pixels </dd></dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00526">526</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="b7590e372a153ace848cf8a6081c8bc4"></a><!-- doxytag: member="sf::Image::GetPixel" ref="b7590e372a153ace848cf8a6081c8bc4" args="(unsigned int X, unsigned int Y) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classsf_1_1Color.htm">Color</a> & sf::Image::GetPixel </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>X</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>Y</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a pixel from the image.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>X</em> </td><td>: X coordinate of pixel in the image </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Y</em> </td><td>: Y coordinate of pixel in the image</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classsf_1_1Color.htm" title="Color is an utility class for manipulating 32-bits RGBA colors.">Color</a> of pixel (X, Y) </dd></dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00431">431</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="85355b09f946aa4b985f9d2a1d620022"></a><!-- doxytag: member="sf::Image::GetPixelsPtr" ref="85355b09f946aa4b985f9d2a1d620022" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const Uint8 * sf::Image::GetPixelsPtr </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a read-only pointer to the array of pixels (RGBA 8 bits integers components) Array size is <a class="el" href="classsf_1_1Image.htm#896f09a4eb769b5b866b6dde9c1a25e7" title="Return the width of the image.">GetWidth()</a> x <a class="el" href="classsf_1_1Image.htm#f2131512b6290fd96fd10c539723fe89" title="Return the height of the image.">GetHeight()</a> x 4 This pointer becomes invalid if you reload or resize the image.
<p>
Get a read-only pointer to the array of pixels (RGBA 8 bits integers components) Array size is <a class="el" href="classsf_1_1Image.htm#896f09a4eb769b5b866b6dde9c1a25e7" title="Return the width of the image.">GetWidth()</a> x <a class="el" href="classsf_1_1Image.htm#f2131512b6290fd96fd10c539723fe89" title="Return the height of the image.">GetHeight()</a> x 4 This pointer becomes invalid if you reload or resize the image.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Const pointer to the array of pixels </dd></dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00453">453</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="066704507bcaabe27db17170bf02bd56"></a><!-- doxytag: member="sf::Image::GetTexCoords" ref="066704507bcaabe27db17170bf02bd56" args="(const IntRect &Rect) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Rect.htm">FloatRect</a> sf::Image::GetTexCoords </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1Rect.htm">IntRect</a> & </td>
<td class="paramname"> <em>Rect</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convert a subrect expressed in pixels, into float texture coordinates.
<p>
Convert a subrect expressed in pixels, into float texture coordinates.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classsf_1_1Rect.htm" title="Rect is an utility class for manipulating rectangles.">Rect</a></em> </td><td>: Sub-rectangle of image to convert</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Texture coordinates corresponding to the sub-rectangle </dd></dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00545">545</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="b41056600a1a4848833cc8b5239a9488"></a><!-- doxytag: member="sf::Image::GetValidTextureSize" ref="b41056600a1a4848833cc8b5239a9488" args="(unsigned int Size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int sf::Image::GetValidTextureSize </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>Size</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a valid texture size according to hardware support.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Size</em> </td><td>: Size to convert</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Valid nearest size (greater than or equal to specified size) </dd></dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00560">560</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="896f09a4eb769b5b866b6dde9c1a25e7"></a><!-- doxytag: member="sf::Image::GetWidth" ref="896f09a4eb769b5b866b6dde9c1a25e7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int sf::Image::GetWidth </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the width of the image.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Width in pixels </dd></dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00517">517</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="d175b4c9110549c5df324ba61c580ce3"></a><!-- doxytag: member="sf::Image::IsSmooth" ref="d175b4c9110549c5df324ba61c580ce3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool sf::Image::IsSmooth </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tells whether the smooth filtering is enabled or not.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if image smoothing is enabled </dd></dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00535">535</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="7cf6316aa5d022e0bdd95f1e79c9f50b"></a><!-- doxytag: member="sf::Image::LoadFromFile" ref="7cf6316aa5d022e0bdd95f1e79c9f50b" args="(const std::string &Filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool sf::Image::LoadFromFile </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>Filename</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Load the image from a file.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Filename</em> </td><td>: Path of the image file to load</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if loading was successful </dd></dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00123">123</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="72565ffabe12dfb2602e209c2e6f0486"></a><!-- doxytag: member="sf::Image::LoadFromMemory" ref="72565ffabe12dfb2602e209c2e6f0486" args="(const char *Data, std::size_t SizeInBytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool sf::Image::LoadFromMemory </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t </td>
<td class="paramname"> <em>SizeInBytes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Load the image from a file in memory.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Data</em> </td><td>: Pointer to the file data in memory </td></tr>
<tr><td valign="top"></td><td valign="top"><em>SizeInBytes</em> </td><td>: Size of the data to load, in bytes</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if loading was successful </dd></dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00145">145</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="67d65c552c9bcba989a061e9c5b5d10c"></a><!-- doxytag: member="sf::Image::LoadFromPixels" ref="67d65c552c9bcba989a061e9c5b5d10c" args="(unsigned int Width, unsigned int Height, const Uint8 *Data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool sf::Image::LoadFromPixels </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>Width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>Height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Uint8 * </td>
<td class="paramname"> <em>Data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Load the image directly from an array of pixels.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Width</em> </td><td>: <a class="el" href="classsf_1_1Image.htm" title="Image is the low-level class for loading and manipulating images.">Image</a> width </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Height</em> </td><td>: <a class="el" href="classsf_1_1Image.htm" title="Image is the low-level class for loading and manipulating images.">Image</a> height </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Data</em> </td><td>: Pointer to the pixels in memory (assumed format is RGBA)</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if loading was successful </dd></dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00174">174</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="5f9927e407bbe34172553ecfff2f54f3"></a><!-- doxytag: member="sf::Image::operator=" ref="5f9927e407bbe34172553ecfff2f54f3" args="(const Image &Other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Image.htm">Image</a> & sf::Image::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1Image.htm">Image</a> & </td>
<td class="paramname"> <em>Other</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assignment operator.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Other</em> </td><td>: instance to assign</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to the image </dd></dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00585">585</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="50eed54ef8e9f3aeef5bb7f19144aa08"></a><!-- doxytag: member="sf::Image::SaveToFile" ref="50eed54ef8e9f3aeef5bb7f19144aa08" args="(const std::string &Filename) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool sf::Image::SaveToFile </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>Filename</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Save the content of the image to a file.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Filename</em> </td><td>: Path of the file to save (overwritten if already exist)</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if saving was successful </dd></dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00209">209</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="623f2379b30307b4ee4eb08d517d9584"></a><!-- doxytag: member="sf::Image::SetPixel" ref="623f2379b30307b4ee4eb08d517d9584" args="(unsigned int X, unsigned int Y, const Color &Col)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Image::SetPixel </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>X</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>Y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsf_1_1Color.htm">Color</a> & </td>
<td class="paramname"> <em>Col</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Change the color of a pixel.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>X</em> </td><td>: X coordinate of pixel in the image </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Y</em> </td><td>: Y coordinate of pixel in the image </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Col</em> </td><td>: New color for pixel (X, Y) </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00408">408</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="d167422fd331cd069674391fb16e8452"></a><!-- doxytag: member="sf::Image::SetSmooth" ref="d167422fd331cd069674391fb16e8452" args="(bool Smooth)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Image::SetSmooth </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>Smooth</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Enable or disable image smooth filter.
<p>
Enable or disable image smoothing filter.<p>
This parameter is enabled by default<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Smooth</em> </td><td>: True to enable smoothing filter, false to disable it </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="Image_8cpp-source.htm#l00490">490</a> of file <a class="el" href="Image_8cpp-source.htm">Image.cpp</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Image_8hpp-source.htm">Image.hpp</a><li><a class="el" href="Image_8cpp-source.htm">Image.cpp</a></ul>
</div>
<p id="footer">
:: Copyright © 2007-2008 Laurent Gomila, all rights reserved ::
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.5.2</a> ::
</p>
</body>
</html>
|