glfw3native.h
Go to the documentation of this file.
1 /*************************************************************************
2  * GLFW 3.3 - www.glfw.org
3  * A library for OpenGL, window and input
4  *------------------------------------------------------------------------
5  * Copyright (c) 2002-2006 Marcus Geelnard
6  * Copyright (c) 2006-2018 Camilla Löwy <elmindreda@glfw.org>
7  *
8  * This software is provided 'as-is', without any express or implied
9  * warranty. In no event will the authors be held liable for any damages
10  * arising from the use of this software.
11  *
12  * Permission is granted to anyone to use this software for any purpose,
13  * including commercial applications, and to alter it and redistribute it
14  * freely, subject to the following restrictions:
15  *
16  * 1. The origin of this software must not be misrepresented; you must not
17  * claim that you wrote the original software. If you use this software
18  * in a product, an acknowledgment in the product documentation would
19  * be appreciated but is not required.
20  *
21  * 2. Altered source versions must be plainly marked as such, and must not
22  * be misrepresented as being the original software.
23  *
24  * 3. This notice may not be removed or altered from any source
25  * distribution.
26  *
27  *************************************************************************/
28 
29 #ifndef _glfw3_native_h_
30 #define _glfw3_native_h_
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 
37 /*************************************************************************
38  * Doxygen documentation
39  *************************************************************************/
40 
80 /*************************************************************************
81  * System headers and types
82  *************************************************************************/
83 
84 #if defined(GLFW_EXPOSE_NATIVE_WIN32) || defined(GLFW_EXPOSE_NATIVE_WGL)
85  // This is a workaround for the fact that glfw3.h needs to export APIENTRY (for
86  // example to allow applications to correctly declare a GL_KHR_debug callback)
87  // but windows.h assumes no one will define APIENTRY before it does
88  #if defined(GLFW_APIENTRY_DEFINED)
89  #undef APIENTRY
90  #undef GLFW_APIENTRY_DEFINED
91  #endif
92  #include <windows.h>
93 #elif defined(GLFW_EXPOSE_NATIVE_COCOA) || defined(GLFW_EXPOSE_NATIVE_NSGL)
94  #if defined(__OBJC__)
95  #import <Cocoa/Cocoa.h>
96  #else
97  #include <ApplicationServices/ApplicationServices.h>
98  typedef void* id;
99  #endif
100 #elif defined(GLFW_EXPOSE_NATIVE_X11) || defined(GLFW_EXPOSE_NATIVE_GLX)
101  #include <X11/Xlib.h>
102  #include <X11/extensions/Xrandr.h>
103 #elif defined(GLFW_EXPOSE_NATIVE_WAYLAND)
104  #include <wayland-client.h>
105 #endif
106 
107 #if defined(GLFW_EXPOSE_NATIVE_WGL)
108  /* WGL is declared by windows.h */
109 #endif
110 #if defined(GLFW_EXPOSE_NATIVE_NSGL)
111  /* NSGL is declared by Cocoa.h */
112 #endif
113 #if defined(GLFW_EXPOSE_NATIVE_GLX)
114  #include <GL/glx.h>
115 #endif
116 #if defined(GLFW_EXPOSE_NATIVE_EGL)
117  #include <EGL/egl.h>
118 #endif
119 #if defined(GLFW_EXPOSE_NATIVE_OSMESA)
120  #include <GL/osmesa.h>
121 #endif
122 
123 
124 /*************************************************************************
125  * Functions
126  *************************************************************************/
127 
128 #if defined(GLFW_EXPOSE_NATIVE_WIN32)
129 
142 GLFWAPI const char* glfwGetWin32Adapter(GLFWmonitor* monitor);
143 
157 GLFWAPI const char* glfwGetWin32Monitor(GLFWmonitor* monitor);
158 
179 GLFWAPI HWND glfwGetWin32Window(GLFWwindow* window);
180 #endif
181 
182 #if defined(GLFW_EXPOSE_NATIVE_WGL)
183 
203 GLFWAPI HGLRC glfwGetWGLContext(GLFWwindow* window);
204 #endif
205 
206 #if defined(GLFW_EXPOSE_NATIVE_COCOA)
207 
219 GLFWAPI CGDirectDisplayID glfwGetCocoaMonitor(GLFWmonitor* monitor);
220 
233 GLFWAPI id glfwGetCocoaWindow(GLFWwindow* window);
234 #endif
235 
236 #if defined(GLFW_EXPOSE_NATIVE_NSGL)
237 
249 GLFWAPI id glfwGetNSGLContext(GLFWwindow* window);
250 #endif
251 
252 #if defined(GLFW_EXPOSE_NATIVE_X11)
253 
265 GLFWAPI Display* glfwGetX11Display(void);
266 
279 GLFWAPI RRCrtc glfwGetX11Adapter(GLFWmonitor* monitor);
280 
293 GLFWAPI RROutput glfwGetX11Monitor(GLFWmonitor* monitor);
294 
307 GLFWAPI Window glfwGetX11Window(GLFWwindow* window);
308 
329 GLFWAPI void glfwSetX11SelectionString(const char* string);
330 
357 GLFWAPI const char* glfwGetX11SelectionString(void);
358 #endif
359 
360 #if defined(GLFW_EXPOSE_NATIVE_GLX)
361 
373 GLFWAPI GLXContext glfwGetGLXContext(GLFWwindow* window);
374 
387 GLFWAPI GLXWindow glfwGetGLXWindow(GLFWwindow* window);
388 #endif
389 
390 #if defined(GLFW_EXPOSE_NATIVE_WAYLAND)
391 
403 GLFWAPI struct wl_display* glfwGetWaylandDisplay(void);
404 
417 GLFWAPI struct wl_output* glfwGetWaylandMonitor(GLFWmonitor* monitor);
418 
431 GLFWAPI struct wl_surface* glfwGetWaylandWindow(GLFWwindow* window);
432 #endif
433 
434 #if defined(GLFW_EXPOSE_NATIVE_EGL)
435 
447 GLFWAPI EGLDisplay glfwGetEGLDisplay(void);
448 
461 GLFWAPI EGLContext glfwGetEGLContext(GLFWwindow* window);
462 
475 GLFWAPI EGLSurface glfwGetEGLSurface(GLFWwindow* window);
476 #endif
477 
478 #if defined(GLFW_EXPOSE_NATIVE_OSMESA)
479 
498 GLFWAPI int glfwGetOSMesaColorBuffer(GLFWwindow* window, int* width, int* height, int* format, void** buffer);
499 
519 GLFWAPI int glfwGetOSMesaDepthBuffer(GLFWwindow* window, int* width, int* height, int* bytesPerValue, void** buffer);
520 
533 GLFWAPI OSMesaContext glfwGetOSMesaContext(GLFWwindow* window);
534 #endif
535 
536 #ifdef __cplusplus
537 }
538 #endif
539 
540 #endif /* _glfw3_native_h_ */
541 
glfwGetOSMesaDepthBuffer
int glfwGetOSMesaDepthBuffer(GLFWwindow *window, int *width, int *height, int *bytesPerValue, void **buffer)
Retrieves the depth buffer associated with the specified window.
glfwGetX11SelectionString
const char * glfwGetX11SelectionString(void)
Returns the contents of the current primary selection as a string.
glfwGetGLXWindow
GLXWindow glfwGetGLXWindow(GLFWwindow *window)
Returns the GLXWindow of the specified window.
glfwGetWaylandDisplay
struct wl_display * glfwGetWaylandDisplay(void)
Returns the struct wl_display* used by GLFW.
GLFWwindow
struct GLFWwindow GLFWwindow
Opaque window object.
Definition: glfw3.h:1178
glfwGetCocoaMonitor
CGDirectDisplayID glfwGetCocoaMonitor(GLFWmonitor *monitor)
Returns the CGDirectDisplayID of the specified monitor.
glfwGetEGLContext
EGLContext glfwGetEGLContext(GLFWwindow *window)
Returns the EGLContext of the specified window.
glfwSetX11SelectionString
void glfwSetX11SelectionString(const char *string)
Sets the current primary selection to the specified string.
glfwGetWaylandMonitor
struct wl_output * glfwGetWaylandMonitor(GLFWmonitor *monitor)
Returns the struct wl_output* of the specified monitor.
glfwGetWGLContext
HGLRC glfwGetWGLContext(GLFWwindow *window)
Returns the HGLRC of the specified window.
glfwGetGLXContext
GLXContext glfwGetGLXContext(GLFWwindow *window)
Returns the GLXContext of the specified window.
glfwGetX11Display
Display * glfwGetX11Display(void)
Returns the Display used by GLFW.
glfwGetCocoaWindow
id glfwGetCocoaWindow(GLFWwindow *window)
Returns the NSWindow of the specified window.
glfwGetWaylandWindow
struct wl_surface * glfwGetWaylandWindow(GLFWwindow *window)
Returns the main struct wl_surface* of the specified window.
glfwGetWin32Monitor
const char * glfwGetWin32Monitor(GLFWmonitor *monitor)
Returns the display device name of the specified monitor.
glfwGetNSGLContext
id glfwGetNSGLContext(GLFWwindow *window)
Returns the NSOpenGLContext of the specified window.
glfwGetWin32Adapter
const char * glfwGetWin32Adapter(GLFWmonitor *monitor)
Returns the adapter device name of the specified monitor.
glfwGetOSMesaContext
OSMesaContext glfwGetOSMesaContext(GLFWwindow *window)
Returns the OSMesaContext of the specified window.
glfwGetX11Window
Window glfwGetX11Window(GLFWwindow *window)
Returns the Window of the specified window.
glfwGetEGLSurface
EGLSurface glfwGetEGLSurface(GLFWwindow *window)
Returns the EGLSurface of the specified window.
glfwGetOSMesaColorBuffer
int glfwGetOSMesaColorBuffer(GLFWwindow *window, int *width, int *height, int *format, void **buffer)
Retrieves the color buffer associated with the specified window.
glfwGetX11Monitor
RROutput glfwGetX11Monitor(GLFWmonitor *monitor)
Returns the RROutput of the specified monitor.
glfwGetX11Adapter
RRCrtc glfwGetX11Adapter(GLFWmonitor *monitor)
Returns the RRCrtc of the specified monitor.
glfwGetEGLDisplay
EGLDisplay glfwGetEGLDisplay(void)
Returns the EGLDisplay used by GLFW.
glfwGetWin32Window
HWND glfwGetWin32Window(GLFWwindow *window)
Returns the HWND of the specified window.
GLFWmonitor
struct GLFWmonitor GLFWmonitor
Opaque monitor object.
Definition: glfw3.h:1166