• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.15"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>Oboe: oboe::Version Struct Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="search/search.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="search/searchdata.js"></script>
14<script type="text/javascript" src="search/search.js"></script>
15<link href="doxygen.css" rel="stylesheet" type="text/css" />
16</head>
17<body>
18<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19<div id="titlearea">
20<table cellspacing="0" cellpadding="0">
21 <tbody>
22 <tr style="height: 56px;">
23  <td id="projectalign" style="padding-left: 0.5em;">
24   <div id="projectname">Oboe
25   &#160;<span id="projectnumber">1.5</span>
26   </div>
27   <div id="projectbrief">A library for creating real-time audio apps on Android</div>
28  </td>
29 </tr>
30 </tbody>
31</table>
32</div>
33<!-- end header part -->
34<!-- Generated by Doxygen 1.8.15 -->
35<script type="text/javascript">
36/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
37var searchBox = new SearchBox("searchBox", "search",false,'Search');
38/* @license-end */
39</script>
40<script type="text/javascript" src="menudata.js"></script>
41<script type="text/javascript" src="menu.js"></script>
42<script type="text/javascript">
43/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
44$(function() {
45  initMenu('',true,false,'search.php','Search');
46  $(document).ready(function() { init_search(); });
47});
48/* @license-end */</script>
49<div id="main-nav"></div>
50<!-- window showing the filter options -->
51<div id="MSearchSelectWindow"
52     onmouseover="return searchBox.OnSearchSelectShow()"
53     onmouseout="return searchBox.OnSearchSelectHide()"
54     onkeydown="return searchBox.OnSearchSelectKey(event)">
55</div>
56
57<!-- iframe showing the search results (closed by default) -->
58<div id="MSearchResultsWindow">
59<iframe src="javascript:void(0)" frameborder="0"
60        name="MSearchResults" id="MSearchResults">
61</iframe>
62</div>
63
64<div id="nav-path" class="navpath">
65  <ul>
66<li class="navelem"><a class="el" href="namespaceoboe.html">oboe</a></li><li class="navelem"><a class="el" href="structoboe_1_1_version.html">Version</a></li>  </ul>
67</div>
68</div><!-- top -->
69<div class="header">
70  <div class="summary">
71<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
72<a href="structoboe_1_1_version-members.html">List of all members</a>  </div>
73  <div class="headertitle">
74<div class="title">oboe::Version Struct Reference</div>  </div>
75</div><!--header-->
76<div class="contents">
77
78<p><code>#include &lt;<a class="el" href="_version_8h_source.html">Version.h</a>&gt;</code></p>
79<table class="memberdecls">
80<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
81Static Public Attributes</h2></td></tr>
82<tr class="memitem:a270f2e92582d5187be339eeda8e2b276"><td class="memItemLeft" align="right" valign="top">static constexpr uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoboe_1_1_version.html#a270f2e92582d5187be339eeda8e2b276">Major</a> = OBOE_VERSION_MAJOR</td></tr>
83<tr class="separator:a270f2e92582d5187be339eeda8e2b276"><td class="memSeparator" colspan="2">&#160;</td></tr>
84<tr class="memitem:ae460bb95e3a9099696205a35fffb5469"><td class="memItemLeft" align="right" valign="top">static constexpr uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoboe_1_1_version.html#ae460bb95e3a9099696205a35fffb5469">Minor</a> = OBOE_VERSION_MINOR</td></tr>
85<tr class="separator:ae460bb95e3a9099696205a35fffb5469"><td class="memSeparator" colspan="2">&#160;</td></tr>
86<tr class="memitem:a690110f2b3e887892da8f29ab5c057b2"><td class="memItemLeft" align="right" valign="top">static constexpr uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoboe_1_1_version.html#a690110f2b3e887892da8f29ab5c057b2">Patch</a> = OBOE_VERSION_PATCH</td></tr>
87<tr class="separator:a690110f2b3e887892da8f29ab5c057b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
88<tr class="memitem:a2c86e578b827fbca5f40c460a7754503"><td class="memItemLeft" align="right" valign="top">static constexpr const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoboe_1_1_version.html#a2c86e578b827fbca5f40c460a7754503">Text</a> = OBOE_VERSION_TEXT</td></tr>
89<tr class="separator:a2c86e578b827fbca5f40c460a7754503"><td class="memSeparator" colspan="2">&#160;</td></tr>
90<tr class="memitem:ac579661e79bcee45dc676d4647891de0"><td class="memItemLeft" align="right" valign="top">static constexpr uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoboe_1_1_version.html#ac579661e79bcee45dc676d4647891de0">Number</a> = OBOE_VERSION_NUMBER</td></tr>
91<tr class="separator:ac579661e79bcee45dc676d4647891de0"><td class="memSeparator" colspan="2">&#160;</td></tr>
92</table>
93<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
94<div class="textblock"><p>Oboe versioning object </p>
95</div><h2 class="groupheader">Member Data Documentation</h2>
96<a id="a270f2e92582d5187be339eeda8e2b276"></a>
97<h2 class="memtitle"><span class="permalink"><a href="#a270f2e92582d5187be339eeda8e2b276">&#9670;&nbsp;</a></span>Major</h2>
98
99<div class="memitem">
100<div class="memproto">
101<table class="mlabels">
102  <tr>
103  <td class="mlabels-left">
104      <table class="memname">
105        <tr>
106          <td class="memname">constexpr uint8_t oboe::Version::Major = OBOE_VERSION_MAJOR</td>
107        </tr>
108      </table>
109  </td>
110  <td class="mlabels-right">
111<span class="mlabels"><span class="mlabel">static</span></span>  </td>
112  </tr>
113</table>
114</div><div class="memdoc">
115<p>This is incremented when we make breaking API changes. Based loosely on <a href="https://semver.org/">https://semver.org/</a>. </p>
116
117</div>
118</div>
119<a id="ae460bb95e3a9099696205a35fffb5469"></a>
120<h2 class="memtitle"><span class="permalink"><a href="#ae460bb95e3a9099696205a35fffb5469">&#9670;&nbsp;</a></span>Minor</h2>
121
122<div class="memitem">
123<div class="memproto">
124<table class="mlabels">
125  <tr>
126  <td class="mlabels-left">
127      <table class="memname">
128        <tr>
129          <td class="memname">constexpr uint8_t oboe::Version::Minor = OBOE_VERSION_MINOR</td>
130        </tr>
131      </table>
132  </td>
133  <td class="mlabels-right">
134<span class="mlabels"><span class="mlabel">static</span></span>  </td>
135  </tr>
136</table>
137</div><div class="memdoc">
138<p>This is incremented when we add backwards compatible functionality. Or set to zero when MAJOR is incremented. </p>
139
140</div>
141</div>
142<a id="ac579661e79bcee45dc676d4647891de0"></a>
143<h2 class="memtitle"><span class="permalink"><a href="#ac579661e79bcee45dc676d4647891de0">&#9670;&nbsp;</a></span>Number</h2>
144
145<div class="memitem">
146<div class="memproto">
147<table class="mlabels">
148  <tr>
149  <td class="mlabels-left">
150      <table class="memname">
151        <tr>
152          <td class="memname">constexpr uint32_t oboe::Version::Number = OBOE_VERSION_NUMBER</td>
153        </tr>
154      </table>
155  </td>
156  <td class="mlabels-right">
157<span class="mlabels"><span class="mlabel">static</span></span>  </td>
158  </tr>
159</table>
160</div><div class="memdoc">
161<p>Integer representation of the current Oboe library version. This will always increase when the version number changes so can be compared using integer comparison. </p>
162
163</div>
164</div>
165<a id="a690110f2b3e887892da8f29ab5c057b2"></a>
166<h2 class="memtitle"><span class="permalink"><a href="#a690110f2b3e887892da8f29ab5c057b2">&#9670;&nbsp;</a></span>Patch</h2>
167
168<div class="memitem">
169<div class="memproto">
170<table class="mlabels">
171  <tr>
172  <td class="mlabels-left">
173      <table class="memname">
174        <tr>
175          <td class="memname">constexpr uint16_t oboe::Version::Patch = OBOE_VERSION_PATCH</td>
176        </tr>
177      </table>
178  </td>
179  <td class="mlabels-right">
180<span class="mlabels"><span class="mlabel">static</span></span>  </td>
181  </tr>
182</table>
183</div><div class="memdoc">
184<p>This is incremented when we make backwards compatible bug fixes. Or set to zero when MINOR is incremented. </p>
185
186</div>
187</div>
188<a id="a2c86e578b827fbca5f40c460a7754503"></a>
189<h2 class="memtitle"><span class="permalink"><a href="#a2c86e578b827fbca5f40c460a7754503">&#9670;&nbsp;</a></span>Text</h2>
190
191<div class="memitem">
192<div class="memproto">
193<table class="mlabels">
194  <tr>
195  <td class="mlabels-left">
196      <table class="memname">
197        <tr>
198          <td class="memname">constexpr const char* oboe::Version::Text = OBOE_VERSION_TEXT</td>
199        </tr>
200      </table>
201  </td>
202  <td class="mlabels-right">
203<span class="mlabels"><span class="mlabel">static</span></span>  </td>
204  </tr>
205</table>
206</div><div class="memdoc">
207<p><a class="el" href="structoboe_1_1_version.html">Version</a> string in the form MAJOR.MINOR.PATCH. </p>
208
209</div>
210</div>
211<hr/>The documentation for this struct was generated from the following file:<ul>
212<li>include/oboe/<a class="el" href="_version_8h_source.html">Version.h</a></li>
213</ul>
214</div><!-- contents -->
215<!-- start footer part -->
216<hr class="footer"/><address class="footer"><small>
217Generated by &#160;<a href="http://www.doxygen.org/index.html">
218<img class="footer" src="doxygen.png" alt="doxygen"/>
219</a> 1.8.15
220</small></address>
221</body>
222</html>
223