summaryrefslogtreecommitdiff
path: root/externals/glfw-3.0.2/docs/html/group__init.html
diff options
context:
space:
mode:
Diffstat (limited to 'externals/glfw-3.0.2/docs/html/group__init.html')
-rw-r--r--externals/glfw-3.0.2/docs/html/group__init.html289
1 files changed, 0 insertions, 289 deletions
diff --git a/externals/glfw-3.0.2/docs/html/group__init.html b/externals/glfw-3.0.2/docs/html/group__init.html
deleted file mode 100644
index 6bb6e9017..000000000
--- a/externals/glfw-3.0.2/docs/html/group__init.html
+++ /dev/null
@@ -1,289 +0,0 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.3.1"/>
7<title>GLFW: Initialization and version information</title>
8<link href="tabs.css" rel="stylesheet" type="text/css"/>
9<script type="text/javascript" src="jquery.js"></script>
10<script type="text/javascript" src="dynsections.js"></script>
11<link href="search/search.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="search/search.js"></script>
13<script type="text/javascript">
14 $(document).ready(function() { searchBox.OnSelectItem(0); });
15</script>
16<link href="doxygen.css" rel="stylesheet" type="text/css" />
17</head>
18<body>
19<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
20<div id="titlearea">
21<table cellspacing="0" cellpadding="0">
22 <tbody>
23 <tr style="height: 56px;">
24 <td style="padding-left: 0.5em;">
25 <div id="projectname">GLFW
26 &#160;<span id="projectnumber">3.0.2</span>
27 </div>
28 <div id="projectbrief">A multi-platform library for OpenGL, window and input</div>
29 </td>
30 </tr>
31 </tbody>
32</table>
33</div>
34<!-- end header part -->
35<!-- Generated by Doxygen 1.8.3.1 -->
36<script type="text/javascript">
37var searchBox = new SearchBox("searchBox", "search",false,'Search');
38</script>
39 <div id="navrow1" class="tabs">
40 <ul class="tablist">
41 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
42 <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
43 <li><a href="modules.html"><span>Modules</span></a></li>
44 <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
45 <li><a href="files.html"><span>Files</span></a></li>
46 <li>
47 <div id="MSearchBox" class="MSearchBoxInactive">
48 <span class="left">
49 <img id="MSearchSelect" src="search/mag_sel.png"
50 onmouseover="return searchBox.OnSearchSelectShow()"
51 onmouseout="return searchBox.OnSearchSelectHide()"
52 alt=""/>
53 <input type="text" id="MSearchField" value="Search" accesskey="S"
54 onfocus="searchBox.OnSearchFieldFocus(true)"
55 onblur="searchBox.OnSearchFieldFocus(false)"
56 onkeyup="searchBox.OnSearchFieldChange(event)"/>
57 </span><span class="right">
58 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
59 </span>
60 </div>
61 </li>
62 </ul>
63 </div>
64</div><!-- top -->
65<!-- window showing the filter options -->
66<div id="MSearchSelectWindow"
67 onmouseover="return searchBox.OnSearchSelectShow()"
68 onmouseout="return searchBox.OnSearchSelectHide()"
69 onkeydown="return searchBox.OnSearchSelectKey(event)">
70<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Pages</a></div>
71
72<!-- iframe showing the search results (closed by default) -->
73<div id="MSearchResultsWindow">
74<iframe src="javascript:void(0)" frameborder="0"
75 name="MSearchResults" id="MSearchResults">
76</iframe>
77</div>
78
79<div class="header">
80 <div class="summary">
81<a href="#func-members">Functions</a> </div>
82 <div class="headertitle">
83<div class="title">Initialization and version information</div> </div>
84</div><!--header-->
85<div class="contents">
86<table class="memberdecls">
87<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
88Functions</h2></td></tr>
89<tr class="memitem:ga317aac130a235ab08c6db0834907d85e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__init.html#ga317aac130a235ab08c6db0834907d85e">glfwInit</a> (void)</td></tr>
90<tr class="memdesc:ga317aac130a235ab08c6db0834907d85e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the GLFW library. <a href="#ga317aac130a235ab08c6db0834907d85e">More...</a><br/></td></tr>
91<tr class="separator:ga317aac130a235ab08c6db0834907d85e"><td class="memSeparator" colspan="2">&#160;</td></tr>
92<tr class="memitem:gaaae48c0a18607ea4a4ba951d939f0901"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__init.html#gaaae48c0a18607ea4a4ba951d939f0901">glfwTerminate</a> (void)</td></tr>
93<tr class="memdesc:gaaae48c0a18607ea4a4ba951d939f0901"><td class="mdescLeft">&#160;</td><td class="mdescRight">Terminates the GLFW library. <a href="#gaaae48c0a18607ea4a4ba951d939f0901">More...</a><br/></td></tr>
94<tr class="separator:gaaae48c0a18607ea4a4ba951d939f0901"><td class="memSeparator" colspan="2">&#160;</td></tr>
95<tr class="memitem:ga9f8ffaacf3c269cc48eafbf8b9b71197"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__init.html#ga9f8ffaacf3c269cc48eafbf8b9b71197">glfwGetVersion</a> (int *major, int *minor, int *rev)</td></tr>
96<tr class="memdesc:ga9f8ffaacf3c269cc48eafbf8b9b71197"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the version of the GLFW library. <a href="#ga9f8ffaacf3c269cc48eafbf8b9b71197">More...</a><br/></td></tr>
97<tr class="separator:ga9f8ffaacf3c269cc48eafbf8b9b71197"><td class="memSeparator" colspan="2">&#160;</td></tr>
98<tr class="memitem:ga23d47dc013fce2bf58036da66079a657"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__init.html#ga23d47dc013fce2bf58036da66079a657">glfwGetVersionString</a> (void)</td></tr>
99<tr class="memdesc:ga23d47dc013fce2bf58036da66079a657"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a string describing the compile-time configuration. <a href="#ga23d47dc013fce2bf58036da66079a657">More...</a><br/></td></tr>
100<tr class="separator:ga23d47dc013fce2bf58036da66079a657"><td class="memSeparator" colspan="2">&#160;</td></tr>
101</table><table class="memberdecls">
102<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
103GLFW version macros</h2></td></tr>
104<tr class="memitem:ga6337d9ea43b22fc529b2bba066b4a576"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__init.html#ga6337d9ea43b22fc529b2bba066b4a576">GLFW_VERSION_MAJOR</a>&#160;&#160;&#160;3</td></tr>
105<tr class="memdesc:ga6337d9ea43b22fc529b2bba066b4a576"><td class="mdescLeft">&#160;</td><td class="mdescRight">The major version number of the GLFW library. <a href="#ga6337d9ea43b22fc529b2bba066b4a576">More...</a><br/></td></tr>
106<tr class="separator:ga6337d9ea43b22fc529b2bba066b4a576"><td class="memSeparator" colspan="2">&#160;</td></tr>
107<tr class="memitem:gaf80d40f0aea7088ff337606e9c48f7a3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__init.html#gaf80d40f0aea7088ff337606e9c48f7a3">GLFW_VERSION_MINOR</a>&#160;&#160;&#160;0</td></tr>
108<tr class="memdesc:gaf80d40f0aea7088ff337606e9c48f7a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">The minor version number of the GLFW library. <a href="#gaf80d40f0aea7088ff337606e9c48f7a3">More...</a><br/></td></tr>
109<tr class="separator:gaf80d40f0aea7088ff337606e9c48f7a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
110<tr class="memitem:gab72ae2e2035d9ea461abc3495eac0502"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__init.html#gab72ae2e2035d9ea461abc3495eac0502">GLFW_VERSION_REVISION</a>&#160;&#160;&#160;2</td></tr>
111<tr class="memdesc:gab72ae2e2035d9ea461abc3495eac0502"><td class="mdescLeft">&#160;</td><td class="mdescRight">The revision number of the GLFW library. <a href="#gab72ae2e2035d9ea461abc3495eac0502">More...</a><br/></td></tr>
112<tr class="separator:gab72ae2e2035d9ea461abc3495eac0502"><td class="memSeparator" colspan="2">&#160;</td></tr>
113</table>
114<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
115<h2 class="groupheader">Macro Definition Documentation</h2>
116<a class="anchor" id="ga6337d9ea43b22fc529b2bba066b4a576"></a>
117<div class="memitem">
118<div class="memproto">
119 <table class="memname">
120 <tr>
121 <td class="memname">#define GLFW_VERSION_MAJOR&#160;&#160;&#160;3</td>
122 </tr>
123 </table>
124</div><div class="memdoc">
125<p>This is incremented when the API is changed in non-compatible ways. </p>
126
127</div>
128</div>
129<a class="anchor" id="gaf80d40f0aea7088ff337606e9c48f7a3"></a>
130<div class="memitem">
131<div class="memproto">
132 <table class="memname">
133 <tr>
134 <td class="memname">#define GLFW_VERSION_MINOR&#160;&#160;&#160;0</td>
135 </tr>
136 </table>
137</div><div class="memdoc">
138<p>This is incremented when features are added to the API but it remains backward-compatible. </p>
139
140</div>
141</div>
142<a class="anchor" id="gab72ae2e2035d9ea461abc3495eac0502"></a>
143<div class="memitem">
144<div class="memproto">
145 <table class="memname">
146 <tr>
147 <td class="memname">#define GLFW_VERSION_REVISION&#160;&#160;&#160;2</td>
148 </tr>
149 </table>
150</div><div class="memdoc">
151<p>This is incremented when a bug fix release is made that does not contain any API changes. </p>
152
153</div>
154</div>
155<h2 class="groupheader">Function Documentation</h2>
156<a class="anchor" id="ga9f8ffaacf3c269cc48eafbf8b9b71197"></a>
157<div class="memitem">
158<div class="memproto">
159 <table class="memname">
160 <tr>
161 <td class="memname">void glfwGetVersion </td>
162 <td>(</td>
163 <td class="paramtype">int *&#160;</td>
164 <td class="paramname"><em>major</em>, </td>
165 </tr>
166 <tr>
167 <td class="paramkey"></td>
168 <td></td>
169 <td class="paramtype">int *&#160;</td>
170 <td class="paramname"><em>minor</em>, </td>
171 </tr>
172 <tr>
173 <td class="paramkey"></td>
174 <td></td>
175 <td class="paramtype">int *&#160;</td>
176 <td class="paramname"><em>rev</em>&#160;</td>
177 </tr>
178 <tr>
179 <td></td>
180 <td>)</td>
181 <td></td><td></td>
182 </tr>
183 </table>
184</div><div class="memdoc">
185<p>This function retrieves the major, minor and revision numbers of the GLFW library. It is intended for when you are using GLFW as a shared library and want to ensure that you are using the minimum required version.</p>
186<dl class="params"><dt>Parameters</dt><dd>
187 <table class="params">
188 <tr><td class="paramdir">[out]</td><td class="paramname">major</td><td>Where to store the major version number, or <code>NULL</code>. </td></tr>
189 <tr><td class="paramdir">[out]</td><td class="paramname">minor</td><td>Where to store the minor version number, or <code>NULL</code>. </td></tr>
190 <tr><td class="paramdir">[out]</td><td class="paramname">rev</td><td>Where to store the revision number, or <code>NULL</code>.</td></tr>
191 </table>
192 </dd>
193</dl>
194<dl class="section remark"><dt>Remarks</dt><dd>This function may be called before <a class="el" href="group__init.html#ga317aac130a235ab08c6db0834907d85e">glfwInit</a>.</dd>
195<dd>
196This function may be called from any thread.</dd></dl>
197<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__init.html#ga23d47dc013fce2bf58036da66079a657" title="Returns a string describing the compile-time configuration.">glfwGetVersionString</a> </dd></dl>
198
199</div>
200</div>
201<a class="anchor" id="ga23d47dc013fce2bf58036da66079a657"></a>
202<div class="memitem">
203<div class="memproto">
204 <table class="memname">
205 <tr>
206 <td class="memname">const char* glfwGetVersionString </td>
207 <td>(</td>
208 <td class="paramtype">void&#160;</td>
209 <td class="paramname"></td><td>)</td>
210 <td></td>
211 </tr>
212 </table>
213</div><div class="memdoc">
214<p>This function returns a static string generated at compile-time according to which configuration macros were defined. This is intended for use when submitting bug reports, to allow developers to see which code paths are enabled in a binary.</p>
215<p>The format of the string is as follows:</p>
216<ul>
217<li>The version of GLFW</li>
218<li>The name of the window system API</li>
219<li>The name of the context creation API</li>
220<li>Any additional options or APIs</li>
221</ul>
222<p>For example, when compiling GLFW 3.0 with MinGW using the Win32 and WGL back ends, the version string may look something like this: </p>
223<pre class="fragment">3.0.0 Win32 WGL MinGW
224</pre><dl class="section return"><dt>Returns</dt><dd>The GLFW version string.</dd></dl>
225<dl class="section remark"><dt>Remarks</dt><dd>This function may be called before <a class="el" href="group__init.html#ga317aac130a235ab08c6db0834907d85e">glfwInit</a>.</dd>
226<dd>
227This function may be called from any thread.</dd></dl>
228<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__init.html#ga9f8ffaacf3c269cc48eafbf8b9b71197" title="Retrieves the version of the GLFW library.">glfwGetVersion</a> </dd></dl>
229
230</div>
231</div>
232<a class="anchor" id="ga317aac130a235ab08c6db0834907d85e"></a>
233<div class="memitem">
234<div class="memproto">
235 <table class="memname">
236 <tr>
237 <td class="memname">int glfwInit </td>
238 <td>(</td>
239 <td class="paramtype">void&#160;</td>
240 <td class="paramname"></td><td>)</td>
241 <td></td>
242 </tr>
243 </table>
244</div><div class="memdoc">
245<p>This function initializes the GLFW library. Before most GLFW functions can be used, GLFW must be initialized, and before a program terminates GLFW should be terminated in order to free any resources allocated during or after initialization.</p>
246<p>If this function fails, it calls <a class="el" href="group__init.html#gaaae48c0a18607ea4a4ba951d939f0901">glfwTerminate</a> before returning. If it succeeds, you should call <a class="el" href="group__init.html#gaaae48c0a18607ea4a4ba951d939f0901">glfwTerminate</a> before the program exits.</p>
247<p>Additional calls to this function after successful initialization but before termination will succeed but will do nothing.</p>
248<dl class="section return"><dt>Returns</dt><dd><code>GL_TRUE</code> if successful, or <code>GL_FALSE</code> if an error occurred.</dd></dl>
249<dl class="section user"><dt>New in GLFW 3</dt><dd>This function no longer registers <a class="el" href="group__init.html#gaaae48c0a18607ea4a4ba951d939f0901">glfwTerminate</a> with <code>atexit</code>.</dd></dl>
250<dl class="section note"><dt>Note</dt><dd>This function may only be called from the main thread.</dd>
251<dd>
252This function may take several seconds to complete on some systems, while on other systems it may take only a fraction of a second to complete.</dd>
253<dd>
254<b>Mac OS X:</b> This function will change the current directory of the application to the <code>Contents/Resources</code> subdirectory of the application's bundle, if present.</dd></dl>
255<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__init.html#gaaae48c0a18607ea4a4ba951d939f0901" title="Terminates the GLFW library.">glfwTerminate</a> </dd></dl>
256
257</div>
258</div>
259<a class="anchor" id="gaaae48c0a18607ea4a4ba951d939f0901"></a>
260<div class="memitem">
261<div class="memproto">
262 <table class="memname">
263 <tr>
264 <td class="memname">void glfwTerminate </td>
265 <td>(</td>
266 <td class="paramtype">void&#160;</td>
267 <td class="paramname"></td><td>)</td>
268 <td></td>
269 </tr>
270 </table>
271</div><div class="memdoc">
272<p>This function destroys all remaining windows, frees any allocated resources and sets the library to an uninitialized state. Once this is called, you must again call <a class="el" href="group__init.html#ga317aac130a235ab08c6db0834907d85e">glfwInit</a> successfully before you will be able to use most GLFW functions.</p>
273<p>If GLFW has been successfully initialized, this function should be called before the program exits. If initialization fails, there is no need to call this function, as it is called by <a class="el" href="group__init.html#ga317aac130a235ab08c6db0834907d85e">glfwInit</a> before it returns failure.</p>
274<dl class="section remark"><dt>Remarks</dt><dd>This function may be called before <a class="el" href="group__init.html#ga317aac130a235ab08c6db0834907d85e">glfwInit</a>.</dd></dl>
275<dl class="section note"><dt>Note</dt><dd>This function may only be called from the main thread.</dd></dl>
276<dl class="section warning"><dt>Warning</dt><dd>No window's context may be current on another thread when this function is called.</dd></dl>
277<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__init.html#ga317aac130a235ab08c6db0834907d85e" title="Initializes the GLFW library.">glfwInit</a> </dd></dl>
278
279</div>
280</div>
281</div><!-- contents -->
282<!-- start footer part -->
283<hr class="footer"/><address class="footer"><small>
284Generated on Sun Aug 25 2013 21:45:13 for GLFW by &#160;<a href="http://www.doxygen.org/index.html">
285<img class="footer" src="doxygen.png" alt="doxygen"/>
286</a> 1.8.3.1
287</small></address>
288</body>
289</html>
HIC SVNT DRACONES