Files
Bomberman/Image_8hpp_source.html
2021-06-26 11:31:13 +00:00

157 lines
19 KiB
HTML

<!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">
<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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Bomberman: lib/Ray/sources/Drawables/Image.hpp 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>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Bomberman
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li><li class="navelem"><a class="el" href="dir_97e082ce3407cc227854e8f48930bd75.html">Ray</a></li><li class="navelem"><a class="el" href="dir_6a062873ed3e64cc8025242d19396498.html">sources</a></li><li class="navelem"><a class="el" href="dir_fbaef1213b89c2c136e136e5f4a6fca1.html">Drawables</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Image.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="Image_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">** EPITECH PROJECT, 2021</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">** Bomberman</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">** File description:</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">** Image</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#ifndef IMAGE_HPP_</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#define IMAGE_HPP_</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;raylib.h&gt;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Texture_8hpp.html">Texture.hpp</a>&quot;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Cache_8hpp.html">Utils/Cache.hpp</a>&quot;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Rectangle_8hpp.html">Drawables/2D/Rectangle.hpp</a>&quot;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceRAY.html">RAY</a></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;{</div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classRAY_1_1Image.html"> 20</a></span>&#160; <span class="keyword">class </span><a class="code" href="classRAY_1_1Image.html">Image</a>: <span class="keyword">public</span> <a class="code" href="classRAY_1_1Drawables_1_1Drawables2D_1_1Rectangle.html">Drawables::Drawables2D::Rectangle</a> {</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <a class="code" href="classRAY_1_1Image.html#ad59f6b1f8b1781a41189c1919dd164b4">Image</a>(<span class="keyword">const</span> std::string &amp;filename, <span class="keywordtype">bool</span> lonely = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <a class="code" href="classRAY_1_1Image.html#ad59f6b1f8b1781a41189c1919dd164b4">Image</a>(<span class="keyword">const</span> <a class="code" href="classRAY_1_1Image.html">Image</a> &amp;image) = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <a class="code" href="classRAY_1_1Image.html">Image</a> &amp;<a class="code" href="classRAY_1_1Image.html#a77d57fe869292359e3b038bdb4afb898">operator=</a>(<span class="keyword">const</span> <a class="code" href="classRAY_1_1Image.html">Image</a> &amp;image) = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <a class="code" href="classRAY_1_1Image.html#afd88acf49b6d2db2fc1c0a881522b521">~Image</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classRAY_1_1Image.html#a6aaba215fd5c5b95efc2d5580cdf8193">exportTo</a>(<span class="keyword">const</span> std::string &amp;outputPath);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classRAY_1_1Image.html#adff1c580f00296c4ee2968cac853e9d9">draw</a>(<a class="code" href="classRAY_1_1Drawables_1_1ADrawable2D.html">Drawables::ADrawable2D</a> &amp;);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classRAY_1_1Image.html#a2c3fc4c64707d0838bcb807f7f49b892">drawOn</a>(<a class="code" href="classRAY_1_1Window.html">RAY::Window</a> &amp;) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classRAY_1_1Image.html#a2c3fc4c64707d0838bcb807f7f49b892">drawOn</a>(<a class="code" href="classRAY_1_1Image.html">RAY::Image</a> &amp;image) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classRAY_1_1Image.html#acb10e3f289140c2f5db05cef5da53f76">resize</a>(<span class="keyword">const</span> <a class="code" href="classRAY_1_1Vector2.html">RAY::Vector2</a> &amp;dimensions);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="classRAY_1_1Image.html">Image</a> &amp;<a class="code" href="classRAY_1_1Image.html#ae52c1201e3444ac7ee424903c1d23ec7">use</a>(<span class="keyword">const</span> std::string &amp;filename);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classRAY_1_1Image.html#a4d1a52afc0713d13f9726923e93c2ba0"> 57</a></span>&#160; std::shared_ptr&lt;::Image&gt; <a class="code" href="classRAY_1_1Image.html#a4d1a52afc0713d13f9726923e93c2ba0">_image</a>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classRAY_1_1Image.html#a0ebbf24ba043af2574b68a9c8632ad68"> 59</a></span>&#160; <span class="keyword">static</span> <a class="code" href="classRAY_1_1Cache.html">Cache&lt;::Image&gt;</a> <a class="code" href="classRAY_1_1Image.html#a0ebbf24ba043af2574b68a9c8632ad68">_imagesCache</a>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classRAY_1_1Image.html#a40716565fbcd8bd1bc6404f367bf32fe"> 61</a></span>&#160; std::string <a class="code" href="classRAY_1_1Image.html#a40716565fbcd8bd1bc6404f367bf32fe">_ressourcePath</a>;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; INTERNAL:</div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classRAY_1_1Image.html#aeebe23d99dfeacbd13766eb8f27d63e0"> 66</a></span>&#160; operator ::Image() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; operator ::Image *();</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; }; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;}</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* !IMAGE_HPP_ */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aRectangle_8hpp_html"><div class="ttname"><a href="Rectangle_8hpp.html">Rectangle.hpp</a></div></div>
<div class="ttc" id="aclassRAY_1_1Image_html_a6aaba215fd5c5b95efc2d5580cdf8193"><div class="ttname"><a href="classRAY_1_1Image.html#a6aaba215fd5c5b95efc2d5580cdf8193">RAY::Image::exportTo</a></div><div class="ttdeci">bool exportTo(const std::string &amp;outputPath)</div><div class="ttdoc">export to file</div><div class="ttdef"><b>Definition:</b> Image.cpp:30</div></div>
<div class="ttc" id="aclassRAY_1_1Image_html_adff1c580f00296c4ee2968cac853e9d9"><div class="ttname"><a href="classRAY_1_1Image.html#adff1c580f00296c4ee2968cac853e9d9">RAY::Image::draw</a></div><div class="ttdeci">void draw(Drawables::ADrawable2D &amp;)</div><div class="ttdoc">draw drawable on image</div><div class="ttdef"><b>Definition:</b> Image.cpp:55</div></div>
<div class="ttc" id="aCache_8hpp_html"><div class="ttname"><a href="Cache_8hpp.html">Cache.hpp</a></div></div>
<div class="ttc" id="aclassRAY_1_1Image_html_a0ebbf24ba043af2574b68a9c8632ad68"><div class="ttname"><a href="classRAY_1_1Image.html#a0ebbf24ba043af2574b68a9c8632ad68">RAY::Image::_imagesCache</a></div><div class="ttdeci">static Cache&lt;::Image &gt; _imagesCache</div><div class="ttdef"><b>Definition:</b> Image.hpp:59</div></div>
<div class="ttc" id="aclassRAY_1_1Window_html"><div class="ttname"><a href="classRAY_1_1Window.html">RAY::Window</a></div><div class="ttdef"><b>Definition:</b> Window.hpp:32</div></div>
<div class="ttc" id="aclassRAY_1_1Vector2_html"><div class="ttname"><a href="classRAY_1_1Vector2.html">RAY::Vector2</a></div><div class="ttdoc">A Two-dimensionnal Vector data type.</div><div class="ttdef"><b>Definition:</b> Vector2.hpp:15</div></div>
<div class="ttc" id="aclassRAY_1_1Image_html_a77d57fe869292359e3b038bdb4afb898"><div class="ttname"><a href="classRAY_1_1Image.html#a77d57fe869292359e3b038bdb4afb898">RAY::Image::operator=</a></div><div class="ttdeci">Image &amp; operator=(const Image &amp;image)=default</div><div class="ttdoc">An image is assignable.</div></div>
<div class="ttc" id="anamespaceRAY_html"><div class="ttname"><a href="namespaceRAY.html">RAY</a></div><div class="ttdef"><b>Definition:</b> IAudio.hpp:12</div></div>
<div class="ttc" id="aclassRAY_1_1Image_html_ad59f6b1f8b1781a41189c1919dd164b4"><div class="ttname"><a href="classRAY_1_1Image.html#ad59f6b1f8b1781a41189c1919dd164b4">RAY::Image::Image</a></div><div class="ttdeci">Image(const std::string &amp;filename, bool lonely=false)</div><div class="ttdoc">Create an image, loading a file.</div><div class="ttdef"><b>Definition:</b> Image.cpp:22</div></div>
<div class="ttc" id="aTexture_8hpp_html"><div class="ttname"><a href="Texture_8hpp.html">Texture.hpp</a></div></div>
<div class="ttc" id="aclassRAY_1_1Drawables_1_1Drawables2D_1_1Rectangle_html"><div class="ttname"><a href="classRAY_1_1Drawables_1_1Drawables2D_1_1Rectangle.html">RAY::Drawables::Drawables2D::Rectangle</a></div><div class="ttdoc">Rectangle in a two-dimensional space.</div><div class="ttdef"><b>Definition:</b> Rectangle.hpp:17</div></div>
<div class="ttc" id="aclassRAY_1_1Image_html"><div class="ttname"><a href="classRAY_1_1Image.html">RAY::Image</a></div><div class="ttdoc">Object representation of a framebuffer.</div><div class="ttdef"><b>Definition:</b> Image.hpp:20</div></div>
<div class="ttc" id="aclassRAY_1_1Image_html_afd88acf49b6d2db2fc1c0a881522b521"><div class="ttname"><a href="classRAY_1_1Image.html#afd88acf49b6d2db2fc1c0a881522b521">RAY::Image::~Image</a></div><div class="ttdeci">~Image() override=default</div><div class="ttdoc">Image destructor, will unload ressources.</div></div>
<div class="ttc" id="aclassRAY_1_1Image_html_a40716565fbcd8bd1bc6404f367bf32fe"><div class="ttname"><a href="classRAY_1_1Image.html#a40716565fbcd8bd1bc6404f367bf32fe">RAY::Image::_ressourcePath</a></div><div class="ttdeci">std::string _ressourcePath</div><div class="ttdef"><b>Definition:</b> Image.hpp:61</div></div>
<div class="ttc" id="aclassRAY_1_1Image_html_a2c3fc4c64707d0838bcb807f7f49b892"><div class="ttname"><a href="classRAY_1_1Image.html#a2c3fc4c64707d0838bcb807f7f49b892">RAY::Image::drawOn</a></div><div class="ttdeci">void drawOn(RAY::Window &amp;) override</div><div class="ttdoc">Draw image on window.</div><div class="ttdef"><b>Definition:</b> Image.cpp:66</div></div>
<div class="ttc" id="aclassRAY_1_1Cache_html"><div class="ttname"><a href="classRAY_1_1Cache.html">RAY::Cache</a></div><div class="ttdoc">A templated class used to cache ressources, indexed with a string.</div><div class="ttdef"><b>Definition:</b> Cache.hpp:23</div></div>
<div class="ttc" id="aclassRAY_1_1Drawables_1_1ADrawable2D_html"><div class="ttname"><a href="classRAY_1_1Drawables_1_1ADrawable2D.html">RAY::Drawables::ADrawable2D</a></div><div class="ttdoc">Abstraction of any two-dimensionnal drawable.</div><div class="ttdef"><b>Definition:</b> ADrawable2D.hpp:21</div></div>
<div class="ttc" id="aclassRAY_1_1Image_html_a4d1a52afc0713d13f9726923e93c2ba0"><div class="ttname"><a href="classRAY_1_1Image.html#a4d1a52afc0713d13f9726923e93c2ba0">RAY::Image::_image</a></div><div class="ttdeci">std::shared_ptr&lt;::Image &gt; _image</div><div class="ttdoc">Image, really, that's just it...</div><div class="ttdef"><b>Definition:</b> Image.hpp:57</div></div>
<div class="ttc" id="aclassRAY_1_1Image_html_acb10e3f289140c2f5db05cef5da53f76"><div class="ttname"><a href="classRAY_1_1Image.html#acb10e3f289140c2f5db05cef5da53f76">RAY::Image::resize</a></div><div class="ttdeci">void resize(const RAY::Vector2 &amp;dimensions)</div><div class="ttdoc">Resize image;.</div><div class="ttdef"><b>Definition:</b> Image.cpp:60</div></div>
<div class="ttc" id="aclassRAY_1_1Image_html_ae52c1201e3444ac7ee424903c1d23ec7"><div class="ttname"><a href="classRAY_1_1Image.html#ae52c1201e3444ac7ee424903c1d23ec7">RAY::Image::use</a></div><div class="ttdeci">Image &amp; use(const std::string &amp;filename)</div><div class="ttdoc">Load image from file, lets one use one entity for multiple files.</div><div class="ttdef"><b>Definition:</b> Image.cpp:41</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>