-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_cursor_8h_source.html
93 lines (93 loc) · 42.2 KB
/
_cursor_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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
<!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): Cursor.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.6.0</span>
</div>
<div id="projectbrief">A C++11 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">Cursor.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-2017 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">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">GF_CURSOR_H</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">GF_CURSOR_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">#</span><span class="preprocessor">include</span> <span class="preprocessor"><</span><span class="preprocessor">cstdint</span><span class="preprocessor">></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="_portability_8h.html">"Portability.h"</a></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="_vector_8h.html">"Vector.h"</a></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">struct</span> SDL_Cursor;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">struct</span> SDL_Surface;</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> <span class="keyword">namespace</span> <a class="code" href="namespacegf.html">gf</a> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">inline</span> <span class="keyword">namespace</span> v1 {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#</span><span class="preprocessor">endif</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">class</span> <a class="code" href="classgf_1_1_image.html">Image</a>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">/**</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * @ingroup window</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * @brief A mouse cursor</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> *</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * This class abstracts the operating system resources</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * associated with either a native system cursor or a custom</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * cursor.</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> *</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * After loading the cursor the graphical appearance</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * with either loadFromPixels() or loadFromSystem(), the</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * cursor can be changed with gf::Window::setMouseCursor().</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> *</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * The behaviour is undefined if the cursor is destroyed while</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * in use by the window.</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> *</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * Usage example:</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * @code</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * gf::Window window;</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> *</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * // ... create window as usual ...</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> *</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * gf::Cursor cursor;</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> *</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * if (cursor.loadFromSystem(gf::Cursor::Hand)) {</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * window.setMouseCursor(cursor);</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * }</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * @endcode</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> *</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * @see gf::Window::setMouseCursor()</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> */</span></div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classgf_1_1_cursor.html"> 72</a></span>  <span class="keyword">class</span> <a class="code" href="_portability_8h.html#a0169111e0ff1d9fe0f23dee89e904d57">GF_API</a> <a class="code" href="classgf_1_1_cursor.html">Cursor</a> {</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">/**</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * @brief Enumeration of the native system cursor types</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> */</span></div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49"> 78</a></span>  <span class="keyword">enum</span> <a class="code" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49">Type</a> {</div><div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49a25b919906281f922869605e6f2f672a1"> 79</a></span>  <a class="code" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49a25b919906281f922869605e6f2f672a1">Arrow</a>, <span class="comment">///< Arrow cursor (default)</span></div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49ac087eb69713be21880fe6a59dc054e26"> 80</a></span>  <a class="code" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49ac087eb69713be21880fe6a59dc054e26">ArrowWait</a>, <span class="comment">///< Busy arrow cursor</span></div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49ab925b2f97b9f3cce5ed2922fa6286aeb"> 81</a></span>  <a class="code" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49ab925b2f97b9f3cce5ed2922fa6286aeb">Wait</a>, <span class="comment">///< Busy cursor</span></div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49acee561ffbc398c85966d587a7d884c24"> 82</a></span>  <a class="code" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49acee561ffbc398c85966d587a7d884c24">Text</a>, <span class="comment">///< I-beam, cursor when hovering over a field allowing text entry</span></div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49aa55c208b1c2436eed83f2435ffdf1103"> 83</a></span>  <a class="code" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49aa55c208b1c2436eed83f2435ffdf1103">Hand</a>, <span class="comment">///< Pointing hand cursor</span></div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49ab1188d3d430faaa5df59662b14996be5"> 84</a></span>  <a class="code" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49ab1188d3d430faaa5df59662b14996be5">SizeHorizontal</a>, <span class="comment">///< Horizontal double arrow cursor</span></div><div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49a59b4bf3bceb5e2f810b65049b6c2fd01"> 85</a></span>  <a class="code" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49a59b4bf3bceb5e2f810b65049b6c2fd01">SizeVertical</a>, <span class="comment">///< Vertical double arrow cursor</span></div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49a2631436c27011d4152de2235b01ed6ca"> 86</a></span>  <a class="code" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49a2631436c27011d4152de2235b01ed6ca">SizeTopLeftBottomRight</a>, <span class="comment">///< Double arrow cursor going from top-left to bottom-right</span></div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49a6a72ebde234daa28d81ad7d49b388234"> 87</a></span>  <a class="code" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49a6a72ebde234daa28d81ad7d49b388234">SizeBottomLeftTopRight</a>, <span class="comment">///< Double arrow cursor going from bottom-left to top-right</span></div><div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49a473f8c21c3da072f993f43a17229b44b"> 88</a></span>  <a class="code" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49a473f8c21c3da072f993f43a17229b44b">SizeAll</a>, <span class="comment">///< Combination of SizeHorizontal and SizeVertical</span></div><div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49a641d711a2721b05181333b41f35f3e61"> 89</a></span>  <a class="code" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49a641d711a2721b05181333b41f35f3e61">Cross</a>, <span class="comment">///< Crosshair cursor</span></div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49acb38c8fd4917ce29ef56b9d6ff555e06"> 90</a></span>  <a class="code" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49acb38c8fd4917ce29ef56b9d6ff555e06">NotAllowed</a> <span class="comment">///< Action not allowed cursor</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  };</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="comment">/**</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * @brief Default constructor</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> *</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * This constructor doesn't actually create the cursor;</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * initially the new instance is invalid and must not be</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * used until either loadFromPixels() or loadFromSystem()</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * is called and successfully created a cursor.</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> */</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <a class="code" href="classgf_1_1_cursor.html#af4ee2f5f987918c7176079722b6b8b28">Cursor</a>();</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="comment">/**</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * @brief Deleted copy constructor</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> */</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="classgf_1_1_cursor.html#a76bf3d06801ccf44914790d40363781b">Cursor</a>(<span class="keyword">const</span> <a class="code" href="classgf_1_1_cursor.html">Cursor</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="comment">/**</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * @brief Deleted copy assignment</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> */</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <a class="code" href="classgf_1_1_cursor.html">Cursor</a>& <a class="code" href="classgf_1_1_cursor.html#a1f0f50834dd82d3607f3cd57225521e0">operator</a>=(<span class="keyword">const</span> <a class="code" href="classgf_1_1_cursor.html">Cursor</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="comment">/**</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * @brief Move constructor</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> */</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <a class="code" href="classgf_1_1_cursor.html#ab16729d0f64f9b74afe632564ae0b638">Cursor</a>(<a class="code" href="classgf_1_1_cursor.html">Cursor</a>&& other);</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>  <span class="comment">/**</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * @brief Move assignment</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> */</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <a class="code" href="classgf_1_1_cursor.html">Cursor</a>& <a class="code" href="classgf_1_1_cursor.html#a0219fbdf8562f755409095658883590f">operator</a>=(<a class="code" href="classgf_1_1_cursor.html">Cursor</a>&& other);</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="comment">/**</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * @brief Destructor</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> *</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * This destructor releases the system resources</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * associated with this cursor, if any.</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> */</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  ~<a class="code" href="classgf_1_1_cursor.html#af4a272c7a1ea1b794c3488f86c8ebfa3">Cursor</a>();</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>  <span class="comment">/**</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * @brief Create a cursor with the provided pixels</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> *</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> * @a pixels must be an array of @a width by @a height pixels</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> * in 32-bit RGBA format. If not, this will cause undefined behavior.</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> *</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * If @a pixels is null or either @a width or @a height are 0,</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> * the current cursor is left unchanged and the function will</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * return false.</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> *</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * In addition to specifying the pixel data, you can also</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * specify the location of the hotspot of the cursor. The</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * hotspot is the pixel coordinate within the cursor image</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * which will be located exactly where the mouse pointer</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * position is. Any mouse actions that are performed will</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> * return the window/screen location of the hotspot.</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> *</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> *</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * @param pixels An array of pixels of the image</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * @param size The width and height of the image</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * @param hotspot The location of the hotspot</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * @returns True if the cursor was successfully loaded; false otherwise</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> *</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * @sa loadFromImage()</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> */</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_cursor.html#a44a3417fa273d17e0f4793b2ed437065">loadFromPixels</a>(<span class="keyword">const</span> uint8_t* pixels, Vector2u size, Vector2u hotspot);</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="comment">/**</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * @brief Create a cursor from the provided image</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> *</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> * @param image The image</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> * @param hotspot THe location of the hotspot</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * @returns True if the cursor was successfully loaded; false otherwise</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> *</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> * @sa loadFromPixels()</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> */</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_cursor.html#a865d04413e8e7c49d3bf4d5bb76e1a0b">loadFromImage</a>(<span class="keyword">const</span> <a class="code" href="classgf_1_1_image.html">Image</a>& image, Vector2u hotspot);</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>  <span class="comment">/**</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * @brief Create a native system cursor</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> *</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * @param type The native system cursor type</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * @return True if the cursor was successfully loaded; false otherwise</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> */</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_cursor.html#a7fdcfc6496e98b7efc35c09ba431eeb8">loadFromSystem</a>(<a class="code" href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49">Type</a> type);</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>  <span class="keyword">private</span>:</div><div class="line"><a name="l00178"></a><span class="lineno"><a class="line" href="classgf_1_1_cursor.html#a553f958a25683445088050a69d3de8e9"> 178</a></span>  <span class="keyword">friend</span> <span class="keyword">class</span> <a class="code" href="classgf_1_1_shader.html#aa5afc6f82b7b587ed5ada4d227ce32aa">Window</a>;</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  SDL_Cursor *m_cursor;</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</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> <span class="preprocessor">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> }</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="preprocessor">#</span><span class="preprocessor">endif</span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> }</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> </div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="preprocessor">#</span><span class="preprocessor">endif</span> <span class="comment">// GF_CURSOR_H</span></div><div class="ttc" id="classgf_1_1_cursor_html_ab0a2a0075ec20bf14a992f8120d9bf49a59b4bf3bceb5e2f810b65049b6c2fd01"><div class="ttname"><a href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49a59b4bf3bceb5e2f810b65049b6c2fd01">gf::Cursor::SizeVertical</a></div><div class="ttdoc">Vertical double arrow cursor. </div><div class="ttdef"><b>Definition:</b> Cursor.h:85</div></div>
<div class="ttc" id="classgf_1_1_cursor_html_ab0a2a0075ec20bf14a992f8120d9bf49acb38c8fd4917ce29ef56b9d6ff555e06"><div class="ttname"><a href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49acb38c8fd4917ce29ef56b9d6ff555e06">gf::Cursor::NotAllowed</a></div><div class="ttdoc">Action not allowed cursor. </div><div class="ttdef"><b>Definition:</b> Cursor.h:90</div></div>
<div class="ttc" id="classgf_1_1_cursor_html_a1f0f50834dd82d3607f3cd57225521e0"><div class="ttname"><a href="classgf_1_1_cursor.html#a1f0f50834dd82d3607f3cd57225521e0">gf::Cursor::operator=</a></div><div class="ttdeci">Cursor & operator=(const Cursor &)=delete</div><div class="ttdoc">Deleted copy assignment. </div></div>
<div class="ttc" id="classgf_1_1_cursor_html_ab0a2a0075ec20bf14a992f8120d9bf49a25b919906281f922869605e6f2f672a1"><div class="ttname"><a href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49a25b919906281f922869605e6f2f672a1">gf::Cursor::Arrow</a></div><div class="ttdoc">Arrow cursor (default) </div><div class="ttdef"><b>Definition:</b> Cursor.h:79</div></div>
<div class="ttc" id="classgf_1_1_cursor_html_a0219fbdf8562f755409095658883590f"><div class="ttname"><a href="classgf_1_1_cursor.html#a0219fbdf8562f755409095658883590f">gf::Cursor::operator=</a></div><div class="ttdeci">Cursor & operator=(Cursor &&other)</div><div class="ttdoc">Move assignment. </div></div>
<div class="ttc" id="classgf_1_1_cursor_html_ab0a2a0075ec20bf14a992f8120d9bf49"><div class="ttname"><a href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49">gf::Cursor::Type</a></div><div class="ttdeci">Type</div><div class="ttdoc">Enumeration of the native system cursor types. </div><div class="ttdef"><b>Definition:</b> Cursor.h:78</div></div>
<div class="ttc" id="classgf_1_1_cursor_html_af4ee2f5f987918c7176079722b6b8b28"><div class="ttname"><a href="classgf_1_1_cursor.html#af4ee2f5f987918c7176079722b6b8b28">gf::Cursor::Cursor</a></div><div class="ttdeci">Cursor()</div><div class="ttdoc">Default constructor. </div></div>
<div class="ttc" id="classgf_1_1_shader_html_aa5afc6f82b7b587ed5ada4d227ce32aa"><div class="ttname"><a href="classgf_1_1_shader.html#aa5afc6f82b7b587ed5ada4d227ce32aa">gf::Shader::RenderTarget</a></div><div class="ttdeci">friend class RenderTarget</div><div class="ttdef"><b>Definition:</b> Shader.h:388</div></div>
<div class="ttc" id="classgf_1_1_cursor_html_a44a3417fa273d17e0f4793b2ed437065"><div class="ttname"><a href="classgf_1_1_cursor.html#a44a3417fa273d17e0f4793b2ed437065">gf::Cursor::loadFromPixels</a></div><div class="ttdeci">bool loadFromPixels(const uint8_t *pixels, Vector2u size, Vector2u hotspot)</div><div class="ttdoc">Create a cursor with the provided pixels. </div></div>
<div class="ttc" id="classgf_1_1_cursor_html_ab0a2a0075ec20bf14a992f8120d9bf49a6a72ebde234daa28d81ad7d49b388234"><div class="ttname"><a href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49a6a72ebde234daa28d81ad7d49b388234">gf::Cursor::SizeBottomLeftTopRight</a></div><div class="ttdoc">Double arrow cursor going from bottom-left to top-right. </div><div class="ttdef"><b>Definition:</b> Cursor.h:87</div></div>
<div class="ttc" id="classgf_1_1_cursor_html_ab0a2a0075ec20bf14a992f8120d9bf49ac087eb69713be21880fe6a59dc054e26"><div class="ttname"><a href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49ac087eb69713be21880fe6a59dc054e26">gf::Cursor::ArrowWait</a></div><div class="ttdoc">Busy arrow cursor. </div><div class="ttdef"><b>Definition:</b> Cursor.h:80</div></div>
<div class="ttc" id="classgf_1_1_cursor_html_a865d04413e8e7c49d3bf4d5bb76e1a0b"><div class="ttname"><a href="classgf_1_1_cursor.html#a865d04413e8e7c49d3bf4d5bb76e1a0b">gf::Cursor::loadFromImage</a></div><div class="ttdeci">bool loadFromImage(const Image &image, Vector2u hotspot)</div><div class="ttdoc">Create a cursor from the provided image. </div></div>
<div class="ttc" id="classgf_1_1_cursor_html_ab0a2a0075ec20bf14a992f8120d9bf49ab1188d3d430faaa5df59662b14996be5"><div class="ttname"><a href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49ab1188d3d430faaa5df59662b14996be5">gf::Cursor::SizeHorizontal</a></div><div class="ttdoc">Horizontal double arrow cursor. </div><div class="ttdef"><b>Definition:</b> Cursor.h:84</div></div>
<div class="ttc" id="classgf_1_1_cursor_html_ab0a2a0075ec20bf14a992f8120d9bf49a641d711a2721b05181333b41f35f3e61"><div class="ttname"><a href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49a641d711a2721b05181333b41f35f3e61">gf::Cursor::Cross</a></div><div class="ttdoc">Crosshair cursor. </div><div class="ttdef"><b>Definition:</b> Cursor.h:89</div></div>
<div class="ttc" id="classgf_1_1_cursor_html_ab0a2a0075ec20bf14a992f8120d9bf49a473f8c21c3da072f993f43a17229b44b"><div class="ttname"><a href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49a473f8c21c3da072f993f43a17229b44b">gf::Cursor::SizeAll</a></div><div class="ttdoc">Combination of SizeHorizontal and SizeVertical. </div><div class="ttdef"><b>Definition:</b> Cursor.h:88</div></div>
<div class="ttc" id="classgf_1_1_cursor_html_ab0a2a0075ec20bf14a992f8120d9bf49ab925b2f97b9f3cce5ed2922fa6286aeb"><div class="ttname"><a href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49ab925b2f97b9f3cce5ed2922fa6286aeb">gf::Cursor::Wait</a></div><div class="ttdoc">Busy cursor. </div><div class="ttdef"><b>Definition:</b> Cursor.h:81</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:92</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:34</div></div>
<div class="ttc" id="classgf_1_1_cursor_html_ab0a2a0075ec20bf14a992f8120d9bf49acee561ffbc398c85966d587a7d884c24"><div class="ttname"><a href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49acee561ffbc398c85966d587a7d884c24">gf::Cursor::Text</a></div><div class="ttdoc">I-beam, cursor when hovering over a field allowing text entry. </div><div class="ttdef"><b>Definition:</b> Cursor.h:82</div></div>
<div class="ttc" id="classgf_1_1_cursor_html_ab0a2a0075ec20bf14a992f8120d9bf49aa55c208b1c2436eed83f2435ffdf1103"><div class="ttname"><a href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49aa55c208b1c2436eed83f2435ffdf1103">gf::Cursor::Hand</a></div><div class="ttdoc">Pointing hand cursor. </div><div class="ttdef"><b>Definition:</b> Cursor.h:83</div></div>
<div class="ttc" id="classgf_1_1_cursor_html_ab0a2a0075ec20bf14a992f8120d9bf49a2631436c27011d4152de2235b01ed6ca"><div class="ttname"><a href="classgf_1_1_cursor.html#ab0a2a0075ec20bf14a992f8120d9bf49a2631436c27011d4152de2235b01ed6ca">gf::Cursor::SizeTopLeftBottomRight</a></div><div class="ttdoc">Double arrow cursor going from top-left to bottom-right. </div><div class="ttdef"><b>Definition:</b> Cursor.h:86</div></div>
<div class="ttc" id="classgf_1_1_cursor_html_a76bf3d06801ccf44914790d40363781b"><div class="ttname"><a href="classgf_1_1_cursor.html#a76bf3d06801ccf44914790d40363781b">gf::Cursor::Cursor</a></div><div class="ttdeci">Cursor(const Cursor &)=delete</div><div class="ttdoc">Deleted copy constructor. </div></div>
<div class="ttc" id="classgf_1_1_cursor_html"><div class="ttname"><a href="classgf_1_1_cursor.html">gf::Cursor</a></div><div class="ttdoc">A mouse cursor. </div><div class="ttdef"><b>Definition:</b> Cursor.h:72</div></div>
<div class="ttc" id="_portability_8h_html_a0169111e0ff1d9fe0f23dee89e904d57"><div class="ttname"><a href="_portability_8h.html#a0169111e0ff1d9fe0f23dee89e904d57">GF_API</a></div><div class="ttdeci">#define GF_API</div><div class="ttdef"><b>Definition:</b> Portability.h:35</div></div>
<div class="ttc" id="classgf_1_1_cursor_html_ab16729d0f64f9b74afe632564ae0b638"><div class="ttname"><a href="classgf_1_1_cursor.html#ab16729d0f64f9b74afe632564ae0b638">gf::Cursor::Cursor</a></div><div class="ttdeci">Cursor(Cursor &&other)</div><div class="ttdoc">Move constructor. </div></div>
<div class="ttc" id="classgf_1_1_cursor_html_af4a272c7a1ea1b794c3488f86c8ebfa3"><div class="ttname"><a href="classgf_1_1_cursor.html#af4a272c7a1ea1b794c3488f86c8ebfa3">gf::Cursor::~Cursor</a></div><div class="ttdeci">~Cursor()</div><div class="ttdoc">Destructor. </div></div>
<div class="ttc" id="classgf_1_1_cursor_html_a7fdcfc6496e98b7efc35c09ba431eeb8"><div class="ttname"><a href="classgf_1_1_cursor.html#a7fdcfc6496e98b7efc35c09ba431eeb8">gf::Cursor::loadFromSystem</a></div><div class="ttdeci">bool loadFromSystem(Type type)</div><div class="ttdoc">Create a native system cursor. </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>