-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathRenderTexture_8hpp_source.htm
More file actions
153 lines (153 loc) · 19.6 KB
/
Copy pathRenderTexture_8hpp_source.htm
File metadata and controls
153 lines (153 loc) · 19.6 KB
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
<!doctype html>
<html class="no-js" lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpp3ds · Documentation</title>
<link rel="stylesheet" href="../css/app.css" />
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
<script src="../bower_components/modernizr/modernizr.js"></script>
</head>
<body>
<div id="topnav" class="text-center">
<dl class="sub-nav">
<dd id="navlogo"><a href="/">
<img src="../img/logo.svg" />
</a></dd>
<dd><a href="/#what">What is it?</a></dd>
<dd><a href="/#download">Download</a></dd>
<dd><a href="/#faqs">FAQs</a></dd>
<dd class="active"><a href="/docs">Docs</a></dd>
</dl>
</div>
<div id="content">
<!-- Generated by Doxygen 1.8.10 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.htm"><span>Main Page</span></a></li>
<li><a href="modules.htm"><span>Modules</span></a></li>
<li><a href="annotated.htm"><span>Classes</span></a></li>
<li class="current"><a href="files.htm"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.htm"><span>File List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_0b93ed46ee854382aab85c778b89946e.htm">include</a></li><li class="navelem"><a class="el" href="dir_18d409fe281a3b15bd325ab753ead42a.htm">cpp3ds</a></li><li class="navelem"><a class="el" href="dir_085c8d0c91fa2f9d2c1c5ade258c60f9.htm">Graphics</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">RenderTexture.hpp</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="l00003"></a><span class="lineno"> 3</span> <span class="comment">// SFML - Simple and Fast Multimedia Library</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright (C) 2007-2014 Laurent Gomila (laurent.gom@gmail.com)</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">//</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// This software is provided 'as-is', without any express or implied warranty.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// In no event will the authors be held liable for any damages 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 freely,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// 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;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// you must not claim that you wrote the original software.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// If you use this software in a product, an acknowledgment</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// in the product documentation would be appreciated but is not required.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">//</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// 2. Altered source versions must be plainly marked as such,</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// and must not be misrepresented as being the original software.</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">// 3. This notice may not be removed or altered from any source distribution.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">//</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef CPP3DS_RENDERTEXTURE_HPP</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define CPP3DS_RENDERTEXTURE_HPP</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Headers</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span><span class="preprocessor">#include <cpp3ds/Window/Context.hpp></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <cpp3ds/Graphics/Texture.hpp></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <cpp3ds/Graphics/RenderTarget.hpp></span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</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="namespacecpp3ds.htm">cpp3ds</a></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classcpp3ds_1_1RenderTexture.htm"> 43</a></span> <span class="keyword">class </span><a class="code" href="classcpp3ds_1_1RenderTexture.htm">RenderTexture</a> : <span class="keyword">public</span> <a class="code" href="classcpp3ds_1_1RenderTarget.htm">RenderTarget</a></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> {</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">public</span> :</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="classcpp3ds_1_1RenderTexture.htm#a3a3088ca8f62500260a6a3e3c2d83207">RenderTexture</a>();</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">virtual</span> <a class="code" href="classcpp3ds_1_1RenderTexture.htm#a51b8240dbbefafe9e01cc0c3d0b9400b">~RenderTexture</a>();</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">bool</span> <a class="code" href="classcpp3ds_1_1RenderTexture.htm#a8e554ce283fec207a55fe79c889dd68a">create</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> width, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> height, <span class="keywordtype">bool</span> depthBuffer = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">void</span> <a class="code" href="classcpp3ds_1_1RenderTexture.htm#a16edd1c6474a49d062be43164cb52078">setSmooth</a>(<span class="keywordtype">bool</span> smooth);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">bool</span> <a class="code" href="classcpp3ds_1_1RenderTexture.htm#a88bc49e80ef17eb7f8d7cd81105f7963">isSmooth</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordtype">void</span> <a class="code" href="classcpp3ds_1_1RenderTexture.htm#a22e03940d9217065c036652254af5f86">setRepeated</a>(<span class="keywordtype">bool</span> repeated);</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordtype">bool</span> <a class="code" href="classcpp3ds_1_1RenderTexture.htm#a181c61c022d7db997eac0e7c1d051d94">isRepeated</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keywordtype">bool</span> <a class="code" href="classcpp3ds_1_1RenderTexture.htm#a2e76f77e0fb1d10b595b10a8842d00f9">setActive</a>(<span class="keywordtype">bool</span> active = <span class="keyword">true</span>);</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keywordtype">void</span> <a class="code" href="classcpp3ds_1_1RenderTexture.htm#ae8321500ef18570f935aa13f8fbdeecf">display</a>();</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="keyword">virtual</span> <a class="code" href="classcpp3ds_1_1Vector2.htm">Vector2u</a> <a class="code" href="classcpp3ds_1_1RenderTexture.htm#a2262017697d51a803f52180414f1e513">getSize</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> </div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keyword">const</span> <a class="code" href="classcpp3ds_1_1Texture.htm">Texture</a>& <a class="code" href="classcpp3ds_1_1RenderTexture.htm#aa25681af291d3f418692785f2fb4264c">getTexture</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="keyword">private</span> :</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> </div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> activate(<span class="keywordtype">bool</span> active);</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> </div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <span class="comment">// Member data</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"></span> <a class="code" href="classcpp3ds_1_1Texture.htm">Texture</a> m_texture; </div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_width; </div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_height; </div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> </div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <a class="code" href="classcpp3ds_1_1Context.htm">Context</a>* m_context; </div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_frameBuffer; </div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_depthBuffer; </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> </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> </div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> </div>
<div class="ttc" id="classcpp3ds_1_1RenderTexture_htm_a3a3088ca8f62500260a6a3e3c2d83207"><div class="ttname"><a href="classcpp3ds_1_1RenderTexture.htm#a3a3088ca8f62500260a6a3e3c2d83207">cpp3ds::RenderTexture::RenderTexture</a></div><div class="ttdeci">RenderTexture()</div><div class="ttdoc">Default constructor. </div></div>
<div class="ttc" id="classcpp3ds_1_1RenderTexture_htm_a2262017697d51a803f52180414f1e513"><div class="ttname"><a href="classcpp3ds_1_1RenderTexture.htm#a2262017697d51a803f52180414f1e513">cpp3ds::RenderTexture::getSize</a></div><div class="ttdeci">virtual Vector2u getSize() const </div><div class="ttdoc">Return the size of the rendering region of the texture. </div></div>
<div class="ttc" id="namespacecpp3ds_htm"><div class="ttname"><a href="namespacecpp3ds.htm">cpp3ds</a></div><div class="ttdef"><b>Definition:</b> <a href="AlResource_8hpp_source.htm#l00033">AlResource.hpp:33</a></div></div>
<div class="ttc" id="classcpp3ds_1_1RenderTexture_htm_a16edd1c6474a49d062be43164cb52078"><div class="ttname"><a href="classcpp3ds_1_1RenderTexture.htm#a16edd1c6474a49d062be43164cb52078">cpp3ds::RenderTexture::setSmooth</a></div><div class="ttdeci">void setSmooth(bool smooth)</div><div class="ttdoc">Enable or disable texture smoothing. </div></div>
<div class="ttc" id="classcpp3ds_1_1RenderTexture_htm_a8e554ce283fec207a55fe79c889dd68a"><div class="ttname"><a href="classcpp3ds_1_1RenderTexture.htm#a8e554ce283fec207a55fe79c889dd68a">cpp3ds::RenderTexture::create</a></div><div class="ttdeci">bool create(unsigned int width, unsigned int height, bool depthBuffer=false)</div><div class="ttdoc">Create the render-texture. </div></div>
<div class="ttc" id="classcpp3ds_1_1RenderTexture_htm_a88bc49e80ef17eb7f8d7cd81105f7963"><div class="ttname"><a href="classcpp3ds_1_1RenderTexture.htm#a88bc49e80ef17eb7f8d7cd81105f7963">cpp3ds::RenderTexture::isSmooth</a></div><div class="ttdeci">bool isSmooth() const </div><div class="ttdoc">Tell whether the smooth filtering is enabled or not. </div></div>
<div class="ttc" id="classcpp3ds_1_1RenderTexture_htm_aa25681af291d3f418692785f2fb4264c"><div class="ttname"><a href="classcpp3ds_1_1RenderTexture.htm#aa25681af291d3f418692785f2fb4264c">cpp3ds::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>
<div class="ttc" id="classcpp3ds_1_1RenderTexture_htm_ae8321500ef18570f935aa13f8fbdeecf"><div class="ttname"><a href="classcpp3ds_1_1RenderTexture.htm#ae8321500ef18570f935aa13f8fbdeecf">cpp3ds::RenderTexture::display</a></div><div class="ttdeci">void display()</div><div class="ttdoc">Update the contents of the target texture. </div></div>
<div class="ttc" id="classcpp3ds_1_1Vector2_htm"><div class="ttname"><a href="classcpp3ds_1_1Vector2.htm">cpp3ds::Vector2< unsigned int ></a></div></div>
<div class="ttc" id="classcpp3ds_1_1RenderTexture_htm_a2e76f77e0fb1d10b595b10a8842d00f9"><div class="ttname"><a href="classcpp3ds_1_1RenderTexture.htm#a2e76f77e0fb1d10b595b10a8842d00f9">cpp3ds::RenderTexture::setActive</a></div><div class="ttdeci">bool setActive(bool active=true)</div><div class="ttdoc">Activate of deactivate the render-texture for rendering. </div></div>
<div class="ttc" id="classcpp3ds_1_1RenderTexture_htm_a181c61c022d7db997eac0e7c1d051d94"><div class="ttname"><a href="classcpp3ds_1_1RenderTexture.htm#a181c61c022d7db997eac0e7c1d051d94">cpp3ds::RenderTexture::isRepeated</a></div><div class="ttdeci">bool isRepeated() const </div><div class="ttdoc">Tell whether the texture is repeated or not. </div></div>
<div class="ttc" id="classcpp3ds_1_1RenderTarget_htm"><div class="ttname"><a href="classcpp3ds_1_1RenderTarget.htm">cpp3ds::RenderTarget</a></div><div class="ttdoc">Base class for all render targets (window, texture, ...) </div><div class="ttdef"><b>Definition:</b> <a href="RenderTarget_8hpp_source.htm#l00047">RenderTarget.hpp:47</a></div></div>
<div class="ttc" id="classcpp3ds_1_1RenderTexture_htm_a22e03940d9217065c036652254af5f86"><div class="ttname"><a href="classcpp3ds_1_1RenderTexture.htm#a22e03940d9217065c036652254af5f86">cpp3ds::RenderTexture::setRepeated</a></div><div class="ttdeci">void setRepeated(bool repeated)</div><div class="ttdoc">Enable or disable texture repeating. </div></div>
<div class="ttc" id="classcpp3ds_1_1RenderTexture_htm_a51b8240dbbefafe9e01cc0c3d0b9400b"><div class="ttname"><a href="classcpp3ds_1_1RenderTexture.htm#a51b8240dbbefafe9e01cc0c3d0b9400b">cpp3ds::RenderTexture::~RenderTexture</a></div><div class="ttdeci">virtual ~RenderTexture()</div><div class="ttdoc">Destructor. </div></div>
<div class="ttc" id="classcpp3ds_1_1Context_htm"><div class="ttname"><a href="classcpp3ds_1_1Context.htm">cpp3ds::Context</a></div><div class="ttdoc">Class holding a valid drawing context. </div><div class="ttdef"><b>Definition:</b> <a href="Context_8hpp_source.htm#l00047">Context.hpp:47</a></div></div>
<div class="ttc" id="classcpp3ds_1_1RenderTexture_htm"><div class="ttname"><a href="classcpp3ds_1_1RenderTexture.htm">cpp3ds::RenderTexture</a></div><div class="ttdoc">Target for off-screen 2D rendering into a texture. </div><div class="ttdef"><b>Definition:</b> <a href="RenderTexture_8hpp_source.htm#l00043">RenderTexture.hpp:43</a></div></div>
<div class="ttc" id="classcpp3ds_1_1Texture_htm"><div class="ttname"><a href="classcpp3ds_1_1Texture.htm">cpp3ds::Texture</a></div><div class="ttdoc">some things could easily be broken/////// </div><div class="ttdef"><b>Definition:</b> <a href="Texture_8hpp_source.htm#l00047">Texture.hpp:47</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
SFML Copyright © Laurent Gomila
</div>
</div>
</body>
</html>