mirror/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-14 02:31:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added documentation for native API.

Browse Source
This commit is contained in:
Camilla Berglund 2013-01-15 01:41:58 +01:00
parent 1bd59844c8
commit 1856251ffe
1 changed files with 43 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
include/GL/glfw3native.h
View File

@ -35,6 +35,18 @@ extern "C" {
#endif #endif
/*************************************************************************
* Doxygen documentation
*************************************************************************/
/*! @defgroup native Native API
*
* By using the native API, you assert that you know what you are doing and how
* to fix problems caused by using it. If you don't, you shouldn't be using
* it.
*/
/************************************************************************* /*************************************************************************
* System headers and types * System headers and types
*************************************************************************/ *************************************************************************/
@ -71,19 +83,50 @@ extern "C" {
#if defined(GLFW_EXPOSE_NATIVE_WIN32_WGL) #if defined(GLFW_EXPOSE_NATIVE_WIN32_WGL)
/*! @brief Returns the @c HWND of the specified window.
* @return The @c HWND of the specified window.
* @ingroup native
*/
GLFWAPI HWND glfwGetWin32Window(GLFWwindow window); GLFWAPI HWND glfwGetWin32Window(GLFWwindow window);
/*! @brief Returns the @c HGLRC of the specified window.
* @return The @c HGLRC of the specified window.
* @ingroup native
*/
GLFWAPI HGLRC glfwGetWGLContext(GLFWwindow window); GLFWAPI HGLRC glfwGetWGLContext(GLFWwindow window);
#elif defined(GLFW_EXPOSE_NATIVE_COCOA_NSGL) #elif defined(GLFW_EXPOSE_NATIVE_COCOA_NSGL)
/*! @brief Returns the @c NSWindow of the specified window.
* @return The @c NSWindow of the specified window.
* @ingroup native
*/
GLFWAPI id glfwGetCocoaWindow(GLFWwindow window); GLFWAPI id glfwGetCocoaWindow(GLFWwindow window);
/*! @brief Returns the @c NSOpenGLContext of the specified window.
* @return The @c NSOpenGLContext of the specified window.
* @ingroup native
*/
GLFWAPI id glfwGetNSGLContext(GLFWwindow window); GLFWAPI id glfwGetNSGLContext(GLFWwindow window);
#elif defined(GLFW_EXPOSE_NATIVE_X11_GLX) #elif defined(GLFW_EXPOSE_NATIVE_X11_GLX)
/*! @brief Returns the @c Display used by GLFW.
* @return The @c Display used by GLFW.
* @ingroup native
*/
GLFWAPI Display* glfwGetX11Display(void); GLFWAPI Display* glfwGetX11Display(void);
/*! @brief Returns the @c Window of the specified window.
* @return The @c Window of the specified window.
* @ingroup native
*/
GLFWAPI Window glfwGetX11Window(GLFWwindow window); GLFWAPI Window glfwGetX11Window(GLFWwindow window);
/*! @brief Returns the @c GLXContext of the specified window.
* @return The @c GLXContext of the specified window.
* @ingroup native
*/
GLFWAPI GLXContext glfwGetGLXContext(GLFWwindow window); GLFWAPI GLXContext glfwGetGLXContext(GLFWwindow window);
#endif #endif