-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclass_t_c_o_d_image.html
1314 lines (1236 loc) · 73.3 KB
/
class_t_c_o_d_image.html
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
<!-- HTML header for doxygen 1.9.5-->
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-772NXFFJ4E"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() { dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'G-772NXFFJ4E');
</script>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=11" />
<meta name="generator" content="Doxygen 1.9.5" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>libtcod: TCODImage 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>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
DoxygenAwesomeFragmentCopyButton.init()
DoxygenAwesomeParagraphLink.init()
DoxygenAwesomeInteractiveToc.init()
</script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.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 id="projectrow">
<td id="projectalign">
<div id="projectname">libtcod
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('class_t_c_o_d_image.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#friends">Friends</a> |
<a href="class_t_c_o_d_image-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">TCODImage Class Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad6a837f88ed553aac64195a988f9dfc6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#ad6a837f88ed553aac64195a988f9dfc6">TCODImage</a> () noexcept=default</td></tr>
<tr class="memdesc:ad6a837f88ed553aac64195a988f9dfc6"><td class="mdescLeft"> </td><td class="mdescRight">Default constructs an image. This will be in a partially invalid state until assigned a real image. <a href="class_t_c_o_d_image.html#ad6a837f88ed553aac64195a988f9dfc6">More...</a><br /></td></tr>
<tr class="separator:ad6a837f88ed553aac64195a988f9dfc6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55feb97dd472600882c5c4cb4209854b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#a55feb97dd472600882c5c4cb4209854b">TCODImage</a> (int width, int height)</td></tr>
<tr class="memdesc:a55feb97dd472600882c5c4cb4209854b"><td class="mdescLeft"> </td><td class="mdescRight">You can create an image of any size, filled with black with this function. <a href="class_t_c_o_d_image.html#a55feb97dd472600882c5c4cb4209854b">More...</a><br /></td></tr>
<tr class="separator:a55feb97dd472600882c5c4cb4209854b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac63eaa0b730365bccd961b4e1d5e9815"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#ac63eaa0b730365bccd961b4e1d5e9815">TCODImage</a> (const char *filename)</td></tr>
<tr class="memdesc:ac63eaa0b730365bccd961b4e1d5e9815"><td class="mdescLeft"> </td><td class="mdescRight">You can read data from a .bmp or .png file (for example to draw an image using the background color of the console cells). <a href="class_t_c_o_d_image.html#ac63eaa0b730365bccd961b4e1d5e9815">More...</a><br /></td></tr>
<tr class="separator:ac63eaa0b730365bccd961b4e1d5e9815"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a209919c8757a1785df23bdcd6ee74054"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#a209919c8757a1785df23bdcd6ee74054">TCODImage</a> (const <a class="el" href="class_t_c_o_d_console.html">TCODConsole</a> *console)</td></tr>
<tr class="memdesc:a209919c8757a1785df23bdcd6ee74054"><td class="mdescLeft"> </td><td class="mdescRight">You can create an image from any console (either the root console or an offscreen console). <a href="class_t_c_o_d_image.html#a209919c8757a1785df23bdcd6ee74054">More...</a><br /></td></tr>
<tr class="separator:a209919c8757a1785df23bdcd6ee74054"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a21938d82e07462788df451bad7f1e330"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#a21938d82e07462788df451bad7f1e330">TCODImage</a> (<a class="el" href="namespacetcod.html#a60aff2039e431841c88ccbfd389b09d3">tcod::ImagePtr</a> image) noexcept</td></tr>
<tr class="memdesc:a21938d82e07462788df451bad7f1e330"><td class="mdescLeft"> </td><td class="mdescRight">Take ownership of an image pointer. <a href="class_t_c_o_d_image.html#a21938d82e07462788df451bad7f1e330">More...</a><br /></td></tr>
<tr class="separator:a21938d82e07462788df451bad7f1e330"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0cb925f2447204dcda81fab465470f03"><td class="memItemLeft" align="right" valign="top"><a id="a0cb925f2447204dcda81fab465470f03" name="a0cb925f2447204dcda81fab465470f03"></a>
 </td><td class="memItemRight" valign="bottom"><b>TCODImage</b> (const <a class="el" href="class_t_c_o_d_image.html">TCODImage</a> &)=delete</td></tr>
<tr class="separator:a0cb925f2447204dcda81fab465470f03"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a37123e32a8f2bd9e7cf0da6a99e8e451"><td class="memItemLeft" align="right" valign="top"><a id="a37123e32a8f2bd9e7cf0da6a99e8e451" name="a37123e32a8f2bd9e7cf0da6a99e8e451"></a>
<a class="el" href="class_t_c_o_d_image.html">TCODImage</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="class_t_c_o_d_image.html">TCODImage</a> &)=delete</td></tr>
<tr class="separator:a37123e32a8f2bd9e7cf0da6a99e8e451"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad379c454324f6c8a9c35533548458db"><td class="memItemLeft" align="right" valign="top"><a id="aad379c454324f6c8a9c35533548458db" name="aad379c454324f6c8a9c35533548458db"></a>
 </td><td class="memItemRight" valign="bottom"><b>TCODImage</b> (<a class="el" href="class_t_c_o_d_image.html">TCODImage</a> &&rhs) noexcept</td></tr>
<tr class="separator:aad379c454324f6c8a9c35533548458db"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7f62ec9224c89f9f7f640468006b5e6d"><td class="memItemLeft" align="right" valign="top"><a id="a7f62ec9224c89f9f7f640468006b5e6d" name="a7f62ec9224c89f9f7f640468006b5e6d"></a>
<a class="el" href="class_t_c_o_d_image.html">TCODImage</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="class_t_c_o_d_image.html">TCODImage</a> &&rhs) noexcept</td></tr>
<tr class="separator:a7f62ec9224c89f9f7f640468006b5e6d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ab4ff67a62f886acb85e4daacd39893"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#a5ab4ff67a62f886acb85e4daacd39893">TCODImage</a> (const <a class="el" href="classtcod_1_1_matrix.html">tcod::Matrix</a>< <a class="el" href="struct_t_c_o_d___color_r_g_b.html">TCOD_ColorRGB</a>, 2 > &pixels)</td></tr>
<tr class="memdesc:a5ab4ff67a62f886acb85e4daacd39893"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new <a class="el" href="class_t_c_o_d_image.html">TCODImage</a> object from a Matrix of pixels. <a href="class_t_c_o_d_image.html#a5ab4ff67a62f886acb85e4daacd39893">More...</a><br /></td></tr>
<tr class="separator:a5ab4ff67a62f886acb85e4daacd39893"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe4afbfa14d6843b94001a3de23d5aae"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#afe4afbfa14d6843b94001a3de23d5aae">refreshConsole</a> (const <a class="el" href="class_t_c_o_d_console.html">TCODConsole</a> *console)</td></tr>
<tr class="memdesc:afe4afbfa14d6843b94001a3de23d5aae"><td class="mdescLeft"> </td><td class="mdescRight">If you need to refresh the image with the console's new content, you don't have to delete it and create another one. <a href="class_t_c_o_d_image.html#afe4afbfa14d6843b94001a3de23d5aae">More...</a><br /></td></tr>
<tr class="separator:afe4afbfa14d6843b94001a3de23d5aae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae4e876ce09f45b145d447eba4930978a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#ae4e876ce09f45b145d447eba4930978a">getSize</a> (int *w, int *h) const</td></tr>
<tr class="memdesc:ae4e876ce09f45b145d447eba4930978a"><td class="mdescLeft"> </td><td class="mdescRight">You can read the size of an image in pixels with this function. <a href="class_t_c_o_d_image.html#ae4e876ce09f45b145d447eba4930978a">More...</a><br /></td></tr>
<tr class="separator:ae4e876ce09f45b145d447eba4930978a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05c4c03d90eabbde640637754a861967"><td class="memItemLeft" align="right" valign="top">auto </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#a05c4c03d90eabbde640637754a861967">getSize</a> () const noexcept -> std::array< int, 2 ></td></tr>
<tr class="memdesc:a05c4c03d90eabbde640637754a861967"><td class="mdescLeft"> </td><td class="mdescRight">Get the {width, height} of this image. <a href="class_t_c_o_d_image.html#a05c4c03d90eabbde640637754a861967">More...</a><br /></td></tr>
<tr class="separator:a05c4c03d90eabbde640637754a861967"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7dcf01947125c753231e95a2ea09d5d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_t_c_o_d_color.html">TCODColor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#af7dcf01947125c753231e95a2ea09d5d">getPixel</a> (int x, int y) const</td></tr>
<tr class="memdesc:af7dcf01947125c753231e95a2ea09d5d"><td class="mdescLeft"> </td><td class="mdescRight">You can read the colors from an image with this function. <a href="class_t_c_o_d_image.html#af7dcf01947125c753231e95a2ea09d5d">More...</a><br /></td></tr>
<tr class="separator:af7dcf01947125c753231e95a2ea09d5d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e5c4213dc373792279550d926d420af"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#a5e5c4213dc373792279550d926d420af">getAlpha</a> (int x, int y) const</td></tr>
<tr class="memdesc:a5e5c4213dc373792279550d926d420af"><td class="mdescLeft"> </td><td class="mdescRight">If you have set a key color for this image with setKeyColor, or if this image was created from a 32 bits PNG file (with alpha layer), you can get the pixel transparency with this function. <a href="class_t_c_o_d_image.html#a5e5c4213dc373792279550d926d420af">More...</a><br /></td></tr>
<tr class="separator:a5e5c4213dc373792279550d926d420af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a67a64055fb50352c25434e27c3c8bb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#a1a67a64055fb50352c25434e27c3c8bb">isPixelTransparent</a> (int x, int y) const</td></tr>
<tr class="memdesc:a1a67a64055fb50352c25434e27c3c8bb"><td class="mdescLeft"> </td><td class="mdescRight">You can use this simpler version (for images with alpha layer, returns true only if alpha == 0) : <a href="class_t_c_o_d_image.html#a1a67a64055fb50352c25434e27c3c8bb">More...</a><br /></td></tr>
<tr class="separator:a1a67a64055fb50352c25434e27c3c8bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac88492f98efb7012af4a20d060f4375e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_t_c_o_d_color.html">TCODColor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#ac88492f98efb7012af4a20d060f4375e">getMipmapPixel</a> (float x0, float y0, float x1, float y1)</td></tr>
<tr class="memdesc:ac88492f98efb7012af4a20d060f4375e"><td class="mdescLeft"> </td><td class="mdescRight">This method uses mipmaps to get the average color of an arbitrary rectangular region of the image. <a href="class_t_c_o_d_image.html#ac88492f98efb7012af4a20d060f4375e">More...</a><br /></td></tr>
<tr class="separator:ac88492f98efb7012af4a20d060f4375e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba15ba4e07d4060c74892e2cb1e621a3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#aba15ba4e07d4060c74892e2cb1e621a3">clear</a> (const <a class="el" href="class_t_c_o_d_color.html">TCODColor</a> col)</td></tr>
<tr class="memdesc:aba15ba4e07d4060c74892e2cb1e621a3"><td class="mdescLeft"> </td><td class="mdescRight">You can fill the whole image with a color with : <a href="class_t_c_o_d_image.html#aba15ba4e07d4060c74892e2cb1e621a3">More...</a><br /></td></tr>
<tr class="separator:aba15ba4e07d4060c74892e2cb1e621a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b2d26132c1e8c7819e057bb1a3f83fa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#a8b2d26132c1e8c7819e057bb1a3f83fa">putPixel</a> (int x, int y, const <a class="el" href="class_t_c_o_d_color.html">TCODColor</a> col)</td></tr>
<tr class="separator:a8b2d26132c1e8c7819e057bb1a3f83fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a75f4c30a94a17ffe1aaea919469f054d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#a75f4c30a94a17ffe1aaea919469f054d">scale</a> (int new_w, int new_h)</td></tr>
<tr class="memdesc:a75f4c30a94a17ffe1aaea919469f054d"><td class="mdescLeft"> </td><td class="mdescRight">You can resize an image and scale its content. <a href="class_t_c_o_d_image.html#a75f4c30a94a17ffe1aaea919469f054d">More...</a><br /></td></tr>
<tr class="separator:a75f4c30a94a17ffe1aaea919469f054d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a326e1dcae3b16b7c5be28d6bb410ab82"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#a326e1dcae3b16b7c5be28d6bb410ab82">hflip</a> ()</td></tr>
<tr class="separator:a326e1dcae3b16b7c5be28d6bb410ab82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a726614309908c848e3b35f8895e740cb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#a726614309908c848e3b35f8895e740cb">vflip</a> ()</td></tr>
<tr class="separator:a726614309908c848e3b35f8895e740cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a7317338117a84ce86fe77c8a75b704"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#a3a7317338117a84ce86fe77c8a75b704">rotate90</a> (int numRotations=1)</td></tr>
<tr class="memdesc:a3a7317338117a84ce86fe77c8a75b704"><td class="mdescLeft"> </td><td class="mdescRight">Rotate the image clockwise by increment of 90 degrees. <a href="class_t_c_o_d_image.html#a3a7317338117a84ce86fe77c8a75b704">More...</a><br /></td></tr>
<tr class="separator:a3a7317338117a84ce86fe77c8a75b704"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd3a55e3f92a5e395b878339331ddd99"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#acd3a55e3f92a5e395b878339331ddd99">invert</a> ()</td></tr>
<tr class="separator:acd3a55e3f92a5e395b878339331ddd99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8ef8d22f312985da67c10a0fb57d294"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#ac8ef8d22f312985da67c10a0fb57d294">save</a> (const char *filename) const</td></tr>
<tr class="separator:ac8ef8d22f312985da67c10a0fb57d294"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4cd89fd4d7c4c66a8c6bfec7160198d0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#a4cd89fd4d7c4c66a8c6bfec7160198d0">blitRect</a> (<a class="el" href="class_t_c_o_d_console.html">TCODConsole</a> *console, int x, int y, int w=-1, int h=-1, <a class="el" href="group___console.html#ga70f9ab275163943d9149cbdd9c12a894">TCOD_bkgnd_flag_t</a> bkgnd_flag=TCOD_BKGND_SET) const</td></tr>
<tr class="memdesc:a4cd89fd4d7c4c66a8c6bfec7160198d0"><td class="mdescLeft"> </td><td class="mdescRight">This function blits a rectangular part of the image on a console without scaling it or rotating it. <a href="class_t_c_o_d_image.html#a4cd89fd4d7c4c66a8c6bfec7160198d0">More...</a><br /></td></tr>
<tr class="separator:a4cd89fd4d7c4c66a8c6bfec7160198d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a48db685cad3f13f057663b8ead475fee"><td class="memItemLeft" align="right" valign="top"><a id="a48db685cad3f13f057663b8ead475fee" name="a48db685cad3f13f057663b8ead475fee"></a>
void </td><td class="memItemRight" valign="bottom"><b>blitRect</b> (<a class="el" href="struct_t_c_o_d___console.html">TCOD_Console</a> &console, int x, int y, int w=-1, int h=-1, <a class="el" href="group___console.html#ga70f9ab275163943d9149cbdd9c12a894">TCOD_bkgnd_flag_t</a> bkgnd_flag=TCOD_BKGND_SET) const</td></tr>
<tr class="separator:a48db685cad3f13f057663b8ead475fee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a26367a243d5c264df352ea46b8aeaf8a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#a26367a243d5c264df352ea46b8aeaf8a">blit</a> (<a class="el" href="class_t_c_o_d_console.html">TCODConsole</a> *console, float x, float y, <a class="el" href="group___console.html#ga70f9ab275163943d9149cbdd9c12a894">TCOD_bkgnd_flag_t</a> bkgnd_flag=TCOD_BKGND_SET, float scale_x=1.0f, float scale_y=1.0f, float angle=0.0f) const</td></tr>
<tr class="memdesc:a26367a243d5c264df352ea46b8aeaf8a"><td class="mdescLeft"> </td><td class="mdescRight">This function allows you to specify the floating point coordinates of the center of the image, its scale and its rotation angle. <a href="class_t_c_o_d_image.html#a26367a243d5c264df352ea46b8aeaf8a">More...</a><br /></td></tr>
<tr class="separator:a26367a243d5c264df352ea46b8aeaf8a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab9d344fe02a8a27cd0452757236d117f"><td class="memItemLeft" align="right" valign="top"><a id="ab9d344fe02a8a27cd0452757236d117f" name="ab9d344fe02a8a27cd0452757236d117f"></a>
void </td><td class="memItemRight" valign="bottom"><b>blit</b> (<a class="el" href="struct_t_c_o_d___console.html">TCOD_Console</a> &console, float x, float y, <a class="el" href="group___console.html#ga70f9ab275163943d9149cbdd9c12a894">TCOD_bkgnd_flag_t</a> bkgnd_flag=TCOD_BKGND_SET, float scale_x=1.0f, float scale_y=1.0f, float angle=0.0f) const</td></tr>
<tr class="separator:ab9d344fe02a8a27cd0452757236d117f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6a2d9086ba39d9c65dc8b2a26448caf3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#a6a2d9086ba39d9c65dc8b2a26448caf3">setKeyColor</a> (const <a class="el" href="class_t_c_o_d_color.html">TCODColor</a> keyColor)</td></tr>
<tr class="memdesc:a6a2d9086ba39d9c65dc8b2a26448caf3"><td class="mdescLeft"> </td><td class="mdescRight">When blitting an image, you can define a key color that will be ignored by the blitting function. <a href="class_t_c_o_d_image.html#a6a2d9086ba39d9c65dc8b2a26448caf3">More...</a><br /></td></tr>
<tr class="separator:a6a2d9086ba39d9c65dc8b2a26448caf3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a01bbcfb782db3feacff0f95c510f0eda"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#a01bbcfb782db3feacff0f95c510f0eda">blit2x</a> (<a class="el" href="class_t_c_o_d_console.html">TCODConsole</a> *dest, int dx, int dy, int sx=0, int sy=0, int w=-1, int h=-1) const</td></tr>
<tr class="memdesc:a01bbcfb782db3feacff0f95c510f0eda"><td class="mdescLeft"> </td><td class="mdescRight">Eventually, you can use some special characters in the libtcod fonts : <a href="class_t_c_o_d_image.html#a01bbcfb782db3feacff0f95c510f0eda">More...</a><br /></td></tr>
<tr class="separator:a01bbcfb782db3feacff0f95c510f0eda"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada7f5ca6549cd4a4ecf68f27968e93eb"><td class="memItemLeft" align="right" valign="top"><a id="ada7f5ca6549cd4a4ecf68f27968e93eb" name="ada7f5ca6549cd4a4ecf68f27968e93eb"></a>
void </td><td class="memItemRight" valign="bottom"><b>blit2x</b> (<a class="el" href="struct_t_c_o_d___console.html">TCOD_Console</a> &dest, int dx, int dy, int sx=0, int sy=0, int w=-1, int h=-1) const</td></tr>
<tr class="separator:ada7f5ca6549cd4a4ecf68f27968e93eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a72894f9ae6455cf6a6904d1803cfd250"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_t_c_o_d___image.html">TCOD_Image</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#a72894f9ae6455cf6a6904d1803cfd250">get_data</a> () noexcept</td></tr>
<tr class="memdesc:a72894f9ae6455cf6a6904d1803cfd250"><td class="mdescLeft"> </td><td class="mdescRight">Return the pointer to this objects <a class="el" href="struct_t_c_o_d___image.html">TCOD_Image</a> data. <a href="class_t_c_o_d_image.html#a72894f9ae6455cf6a6904d1803cfd250">More...</a><br /></td></tr>
<tr class="separator:a72894f9ae6455cf6a6904d1803cfd250"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae763fc4f0326f71630d95ff6a39a292c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct_t_c_o_d___image.html">TCOD_Image</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#ae763fc4f0326f71630d95ff6a39a292c">get_data</a> () const noexcept</td></tr>
<tr class="memdesc:ae763fc4f0326f71630d95ff6a39a292c"><td class="mdescLeft"> </td><td class="mdescRight">Return the const pointer to this objects <a class="el" href="struct_t_c_o_d___image.html">TCOD_Image</a> data. <a href="class_t_c_o_d_image.html#ae763fc4f0326f71630d95ff6a39a292c">More...</a><br /></td></tr>
<tr class="separator:ae763fc4f0326f71630d95ff6a39a292c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35c89c7e4465e4e52bcfd9c4b1c02ea0"><td class="memItemLeft" align="right" valign="top"><a id="a35c89c7e4465e4e52bcfd9c4b1c02ea0" name="a35c89c7e4465e4e52bcfd9c4b1c02ea0"></a>
 </td><td class="memItemRight" valign="bottom"><b>TCODImage</b> (<a class="el" href="struct_t_c_o_d___image.html">TCOD_image_t</a> img)</td></tr>
<tr class="separator:a35c89c7e4465e4e52bcfd9c4b1c02ea0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a875264d7d61fc96e8914f55a6d513d43"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#a875264d7d61fc96e8914f55a6d513d43">operator TCOD_Image &</a> ()</td></tr>
<tr class="memdesc:a875264d7d61fc96e8914f55a6d513d43"><td class="mdescLeft"> </td><td class="mdescRight">Allow implicit conversions to <a class="el" href="struct_t_c_o_d___image.html">TCOD_Image</a>&. <a href="class_t_c_o_d_image.html#a875264d7d61fc96e8914f55a6d513d43">More...</a><br /></td></tr>
<tr class="separator:a875264d7d61fc96e8914f55a6d513d43"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1032d6388a53269cc1c11cfe2e328147"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_image.html#a1032d6388a53269cc1c11cfe2e328147">operator const TCOD_Image &</a> () const</td></tr>
<tr class="memdesc:a1032d6388a53269cc1c11cfe2e328147"><td class="mdescLeft"> </td><td class="mdescRight">Allow implicit conversions to const <a class="el" href="struct_t_c_o_d___image.html">TCOD_Image</a>&. <a href="class_t_c_o_d_image.html#a1032d6388a53269cc1c11cfe2e328147">More...</a><br /></td></tr>
<tr class="separator:a1032d6388a53269cc1c11cfe2e328147"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ae320701874ed5a790b86e4e2493db185"><td class="memItemLeft" align="right" valign="top"><a id="ae320701874ed5a790b86e4e2493db185" name="ae320701874ed5a790b86e4e2493db185"></a>
struct <a class="el" href="struct_t_c_o_d___image.html">TCOD_Image</a> * </td><td class="memItemRight" valign="bottom"><b>data</b> {nullptr}</td></tr>
<tr class="separator:ae320701874ed5a790b86e4e2493db185"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2033069914b7a489943c997227784a32"><td class="memItemLeft" align="right" valign="top"><a id="a2033069914b7a489943c997227784a32" name="a2033069914b7a489943c997227784a32"></a>
bool </td><td class="memItemRight" valign="bottom"><b>deleteData</b> {false}</td></tr>
<tr class="separator:a2033069914b7a489943c997227784a32"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a2b899140eaafc7d97c3cfb659fb9cbe6"><td class="memItemLeft" align="right" valign="top"><a id="a2b899140eaafc7d97c3cfb659fb9cbe6" name="a2b899140eaafc7d97c3cfb659fb9cbe6"></a>
class </td><td class="memItemRight" valign="bottom"><b>TCODSystem</b></td></tr>
<tr class="separator:a2b899140eaafc7d97c3cfb659fb9cbe6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac770f3d1dc8721458f2fba78a24cdcec"><td class="memItemLeft" align="right" valign="top"><a id="ac770f3d1dc8721458f2fba78a24cdcec" name="ac770f3d1dc8721458f2fba78a24cdcec"></a>
class </td><td class="memItemRight" valign="bottom"><b>TCODZip</b></td></tr>
<tr class="separator:ac770f3d1dc8721458f2fba78a24cdcec"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ad6a837f88ed553aac64195a988f9dfc6" name="ad6a837f88ed553aac64195a988f9dfc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6a837f88ed553aac64195a988f9dfc6">◆ </a></span>TCODImage() <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">TCODImage::TCODImage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructs an image. This will be in a partially invalid state until assigned a real image. </p>
<p >This toolkit contains some image manipulation utilities. </p>
</div>
</div>
<a id="a55feb97dd472600882c5c4cb4209854b" name="a55feb97dd472600882c5c4cb4209854b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55feb97dd472600882c5c4cb4209854b">◆ </a></span>TCODImage() <span class="overload">[2/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TCODImage::TCODImage </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>You can create an image of any size, filled with black with this function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">width,height</td><td>Size of the image in pixels. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac63eaa0b730365bccd961b4e1d5e9815" name="ac63eaa0b730365bccd961b4e1d5e9815"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac63eaa0b730365bccd961b4e1d5e9815">◆ </a></span>TCODImage() <span class="overload">[3/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TCODImage::TCODImage </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>You can read data from a .bmp or .png file (for example to draw an image using the background color of the console cells). </p>
<p >Note that only 24bits and 32bits PNG files are currently supported.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>Name of the .bmp or .png file to load. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a209919c8757a1785df23bdcd6ee74054" name="a209919c8757a1785df23bdcd6ee74054"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a209919c8757a1785df23bdcd6ee74054">◆ </a></span>TCODImage() <span class="overload">[4/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TCODImage::TCODImage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_t_c_o_d_console.html">TCODConsole</a> * </td>
<td class="paramname"><em>console</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>You can create an image from any console (either the root console or an offscreen console). </p>
<p >The image size will depend on the console size and the font characters size. You can then save the image to a file with the save function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">console</td><td>The console to convert. In the C version, use NULL for the root console. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a21938d82e07462788df451bad7f1e330" name="a21938d82e07462788df451bad7f1e330"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21938d82e07462788df451bad7f1e330">◆ </a></span>TCODImage() <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">TCODImage::TCODImage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacetcod.html#a60aff2039e431841c88ccbfd389b09d3">tcod::ImagePtr</a> </td>
<td class="paramname"><em>image</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Take ownership of an image pointer. </p>
<pre class="fragment">embed:rst:leading-asterisk
.. versionadded:: Unreleased
</pre>
</div>
</div>
<a id="a5ab4ff67a62f886acb85e4daacd39893" name="a5ab4ff67a62f886acb85e4daacd39893"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ab4ff67a62f886acb85e4daacd39893">◆ </a></span>TCODImage() <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">TCODImage::TCODImage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classtcod_1_1_matrix.html">tcod::Matrix</a>< <a class="el" href="struct_t_c_o_d___color_r_g_b.html">TCOD_ColorRGB</a>, 2 > & </td>
<td class="paramname"><em>pixels</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a new <a class="el" href="class_t_c_o_d_image.html">TCODImage</a> object from a Matrix of pixels. </p>
<p >This constructor is provisional.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pixels</td><td>A 2D matrix of RGB pixels. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a26367a243d5c264df352ea46b8aeaf8a" name="a26367a243d5c264df352ea46b8aeaf8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26367a243d5c264df352ea46b8aeaf8a">◆ </a></span>blit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCODImage::blit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_t_c_o_d_console.html">TCODConsole</a> * </td>
<td class="paramname"><em>console</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___console.html#ga70f9ab275163943d9149cbdd9c12a894">TCOD_bkgnd_flag_t</a> </td>
<td class="paramname"><em>bkgnd_flag</em> = <code>TCOD_BKGND_SET</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>scale_x</em> = <code>1.0f</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>scale_y</em> = <code>1.0f</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>angle</em> = <code>0.0f</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function allows you to specify the floating point coordinates of the center of the image, its scale and its rotation angle. </p>
<p >void TCODImage::blit(TCODConsole console, float x, float y) void TCODImage::blit(TCODConsole console, float x, float y, TCODBackgroundFlag bkgnd_flag) void TCODImage::blit(TCODConsole console, float x, float y, TCODBackgroundFlag bkgnd_flag, float scale_x) void TCODImage::blit(TCODConsole console, float x, float y, TCODBackgroundFlag bkgnd_flag, float scale_x, float scale_y) void TCODImage::blit(TCODConsole console, float x, float y, TCODBackgroundFlag bkgnd_flag, float scale_x, float scale_y, float angle) </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>In the C version, the image handler, obtained with the load function. </td></tr>
<tr><td class="paramname">console</td><td>The console on which the image will be drawn. In the C version, use NULL for the root console. </td></tr>
<tr><td class="paramname">x,y</td><td>Coordinates in the console of the center of the image. </td></tr>
<tr><td class="paramname">flag</td><td>This flag defines how the cell's background color is modified. See TCOD_bkgnd_flag_t. </td></tr>
<tr><td class="paramname">scale_x,scale_y</td><td>Scale coefficient. Must be > 0.0. </td></tr>
<tr><td class="paramname">angle</td><td>Rotation angle in radians. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a01bbcfb782db3feacff0f95c510f0eda" name="a01bbcfb782db3feacff0f95c510f0eda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01bbcfb782db3feacff0f95c510f0eda">◆ </a></span>blit2x()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCODImage::blit2x </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_t_c_o_d_console.html">TCODConsole</a> * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>dx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>dy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>sx</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>sy</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>w</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>h</em> = <code>-1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Eventually, you can use some special characters in the libtcod fonts : </p>
<p ><img src="subcell.png" alt="" class="inline"/> to double the console resolution using this blitting function. </p><table class="doxtable">
<tr>
<td>Comparison before/after subcell resolution in TCOD :<br />
<img src="subcell_comp.png" alt="" class="inline"/></td><td>Pyromancer ! screenshot, making full usage of subcell resolution :<br />
<img src="subcell_pyro.png" alt="" class="inline"/></td></tr>
</table>
<p >void TCODImage::blit2x(TCODConsole dest, int dx, int dy); void TCODImage::blit2x(TCODConsole dest, int dx, int dy, int sx); void TCODImage::blit2x(TCODConsole dest, int dx, int dy, int sx, int sy); void TCODImage::blit2x(TCODConsole dest, int dx, int dy, int sx, int sy, int w); void TCODImage::blit2x(TCODConsole dest, int dx, int dy, int sx, int sy, int w, int h); </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>In the C and Python version, the image handler, obtained with the load function. </td></tr>
<tr><td class="paramname">dest</td><td>The console of which the image will be blitted. Foreground, background and character data will be overwritten. </td></tr>
<tr><td class="paramname">dx,dy</td><td>Coordinate of the console cell where the upper left corner of the blitted image will be. </td></tr>
<tr><td class="paramname">sx,sy,w,h</td><td>Part of the image to blit. Use -1 in w and h to blit the whole image. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4cd89fd4d7c4c66a8c6bfec7160198d0" name="a4cd89fd4d7c4c66a8c6bfec7160198d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4cd89fd4d7c4c66a8c6bfec7160198d0">◆ </a></span>blitRect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCODImage::blitRect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_t_c_o_d_console.html">TCODConsole</a> * </td>
<td class="paramname"><em>console</em>, </td>
</tr>
<tr>
<td class="paramkey"></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">int </td>
<td class="paramname"><em>w</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>h</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___console.html#ga70f9ab275163943d9149cbdd9c12a894">TCOD_bkgnd_flag_t</a> </td>
<td class="paramname"><em>bkgnd_flag</em> = <code>TCOD_BKGND_SET</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function blits a rectangular part of the image on a console without scaling it or rotating it. </p>
<p >Each pixel of the image fills a console cell.</p>
<p >void TCODImage::blitRect(TCODConsole console, int x, int y) void TCODImage::blitRect(TCODConsole console, int x, int y, int w) void TCODImage::blitRect(TCODConsole console, int x, int y, int w, int h) void TCODImage::blitRect(TCODConsole console, int x, int y, int w, int h, TCODBackgroundFlag bkgnd_flag) </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>In the C version, the image handler, obtained with the load function. </td></tr>
<tr><td class="paramname">console</td><td>The console on which the image will be drawn. In the C version, use NULL for the root console. </td></tr>
<tr><td class="paramname">x,y</td><td>Coordinates in the console of the upper-left corner of the image. </td></tr>
<tr><td class="paramname">w,h</td><td>Dimension of the image on the console. Use -1,-1 to use the image size. </td></tr>
<tr><td class="paramname">flag</td><td>This flag defines how the cell's background color is modified. See TCOD_bkgnd_flag_t. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aba15ba4e07d4060c74892e2cb1e621a3" name="aba15ba4e07d4060c74892e2cb1e621a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba15ba4e07d4060c74892e2cb1e621a3">◆ </a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCODImage::clear </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_t_c_o_d_color.html">TCODColor</a> </td>
<td class="paramname"><em>col</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>You can fill the whole image with a color with : </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>In the C and Python version, the image to fill. </td></tr>
<tr><td class="paramname">color</td><td>The color to use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae763fc4f0326f71630d95ff6a39a292c" name="ae763fc4f0326f71630d95ff6a39a292c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae763fc4f0326f71630d95ff6a39a292c">◆ </a></span>get_data() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="struct_t_c_o_d___image.html">TCOD_Image</a> * TCODImage::get_data </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">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the const pointer to this objects <a class="el" href="struct_t_c_o_d___image.html">TCOD_Image</a> data. </p>
<pre class="fragment">embed:rst:leading-asterisk
.. versionadded:: 1.17
</pre>
</div>
</div>
<a id="a72894f9ae6455cf6a6904d1803cfd250" name="a72894f9ae6455cf6a6904d1803cfd250"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72894f9ae6455cf6a6904d1803cfd250">◆ </a></span>get_data() <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="struct_t_c_o_d___image.html">TCOD_Image</a> * TCODImage::get_data </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the pointer to this objects <a class="el" href="struct_t_c_o_d___image.html">TCOD_Image</a> data. </p>
<pre class="fragment">embed:rst:leading-asterisk
.. versionadded:: 1.17
</pre>
</div>
</div>
<a id="a5e5c4213dc373792279550d926d420af" name="a5e5c4213dc373792279550d926d420af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e5c4213dc373792279550d926d420af">◆ </a></span>getAlpha()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int TCODImage::getAlpha </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>If you have set a key color for this image with setKeyColor, or if this image was created from a 32 bits PNG file (with alpha layer), you can get the pixel transparency with this function. </p>
<p >This function returns a value between 0 (transparent pixel) and 255 (opaque pixel).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>In the C and Python version, the image handler, obtained with the load function. </td></tr>
<tr><td class="paramname">x,y</td><td>The pixel coordinates inside the image. 0 <= x < width 0 <= y < height </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac88492f98efb7012af4a20d060f4375e" name="ac88492f98efb7012af4a20d060f4375e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac88492f98efb7012af4a20d060f4375e">◆ </a></span>getMipmapPixel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_t_c_o_d_color.html">TCODColor</a> TCODImage::getMipmapPixel </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>x0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>y0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>x1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>y1</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This method uses mipmaps to get the average color of an arbitrary rectangular region of the image. </p>
<p >It can be used to draw a scaled-down version of the image. It's used by libtcod's blitting functions.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>In the C version, the image handler, obtained with the load function. </td></tr>
<tr><td class="paramname">x0,y0</td><td>Coordinates in pixels of the upper-left corner of the region. 0.0 <= x0 < x1 0.0 <= y0 < y1 </td></tr>
<tr><td class="paramname">x1,y1</td><td>Coordinates in pixels of the lower-right corner of the region. x0 < x1 < width y0 < y1 < height</td></tr>
</table>
</dd>
</dl>
<p>Get the average color of a 5x5 "superpixel" in the center of the image. <a class="el" href="class_t_c_o_d_image.html">TCODImage</a> *pix = new <a class="el" href="class_t_c_o_d_image.html">TCODImage(80,50)</a>; <a class="el" href="class_t_c_o_d_color.html">TCODColor</a> col=pix->getMipMapPixel(37.5f, 22.5f, 42.5f, 28.5f);</p>
<p >TCOD_image_t pix = TCOD_image_new(80,50); TCOD_color_t col=TCOD_image_get_mipmap_pixel(pix,37.5f, 22.5f, 42.5f, 28.5f);</p>
<p >pix = libtcod.image_new(80,50) col=libtcod.image_get_mipmap_pixel(pix,37.5, 22.5, 42.5, 28.5) </p>
</div>
</div>
<a id="af7dcf01947125c753231e95a2ea09d5d" name="af7dcf01947125c753231e95a2ea09d5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7dcf01947125c753231e95a2ea09d5d">◆ </a></span>getPixel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_t_c_o_d_color.html">TCODColor</a> TCODImage::getPixel </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>You can read the colors from an image with this function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>In the C and Python version, the image handler, obtained with the load function. </td></tr>
<tr><td class="paramname">x,y</td><td>The pixel coordinates inside the image. 0 <= x < width 0 <= y < height</td></tr>
</table>
</dd>
</dl>
<p><a class="el" href="class_t_c_o_d_image.html">TCODImage</a> *pix = new <a class="el" href="class_t_c_o_d_image.html">TCODImage(80,50)</a>; <a class="el" href="class_t_c_o_d_color.html">TCODColor</a> col=pix->getPixel(40,25);</p>
<p >TCOD_image_t pix = TCOD_image_new(80,50); TCOD_color_t col=TCOD_image_get_pixel(pix,40,25);</p>
<p >pix = libtcod.image_new(80,50) col=libtcod.image_get_pixel(pix,40,25) </p>
</div>
</div>
<a id="a05c4c03d90eabbde640637754a861967" name="a05c4c03d90eabbde640637754a861967"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05c4c03d90eabbde640637754a861967">◆ </a></span>getSize() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto TCODImage::getSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const -> std::array<int, 2> </td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the {width, height} of this image. </p>
<pre class="fragment">embed:rst:leading-asterisk
.. versionadded:: Unreleased
</pre>
</div>
</div>
<a id="ae4e876ce09f45b145d447eba4930978a" name="ae4e876ce09f45b145d447eba4930978a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4e876ce09f45b145d447eba4930978a">◆ </a></span>getSize() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCODImage::getSize </td>
<td>(</td>
<td class="paramtype">int * </td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>h</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>You can read the size of an image in pixels with this function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>In the C version, the image handler, obtained with the load function. </td></tr>
<tr><td class="paramname">w,h</td><td>When the function returns, those variables contain the size of the image.</td></tr>
</table>
</dd>
</dl>
<p><a class="el" href="class_t_c_o_d_image.html">TCODImage</a> *pix = new <a class="el" href="class_t_c_o_d_image.html">TCODImage(80,50)</a>; int w,h; pix->getSize(&w,&h); // w = 80, h = 50</p>
<p >TCOD_image_t pix = TCOD_image_new(80,50); int w,h; TCOD_image_get_size(pix,&w,&h); // w = 80, h = 50</p>
<p >pix = libtcod.image_new(80,50) w,h=libtcod.image_get_size(pix) </p>
<h1><a class="anchor" id="autotoc_md20"></a>
w = 80, h = 50</h1>
</div>
</div>
<a id="a326e1dcae3b16b7c5be28d6bb410ab82" name="a326e1dcae3b16b7c5be28d6bb410ab82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a326e1dcae3b16b7c5be28d6bb410ab82">◆ </a></span>hflip()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCODImage::hflip </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>In the C and Python version, the image handler, obtained with the load function. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acd3a55e3f92a5e395b878339331ddd99" name="acd3a55e3f92a5e395b878339331ddd99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd3a55e3f92a5e395b878339331ddd99">◆ </a></span>invert()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TCODImage::invert </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>In the C and Python version, the image handler, obtained with the load function. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1a67a64055fb50352c25434e27c3c8bb" name="a1a67a64055fb50352c25434e27c3c8bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a67a64055fb50352c25434e27c3c8bb">◆ </a></span>isPixelTransparent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool TCODImage::isPixelTransparent </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>