summaryrefslogtreecommitdiff
path: root/externals/glfw-3.0.2/docs/html/group__native.html
diff options
context:
space:
mode:
authorGravatar bunnei2014-08-23 22:12:59 -0400
committerGravatar bunnei2014-08-23 22:12:59 -0400
commitfab2f28ea5f33106dfdc5d1c4197e01b4be9276a (patch)
tree3c061504a703418a22880c72a9bf051aa7bab57f /externals/glfw-3.0.2/docs/html/group__native.html
parentMerge pull request #68 from archshift/readfile (diff)
parentRemove documentation for external modules. (diff)
downloadyuzu-fab2f28ea5f33106dfdc5d1c4197e01b4be9276a.tar.gz
yuzu-fab2f28ea5f33106dfdc5d1c4197e01b4be9276a.tar.xz
yuzu-fab2f28ea5f33106dfdc5d1c4197e01b4be9276a.zip
Merge pull request #73 from yuriks/remove-docs
Remove documentation for external modules.
Diffstat (limited to 'externals/glfw-3.0.2/docs/html/group__native.html')
-rw-r--r--externals/glfw-3.0.2/docs/html/group__native.html316
1 files changed, 0 insertions, 316 deletions
diff --git a/externals/glfw-3.0.2/docs/html/group__native.html b/externals/glfw-3.0.2/docs/html/group__native.html
deleted file mode 100644
index a43378bd9..000000000
--- a/externals/glfw-3.0.2/docs/html/group__native.html
+++ /dev/null
@@ -1,316 +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: Native access</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">Native access</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:gafe5079aa79038b0079fc09d5f0a8e667"><td class="memItemLeft" align="right" valign="top">HWND&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#gafe5079aa79038b0079fc09d5f0a8e667">glfwGetWin32Window</a> (<a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> *window)</td></tr>
90<tr class="memdesc:gafe5079aa79038b0079fc09d5f0a8e667"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <code>HWND</code> of the specified window. <a href="#gafe5079aa79038b0079fc09d5f0a8e667">More...</a><br/></td></tr>
91<tr class="separator:gafe5079aa79038b0079fc09d5f0a8e667"><td class="memSeparator" colspan="2">&#160;</td></tr>
92<tr class="memitem:gadc4010d91d9cc1134d040eeb1202a143"><td class="memItemLeft" align="right" valign="top">HGLRC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#gadc4010d91d9cc1134d040eeb1202a143">glfwGetWGLContext</a> (<a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> *window)</td></tr>
93<tr class="memdesc:gadc4010d91d9cc1134d040eeb1202a143"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <code>HGLRC</code> of the specified window. <a href="#gadc4010d91d9cc1134d040eeb1202a143">More...</a><br/></td></tr>
94<tr class="separator:gadc4010d91d9cc1134d040eeb1202a143"><td class="memSeparator" colspan="2">&#160;</td></tr>
95<tr class="memitem:gac3ed9d495d0c2bb9652de5a50c648715"><td class="memItemLeft" align="right" valign="top">id&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#gac3ed9d495d0c2bb9652de5a50c648715">glfwGetCocoaWindow</a> (<a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> *window)</td></tr>
96<tr class="memdesc:gac3ed9d495d0c2bb9652de5a50c648715"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <code>NSWindow</code> of the specified window. <a href="#gac3ed9d495d0c2bb9652de5a50c648715">More...</a><br/></td></tr>
97<tr class="separator:gac3ed9d495d0c2bb9652de5a50c648715"><td class="memSeparator" colspan="2">&#160;</td></tr>
98<tr class="memitem:ga559e002e3cd63c979881770cd4dc63bc"><td class="memItemLeft" align="right" valign="top">id&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#ga559e002e3cd63c979881770cd4dc63bc">glfwGetNSGLContext</a> (<a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> *window)</td></tr>
99<tr class="memdesc:ga559e002e3cd63c979881770cd4dc63bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <code>NSOpenGLContext</code> of the specified window. <a href="#ga559e002e3cd63c979881770cd4dc63bc">More...</a><br/></td></tr>
100<tr class="separator:ga559e002e3cd63c979881770cd4dc63bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
101<tr class="memitem:ga8519b66594ea3ef6eeafaa2e3ee37406"><td class="memItemLeft" align="right" valign="top">Display *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#ga8519b66594ea3ef6eeafaa2e3ee37406">glfwGetX11Display</a> (void)</td></tr>
102<tr class="memdesc:ga8519b66594ea3ef6eeafaa2e3ee37406"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <code>Display</code> used by GLFW. <a href="#ga8519b66594ea3ef6eeafaa2e3ee37406">More...</a><br/></td></tr>
103<tr class="separator:ga8519b66594ea3ef6eeafaa2e3ee37406"><td class="memSeparator" colspan="2">&#160;</td></tr>
104<tr class="memitem:ga90ca676322740842db446999a1b1f21d"><td class="memItemLeft" align="right" valign="top">Window&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#ga90ca676322740842db446999a1b1f21d">glfwGetX11Window</a> (<a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> *window)</td></tr>
105<tr class="memdesc:ga90ca676322740842db446999a1b1f21d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <code>Window</code> of the specified window. <a href="#ga90ca676322740842db446999a1b1f21d">More...</a><br/></td></tr>
106<tr class="separator:ga90ca676322740842db446999a1b1f21d"><td class="memSeparator" colspan="2">&#160;</td></tr>
107<tr class="memitem:ga62d884114b0abfcdc2930e89f20867e2"><td class="memItemLeft" align="right" valign="top">GLXContext&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#ga62d884114b0abfcdc2930e89f20867e2">glfwGetGLXContext</a> (<a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> *window)</td></tr>
108<tr class="memdesc:ga62d884114b0abfcdc2930e89f20867e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <code>GLXContext</code> of the specified window. <a href="#ga62d884114b0abfcdc2930e89f20867e2">More...</a><br/></td></tr>
109<tr class="separator:ga62d884114b0abfcdc2930e89f20867e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
110<tr class="memitem:ga1cd8d973f47aacb5532d368147cc3138"><td class="memItemLeft" align="right" valign="top">EGLDisplay&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#ga1cd8d973f47aacb5532d368147cc3138">glfwGetEGLDisplay</a> (void)</td></tr>
111<tr class="memdesc:ga1cd8d973f47aacb5532d368147cc3138"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <code>EGLDisplay</code> used by GLFW. <a href="#ga1cd8d973f47aacb5532d368147cc3138">More...</a><br/></td></tr>
112<tr class="separator:ga1cd8d973f47aacb5532d368147cc3138"><td class="memSeparator" colspan="2">&#160;</td></tr>
113<tr class="memitem:ga671c5072becd085f4ab5771a9c8efcf1"><td class="memItemLeft" align="right" valign="top">EGLContext&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#ga671c5072becd085f4ab5771a9c8efcf1">glfwGetEGLContext</a> (<a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> *window)</td></tr>
114<tr class="memdesc:ga671c5072becd085f4ab5771a9c8efcf1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <code>EGLContext</code> of the specified window. <a href="#ga671c5072becd085f4ab5771a9c8efcf1">More...</a><br/></td></tr>
115<tr class="separator:ga671c5072becd085f4ab5771a9c8efcf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
116<tr class="memitem:ga2199b36117a6a695fec8441d8052eee6"><td class="memItemLeft" align="right" valign="top">EGLSurface&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#ga2199b36117a6a695fec8441d8052eee6">glfwGetEGLSurface</a> (<a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> *window)</td></tr>
117<tr class="memdesc:ga2199b36117a6a695fec8441d8052eee6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <code>EGLSurface</code> of the specified window. <a href="#ga2199b36117a6a695fec8441d8052eee6">More...</a><br/></td></tr>
118<tr class="separator:ga2199b36117a6a695fec8441d8052eee6"><td class="memSeparator" colspan="2">&#160;</td></tr>
119</table>
120<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
121<p><b>By using the native API, you assert that you know what you're doing and how to fix problems caused by using it. If you don't, you shouldn't be using it.</b></p>
122<p>Before the inclusion of <a class="el" href="glfw3native_8h.html">glfw3native.h</a>, you must define exactly one window API macro and exactly one context API macro. Failure to do this will cause a compile-time error.</p>
123<p>The available window API macros are:</p>
124<ul>
125<li><code>GLFW_EXPOSE_NATIVE_WIN32</code></li>
126<li><code>GLFW_EXPOSE_NATIVE_COCOA</code></li>
127<li><code>GLFW_EXPOSE_NATIVE_X11</code></li>
128</ul>
129<p>The available context API macros are:</p>
130<ul>
131<li><code>GLFW_EXPOSE_NATIVE_WGL</code></li>
132<li><code>GLFW_EXPOSE_NATIVE_NSGL</code></li>
133<li><code>GLFW_EXPOSE_NATIVE_GLX</code></li>
134<li><code>GLFW_EXPOSE_NATIVE_EGL</code></li>
135</ul>
136<p>These macros select which of the native access functions that are declared and which platform-specific headers to include. It is then up your (by definition platform-specific) code to handle which of these should be defined. </p>
137<h2 class="groupheader">Function Documentation</h2>
138<a class="anchor" id="gac3ed9d495d0c2bb9652de5a50c648715"></a>
139<div class="memitem">
140<div class="memproto">
141 <table class="memname">
142 <tr>
143 <td class="memname">id glfwGetCocoaWindow </td>
144 <td>(</td>
145 <td class="paramtype"><a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> *&#160;</td>
146 <td class="paramname"><em>window</em></td><td>)</td>
147 <td></td>
148 </tr>
149 </table>
150</div><div class="memdoc">
151<dl class="section return"><dt>Returns</dt><dd>The <code>NSWindow</code> of the specified window. </dd></dl>
152
153</div>
154</div>
155<a class="anchor" id="ga671c5072becd085f4ab5771a9c8efcf1"></a>
156<div class="memitem">
157<div class="memproto">
158 <table class="memname">
159 <tr>
160 <td class="memname">EGLContext glfwGetEGLContext </td>
161 <td>(</td>
162 <td class="paramtype"><a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> *&#160;</td>
163 <td class="paramname"><em>window</em></td><td>)</td>
164 <td></td>
165 </tr>
166 </table>
167</div><div class="memdoc">
168<dl class="section return"><dt>Returns</dt><dd>The <code>EGLContext</code> of the specified window. </dd></dl>
169
170</div>
171</div>
172<a class="anchor" id="ga1cd8d973f47aacb5532d368147cc3138"></a>
173<div class="memitem">
174<div class="memproto">
175 <table class="memname">
176 <tr>
177 <td class="memname">EGLDisplay glfwGetEGLDisplay </td>
178 <td>(</td>
179 <td class="paramtype">void&#160;</td>
180 <td class="paramname"></td><td>)</td>
181 <td></td>
182 </tr>
183 </table>
184</div><div class="memdoc">
185<dl class="section return"><dt>Returns</dt><dd>The <code>EGLDisplay</code> used by GLFW. </dd></dl>
186
187</div>
188</div>
189<a class="anchor" id="ga2199b36117a6a695fec8441d8052eee6"></a>
190<div class="memitem">
191<div class="memproto">
192 <table class="memname">
193 <tr>
194 <td class="memname">EGLSurface glfwGetEGLSurface </td>
195 <td>(</td>
196 <td class="paramtype"><a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> *&#160;</td>
197 <td class="paramname"><em>window</em></td><td>)</td>
198 <td></td>
199 </tr>
200 </table>
201</div><div class="memdoc">
202<dl class="section return"><dt>Returns</dt><dd>The <code>EGLSurface</code> of the specified window. </dd></dl>
203
204</div>
205</div>
206<a class="anchor" id="ga62d884114b0abfcdc2930e89f20867e2"></a>
207<div class="memitem">
208<div class="memproto">
209 <table class="memname">
210 <tr>
211 <td class="memname">GLXContext glfwGetGLXContext </td>
212 <td>(</td>
213 <td class="paramtype"><a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> *&#160;</td>
214 <td class="paramname"><em>window</em></td><td>)</td>
215 <td></td>
216 </tr>
217 </table>
218</div><div class="memdoc">
219<dl class="section return"><dt>Returns</dt><dd>The <code>GLXContext</code> of the specified window. </dd></dl>
220
221</div>
222</div>
223<a class="anchor" id="ga559e002e3cd63c979881770cd4dc63bc"></a>
224<div class="memitem">
225<div class="memproto">
226 <table class="memname">
227 <tr>
228 <td class="memname">id glfwGetNSGLContext </td>
229 <td>(</td>
230 <td class="paramtype"><a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> *&#160;</td>
231 <td class="paramname"><em>window</em></td><td>)</td>
232 <td></td>
233 </tr>
234 </table>
235</div><div class="memdoc">
236<dl class="section return"><dt>Returns</dt><dd>The <code>NSOpenGLContext</code> of the specified window. </dd></dl>
237
238</div>
239</div>
240<a class="anchor" id="gadc4010d91d9cc1134d040eeb1202a143"></a>
241<div class="memitem">
242<div class="memproto">
243 <table class="memname">
244 <tr>
245 <td class="memname">HGLRC glfwGetWGLContext </td>
246 <td>(</td>
247 <td class="paramtype"><a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> *&#160;</td>
248 <td class="paramname"><em>window</em></td><td>)</td>
249 <td></td>
250 </tr>
251 </table>
252</div><div class="memdoc">
253<dl class="section return"><dt>Returns</dt><dd>The <code>HGLRC</code> of the specified window. </dd></dl>
254
255</div>
256</div>
257<a class="anchor" id="gafe5079aa79038b0079fc09d5f0a8e667"></a>
258<div class="memitem">
259<div class="memproto">
260 <table class="memname">
261 <tr>
262 <td class="memname">HWND glfwGetWin32Window </td>
263 <td>(</td>
264 <td class="paramtype"><a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> *&#160;</td>
265 <td class="paramname"><em>window</em></td><td>)</td>
266 <td></td>
267 </tr>
268 </table>
269</div><div class="memdoc">
270<dl class="section return"><dt>Returns</dt><dd>The <code>HWND</code> of the specified window. </dd></dl>
271
272</div>
273</div>
274<a class="anchor" id="ga8519b66594ea3ef6eeafaa2e3ee37406"></a>
275<div class="memitem">
276<div class="memproto">
277 <table class="memname">
278 <tr>
279 <td class="memname">Display* glfwGetX11Display </td>
280 <td>(</td>
281 <td class="paramtype">void&#160;</td>
282 <td class="paramname"></td><td>)</td>
283 <td></td>
284 </tr>
285 </table>
286</div><div class="memdoc">
287<dl class="section return"><dt>Returns</dt><dd>The <code>Display</code> used by GLFW. </dd></dl>
288
289</div>
290</div>
291<a class="anchor" id="ga90ca676322740842db446999a1b1f21d"></a>
292<div class="memitem">
293<div class="memproto">
294 <table class="memname">
295 <tr>
296 <td class="memname">Window glfwGetX11Window </td>
297 <td>(</td>
298 <td class="paramtype"><a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> *&#160;</td>
299 <td class="paramname"><em>window</em></td><td>)</td>
300 <td></td>
301 </tr>
302 </table>
303</div><div class="memdoc">
304<dl class="section return"><dt>Returns</dt><dd>The <code>Window</code> of the specified window. </dd></dl>
305
306</div>
307</div>
308</div><!-- contents -->
309<!-- start footer part -->
310<hr class="footer"/><address class="footer"><small>
311Generated on Sun Aug 25 2013 21:45:13 for GLFW by &#160;<a href="http://www.doxygen.org/index.html">
312<img class="footer" src="doxygen.png" alt="doxygen"/>
313</a> 1.8.3.1
314</small></address>
315</body>
316</html>
HIC SVNT DRACONES