@NonnullDefault

Package org.lwjgl.glfw

Contains bindings to the GLFW library.

GLFW comes with extensive documentation, which you can read online here. The Frequently Asked Questions are also useful.

Using GLFW on macOS

On macOS the JVM must be started with the -XstartOnFirstThread argument for GLFW to work. This is necessary because most GLFW functions must be called on the main thread and the Cocoa API requires that thread to be the first thread in the process. GLFW windows and the GLFW event loop are incompatible with other window toolkits (such as AWT/Swing or JavaFX).

Applications that cannot function with the above limitation may set GLFW_LIBRARY_NAME to the value "glfw_async". This will instruct LWJGL to load an alternative GLFW build that dispatches Cocoa calls to the main thread in blocking mode. The other window toolkit must be initialized (e.g. with AWT's Toolkit.getDefaultToolkit()) before Init is called.

Interface Summary

Interface	Description
GLFWAllocateCallbackI	The function pointer type for memory allocation callbacks.
GLFWCharCallbackI	Instances of this interface may be passed to the SetCharCallback method.
GLFWCharModsCallbackI	Instances of this interface may be passed to the SetCharModsCallback method.
GLFWCursorEnterCallbackI	Instances of this interface may be passed to the SetCursorEnterCallback method.
GLFWCursorPosCallbackI	Instances of this interface may be passed to the SetCursorPosCallback method.
GLFWDeallocateCallbackI	The function pointer type for memory deallocation callbacks.
GLFWDropCallbackI	Instances of this interface may be passed to the SetDropCallback method.
GLFWErrorCallbackI	Instances of this interface may be passed to the SetErrorCallback method.
GLFWFramebufferSizeCallbackI	Instances of this interface may be passed to the SetFramebufferSizeCallback method.
GLFWJoystickCallbackI	Instances of this interface may be passed to the SetJoystickCallback method.
GLFWKeyCallbackI	Instances of this interface may be passed to the SetKeyCallback method.
GLFWMonitorCallbackI	Instances of this interface may be passed to the SetMonitorCallback method.
GLFWMouseButtonCallbackI	Instances of this interface may be passed to the SetMouseButtonCallback method.
GLFWReallocateCallbackI	The function pointer type for memory reallocation callbacks.
GLFWScrollCallbackI	Instances of this interface may be passed to the SetScrollCallback method.
GLFWWindowCloseCallbackI	Instances of this interface may be passed to the SetWindowCloseCallback method.
GLFWWindowContentScaleCallbackI	Instances of this interface may be passed to the SetWindowContentScaleCallback method.
GLFWWindowFocusCallbackI	Instances of this interface may be passed to the SetWindowFocusCallback method.
GLFWWindowIconifyCallbackI	Instances of this interface may be passed to the SetWindowIconifyCallback method.
GLFWWindowMaximizeCallbackI	Instances of this interface may be passed to the SetWindowMaximizeCallback method.
GLFWWindowPosCallbackI	Instances of this interface may be passed to the SetWindowPosCallback method.
GLFWWindowRefreshCallbackI	Instances of this interface may be passed to the SetWindowRefreshCallback method.
GLFWWindowSizeCallbackI	Instances of this interface may be passed to the SetWindowSizeCallback method.

Class Summary

Class	Description
GLFW	Native bindings to the GLFW library.
GLFW.Functions	Contains the function pointers loaded from the glfw SharedLibrary.
GLFWAllocateCallback	The function pointer type for memory allocation callbacks.
GLFWAllocator	A custom memory allocator that can be set with InitAllocator.
GLFWAllocator.Buffer	An array of GLFWAllocator structs.
GLFWCharCallback	Instances of this class may be passed to the SetCharCallback method.
GLFWCharModsCallback	Instances of this class may be passed to the SetCharModsCallback method.
GLFWCursorEnterCallback	Instances of this class may be passed to the SetCursorEnterCallback method.
GLFWCursorPosCallback	Instances of this class may be passed to the SetCursorPosCallback method.
GLFWDeallocateCallback	The function pointer type for memory deallocation callbacks.
GLFWDropCallback	Instances of this class may be passed to the SetDropCallback method.
GLFWErrorCallback	Instances of this class may be passed to the SetErrorCallback method.
GLFWFramebufferSizeCallback	Instances of this class may be passed to the SetFramebufferSizeCallback method.
GLFWGamepadState	Describes the input state of a gamepad.
GLFWGamepadState.Buffer	An array of GLFWGamepadState structs.
GLFWGammaRamp	Describes the gamma ramp for a monitor.
GLFWGammaRamp.Buffer	An array of GLFWGammaRamp structs.
GLFWImage	Image data.
GLFWImage.Buffer	An array of GLFWImage structs.
GLFWJoystickCallback	Instances of this class may be passed to the SetJoystickCallback method.
GLFWKeyCallback	Instances of this class may be passed to the SetKeyCallback method.
GLFWMonitorCallback	Instances of this class may be passed to the SetMonitorCallback method.
GLFWMouseButtonCallback	Instances of this class may be passed to the SetMouseButtonCallback method.
GLFWNativeCocoa	Native bindings to the GLFW library's Cocoa native access functions.
GLFWNativeCocoa.Functions	Contains the function pointers loaded from GLFW.getLibrary().
GLFWNativeEGL	Native bindings to the GLFW library's EGL native access functions.
GLFWNativeEGL.Functions	Contains the function pointers loaded from GLFW.getLibrary().
GLFWNativeGLX	Native bindings to the GLFW library's GLX native access functions.
GLFWNativeGLX.Functions	Contains the function pointers loaded from GLFW.getLibrary().
GLFWNativeNSGL	Native bindings to the GLFW library's NSGL native access functions.
GLFWNativeNSGL.Functions	Contains the function pointers loaded from GLFW.getLibrary().
GLFWNativeOSMesa	Native bindings to the GLFW library's GLX native access functions.
GLFWNativeOSMesa.Functions	Contains the function pointers loaded from GLFW.getLibrary().
GLFWNativeWayland	Native bindings to the GLFW library's Wayland native access functions.
GLFWNativeWayland.Functions	Contains the function pointers loaded from GLFW.getLibrary().
GLFWNativeWGL	Native bindings to the GLFW library's WGL native access functions.
GLFWNativeWGL.Functions	Contains the function pointers loaded from GLFW.getLibrary().
GLFWNativeWin32	Native bindings to the GLFW library's Win32 native access functions.
GLFWNativeWin32.Functions	Contains the function pointers loaded from GLFW.getLibrary().
GLFWNativeX11	Native bindings to the GLFW library's X11 native access functions.
GLFWNativeX11.Functions	Contains the function pointers loaded from GLFW.getLibrary().
GLFWReallocateCallback	The function pointer type for memory reallocation callbacks.
GLFWScrollCallback	Instances of this class may be passed to the SetScrollCallback method.
GLFWVidMode	Describes a single video mode.
GLFWVidMode.Buffer	An array of GLFWVidMode structs.
GLFWVulkan	Native bindings to the GLFW library's Vulkan functions.
GLFWVulkan.Functions	Contains the function pointers loaded from GLFW.getLibrary().
GLFWWindowCloseCallback	Instances of this class may be passed to the SetWindowCloseCallback method.
GLFWWindowContentScaleCallback	Instances of this class may be passed to the SetWindowContentScaleCallback method.
GLFWWindowFocusCallback	Instances of this class may be passed to the SetWindowFocusCallback method.
GLFWWindowIconifyCallback	Instances of this class may be passed to the SetWindowIconifyCallback method.
GLFWWindowMaximizeCallback	Instances of this class may be passed to the SetWindowMaximizeCallback method.
GLFWWindowPosCallback	Instances of this class may be passed to the SetWindowPosCallback method.
GLFWWindowRefreshCallback	Instances of this class may be passed to the SetWindowRefreshCallback method.
GLFWWindowSizeCallback	Instances of this class may be passed to the SetWindowSizeCallback method.