-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_basic_sprite_8h_source.html
75 lines (75 loc) · 17.1 KB
/
_basic_sprite_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
<!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): BasicSprite.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">BasicSprite.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_BASIC_SPRITE_H</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define GF_BASIC_SPRITE_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 "BufferRef.h"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "Portability.h"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "Rect.h"</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="keyword">namespace </span><a class="code" href="namespacegf.html">gf</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">inline</span> <span class="keyword">namespace </span>v1 {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">class </span><a class="code" href="namespacegf.html#af345882cbbc4e834ec38715ef1cb0c2baa3e8ae43188ae76d38f414b2bdb0077b">Texture</a>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">struct </span>Vertex;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classgf_1_1_basic_sprite.html"> 46</a></span>  <span class="keyword">class </span>GF_API <a class="code" href="classgf_1_1_basic_sprite.html">BasicSprite</a> {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classgf_1_1_basic_sprite.html">BasicSprite</a>();</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="classgf_1_1_basic_sprite.html">BasicSprite</a>(<span class="keyword">const</span> <a class="code" href="classgf_1_1_texture.html">Texture</a>& texture);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classgf_1_1_basic_sprite.html">BasicSprite</a>(<span class="keyword">const</span> <a class="code" href="classgf_1_1_texture.html">Texture</a>& texture, <span class="keyword">const</span> <a class="code" href="structgf_1_1_rect.html">RectF</a>& textureRect);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordtype">void</span> setTexture(<span class="keyword">const</span> <a class="code" href="classgf_1_1_texture.html">Texture</a>& texture, <span class="keywordtype">bool</span> resetRect = <span class="keyword">false</span>);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="classgf_1_1_basic_sprite.html#a0dd9592f0ee38cb0b9a71e22d258d52e"> 104</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_basic_sprite.html#a0dd9592f0ee38cb0b9a71e22d258d52e">getTexture</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordflow">return</span> *m_texture;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  }</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="classgf_1_1_basic_sprite.html#aea9175b06999f82ac29e190a0e50836a"> 115</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_basic_sprite.html#aea9175b06999f82ac29e190a0e50836a">hasTexture</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordflow">return</span> m_texture != <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  }</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordtype">void</span> unsetTexture();</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordtype">void</span> setTextureRect(<span class="keyword">const</span> <a class="code" href="structgf_1_1_rect.html">RectF</a>& rect);</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00152"></a><span class="lineno"><a class="line" href="classgf_1_1_basic_sprite.html#a08c9388b86ece6cce9135200c7d8d166"> 152</a></span>  <span class="keyword">const</span> <a class="code" href="structgf_1_1_rect.html">RectF</a>& <a class="code" href="classgf_1_1_basic_sprite.html#a08c9388b86ece6cce9135200c7d8d166">getTextureRect</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordflow">return</span> m_textureRect;</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  }</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <a class="code" href="structgf_1_1_rect.html">RectF</a> getLocalBounds() <span class="keyword">const</span>;</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> </div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keywordtype">void</span> updateGeometry(<a class="code" href="classgf_1_1_buffer_ref.html">BufferRef<Vertex></a> vertices);</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="keyword">const</span> <a class="code" href="classgf_1_1_texture.html">Texture</a> *m_texture;</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <a class="code" href="structgf_1_1_rect.html">RectF</a> m_textureRect;</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <a class="code" href="structgf_1_1_rect.html">RectF</a> m_bounds;</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  };</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> </div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> }</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> }</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> </div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="preprocessor">#endif // GF_BASIC_SPRITE_H</span></div><div class="ttc" id="classgf_1_1_basic_sprite_html_aea9175b06999f82ac29e190a0e50836a"><div class="ttname"><a href="classgf_1_1_basic_sprite.html#aea9175b06999f82ac29e190a0e50836a">gf::BasicSprite::hasTexture</a></div><div class="ttdeci">bool hasTexture() const</div><div class="ttdoc">Check if a texture is set. </div><div class="ttdef"><b>Definition:</b> BasicSprite.h:115</div></div>
<div class="ttc" id="classgf_1_1_buffer_ref_html"><div class="ttname"><a href="classgf_1_1_buffer_ref.html">gf::BufferRef</a></div><div class="ttdoc">A reference to a modifiable buffer and its size. </div><div class="ttdef"><b>Definition:</b> BufferRef.h:43</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_basic_sprite_html_a08c9388b86ece6cce9135200c7d8d166"><div class="ttname"><a href="classgf_1_1_basic_sprite.html#a08c9388b86ece6cce9135200c7d8d166">gf::BasicSprite::getTextureRect</a></div><div class="ttdeci">const RectF & getTextureRect() const</div><div class="ttdoc">Get the sub-rectangle of the texture displayed by the sprite. </div><div class="ttdef"><b>Definition:</b> BasicSprite.h:152</div></div>
<div class="ttc" id="namespacegf_html_af345882cbbc4e834ec38715ef1cb0c2baa3e8ae43188ae76d38f414b2bdb0077b"><div class="ttname"><a href="namespacegf.html#af345882cbbc4e834ec38715ef1cb0c2baa3e8ae43188ae76d38f414b2bdb0077b">gf::GraphicsTag::Texture</a></div></div>
<div class="ttc" id="structgf_1_1_rect_html"><div class="ttname"><a href="structgf_1_1_rect.html">gf::Rect< float ></a></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_basic_sprite_html_a0dd9592f0ee38cb0b9a71e22d258d52e"><div class="ttname"><a href="classgf_1_1_basic_sprite.html#a0dd9592f0ee38cb0b9a71e22d258d52e">gf::BasicSprite::getTexture</a></div><div class="ttdeci">const Texture & getTexture() const</div><div class="ttdoc">Get the source texture of the sprite. </div><div class="ttdef"><b>Definition:</b> BasicSprite.h:104</div></div>
<div class="ttc" id="classgf_1_1_basic_sprite_html"><div class="ttname"><a href="classgf_1_1_basic_sprite.html">gf::BasicSprite</a></div><div class="ttdoc">A basic sprite. </div><div class="ttdef"><b>Definition:</b> BasicSprite.h:46</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>