/*************************************************************************
* GLFW 3.2 – www.glfw.org
* A library for OpenGL, window and input
*————————————————————————
* Copyright (c) 2002-2006 Marcus Geelnard
* Copyright (c) 2006-2016 Camilla Berglund
*
* This software is provided ‘as-is’, without any express or implied
* warranty. In no event will the authors be held liable for any damages
* arising from the use of this software.
*
* Permission is granted to anyone to use this software for any purpose,
* including commercial applications, and to alter it and redistribute it
* freely, subject to the following restrictions:
*
* 1. The origin of this software must not be misrepresented; you must not
*claim that you wrote the original software. If you use this software
*in a product, an acknowledgment in the product documentation would
*be appreciated but is not required.
*
* 2. Altered source versions must be plainly marked as such, and must not
*be misrepresented as being the original software.
*
* 3. This notice may not be removed or altered from any source
*distribution.
*
*************************************************************************/
#ifndef _glfw3_native_h_
#define _glfw3_native_h_
#ifdef __cplusplus
extern “C” {
#endif
/*************************************************************************
* Doxygen documentation
*************************************************************************/
/*! @file glfw3native.h
*@brief The header of the native access functions.
*
*This is the header file of the native access functions.See @ref native for
*more information.
*/
/*! @defgroup native Native access
*
***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.**
*
*Before the inclusion of @ref glfw3native.h, you may define exactly one
*window system API macro and zero or more context creation API macros.
*
*The chosen backends must match those the library was compiled for.Failure
*to do this will cause a link-time error.
*
*The available window API macros are:
** `GLFW_EXPOSE_NATIVE_WIN32`
** `GLFW_EXPOSE_NATIVE_COCOA`
** `GLFW_EXPOSE_NATIVE_X11`
** `GLFW_EXPOSE_NATIVE_WAYLAND`
** `GLFW_EXPOSE_NATIVE_MIR`
*
*The available context API macros are:
** `GLFW_EXPOSE_NATIVE_WGL`
** `GLFW_EXPOSE_NATIVE_NSGL`
** `GLFW_EXPOSE_NATIVE_GLX`
** `GLFW_EXPOSE_NATIVE_EGL`
*
*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.
*/
/*************************************************************************
* System headers and types
*************************************************************************/
#if defined(GLFW_EXPOSE_NATIVE_WIN32)
// This is a workaround for the fact that glfw3.h needs to export APIENTRY (for
// example to allow applications to correctly declare a GL_ARB_debug_output
// callback) but windows.h assumes no one will define APIENTRY before it does
#undef APIENTRY
#include
#elif defined(GLFW_EXPOSE_NATIVE_COCOA)
#include
#if defined(__OBJC__)
#import
#else
typedef void* id;
#endif
#elif defined(GLFW_EXPOSE_NATIVE_X11)
#include
#include
#elif defined(GLFW_EXPOSE_NATIVE_WAYLAND)
#include
#elif defined(GLFW_EXPOSE_NATIVE_MIR)
#include
#endif
#if defined(GLFW_EXPOSE_NATIVE_WGL)
/* WGL is declared by windows.h */
#endif
#if defined(GLFW_EXPOSE_NATIVE_NSGL)
/* NSGL is declared by Cocoa.h */
#endif
#if defined(GLFW_EXPOSE_NATIVE_GLX)
#include
#endif
#if defined(GLFW_EXPOSE_NATIVE_EGL)
#include
#endif
/*************************************************************************
* Functions
*************************************************************************/
#if defined(GLFW_EXPOSE_NATIVE_WIN32)
/*! @brief Returns the adapter device name of the specified monitor.
*
*@return The UTF-8 encoded adapter device name (for example `\.DISPLAY1`)
*of the specified monitor, or `NULL` if an [error](@ref error_handling)
*occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.1.
*
*@ingroup native
*/
GLFWAPI const char* glfwGetWin32Adapter(GLFWmonitor* monitor);
/*! @brief Returns the display device name of the specified monitor.
*
*@return The UTF-8 encoded display device name (for example
*`\.DISPLAY1Monitor0`) of the specified monitor, or `NULL` if an
*[error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.1.
*
*@ingroup native
*/
GLFWAPI const char* glfwGetWin32Monitor(GLFWmonitor* monitor);
/*! @brief Returns the `HWND` of the specified window.
*
*@return The `HWND` of the specified window, or `NULL` if an
*[error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.0.
*
*@ingroup native
*/
GLFWAPI HWND glfwGetWin32Window(GLFWwindow* window);
#endif
#if defined(GLFW_EXPOSE_NATIVE_WGL)
/*! @brief Returns the `HGLRC` of the specified window.
*
*@return The `HGLRC` of the specified window, or `NULL` if an
*[error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.0.
*
*@ingroup native
*/
GLFWAPI HGLRC glfwGetWGLContext(GLFWwindow* window);
#endif
#if defined(GLFW_EXPOSE_NATIVE_COCOA)
/*! @brief Returns the `CGDirectDisplayID` of the specified monitor.
*
*@return The `CGDirectDisplayID` of the specified monitor, or
*`kCGNullDirectDisplay` if an [error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.1.
*
*@ingroup native
*/
GLFWAPI CGDirectDisplayID glfwGetCocoaMonitor(GLFWmonitor* monitor);
/*! @brief Returns the `NSWindow` of the specified window.
*
*@return The `NSWindow` of the specified window, or `nil` if an
*[error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.0.
*
*@ingroup native
*/
GLFWAPI id glfwGetCocoaWindow(GLFWwindow* window);
#endif
#if defined(GLFW_EXPOSE_NATIVE_NSGL)
/*! @brief Returns the `NSOpenGLContext` of the specified window.
*
*@return The `NSOpenGLContext` of the specified window, or `nil` if an
*[error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.0.
*
*@ingroup native
*/
GLFWAPI id glfwGetNSGLContext(GLFWwindow* window);
#endif
#if defined(GLFW_EXPOSE_NATIVE_X11)
/*! @brief Returns the `Display` used by GLFW.
*
*@return The `Display` used by GLFW, or `NULL` if an
*[error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.0.
*
*@ingroup native
*/
GLFWAPI Display* glfwGetX11Display(void);
/*! @brief Returns the `RRCrtc` of the specified monitor.
*
*@return The `RRCrtc` of the specified monitor, or `None` if an
*[error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.1.
*
*@ingroup native
*/
GLFWAPI RRCrtc glfwGetX11Adapter(GLFWmonitor* monitor);
/*! @brief Returns the `RROutput` of the specified monitor.
*
*@return The `RROutput` of the specified monitor, or `None` if an
*[error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.1.
*
*@ingroup native
*/
GLFWAPI RROutput glfwGetX11Monitor(GLFWmonitor* monitor);
/*! @brief Returns the `Window` of the specified window.
*
*@return The `Window` of the specified window, or `None` if an
*[error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.0.
*
*@ingroup native
*/
GLFWAPI Window glfwGetX11Window(GLFWwindow* window);
#endif
#if defined(GLFW_EXPOSE_NATIVE_GLX)
/*! @brief Returns the `GLXContext` of the specified window.
*
*@return The `GLXContext` of the specified window, or `NULL` if an
*[error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.0.
*
*@ingroup native
*/
GLFWAPI GLXContext glfwGetGLXContext(GLFWwindow* window);
/*! @brief Returns the `GLXWindow` of the specified window.
*
*@return The `GLXWindow` of the specified window, or `None` if an
*[error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.2.
*
*@ingroup native
*/
GLFWAPI GLXWindow glfwGetGLXWindow(GLFWwindow* window);
#endif
#if defined(GLFW_EXPOSE_NATIVE_WAYLAND)
/*! @brief Returns the `struct wl_display*` used by GLFW.
*
*@return The `struct wl_display*` used by GLFW, or `NULL` if an
*[error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.2.
*
*@ingroup native
*/
GLFWAPI struct wl_display* glfwGetWaylandDisplay(void);
/*! @brief Returns the `struct wl_output*` of the specified monitor.
*
*@return The `struct wl_output*` of the specified monitor, or `NULL` if an
*[error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.2.
*
*@ingroup native
*/
GLFWAPI struct wl_output* glfwGetWaylandMonitor(GLFWmonitor* monitor);
/*! @brief Returns the main `struct wl_surface*` of the specified window.
*
*@return The main `struct wl_surface*` of the specified window, or `NULL` if
*an [error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.2.
*
*@ingroup native
*/
GLFWAPI struct wl_surface* glfwGetWaylandWindow(GLFWwindow* window);
#endif
#if defined(GLFW_EXPOSE_NATIVE_MIR)
/*! @brief Returns the `MirConnection*` used by GLFW.
*
*@return The `MirConnection*` used by GLFW, or `NULL` if an
*[error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.2.
*
*@ingroup native
*/
GLFWAPI MirConnection* glfwGetMirDisplay(void);
/*! @brief Returns the Mir output ID of the specified monitor.
*
*@return The Mir output ID of the specified monitor, or zero if an
*[error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.2.
*
*@ingroup native
*/
GLFWAPI int glfwGetMirMonitor(GLFWmonitor* monitor);
/*! @brief Returns the `MirSurface*` of the specified window.
*
*@return The `MirSurface*` of the specified window, or `NULL` if an
*[error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.2.
*
*@ingroup native
*/
GLFWAPI MirSurface* glfwGetMirWindow(GLFWwindow* window);
#endif
#if defined(GLFW_EXPOSE_NATIVE_EGL)
/*! @brief Returns the `EGLDisplay` used by GLFW.
*
*@return The `EGLDisplay` used by GLFW, or `EGL_NO_DISPLAY` if an
*[error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.0.
*
*@ingroup native
*/
GLFWAPI EGLDisplay glfwGetEGLDisplay(void);
/*! @brief Returns the `EGLContext` of the specified window.
*
*@return The `EGLContext` of the specified window, or `EGL_NO_CONTEXT` if an
*[error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.0.
*
*@ingroup native
*/
GLFWAPI EGLContext glfwGetEGLContext(GLFWwindow* window);
/*! @brief Returns the `EGLSurface` of the specified window.
*
*@return The `EGLSurface` of the specified window, or `EGL_NO_SURFACE` if an
*[error](@ref error_handling) occurred.
*
*@thread_safety This function may be called from any thread.Access is not
*synchronized.
*
*@since Added in version 3.0.
*
*@ingroup native
*/
GLFWAPI EGLSurface glfwGetEGLSurface(GLFWwindow* window);
#endif
#ifdef __cplusplus
}
#endif
#endif /* _glfw3_native_h_ */
Reviews
There are no reviews yet.