-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_buffer_ref_8h_source.html
79 lines (79 loc) · 33.2 KB
/
_buffer_ref_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
<!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): BufferRef.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">BufferRef.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="preprocessor">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">GF_BUFFER_REF_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">GF_BUFFER_REF_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#</span><span class="preprocessor">include</span> <span class="preprocessor"><</span><span class="preprocessor">array</span><span class="preprocessor">></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#</span><span class="preprocessor">include</span> <span class="preprocessor"><</span><span class="preprocessor">vector</span><span class="preprocessor">></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="keyword">namespace</span> <a class="code" href="namespacegf.html">gf</a> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">inline</span> <span class="keyword">namespace</span> v1 {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#</span><span class="preprocessor">endif</span></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="comment">/**</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * @ingroup core</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * @brief A reference to a modifiable buffer and its size</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> *</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * This class stores a pointer to a buffer and its size. It can be built</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * from various inputs: `std::vector`, `std::array`, static array, pointer</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * and size.</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> *</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * @sa gf::ArrayRef, gf::StringRef</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> */</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classgf_1_1_buffer_ref.html"> 43</a></span>  <span class="keyword">class</span> <a class="code" href="classgf_1_1_buffer_ref.html">BufferRef</a> {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">public</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"> * @brief Default constructor</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> *</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * Data is `nullptr` and size is 0.</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"><a class="line" href="classgf_1_1_buffer_ref.html#acf5eedb9be405a0ae796ce7fbe16edee"> 50</a></span>  <span class="keyword">constexpr</span> <a class="code" href="classgf_1_1_buffer_ref.html#acf5eedb9be405a0ae796ce7fbe16edee">BufferRef</a>()</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  : m_data(<span class="keywordtype">nullptr</span>)</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  , m_size(0)</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">/**</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * @brief Null constructor</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> *</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * Data is `nullptr` and size is 0.</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> */</span></div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classgf_1_1_buffer_ref.html#a14a1707b2260d02acf1a15abc592f7bf"> 62</a></span>  <span class="keyword">constexpr</span> <a class="code" href="classgf_1_1_buffer_ref.html#a14a1707b2260d02acf1a15abc592f7bf">BufferRef</a>(std::nullptr_t)</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  : m_data(<span class="keywordtype">nullptr</span>)</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  , m_size(0)</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  {</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  }</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</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"> * @brief Constructor from a pointer and a size</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"> 72</span> <span class="comment"> * @param data A pointer to a buffer</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * @param size The number of elements in the buffer</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> */</span></div><div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="classgf_1_1_buffer_ref.html#a61d37985d36b29807cb5f7d6a1e73351"> 75</a></span>  <span class="keyword">constexpr</span> <a class="code" href="classgf_1_1_buffer_ref.html#a61d37985d36b29807cb5f7d6a1e73351">BufferRef</a>(T *data, std::size_t size)</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  : m_data(data)</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  , m_size(size)</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  {</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  }</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="comment">/**</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * @brief Constructor from a `std::vector`</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> *</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> * @param values The vector of elements</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> */</span></div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classgf_1_1_buffer_ref.html#a564ab595e2f37ba02965f9ec40c148fe"> 87</a></span>  <a class="code" href="classgf_1_1_buffer_ref.html#a564ab595e2f37ba02965f9ec40c148fe">BufferRef</a>(std::vector<T>& values)</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  : <a class="code" href="classgf_1_1_buffer_ref.html#a564ab595e2f37ba02965f9ec40c148fe">m_data</a>(<a class="code" href="classgf_1_1_buffer_ref.html#a564ab595e2f37ba02965f9ec40c148fe">values</a>.<a class="code" href="classgf_1_1_buffer_ref.html#a564ab595e2f37ba02965f9ec40c148fe">data</a>())</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  , <a class="code" href="classgf_1_1_buffer_ref.html#a564ab595e2f37ba02965f9ec40c148fe">m_size</a>(<a class="code" href="classgf_1_1_buffer_ref.html#a564ab595e2f37ba02965f9ec40c148fe">values</a>.<a class="code" href="classgf_1_1_buffer_ref.html#a564ab595e2f37ba02965f9ec40c148fe">size</a>())</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</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> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="comment">/**</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * @brief Constructor from a `std::array`</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> *</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * @param values The array of elements</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> */</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">template</span><std::size_t N></div><div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="classgf_1_1_buffer_ref.html#af24ad594aa31890cd2c9429d26467352"> 100</a></span>  <a class="code" href="classgf_1_1_buffer_ref.html#af24ad594aa31890cd2c9429d26467352">BufferRef</a>(std::array<T,N>& values)</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  : m_data(values.data())</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  , m_size(values.size())</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  {</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  }</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>  <span class="comment">/**</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * @brief Constructor from a static array</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> *</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * The size is computed at compile-time.</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> *</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * @param data The static array</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="keyword">template</span><std::size_t N></div><div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="classgf_1_1_buffer_ref.html#a38f5a772204de54c3c56607e822f1c37"> 115</a></span>  <span class="keyword">constexpr</span> <a class="code" href="classgf_1_1_buffer_ref.html#a38f5a772204de54c3c56607e822f1c37">BufferRef</a>(T (&data)[N])</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  : m_data(data)</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  , m_size(N)</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  {</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="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="comment">/**</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * @brief Get a pointer to the elements</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> *</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * @returns A pointer to the first element in the array</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> */</span></div><div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="classgf_1_1_buffer_ref.html#a6faba44c8e0da85c2d7c317ebc3025fb"> 127</a></span>  T *<a class="code" href="classgf_1_1_buffer_ref.html#a6faba44c8e0da85c2d7c317ebc3025fb">getData</a>() <span class="keyword">noexcept</span> {</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordflow">return</span> m_data;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  }</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 Get the number of elements</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"> * @returns The number of elements in the array</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> */</span></div><div class="line"><a name="l00136"></a><span class="lineno"><a class="line" href="classgf_1_1_buffer_ref.html#a44d178a1aaa1ba47bb6ae4cfa706e962"> 136</a></span>  <span class="keyword">constexpr</span> std::size_t <a class="code" href="classgf_1_1_buffer_ref.html#a44d178a1aaa1ba47bb6ae4cfa706e962">getSize</a>() <span class="keyword">const</span> <span class="keyword">noexcept</span> {</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordflow">return</span> m_size;</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  }</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</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"> * @brief Get an iterator to the first element</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> *</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * @returns A pointer to the first element</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> *</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * @sa end()</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> */</span></div><div class="line"><a name="l00147"></a><span class="lineno"><a class="line" href="classgf_1_1_buffer_ref.html#a07803ae555243760e4f25313c048fce1"> 147</a></span>  T *<a class="code" href="classgf_1_1_buffer_ref.html#a07803ae555243760e4f25313c048fce1">begin</a>() <span class="keyword">noexcept</span> {</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keywordflow">return</span> m_data;</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  }</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="comment">/**</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * @brief Get an iterator past the last element</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"> * @returns A pointer past the last element</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="comment"> * @sa begin()</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> */</span></div><div class="line"><a name="l00158"></a><span class="lineno"><a class="line" href="classgf_1_1_buffer_ref.html#a545c6bc0d8f5bc3a7c629e7daad34c39"> 158</a></span>  T *<a class="code" href="classgf_1_1_buffer_ref.html#a545c6bc0d8f5bc3a7c629e7daad34c39">end</a>() <span class="keyword">noexcept</span> {</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keywordflow">return</span> m_data + m_size;</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  }</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="comment">/**</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * @brief Get an element at a given index</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"> * No verification is done on the index.</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="comment"> * @param index The index of the element</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * @returns The element at the given index</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"><a class="line" href="classgf_1_1_buffer_ref.html#a9453904f6ea174e0a041a40ac8b33e0c"> 170</a></span>  T& <a class="code" href="classgf_1_1_buffer_ref.html#a9453904f6ea174e0a041a40ac8b33e0c">operator</a>[](std::size_t index) {</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="keywordflow">return</span> m_data[index];</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  }</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> </div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  T *m_data;</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  std::size_t m_size;</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> </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">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">DOXYGEN_SHOULD_SKIP_THIS</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">endif</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> </div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="preprocessor">#</span><span class="preprocessor">endif</span> <span class="comment">// GF_BUFFER_REF_H</span></div><div class="ttc" id="classgf_1_1_buffer_ref_html_a9453904f6ea174e0a041a40ac8b33e0c"><div class="ttname"><a href="classgf_1_1_buffer_ref.html#a9453904f6ea174e0a041a40ac8b33e0c">gf::BufferRef::operator[]</a></div><div class="ttdeci">T & operator[](std::size_t index)</div><div class="ttdoc">Get an element at a given index. </div><div class="ttdef"><b>Definition:</b> BufferRef.h:170</div></div>
<div class="ttc" id="classgf_1_1_buffer_ref_html_af24ad594aa31890cd2c9429d26467352"><div class="ttname"><a href="classgf_1_1_buffer_ref.html#af24ad594aa31890cd2c9429d26467352">gf::BufferRef::BufferRef</a></div><div class="ttdeci">BufferRef(std::array< T, N > &values)</div><div class="ttdoc">Constructor from a std::array </div><div class="ttdef"><b>Definition:</b> BufferRef.h:100</div></div>
<div class="ttc" id="classgf_1_1_buffer_ref_html_a545c6bc0d8f5bc3a7c629e7daad34c39"><div class="ttname"><a href="classgf_1_1_buffer_ref.html#a545c6bc0d8f5bc3a7c629e7daad34c39">gf::BufferRef::end</a></div><div class="ttdeci">T * end() noexcept</div><div class="ttdoc">Get an iterator past the last element. </div><div class="ttdef"><b>Definition:</b> BufferRef.h:158</div></div>
<div class="ttc" id="classgf_1_1_buffer_ref_html_a38f5a772204de54c3c56607e822f1c37"><div class="ttname"><a href="classgf_1_1_buffer_ref.html#a38f5a772204de54c3c56607e822f1c37">gf::BufferRef::BufferRef</a></div><div class="ttdeci">constexpr BufferRef(T(&data)[N])</div><div class="ttdoc">Constructor from a static array. </div><div class="ttdef"><b>Definition:</b> BufferRef.h:115</div></div>
<div class="ttc" id="classgf_1_1_buffer_ref_html_a44d178a1aaa1ba47bb6ae4cfa706e962"><div class="ttname"><a href="classgf_1_1_buffer_ref.html#a44d178a1aaa1ba47bb6ae4cfa706e962">gf::BufferRef::getSize</a></div><div class="ttdeci">constexpr std::size_t getSize() const noexcept</div><div class="ttdoc">Get the number of elements. </div><div class="ttdef"><b>Definition:</b> BufferRef.h:136</div></div>
<div class="ttc" id="classgf_1_1_buffer_ref_html_a07803ae555243760e4f25313c048fce1"><div class="ttname"><a href="classgf_1_1_buffer_ref.html#a07803ae555243760e4f25313c048fce1">gf::BufferRef::begin</a></div><div class="ttdeci">T * begin() noexcept</div><div class="ttdoc">Get an iterator to the first element. </div><div class="ttdef"><b>Definition:</b> BufferRef.h:147</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_buffer_ref_html_a14a1707b2260d02acf1a15abc592f7bf"><div class="ttname"><a href="classgf_1_1_buffer_ref.html#a14a1707b2260d02acf1a15abc592f7bf">gf::BufferRef::BufferRef</a></div><div class="ttdeci">constexpr BufferRef(std::nullptr_t)</div><div class="ttdoc">Null constructor. </div><div class="ttdef"><b>Definition:</b> BufferRef.h:62</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_buffer_ref_html_a61d37985d36b29807cb5f7d6a1e73351"><div class="ttname"><a href="classgf_1_1_buffer_ref.html#a61d37985d36b29807cb5f7d6a1e73351">gf::BufferRef::BufferRef</a></div><div class="ttdeci">constexpr BufferRef(T *data, std::size_t size)</div><div class="ttdoc">Constructor from a pointer and a size. </div><div class="ttdef"><b>Definition:</b> BufferRef.h:75</div></div>
<div class="ttc" id="classgf_1_1_buffer_ref_html_acf5eedb9be405a0ae796ce7fbe16edee"><div class="ttname"><a href="classgf_1_1_buffer_ref.html#acf5eedb9be405a0ae796ce7fbe16edee">gf::BufferRef::BufferRef</a></div><div class="ttdeci">constexpr BufferRef()</div><div class="ttdoc">Default constructor. </div><div class="ttdef"><b>Definition:</b> BufferRef.h:50</div></div>
<div class="ttc" id="classgf_1_1_buffer_ref_html_a6faba44c8e0da85c2d7c317ebc3025fb"><div class="ttname"><a href="classgf_1_1_buffer_ref.html#a6faba44c8e0da85c2d7c317ebc3025fb">gf::BufferRef::getData</a></div><div class="ttdeci">T * getData() noexcept</div><div class="ttdoc">Get a pointer to the elements. </div><div class="ttdef"><b>Definition:</b> BufferRef.h:127</div></div>
<div class="ttc" id="classgf_1_1_buffer_ref_html_a564ab595e2f37ba02965f9ec40c148fe"><div class="ttname"><a href="classgf_1_1_buffer_ref.html#a564ab595e2f37ba02965f9ec40c148fe">gf::BufferRef::BufferRef</a></div><div class="ttdeci">BufferRef(std::vector< T > &values)</div><div class="ttdoc">Constructor from a std::vector </div><div class="ttdef"><b>Definition:</b> BufferRef.h:87</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>