|
|
- <!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.11"/>
- <title>GLFW: Native access</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>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <script type="text/javascript">
- $(document).ready(function() { init_search(); });
- </script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <link href="extra.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <div class="glfwheader">
- <a href="http://www.glfw.org/" id="glfwhome">GLFW</a>
- <ul class="glfwnavbar">
- <li><a href="http://www.glfw.org/documentation.html">Documentation</a></li>
- <li><a href="http://www.glfw.org/download.html">Download</a></li>
- <li><a href="http://www.glfw.org/media.html">Media</a></li>
- <li><a href="http://www.glfw.org/community.html">Community</a></li>
- </ul>
- </div>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.11 -->
- <script type="text/javascript">
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- </script>
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="pages.html"><span>Related Pages</span></a></li>
- <li class="current"><a href="modules.html"><span>Modules</span></a></li>
- <li><a href="annotated.html"><span>Data Structures</span></a></li>
- <li><a href="files.html"><span>Files</span></a></li>
- <li>
- <div id="MSearchBox" class="MSearchBoxInactive">
- <span class="left">
- <img id="MSearchSelect" src="search/mag_sel.png"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- alt=""/>
- <input type="text" id="MSearchField" value="Search" accesskey="S"
- onfocus="searchBox.OnSearchFieldFocus(true)"
- onblur="searchBox.OnSearchFieldFocus(false)"
- onkeyup="searchBox.OnSearchFieldChange(event)"/>
- </span><span class="right">
- <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
- </span>
- </div>
- </li>
- </ul>
- </div>
- </div><!-- top -->
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
-
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
-
- <div class="header">
- <div class="summary">
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">Native access</div> </div>
- </div><!--header-->
- <div class="contents">
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:gac84f63a3f9db145b9435e5e0dbc4183d"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#gac84f63a3f9db145b9435e5e0dbc4183d">glfwGetWin32Adapter</a> (<a class="el" href="group__monitor.html#ga8d9efd1cde9426692c73fe40437d0ae3">GLFWmonitor</a> *monitor)</td></tr>
- <tr class="memdesc:gac84f63a3f9db145b9435e5e0dbc4183d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the adapter device name of the specified monitor. <a href="#gac84f63a3f9db145b9435e5e0dbc4183d">More...</a><br /></td></tr>
- <tr class="separator:gac84f63a3f9db145b9435e5e0dbc4183d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gac408b09a330749402d5d1fa1f5894dd9"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#gac408b09a330749402d5d1fa1f5894dd9">glfwGetWin32Monitor</a> (<a class="el" href="group__monitor.html#ga8d9efd1cde9426692c73fe40437d0ae3">GLFWmonitor</a> *monitor)</td></tr>
- <tr class="memdesc:gac408b09a330749402d5d1fa1f5894dd9"><td class="mdescLeft"> </td><td class="mdescRight">Returns the display device name of the specified monitor. <a href="#gac408b09a330749402d5d1fa1f5894dd9">More...</a><br /></td></tr>
- <tr class="separator:gac408b09a330749402d5d1fa1f5894dd9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gafe5079aa79038b0079fc09d5f0a8e667"><td class="memItemLeft" align="right" valign="top">HWND </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>
- <tr class="memdesc:gafe5079aa79038b0079fc09d5f0a8e667"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>HWND</code> of the specified window. <a href="#gafe5079aa79038b0079fc09d5f0a8e667">More...</a><br /></td></tr>
- <tr class="separator:gafe5079aa79038b0079fc09d5f0a8e667"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gadc4010d91d9cc1134d040eeb1202a143"><td class="memItemLeft" align="right" valign="top">HGLRC </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>
- <tr class="memdesc:gadc4010d91d9cc1134d040eeb1202a143"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>HGLRC</code> of the specified window. <a href="#gadc4010d91d9cc1134d040eeb1202a143">More...</a><br /></td></tr>
- <tr class="separator:gadc4010d91d9cc1134d040eeb1202a143"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaf22f429aec4b1aab316142d66d9be3e6"><td class="memItemLeft" align="right" valign="top">CGDirectDisplayID </td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#gaf22f429aec4b1aab316142d66d9be3e6">glfwGetCocoaMonitor</a> (<a class="el" href="group__monitor.html#ga8d9efd1cde9426692c73fe40437d0ae3">GLFWmonitor</a> *monitor)</td></tr>
- <tr class="memdesc:gaf22f429aec4b1aab316142d66d9be3e6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>CGDirectDisplayID</code> of the specified monitor. <a href="#gaf22f429aec4b1aab316142d66d9be3e6">More...</a><br /></td></tr>
- <tr class="separator:gaf22f429aec4b1aab316142d66d9be3e6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gac3ed9d495d0c2bb9652de5a50c648715"><td class="memItemLeft" align="right" valign="top">id </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>
- <tr class="memdesc:gac3ed9d495d0c2bb9652de5a50c648715"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>NSWindow</code> of the specified window. <a href="#gac3ed9d495d0c2bb9652de5a50c648715">More...</a><br /></td></tr>
- <tr class="separator:gac3ed9d495d0c2bb9652de5a50c648715"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga559e002e3cd63c979881770cd4dc63bc"><td class="memItemLeft" align="right" valign="top">id </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>
- <tr class="memdesc:ga559e002e3cd63c979881770cd4dc63bc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>NSOpenGLContext</code> of the specified window. <a href="#ga559e002e3cd63c979881770cd4dc63bc">More...</a><br /></td></tr>
- <tr class="separator:ga559e002e3cd63c979881770cd4dc63bc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga8519b66594ea3ef6eeafaa2e3ee37406"><td class="memItemLeft" align="right" valign="top">Display * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#ga8519b66594ea3ef6eeafaa2e3ee37406">glfwGetX11Display</a> (void)</td></tr>
- <tr class="memdesc:ga8519b66594ea3ef6eeafaa2e3ee37406"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>Display</code> used by GLFW. <a href="#ga8519b66594ea3ef6eeafaa2e3ee37406">More...</a><br /></td></tr>
- <tr class="separator:ga8519b66594ea3ef6eeafaa2e3ee37406"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga088fbfa80f50569402b41be71ad66e40"><td class="memItemLeft" align="right" valign="top">RRCrtc </td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#ga088fbfa80f50569402b41be71ad66e40">glfwGetX11Adapter</a> (<a class="el" href="group__monitor.html#ga8d9efd1cde9426692c73fe40437d0ae3">GLFWmonitor</a> *monitor)</td></tr>
- <tr class="memdesc:ga088fbfa80f50569402b41be71ad66e40"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>RRCrtc</code> of the specified monitor. <a href="#ga088fbfa80f50569402b41be71ad66e40">More...</a><br /></td></tr>
- <tr class="separator:ga088fbfa80f50569402b41be71ad66e40"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gab2f8cc043905e9fa9b12bfdbbcfe874c"><td class="memItemLeft" align="right" valign="top">RROutput </td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#gab2f8cc043905e9fa9b12bfdbbcfe874c">glfwGetX11Monitor</a> (<a class="el" href="group__monitor.html#ga8d9efd1cde9426692c73fe40437d0ae3">GLFWmonitor</a> *monitor)</td></tr>
- <tr class="memdesc:gab2f8cc043905e9fa9b12bfdbbcfe874c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>RROutput</code> of the specified monitor. <a href="#gab2f8cc043905e9fa9b12bfdbbcfe874c">More...</a><br /></td></tr>
- <tr class="separator:gab2f8cc043905e9fa9b12bfdbbcfe874c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga90ca676322740842db446999a1b1f21d"><td class="memItemLeft" align="right" valign="top">Window </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>
- <tr class="memdesc:ga90ca676322740842db446999a1b1f21d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>Window</code> of the specified window. <a href="#ga90ca676322740842db446999a1b1f21d">More...</a><br /></td></tr>
- <tr class="separator:ga90ca676322740842db446999a1b1f21d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga62d884114b0abfcdc2930e89f20867e2"><td class="memItemLeft" align="right" valign="top">GLXContext </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>
- <tr class="memdesc:ga62d884114b0abfcdc2930e89f20867e2"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>GLXContext</code> of the specified window. <a href="#ga62d884114b0abfcdc2930e89f20867e2">More...</a><br /></td></tr>
- <tr class="separator:ga62d884114b0abfcdc2930e89f20867e2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga1ed27b8766e859a21381e8f8ce18d049"><td class="memItemLeft" align="right" valign="top">GLXWindow </td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#ga1ed27b8766e859a21381e8f8ce18d049">glfwGetGLXWindow</a> (<a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> *window)</td></tr>
- <tr class="memdesc:ga1ed27b8766e859a21381e8f8ce18d049"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>GLXWindow</code> of the specified window. <a href="#ga1ed27b8766e859a21381e8f8ce18d049">More...</a><br /></td></tr>
- <tr class="separator:ga1ed27b8766e859a21381e8f8ce18d049"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaaf8118a3c877f3a6bc8e7a649519de5e"><td class="memItemLeft" align="right" valign="top">struct wl_display * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#gaaf8118a3c877f3a6bc8e7a649519de5e">glfwGetWaylandDisplay</a> (void)</td></tr>
- <tr class="memdesc:gaaf8118a3c877f3a6bc8e7a649519de5e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>struct wl_display*</code> used by GLFW. <a href="#gaaf8118a3c877f3a6bc8e7a649519de5e">More...</a><br /></td></tr>
- <tr class="separator:gaaf8118a3c877f3a6bc8e7a649519de5e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gab10427a667b6cd91eec7709f7a906bd3"><td class="memItemLeft" align="right" valign="top">struct wl_output * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#gab10427a667b6cd91eec7709f7a906bd3">glfwGetWaylandMonitor</a> (<a class="el" href="group__monitor.html#ga8d9efd1cde9426692c73fe40437d0ae3">GLFWmonitor</a> *monitor)</td></tr>
- <tr class="memdesc:gab10427a667b6cd91eec7709f7a906bd3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>struct wl_output*</code> of the specified monitor. <a href="#gab10427a667b6cd91eec7709f7a906bd3">More...</a><br /></td></tr>
- <tr class="separator:gab10427a667b6cd91eec7709f7a906bd3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga4738d7aca4191363519a9a641c3ab64c"><td class="memItemLeft" align="right" valign="top">struct wl_surface * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#ga4738d7aca4191363519a9a641c3ab64c">glfwGetWaylandWindow</a> (<a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> *window)</td></tr>
- <tr class="memdesc:ga4738d7aca4191363519a9a641c3ab64c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the main <code>struct wl_surface*</code> of the specified window. <a href="#ga4738d7aca4191363519a9a641c3ab64c">More...</a><br /></td></tr>
- <tr class="separator:ga4738d7aca4191363519a9a641c3ab64c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga40dd05325d9813fa67d61328c51d2930"><td class="memItemLeft" align="right" valign="top">MirConnection * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#ga40dd05325d9813fa67d61328c51d2930">glfwGetMirDisplay</a> (void)</td></tr>
- <tr class="memdesc:ga40dd05325d9813fa67d61328c51d2930"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>MirConnection*</code> used by GLFW. <a href="#ga40dd05325d9813fa67d61328c51d2930">More...</a><br /></td></tr>
- <tr class="separator:ga40dd05325d9813fa67d61328c51d2930"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gae0941c11dc8f01aeb7cbb563f5cd930b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#gae0941c11dc8f01aeb7cbb563f5cd930b">glfwGetMirMonitor</a> (<a class="el" href="group__monitor.html#ga8d9efd1cde9426692c73fe40437d0ae3">GLFWmonitor</a> *monitor)</td></tr>
- <tr class="memdesc:gae0941c11dc8f01aeb7cbb563f5cd930b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the Mir output ID of the specified monitor. <a href="#gae0941c11dc8f01aeb7cbb563f5cd930b">More...</a><br /></td></tr>
- <tr class="separator:gae0941c11dc8f01aeb7cbb563f5cd930b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga964d52bb7932216c379762eef1ea9b05"><td class="memItemLeft" align="right" valign="top">MirSurface * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#ga964d52bb7932216c379762eef1ea9b05">glfwGetMirWindow</a> (<a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> *window)</td></tr>
- <tr class="memdesc:ga964d52bb7932216c379762eef1ea9b05"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>MirSurface*</code> of the specified window. <a href="#ga964d52bb7932216c379762eef1ea9b05">More...</a><br /></td></tr>
- <tr class="separator:ga964d52bb7932216c379762eef1ea9b05"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga1cd8d973f47aacb5532d368147cc3138"><td class="memItemLeft" align="right" valign="top">EGLDisplay </td><td class="memItemRight" valign="bottom"><a class="el" href="group__native.html#ga1cd8d973f47aacb5532d368147cc3138">glfwGetEGLDisplay</a> (void)</td></tr>
- <tr class="memdesc:ga1cd8d973f47aacb5532d368147cc3138"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>EGLDisplay</code> used by GLFW. <a href="#ga1cd8d973f47aacb5532d368147cc3138">More...</a><br /></td></tr>
- <tr class="separator:ga1cd8d973f47aacb5532d368147cc3138"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga671c5072becd085f4ab5771a9c8efcf1"><td class="memItemLeft" align="right" valign="top">EGLContext </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>
- <tr class="memdesc:ga671c5072becd085f4ab5771a9c8efcf1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>EGLContext</code> of the specified window. <a href="#ga671c5072becd085f4ab5771a9c8efcf1">More...</a><br /></td></tr>
- <tr class="separator:ga671c5072becd085f4ab5771a9c8efcf1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga2199b36117a6a695fec8441d8052eee6"><td class="memItemLeft" align="right" valign="top">EGLSurface </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>
- <tr class="memdesc:ga2199b36117a6a695fec8441d8052eee6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>EGLSurface</code> of the specified window. <a href="#ga2199b36117a6a695fec8441d8052eee6">More...</a><br /></td></tr>
- <tr class="separator:ga2199b36117a6a695fec8441d8052eee6"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <p><b>By using the native access functions you assert that you know what you're doing and how to fix problems caused by using them. If you don't, you shouldn't be using them.</b></p>
- <p>Before the inclusion of <a class="el" href="glfw3native_8h.html">glfw3native.h</a>, you may define exactly one window system API macro and zero or more context creation API macros.</p>
- <p>The chosen backends must match those the library was compiled for. Failure to do this will cause a link-time error.</p>
- <p>The available window API macros are:</p><ul>
- <li><code>GLFW_EXPOSE_NATIVE_WIN32</code></li>
- <li><code>GLFW_EXPOSE_NATIVE_COCOA</code></li>
- <li><code>GLFW_EXPOSE_NATIVE_X11</code></li>
- <li><code>GLFW_EXPOSE_NATIVE_WAYLAND</code></li>
- <li><code>GLFW_EXPOSE_NATIVE_MIR</code></li>
- </ul>
- <p>The available context API macros are:</p><ul>
- <li><code>GLFW_EXPOSE_NATIVE_WGL</code></li>
- <li><code>GLFW_EXPOSE_NATIVE_NSGL</code></li>
- <li><code>GLFW_EXPOSE_NATIVE_GLX</code></li>
- <li><code>GLFW_EXPOSE_NATIVE_EGL</code></li>
- </ul>
- <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>
- <h2 class="groupheader">Function Documentation</h2>
- <a class="anchor" id="gaf22f429aec4b1aab316142d66d9be3e6"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">CGDirectDisplayID glfwGetCocoaMonitor </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__monitor.html#ga8d9efd1cde9426692c73fe40437d0ae3">GLFWmonitor</a> * </td>
- <td class="paramname"><em>monitor</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The <code>CGDirectDisplayID</code> of the specified monitor, or <code>kCGNullDirectDisplay</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.1. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="gac3ed9d495d0c2bb9652de5a50c648715"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">id glfwGetCocoaWindow </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> * </td>
- <td class="paramname"><em>window</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The <code>NSWindow</code> of the specified window, or <code>nil</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.0. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ga671c5072becd085f4ab5771a9c8efcf1"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">EGLContext glfwGetEGLContext </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> * </td>
- <td class="paramname"><em>window</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The <code>EGLContext</code> of the specified window, or <code>EGL_NO_CONTEXT</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.0. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ga1cd8d973f47aacb5532d368147cc3138"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">EGLDisplay glfwGetEGLDisplay </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The <code>EGLDisplay</code> used by GLFW, or <code>EGL_NO_DISPLAY</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.0. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ga2199b36117a6a695fec8441d8052eee6"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">EGLSurface glfwGetEGLSurface </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> * </td>
- <td class="paramname"><em>window</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The <code>EGLSurface</code> of the specified window, or <code>EGL_NO_SURFACE</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.0. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ga62d884114b0abfcdc2930e89f20867e2"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">GLXContext glfwGetGLXContext </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> * </td>
- <td class="paramname"><em>window</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The <code>GLXContext</code> of the specified window, or <code>NULL</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.0. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ga1ed27b8766e859a21381e8f8ce18d049"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">GLXWindow glfwGetGLXWindow </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> * </td>
- <td class="paramname"><em>window</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The <code>GLXWindow</code> of the specified window, or <code>None</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.2. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ga40dd05325d9813fa67d61328c51d2930"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">MirConnection* glfwGetMirDisplay </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The <code>MirConnection*</code> used by GLFW, or <code>NULL</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.2. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="gae0941c11dc8f01aeb7cbb563f5cd930b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">int glfwGetMirMonitor </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__monitor.html#ga8d9efd1cde9426692c73fe40437d0ae3">GLFWmonitor</a> * </td>
- <td class="paramname"><em>monitor</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The Mir output ID of the specified monitor, or zero if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.2. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ga964d52bb7932216c379762eef1ea9b05"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">MirSurface* glfwGetMirWindow </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> * </td>
- <td class="paramname"><em>window</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The <code>MirSurface*</code> of the specified window, or <code>NULL</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.2. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ga559e002e3cd63c979881770cd4dc63bc"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">id glfwGetNSGLContext </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> * </td>
- <td class="paramname"><em>window</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The <code>NSOpenGLContext</code> of the specified window, or <code>nil</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.0. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="gaaf8118a3c877f3a6bc8e7a649519de5e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">struct wl_display* glfwGetWaylandDisplay </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The <code>struct wl_display*</code> used by GLFW, or <code>NULL</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.2. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="gab10427a667b6cd91eec7709f7a906bd3"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">struct wl_output* glfwGetWaylandMonitor </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__monitor.html#ga8d9efd1cde9426692c73fe40437d0ae3">GLFWmonitor</a> * </td>
- <td class="paramname"><em>monitor</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The <code>struct wl_output*</code> of the specified monitor, or <code>NULL</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.2. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ga4738d7aca4191363519a9a641c3ab64c"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">struct wl_surface* glfwGetWaylandWindow </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> * </td>
- <td class="paramname"><em>window</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The main <code>struct wl_surface*</code> of the specified window, or <code>NULL</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.2. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="gadc4010d91d9cc1134d040eeb1202a143"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">HGLRC glfwGetWGLContext </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> * </td>
- <td class="paramname"><em>window</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The <code>HGLRC</code> of the specified window, or <code>NULL</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.0. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="gac84f63a3f9db145b9435e5e0dbc4183d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">const char* glfwGetWin32Adapter </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__monitor.html#ga8d9efd1cde9426692c73fe40437d0ae3">GLFWmonitor</a> * </td>
- <td class="paramname"><em>monitor</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The UTF-8 encoded adapter device name (for example <code>\\.\DISPLAY1</code>) of the specified monitor, or <code>NULL</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.1. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="gac408b09a330749402d5d1fa1f5894dd9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">const char* glfwGetWin32Monitor </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__monitor.html#ga8d9efd1cde9426692c73fe40437d0ae3">GLFWmonitor</a> * </td>
- <td class="paramname"><em>monitor</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The UTF-8 encoded display device name (for example <code>\\.\DISPLAY1\Monitor0</code>) of the specified monitor, or <code>NULL</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.1. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="gafe5079aa79038b0079fc09d5f0a8e667"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">HWND glfwGetWin32Window </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> * </td>
- <td class="paramname"><em>window</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The <code>HWND</code> of the specified window, or <code>NULL</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.0. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ga088fbfa80f50569402b41be71ad66e40"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">RRCrtc glfwGetX11Adapter </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__monitor.html#ga8d9efd1cde9426692c73fe40437d0ae3">GLFWmonitor</a> * </td>
- <td class="paramname"><em>monitor</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The <code>RRCrtc</code> of the specified monitor, or <code>None</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.1. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ga8519b66594ea3ef6eeafaa2e3ee37406"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Display* glfwGetX11Display </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The <code>Display</code> used by GLFW, or <code>NULL</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.0. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="gab2f8cc043905e9fa9b12bfdbbcfe874c"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">RROutput glfwGetX11Monitor </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__monitor.html#ga8d9efd1cde9426692c73fe40437d0ae3">GLFWmonitor</a> * </td>
- <td class="paramname"><em>monitor</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The <code>RROutput</code> of the specified monitor, or <code>None</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.1. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ga90ca676322740842db446999a1b1f21d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Window glfwGetX11Window </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__window.html#ga3c96d80d363e67d13a41b5d1821f3242">GLFWwindow</a> * </td>
- <td class="paramname"><em>window</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>The <code>Window</code> of the specified window, or <code>None</code> if an <a class="el" href="intro_guide.html#error_handling">error</a> occurred.</dd></dl>
- <dl class="section user"><dt>Thread safety</dt><dd>This function may be called from any thread. Access is not synchronized.</dd></dl>
- <dl class="section since"><dt>Since</dt><dd>Added in version 3.0. </dd></dl>
-
- </div>
- </div>
- </div><!-- contents -->
- <address class="footer">
- <p>
- Last update on Thu Aug 18 2016 for GLFW 3.2.1
- </p>
- </address>
- </body>
- </html>
|
