-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_render_texture_8h_source.html
78 lines (78 loc) · 17.6 KB
/
_render_texture_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
78
<!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): RenderTexture.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">RenderTexture.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_RENDER_TEXTURE_H</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define GF_RENDER_TEXTURE_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 "Portability.h"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "RenderTarget.h"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span><a class="code" href="namespacegf.html">gf</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">inline</span> <span class="keyword">namespace </span>v1 {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="classgf_1_1_render_texture.html"> 98</a></span>  <span class="keyword">class </span>GF_API <a class="code" href="classgf_1_1_render_texture.html">RenderTexture</a> : <span class="keyword">public</span> <a class="code" href="classgf_1_1_render_target.html">RenderTarget</a> {</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <a class="code" href="classgf_1_1_render_texture.html">RenderTexture</a>(<a class="code" href="structgf_1_1_vector.html">Vector2i</a> size);</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00117"></a><span class="lineno"><a class="line" href="classgf_1_1_render_texture.html#a8e7c831c8cb1c52ba3d08b4b55d361f8"> 117</a></span>  <span class="keywordtype">void</span> <a class="code" href="classgf_1_1_render_texture.html#a8e7c831c8cb1c52ba3d08b4b55d361f8">setSmooth</a>(<span class="keywordtype">bool</span> smooth = <span class="keyword">true</span>) {</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  m_texture.setSmooth(smooth);</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  }</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="classgf_1_1_render_texture.html#a3d7013e54346d6bba18fd22151351083"> 128</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_render_texture.html#a3d7013e54346d6bba18fd22151351083">isSmooth</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordflow">return</span> m_texture.isSmooth();</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  }</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00142"></a><span class="lineno"><a class="line" href="classgf_1_1_render_texture.html#a9fe8e4c5dcca46c10ae3b4d28bcb3ed9"> 142</a></span>  <span class="keywordtype">void</span> <a class="code" href="classgf_1_1_render_texture.html#a9fe8e4c5dcca46c10ae3b4d28bcb3ed9">setRepeated</a>(<span class="keywordtype">bool</span> repeated = <span class="keyword">true</span>) {</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  m_texture.setRepeated(repeated);</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  }</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div><div class="line"><a name="l00153"></a><span class="lineno"><a class="line" href="classgf_1_1_render_texture.html#adf95c990efd177dc7c229d198a27dedb"> 153</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_render_texture.html#adf95c990efd177dc7c229d198a27dedb">isRepeated</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keywordflow">return</span> m_texture.isRepeated();</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  }</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keyword">virtual</span> <a class="code" href="structgf_1_1_vector.html">Vector2i</a> getSize() <span class="keyword">const override</span>;</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keywordtype">void</span> setActive();</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <span class="keywordtype">void</span> display();</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> </div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <a class="code" href="classgf_1_1_image.html">Image</a> capture() <span class="keyword">const</span>;</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div><div class="line"><a name="l00200"></a><span class="lineno"><a class="line" href="classgf_1_1_render_texture.html#a7bfdfa3ecdf12af04994c4573a6925ca"> 200</a></span>  <span class="keyword">const</span> <a class="code" href="classgf_1_1_texture.html">Texture</a>& <a class="code" href="classgf_1_1_render_texture.html#a7bfdfa3ecdf12af04994c4573a6925ca">getTexture</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <span class="keywordflow">return</span> m_texture;</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  }</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <a class="code" href="classgf_1_1_graphics_handle.html">GraphicsHandle<GraphicsTag::Framebuffer></a> m_framebuffer;</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <a class="code" href="classgf_1_1_texture.html">Texture</a> m_texture;</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  };</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> }</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> }</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> </div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="preprocessor">#endif // GF_RENDER_TEXTURE_H</span></div><div class="ttc" id="classgf_1_1_render_texture_html"><div class="ttname"><a href="classgf_1_1_render_texture.html">gf::RenderTexture</a></div><div class="ttdoc">Target for off-screen 2D rendering into a texture. </div><div class="ttdef"><b>Definition:</b> RenderTexture.h:98</div></div>
<div class="ttc" id="classgf_1_1_render_target_html"><div class="ttname"><a href="classgf_1_1_render_target.html">gf::RenderTarget</a></div><div class="ttdoc">Base class for all render targets (window, texture, ...) </div><div class="ttdef"><b>Definition:</b> RenderTarget.h:73</div></div>
<div class="ttc" id="classgf_1_1_render_texture_html_adf95c990efd177dc7c229d198a27dedb"><div class="ttname"><a href="classgf_1_1_render_texture.html#adf95c990efd177dc7c229d198a27dedb">gf::RenderTexture::isRepeated</a></div><div class="ttdeci">bool isRepeated() const</div><div class="ttdoc">Check if the texture is repeated or not. </div><div class="ttdef"><b>Definition:</b> RenderTexture.h:153</div></div>
<div class="ttc" id="classgf_1_1_render_texture_html_a8e7c831c8cb1c52ba3d08b4b55d361f8"><div class="ttname"><a href="classgf_1_1_render_texture.html#a8e7c831c8cb1c52ba3d08b4b55d361f8">gf::RenderTexture::setSmooth</a></div><div class="ttdeci">void setSmooth(bool smooth=true)</div><div class="ttdoc">Enable or disable texture smoothing. </div><div class="ttdef"><b>Definition:</b> RenderTexture.h:117</div></div>
<div class="ttc" id="classgf_1_1_render_texture_html_a9fe8e4c5dcca46c10ae3b4d28bcb3ed9"><div class="ttname"><a href="classgf_1_1_render_texture.html#a9fe8e4c5dcca46c10ae3b4d28bcb3ed9">gf::RenderTexture::setRepeated</a></div><div class="ttdeci">void setRepeated(bool repeated=true)</div><div class="ttdoc">Enable or disable texture repeating. </div><div class="ttdef"><b>Definition:</b> RenderTexture.h:142</div></div>
<div class="ttc" id="classgf_1_1_graphics_handle_html"><div class="ttname"><a href="classgf_1_1_graphics_handle.html">gf::GraphicsHandle< GraphicsTag::Framebuffer ></a></div></div>
<div class="ttc" id="classgf_1_1_texture_html"><div class="ttname"><a href="classgf_1_1_texture.html">gf::Texture</a></div><div class="ttdoc">A texture for colored images. </div><div class="ttdef"><b>Definition:</b> Texture.h:301</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_render_texture_html_a3d7013e54346d6bba18fd22151351083"><div class="ttname"><a href="classgf_1_1_render_texture.html#a3d7013e54346d6bba18fd22151351083">gf::RenderTexture::isSmooth</a></div><div class="ttdeci">bool isSmooth() const</div><div class="ttdoc">Check if the smooth filtering is enabled or not. </div><div class="ttdef"><b>Definition:</b> RenderTexture.h:128</div></div>
<div class="ttc" id="classgf_1_1_render_texture_html_a7bfdfa3ecdf12af04994c4573a6925ca"><div class="ttname"><a href="classgf_1_1_render_texture.html#a7bfdfa3ecdf12af04994c4573a6925ca">gf::RenderTexture::getTexture</a></div><div class="ttdeci">const Texture & getTexture() const</div><div class="ttdoc">Get a read-only reference to the target texture. </div><div class="ttdef"><b>Definition:</b> RenderTexture.h:200</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>