Skip to content
This repository was archived by the owner on Apr 16, 2024. It is now read-only.

Commit bd9a871

Browse files
rmaxi-mermaxi-me
authored
docs: update documentation (#31)
* docs: add engine documentation * docs: generate doxygen doc and bump version
1 parent aced921 commit bd9a871

File tree

223 files changed

+7974
-711
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

223 files changed

+7974
-711
lines changed

‎Documentation/conan/package.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@
6161
{id: 11, label: 'bzip2/1.0.8', shape: 'box', color: {background: 'SkyBlue'}, fulllabel: '<h3>bzip2/1.0.8</h3><ul><li><b>id</b>: da606cf731e334010b0bf6e85a2a6f891b9f36b0</li><li><b>url</b>: <a href="https://github.com/conan-io/conan-center-index">https://github.com/conan-io/conan-center-index</a></li><li><b>homepage</b>: <a href="http://www.bzip.org">http://www.bzip.org</a></li><li><b>license</b>: bzip2-1.0.8</li><li><b>topics</b>: ("conan", "bzip2", "data-compressor", "file-compression")</li><ul>'}
6262
]);
6363
var edges = new vis.DataSet([
64-
{ from: 3, to: 4 },
64+
{ from: 4, to: 5 },
65+
{ from: 3, to: 4 },
6566
{ from: 3, to: 5 },
6667
{ from: 3, to: 11 },
6768
{ from: 0, to: 1 },
@@ -70,7 +71,6 @@
7071
{ from: 0, to: 9 },
7172
{ from: 0, to: 10 },
7273
{ from: 1, to: 2 },
73-
{ from: 4, to: 5 },
7474
{ from: 2, to: 3 },
7575
{ from: 2, to: 6 }
7676
]);

‎Documentation/html/ABrush_8hpp_source.html

+119
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.18"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>EpiGimp: src/EpiGimp/include/Tools/ABrush.hpp Source File</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectlogo"><img alt="Logo" src="Logo.png"/></td>
24+
<td id="projectalign" style="padding-left: 0.5em;">
25+
<div id="projectname">EpiGimp
26+
&#160;<span id="projectnumber">1.2.0</span>
27+
</div>
28+
<div id="projectbrief">An Image Processing Software</div>
29+
</td>
30+
</tr>
31+
</tbody>
32+
</table>
33+
</div>
34+
<!-- end header part -->
35+
<!-- Generated by Doxygen 1.8.18 -->
36+
<script type="text/javascript">
37+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
38+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
39+
/* @license-end */
40+
</script>
41+
<script type="text/javascript" src="menudata.js"></script>
42+
<script type="text/javascript" src="menu.js"></script>
43+
<script type="text/javascript">
44+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
45+
$(function() {
46+
initMenu('',true,false,'search.php','Search');
47+
$(document).ready(function() { init_search(); });
48+
});
49+
/* @license-end */</script>
50+
<div id="main-nav"></div>
51+
<!-- window showing the filter options -->
52+
<div id="MSearchSelectWindow"
53+
onmouseover="return searchBox.OnSearchSelectShow()"
54+
onmouseout="return searchBox.OnSearchSelectHide()"
55+
onkeydown="return searchBox.OnSearchSelectKey(event)">
56+
</div>
57+
58+
<!-- iframe showing the search results (closed by default) -->
59+
<div id="MSearchResultsWindow">
60+
<iframe src="javascript:void(0)" frameborder="0"
61+
name="MSearchResults" id="MSearchResults">
62+
</iframe>
63+
</div>
64+
65+
<div id="nav-path" class="navpath">
66+
<ul>
67+
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_0c8e873e8a93214a96121aafcf240be3.html">EpiGimp</a></li><li class="navelem"><a class="el" href="dir_c69f24118ab3c9715ac6faa664e0a7be.html">include</a></li><li class="navelem"><a class="el" href="dir_9bee12525b9ac45aab85f6f1e0f55fae.html">Tools</a></li> </ul>
68+
</div>
69+
</div><!-- top -->
70+
<div class="header">
71+
<div class="headertitle">
72+
<div class="title">ABrush.hpp</div> </div>
73+
</div><!--header-->
74+
<div class="contents">
75+
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
76+
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">** EpiGimp Copyright (C) 2020 Maxime Houis</span></div>
77+
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">** This program comes with ABSOLUTELY NO WARRANTY.</span></div>
78+
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">** This is free software, and you are welcome to redistribute it</span></div>
79+
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">** under certain conditions; see LICENSE for details.</span></div>
80+
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">*/</span></div>
81+
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
82+
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#pragma once</span></div>
83+
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
84+
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &quot;ATool.hpp&quot;</span></div>
85+
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
86+
<div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="classABrush.html"> 12</a></span>&#160;<span class="keyword">class </span><a class="code" href="classABrush.html">ABrush</a> : <span class="keyword">public</span> <a class="code" href="classATool.html">ATool</a> {</div>
87+
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="keyword">private</span>:</div>
88+
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; <span class="keywordtype">bool</span> m_mousePressed{<span class="keyword">false</span>};</div>
89+
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; </div>
90+
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="keywordtype">void</span> drawCircle(sf::Image &amp;image, <span class="keyword">const</span> sf::Vector2f &amp;pos);</div>
91+
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keywordtype">void</span> paint(<span class="keyword">const</span> sf::Vector2i &amp;pos);</div>
92+
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
93+
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">protected</span>:</div>
94+
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keyword">static</span> std::uint32_t m_brushSize;</div>
95+
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
96+
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">public</span>:</div>
97+
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; ~<a class="code" href="classABrush.html">ABrush</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div>
98+
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
99+
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordtype">void</span> onClickPressed(sf::Mouse::Button button, <span class="keyword">const</span> sf::Vector2i &amp;pos) <span class="keyword">override</span>;</div>
100+
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordtype">void</span> onClickReleased(sf::Mouse::Button button, <span class="keyword">const</span> sf::Vector2i &amp;pos) <span class="keyword">override</span>;</div>
101+
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordtype">void</span> onMouseMoved(<span class="keyword">const</span> sf::Vector2i &amp;pos) <span class="keyword">override</span>;</div>
102+
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordtype">void</span> toolGUI() <span class="keyword">override</span>;</div>
103+
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
104+
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">virtual</span> sf::Color getBrushColor() = 0;</div>
105+
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
106+
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *getName() <span class="keyword">override</span> = 0;</div>
107+
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *getDescription() <span class="keyword">override</span> = 0;</div>
108+
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;};</div>
109+
</div><!-- fragment --></div><!-- contents -->
110+
<div class="ttc" id="aclassATool_html"><div class="ttname"><a href="classATool.html">ATool</a></div><div class="ttdef"><b>Definition:</b> ATool.hpp:15</div></div>
111+
<div class="ttc" id="aclassABrush_html"><div class="ttname"><a href="classABrush.html">ABrush</a></div><div class="ttdef"><b>Definition:</b> ABrush.hpp:12</div></div>
112+
<!-- start footer part -->
113+
<hr class="footer"/><address class="footer"><small>
114+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
115+
<img class="footer" src="doxygen.png" alt="doxygen"/>
116+
</a> 1.8.18
117+
</small></address>
118+
</body>
119+
</html>

‎Documentation/html/ATool_8hpp_source.html

+121
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.18"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>EpiGimp: src/EpiGimp/include/Tools/ATool.hpp Source File</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectlogo"><img alt="Logo" src="Logo.png"/></td>
24+
<td id="projectalign" style="padding-left: 0.5em;">
25+
<div id="projectname">EpiGimp
26+
&#160;<span id="projectnumber">1.2.0</span>
27+
</div>
28+
<div id="projectbrief">An Image Processing Software</div>
29+
</td>
30+
</tr>
31+
</tbody>
32+
</table>
33+
</div>
34+
<!-- end header part -->
35+
<!-- Generated by Doxygen 1.8.18 -->
36+
<script type="text/javascript">
37+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
38+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
39+
/* @license-end */
40+
</script>
41+
<script type="text/javascript" src="menudata.js"></script>
42+
<script type="text/javascript" src="menu.js"></script>
43+
<script type="text/javascript">
44+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
45+
$(function() {
46+
initMenu('',true,false,'search.php','Search');
47+
$(document).ready(function() { init_search(); });
48+
});
49+
/* @license-end */</script>
50+
<div id="main-nav"></div>
51+
<!-- window showing the filter options -->
52+
<div id="MSearchSelectWindow"
53+
onmouseover="return searchBox.OnSearchSelectShow()"
54+
onmouseout="return searchBox.OnSearchSelectHide()"
55+
onkeydown="return searchBox.OnSearchSelectKey(event)">
56+
</div>
57+
58+
<!-- iframe showing the search results (closed by default) -->
59+
<div id="MSearchResultsWindow">
60+
<iframe src="javascript:void(0)" frameborder="0"
61+
name="MSearchResults" id="MSearchResults">
62+
</iframe>
63+
</div>
64+
65+
<div id="nav-path" class="navpath">
66+
<ul>
67+
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_0c8e873e8a93214a96121aafcf240be3.html">EpiGimp</a></li><li class="navelem"><a class="el" href="dir_c69f24118ab3c9715ac6faa664e0a7be.html">include</a></li><li class="navelem"><a class="el" href="dir_9bee12525b9ac45aab85f6f1e0f55fae.html">Tools</a></li> </ul>
68+
</div>
69+
</div><!-- top -->
70+
<div class="header">
71+
<div class="headertitle">
72+
<div class="title">ATool.hpp</div> </div>
73+
</div><!--header-->
74+
<div class="contents">
75+
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
76+
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">** EpiGimp Copyright (C) 2020 Maxime Houis</span></div>
77+
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">** This program comes with ABSOLUTELY NO WARRANTY.</span></div>
78+
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">** This is free software, and you are welcome to redistribute it</span></div>
79+
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">** under certain conditions; see LICENSE for details.</span></div>
80+
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">*/</span></div>
81+
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
82+
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#pragma once</span></div>
83+
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
84+
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;SFML/Graphics.hpp&gt;</span></div>
85+
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;imgui.h&gt;</span></div>
86+
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
87+
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;Layer.hpp&quot;</span></div>
88+
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
89+
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="classATool.html"> 15</a></span>&#160;<span class="keyword">class </span><a class="code" href="classATool.html">ATool</a> {</div>
90+
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">protected</span>:</div>
91+
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; sf::RenderWindow *m_window{<span class="keyword">nullptr</span>};</div>
92+
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <a class="code" href="structLayer.html">Layer</a> *m_activeLayer{<span class="keyword">nullptr</span>};</div>
93+
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
94+
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keyword">static</span> <span class="keywordtype">float</span> m_color[4]; <span class="comment">// QoL: color is shared across instances to unify tools</span></div>
95+
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">public</span>:</div>
96+
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <a class="code" href="classATool.html">ATool</a>();</div>
97+
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="classATool.html">ATool</a>();</div>
98+
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
99+
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordtype">void</span> handleEvent(<span class="keyword">const</span> sf::Event &amp;event);</div>
100+
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordtype">void</span> registerWindow(sf::RenderWindow &amp;window);</div>
101+
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordtype">void</span> setActiveLayer(<a class="code" href="structLayer.html">Layer</a> *layer);</div>
102+
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
103+
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> onClickPressed(sf::Mouse::Button button, <span class="keyword">const</span> sf::Vector2i &amp;pos) = 0;</div>
104+
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> onClickReleased(sf::Mouse::Button button, <span class="keyword">const</span> sf::Vector2i &amp;pos) = 0;</div>
105+
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> onMouseMoved(<span class="keyword">const</span> sf::Vector2i &amp;pos) = 0;</div>
106+
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> toolGUI();</div>
107+
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
108+
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">inline</span> <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *getName() = 0;</div>
109+
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">inline</span> <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *getDescription() = 0;</div>
110+
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;};</div>
111+
</div><!-- fragment --></div><!-- contents -->
112+
<div class="ttc" id="aclassATool_html"><div class="ttname"><a href="classATool.html">ATool</a></div><div class="ttdef"><b>Definition:</b> ATool.hpp:15</div></div>
113+
<div class="ttc" id="astructLayer_html"><div class="ttname"><a href="structLayer.html">Layer</a></div><div class="ttdef"><b>Definition:</b> Layer.hpp:12</div></div>
114+
<!-- start footer part -->
115+
<hr class="footer"/><address class="footer"><small>
116+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
117+
<img class="footer" src="doxygen.png" alt="doxygen"/>
118+
</a> 1.8.18
119+
</small></address>
120+
</body>
121+
</html>

‎Documentation/html/AWidget_8hpp.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<td id="projectlogo"><img alt="Logo" src="Logo.png"/></td>
2424
<td id="projectalign" style="padding-left: 0.5em;">
2525
<div id="projectname">EpiGimp
26-
&#160;<span id="projectnumber">1.1.1</span>
26+
&#160;<span id="projectnumber">1.2.0</span>
2727
</div>
2828
<div id="projectbrief">An Image Processing Software</div>
2929
</td>

0 commit comments

Comments
 (0)