-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_image_8h_source.html
77 lines (77 loc) · 20.5 KB
/
_image_8h_source.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Gamedev Framework (gf): Image.h Source File</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/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="gf_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Gamedev Framework (gf)
 <span id="projectnumber">0.14.0</span>
</div>
<div id="projectbrief">A C++14 framework for 2D games</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_6d069d519ae9d12fa11dd8e685586b60.html">gf</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Image.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Gamedev Framework (gf)</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (C) 2016-2019 Julien Bernard</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This software is provided 'as-is', without any express or implied</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * warranty. In no event will the authors be held liable for any damages</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * arising from the use of this software.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Permission is granted to anyone to use this software for any purpose,</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * including commercial applications, and to alter it and redistribute it</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * freely, subject to the following restrictions:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * 1. The origin of this software must not be misrepresented; you must not</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * claim that you wrote the original software. If you use this software</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * in a product, an acknowledgment in the product documentation would be</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * appreciated but is not required.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * 2. Altered source versions must be plainly marked as such, and must not be</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * misrepresented as being the original software.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * 3. This notice may not be removed or altered from any source distribution.</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> *</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * Part of this file comes from SFML, with the same license:</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * Copyright (C) 2007-2015 Laurent Gomila ([email protected])</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifndef GF_IMAGE_H</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define GF_IMAGE_H</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <cstddef></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "ArrayRef.h"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "Path.h"</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "Portability.h"</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include "Vector.h"</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span><a class="code" href="namespacegf.html">gf</a> {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">inline</span> <span class="keyword">namespace </span>v1 {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">class </span>InputStream;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="group__core.html#gaf9faa55f8d780c38401260afb3e1429e"> 47</a></span>  <span class="keyword">enum</span> <a class="code" href="group__core.html#gaf9faa55f8d780c38401260afb3e1429e">PixelFormat</a> {</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="group__core.html#ggaf9faa55f8d780c38401260afb3e1429ea56423b353be446e7927b0e32c446b9d2"> 48</a></span>  <a class="code" href="group__core.html#ggaf9faa55f8d780c38401260afb3e1429ea56423b353be446e7927b0e32c446b9d2">Rgba32</a>, </div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="group__core.html#ggaf9faa55f8d780c38401260afb3e1429ea703b735d668ecd6be74797caf89fce8d"> 49</a></span>  <a class="code" href="group__core.html#ggaf9faa55f8d780c38401260afb3e1429ea703b735d668ecd6be74797caf89fce8d">Rgb24</a>, </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  };</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="classgf_1_1_image.html"> 80</a></span>  <span class="keyword">class </span>GF_API <a class="code" href="classgf_1_1_image.html">Image</a> {</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="classgf_1_1_image.html">Image</a>();</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="classgf_1_1_image.html">Image</a>(<a class="code" href="structgf_1_1_vector.html">Vector2i</a> size);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <a class="code" href="classgf_1_1_image.html">Image</a>(<a class="code" href="structgf_1_1_vector.html">Vector2i</a> size, <a class="code" href="structgf_1_1_vector_3_01_t_00_014_01_4.html">Color4u</a> color);</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <a class="code" href="classgf_1_1_image.html">Image</a>(<a class="code" href="structgf_1_1_vector.html">Vector2i</a> size, <a class="code" href="structgf_1_1_vector_3_01_t_00_013_01_4.html">Color3u</a> color);</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <a class="code" href="classgf_1_1_image.html">Image</a>(<a class="code" href="structgf_1_1_vector.html">Vector2i</a> size, <span class="keyword">const</span> uint8_t *pixels, <a class="code" href="group__core.html#gaf9faa55f8d780c38401260afb3e1429e">PixelFormat</a> format = <a class="code" href="group__core.html#ggaf9faa55f8d780c38401260afb3e1429ea56423b353be446e7927b0e32c446b9d2">PixelFormat::Rgba32</a>);</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <a class="code" href="classgf_1_1_image.html">Image</a>(<span class="keyword">const</span> <a class="code" href="group__core.html#ga6788e40b762777c1081f796076116a02">Path</a>& filename);</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <a class="code" href="classgf_1_1_image.html">Image</a>(<a class="code" href="classgf_1_1_array_ref.html">ArrayRef<uint8_t></a> content);</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <a class="code" href="classgf_1_1_image.html">Image</a>(<a class="code" href="classgf_1_1_input_stream.html">InputStream</a>& stream);</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <a class="code" href="classgf_1_1_image.html">Image</a>(<span class="keyword">const</span> <a class="code" href="classgf_1_1_image.html">Image</a>&) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <a class="code" href="classgf_1_1_image.html">Image</a>& operator=(<span class="keyword">const</span> <a class="code" href="classgf_1_1_image.html">Image</a>&) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <a class="code" href="classgf_1_1_image.html">Image</a>(<a class="code" href="classgf_1_1_image.html">Image</a>&&) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> </div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <a class="code" href="classgf_1_1_image.html">Image</a>& operator=(<a class="code" href="classgf_1_1_image.html">Image</a>&&) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> </div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <span class="keywordtype">bool</span> saveToFile(<span class="keyword">const</span> <a class="code" href="group__core.html#ga6788e40b762777c1081f796076116a02">Path</a>& filename) <span class="keyword">const</span>;</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> </div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <a class="code" href="structgf_1_1_vector.html">Vector2i</a> getSize() <span class="keyword">const</span>;</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <span class="keywordtype">void</span> createMaskFromColor(<span class="keyword">const</span> <a class="code" href="structgf_1_1_vector_3_01_t_00_014_01_4.html">Color4u</a>& color, uint8_t alpha = 0);</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> </div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  <span class="keywordtype">void</span> setPixel(<a class="code" href="structgf_1_1_vector.html">Vector2i</a> pos, <span class="keyword">const</span> <a class="code" href="structgf_1_1_vector_3_01_t_00_014_01_4.html">Color4u</a>& color);</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> </div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  <a class="code" href="structgf_1_1_vector_3_01_t_00_014_01_4.html">Color4u</a> getPixel(<a class="code" href="structgf_1_1_vector.html">Vector2i</a> pos) <span class="keyword">const</span>;</div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> </div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  <span class="keyword">const</span> uint8_t* getPixelsPtr() <span class="keyword">const</span>;</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span> </div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  <span class="keywordtype">void</span> flipHorizontally();</div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span> </div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  <a class="code" href="structgf_1_1_vector.html">Vector2i</a> m_size;</div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  std::vector<uint8_t> m_pixels;</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> </div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  };</div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> </div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> }</div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> }</div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> </div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="preprocessor">#endif // GF_IMAGE_H</span></div><div class="ttc" id="group__core_html_gaf9faa55f8d780c38401260afb3e1429e"><div class="ttname"><a href="group__core.html#gaf9faa55f8d780c38401260afb3e1429e">gf::PixelFormat</a></div><div class="ttdeci">PixelFormat</div><div class="ttdoc">Pixel format. </div><div class="ttdef"><b>Definition:</b> Image.h:47</div></div>
<div class="ttc" id="classgf_1_1_image_html"><div class="ttname"><a href="classgf_1_1_image.html">gf::Image</a></div><div class="ttdoc">Class for loading, manipulating and saving images. </div><div class="ttdef"><b>Definition:</b> Image.h:80</div></div>
<div class="ttc" id="namespacegf_html"><div class="ttname"><a href="namespacegf.html">gf</a></div><div class="ttdoc">The namespace for gf classes. </div><div class="ttdef"><b>Definition:</b> Action.h:35</div></div>
<div class="ttc" id="classgf_1_1_input_stream_html"><div class="ttname"><a href="classgf_1_1_input_stream.html">gf::InputStream</a></div><div class="ttdoc">Abstract class for custom file input streams. </div><div class="ttdef"><b>Definition:</b> Stream.h:54</div></div>
<div class="ttc" id="classgf_1_1_array_ref_html"><div class="ttname"><a href="classgf_1_1_array_ref.html">gf::ArrayRef< uint8_t ></a></div></div>
<div class="ttc" id="structgf_1_1_vector_3_01_t_00_014_01_4_html"><div class="ttname"><a href="structgf_1_1_vector_3_01_t_00_014_01_4.html">gf::Vector< T, 4 ></a></div><div class="ttdoc">A 4D vector. </div><div class="ttdef"><b>Definition:</b> Vector.h:838</div></div>
<div class="ttc" id="group__core_html_ggaf9faa55f8d780c38401260afb3e1429ea56423b353be446e7927b0e32c446b9d2"><div class="ttname"><a href="group__core.html#ggaf9faa55f8d780c38401260afb3e1429ea56423b353be446e7927b0e32c446b9d2">gf::Rgba32</a></div><div class="ttdoc">Four 8-bit channels. </div><div class="ttdef"><b>Definition:</b> Image.h:48</div></div>
<div class="ttc" id="group__core_html_ggaf9faa55f8d780c38401260afb3e1429ea703b735d668ecd6be74797caf89fce8d"><div class="ttname"><a href="group__core.html#ggaf9faa55f8d780c38401260afb3e1429ea703b735d668ecd6be74797caf89fce8d">gf::Rgb24</a></div><div class="ttdoc">Three 8-bit channels. </div><div class="ttdef"><b>Definition:</b> Image.h:49</div></div>
<div class="ttc" id="group__core_html_ga6788e40b762777c1081f796076116a02"><div class="ttname"><a href="group__core.html#ga6788e40b762777c1081f796076116a02">gf::Path</a></div><div class="ttdeci">boost::filesystem::path Path</div><div class="ttdoc">A path in the filesystem. </div><div class="ttdef"><b>Definition:</b> Path.h:44</div></div>
<div class="ttc" id="structgf_1_1_vector_3_01_t_00_013_01_4_html"><div class="ttname"><a href="structgf_1_1_vector_3_01_t_00_013_01_4.html">gf::Vector< T, 3 ></a></div><div class="ttdoc">A 3D vector. </div><div class="ttdef"><b>Definition:</b> Vector.h:563</div></div>
<div class="ttc" id="structgf_1_1_vector_html"><div class="ttname"><a href="structgf_1_1_vector.html">gf::Vector< int, 2 ></a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>