GLFW: Error codes

GLFW

- Documentation
- Download
- Media
- Community

Macros
Error codes
Initialization, version and error reference

## 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 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...
#define | GLFW_NO_WINDOW_CONTEXT 0x0001000A
| The specified window does not have an OpenGL or OpenGL ES context. More...

## Detailed Description

See error handling for how these are used.

## Macro Definition Documentation

## ◆ GLFW_API_UNAVAILABLE

#define GLFW_API_UNAVAILABLE 0x00010006

GLFW could not find support for the requested API on the system.

Analysis The installed graphics driver does not support the requested
  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 support 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. Older graphics drivers do not support Vulkan.

## ◆ GLFW_FORMAT_UNAVAILABLE

#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.

## ◆ GLFW_INVALID_ENUM

#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.

## ◆ GLFW_INVALID_VALUE

#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.

## ◆ GLFW_NO_CURRENT_CONTEXT

#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.

## ◆ GLFW_NO_WINDOW_CONTEXT

#define GLFW_NO_WINDOW_CONTEXT 0x0001000A

A window that does not have an OpenGL or OpenGL ES context was passed to a function that requires it to have one.

Analysis Application programmer error. Fix the offending call.

## ◆ GLFW_NOT_INITIALIZED

#define GLFW_NOT_INITIALIZED 0x00010001

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

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

## ◆ GLFW_OUT_OF_MEMORY

#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.

## ◆ GLFW_PLATFORM_ERROR

#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.

## ◆ GLFW_VERSION_UNAVAILABLE

#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.