Error codes

Description

See error handling for how these are used.

Macros
#define	GLFW_NOT_INITIALIZED   0x00010001
	GLFW has not been initialized. More...
#define	GLFW_NO_CURRENT_CONTEXT   0x00010002
	No context is current for this thread. More...
#define	GLFW_INVALID_ENUM   0x00010003
	One of the arguments to the function was an invalid enum value. More...
#define	GLFW_INVALID_VALUE   0x00010004
	One of the arguments to the function was an invalid value. More...
#define	GLFW_OUT_OF_MEMORY   0x00010005
	A memory allocation failed. More...
#define	GLFW_API_UNAVAILABLE   0x00010006
	GLFW could not find support for the requested client API on the system. More...
#define	GLFW_VERSION_UNAVAILABLE   0x00010007
	The requested OpenGL or OpenGL ES version is not available. More...
#define	GLFW_PLATFORM_ERROR   0x00010008
	A platform-specific error occurred that does not match any of the more specific categories. More...
#define	GLFW_FORMAT_UNAVAILABLE   0x00010009
	The requested format is not supported or available. More...

Macro Definition Documentation

#define GLFW_API_UNAVAILABLE   0x00010006

GLFW could not find support for the requested client API on the system. If emitted by functions other than glfwCreateWindow, no supported client API was found.

Analysis

The installed graphics driver does not support the requested client API, or does not support it via the chosen context creation backend. Below are a few examples.

Some pre-installed Windows graphics drivers do not support OpenGL. AMD only supports OpenGL ES via EGL, while Nvidia and Intel only supports it via a WGL or GLX extension. OS X does not provide OpenGL ES at all. The Mesa EGL, OpenGL and OpenGL ES libraries do not interface with the Nvidia binary driver.

#define GLFW_FORMAT_UNAVAILABLE   0x00010009

If emitted during window creation, the requested pixel format is not supported.

If emitted when querying the clipboard, the contents of the clipboard could not be converted to the requested format.

Analysis

If emitted during window creation, one or more hard constraints did not match any of the available pixel formats. If your application is sufficiently flexible, downgrade your requirements and try again. Otherwise, inform the user that their machine does not match your requirements.

If emitted when querying the clipboard, ignore the error or report it to the user, as appropriate.

#define GLFW_INVALID_ENUM   0x00010003

One of the arguments to the function was an invalid enum value, for example requesting GLFW_RED_BITS with glfwGetWindowAttrib.

Analysis

Application programmer error. Fix the offending call.

#define GLFW_INVALID_VALUE   0x00010004

One of the arguments to the function was an invalid value, for example requesting a non-existent OpenGL or OpenGL ES version like 2.7.

Requesting a valid but unavailable OpenGL or OpenGL ES version will instead result in a GLFW_VERSION_UNAVAILABLE error.

Analysis

Application programmer error. Fix the offending call.

#define GLFW_NO_CURRENT_CONTEXT   0x00010002

This occurs if a GLFW function was called that needs and operates on the current OpenGL or OpenGL ES context but no context is current on the calling thread. One such function is glfwSwapInterval.

Analysis

Application programmer error. Ensure a context is current before calling functions that require a current context.

#define GLFW_NOT_INITIALIZED   0x00010001

This occurs if a GLFW function was called that may not be called unless the library is initialized.

Analysis

Application programmer error. Initialize GLFW before calling any function that requires initialization.

#define GLFW_OUT_OF_MEMORY   0x00010005

A memory allocation failed.

Analysis

A bug in GLFW or the underlying operating system. Report the bug to our issue tracker.

#define GLFW_PLATFORM_ERROR   0x00010008

A platform-specific error occurred that does not match any of the more specific categories.

Analysis

A bug or configuration error in GLFW, the underlying operating system or its drivers, or a lack of required resources. Report the issue to our issue tracker.

#define GLFW_VERSION_UNAVAILABLE   0x00010007

The requested OpenGL or OpenGL ES version (including any requested context or framebuffer hints) is not available on this machine.

Analysis

The machine does not support your requirements. If your application is sufficiently flexible, downgrade your requirements and try again. Otherwise, inform the user that their machine does not match your requirements.

Future invalid OpenGL and OpenGL ES versions, for example OpenGL 4.8 if 5.0 comes out before the 4.x series gets that far, also fail with this error and not GLFW_INVALID_VALUE, because GLFW cannot know what future versions will exist.