Loading...
Searching...
No Matches
Window reference

## Description

This is the reference documentation for window related functions and types, including creation, deletion and event polling. For more task-oriented information, see the Window guide.

## Macros

#define | GLFW_FOCUSED 0x00020001
| Input focus window hint and attribute.
#define | GLFW_ICONIFIED 0x00020002
| Window iconification window attribute.
#define | GLFW_RESIZABLE 0x00020003
| Window resize-ability window hint and attribute.
#define | GLFW_VISIBLE 0x00020004
| Window visibility window hint and attribute.
#define | GLFW_DECORATED 0x00020005
| Window decoration window hint and attribute.
#define | GLFW_AUTO_ICONIFY 0x00020006
| Window auto-iconification window hint and attribute.
#define | GLFW_FLOATING 0x00020007
| Window decoration window hint and attribute.
#define | GLFW_MAXIMIZED 0x00020008
| Window maximization window hint and attribute.
#define | GLFW_CENTER_CURSOR 0x00020009
| Cursor centering window hint.
#define | GLFW_TRANSPARENT_FRAMEBUFFER 0x0002000A
| Window framebuffer transparency hint and attribute.
#define | GLFW_HOVERED 0x0002000B
| Mouse cursor hover window attribute.
#define | GLFW_FOCUS_ON_SHOW 0x0002000C
| Input focus on calling show window hint and attribute.
#define | GLFW_MOUSE_PASSTHROUGH 0x0002000D
| Mouse input transparency window hint and attribute.
#define | GLFW_POSITION_X 0x0002000E
| Initial position x-coordinate window hint.
#define | GLFW_POSITION_Y 0x0002000F
| Initial position y-coordinate window hint.
#define | GLFW_RED_BITS 0x00021001
| Framebuffer bit depth hint.
#define | GLFW_GREEN_BITS 0x00021002
| Framebuffer bit depth hint.
#define | GLFW_BLUE_BITS 0x00021003
| Framebuffer bit depth hint.
#define | GLFW_ALPHA_BITS 0x00021004
| Framebuffer bit depth hint.
#define | GLFW_DEPTH_BITS 0x00021005
| Framebuffer bit depth hint.
#define | GLFW_STENCIL_BITS 0x00021006
| Framebuffer bit depth hint.
#define | GLFW_ACCUM_RED_BITS 0x00021007
| Framebuffer bit depth hint.
#define | GLFW_ACCUM_GREEN_BITS 0x00021008
| Framebuffer bit depth hint.
#define | GLFW_ACCUM_BLUE_BITS 0x00021009
| Framebuffer bit depth hint.
#define | GLFW_ACCUM_ALPHA_BITS 0x0002100A
| Framebuffer bit depth hint.
#define | GLFW_AUX_BUFFERS 0x0002100B
| Framebuffer auxiliary buffer hint.
#define | GLFW_STEREO 0x0002100C
| OpenGL stereoscopic rendering hint.
#define | GLFW_SAMPLES 0x0002100D
| Framebuffer MSAA samples hint.
#define | GLFW_SRGB_CAPABLE 0x0002100E
| Framebuffer sRGB hint.
#define | GLFW_REFRESH_RATE 0x0002100F
| Monitor refresh rate hint.
#define | GLFW_DOUBLEBUFFER 0x00021010
| Framebuffer double buffering hint and attribute.
#define | GLFW_CLIENT_API 0x00022001
| Context client API hint and attribute.
#define | GLFW_CONTEXT_VERSION_MAJOR 0x00022002
| Context client API major version hint and attribute.
#define | GLFW_CONTEXT_VERSION_MINOR 0x00022003
| Context client API minor version hint and attribute.
#define | GLFW_CONTEXT_REVISION 0x00022004
| Context client API revision number attribute.
#define | GLFW_CONTEXT_ROBUSTNESS 0x00022005
| Context robustness hint and attribute.
#define | GLFW_OPENGL_FORWARD_COMPAT 0x00022006
| OpenGL forward-compatibility hint and attribute.
#define | GLFW_CONTEXT_DEBUG 0x00022007
| Debug mode context hint and attribute.
#define | GLFW_OPENGL_DEBUG_CONTEXT GLFW_CONTEXT_DEBUG
| Legacy name for compatibility.
#define | GLFW_OPENGL_PROFILE 0x00022008
| OpenGL profile hint and attribute.
#define | GLFW_CONTEXT_RELEASE_BEHAVIOR 0x00022009
| Context flush-on-release hint and attribute.
#define | GLFW_CONTEXT_NO_ERROR 0x0002200A
| Context error suppression hint and attribute.
#define | GLFW_CONTEXT_CREATION_API 0x0002200B
| Context creation API hint and attribute.
#define | GLFW_SCALE_TO_MONITOR 0x0002200C
| Window content area scaling window window hint.
#define | GLFW_SCALE_FRAMEBUFFER 0x0002200D
| Window framebuffer scaling window hint.
#define | GLFW_COCOA_RETINA_FRAMEBUFFER 0x00023001
| Legacy name for compatibility.
#define | GLFW_COCOA_FRAME_NAME 0x00023002
| macOS specific window hint.
#define | GLFW_COCOA_GRAPHICS_SWITCHING 0x00023003
| macOS specific window hint.
#define | GLFW_X11_CLASS_NAME 0x00024001
| X11 specific window hint.
#define | GLFW_X11_INSTANCE_NAME 0x00024002
| X11 specific window hint.
#define | GLFW_WIN32_KEYBOARD_MENU 0x00025001
#define | GLFW_WIN32_SHOWDEFAULT 0x00025002
| Win32 specific window hint.
#define | GLFW_WAYLAND_APP_ID 0x00026001
| Wayland specific window hint.

## Typedefs

typedef struct GLFWwindow | GLFWwindow
| Opaque window object.
typedef void(* | GLFWwindowposfun) (GLFWwindow *window, int xpos, int ypos)
| The function pointer type for window position callbacks.
typedef void(* | GLFWwindowsizefun) (GLFWwindow *window, int width, int height)
| The function pointer type for window size callbacks.
typedef void(* | GLFWwindowclosefun) (GLFWwindow *window)
| The function pointer type for window close callbacks.
typedef void(* | GLFWwindowrefreshfun) (GLFWwindow *window)
| The function pointer type for window content refresh callbacks.
typedef void(* | GLFWwindowfocusfun) (GLFWwindow *window, int focused)
| The function pointer type for window focus callbacks.
typedef void(* | GLFWwindowiconifyfun) (GLFWwindow *window, int iconified)
| The function pointer type for window iconify callbacks.
typedef void(* | GLFWwindowmaximizefun) (GLFWwindow *window, int maximized)
| The function pointer type for window maximize callbacks.
typedef void(* | GLFWframebuffersizefun) (GLFWwindow *window, int width, int height)
| The function pointer type for framebuffer size callbacks.
typedef void(* | GLFWwindowcontentscalefun) (GLFWwindow *window, float xscale, float yscale)
| The function pointer type for window content scale callbacks.
typedef struct GLFWimage | GLFWimage
| Image data.

## Functions

void | glfwDefaultWindowHints (void)
| Resets all window hints to their default values.
void | glfwWindowHint (int hint, int value)
| Sets the specified window hint to the desired value.
void | glfwWindowHintString (int hint, const char *value)
| Sets the specified window hint to the desired value.
GLFWwindow * | glfwCreateWindow (int width, int height, const char *title, GLFWmonitor *monitor, GLFWwindow *share)
| Creates a window and its associated context.
void | glfwDestroyWindow (GLFWwindow *window)
| Destroys the specified window and its context.
int | glfwWindowShouldClose (GLFWwindow *window)
| Checks the close flag of the specified window.
void | glfwSetWindowShouldClose (GLFWwindow *window, int value)
| Sets the close flag of the specified window.
const char * | glfwGetWindowTitle (GLFWwindow *window)
| Returns the title of the specified window.
void | glfwSetWindowTitle (GLFWwindow *window, const char *title)
| Sets the title of the specified window.
void | glfwSetWindowIcon (GLFWwindow *window, int count, const GLFWimage *images)
| Sets the icon for the specified window.
void | glfwGetWindowPos (GLFWwindow *window, int *xpos, int *ypos)
| Retrieves the position of the content area of the specified window.
void | glfwSetWindowPos (GLFWwindow *window, int xpos, int ypos)
| Sets the position of the content area of the specified window.
void | glfwGetWindowSize (GLFWwindow *window, int *width, int *height)
| Retrieves the size of the content area of the specified window.
void | glfwSetWindowSizeLimits (GLFWwindow *window, int minwidth, int minheight, int maxwidth, int maxheight)
| Sets the size limits of the specified window.
void | glfwSetWindowAspectRatio (GLFWwindow *window, int numer, int denom)
| Sets the aspect ratio of the specified window.
void | glfwSetWindowSize (GLFWwindow *window, int width, int height)
| Sets the size of the content area of the specified window.
void | glfwGetFramebufferSize (GLFWwindow *window, int *width, int *height)
| Retrieves the size of the framebuffer of the specified window.
void | glfwGetWindowFrameSize (GLFWwindow *window, int *left, int *top, int *right, int *bottom)
| Retrieves the size of the frame of the window.
void | glfwGetWindowContentScale (GLFWwindow *window, float *xscale, float *yscale)
| Retrieves the content scale for the specified window.
float | glfwGetWindowOpacity (GLFWwindow *window)
| Returns the opacity of the whole window.
void | glfwSetWindowOpacity (GLFWwindow *window, float opacity)
| Sets the opacity of the whole window.
void | glfwIconifyWindow (GLFWwindow *window)
| Iconifies the specified window.
void | glfwRestoreWindow (GLFWwindow *window)
| Restores the specified window.
void | glfwMaximizeWindow (GLFWwindow *window)
| Maximizes the specified window.
void | glfwShowWindow (GLFWwindow *window)
| Makes the specified window visible.
void | glfwHideWindow (GLFWwindow *window)
| Hides the specified window.
void | glfwFocusWindow (GLFWwindow *window)
| Brings the specified window to front and sets input focus.
void | glfwRequestWindowAttention (GLFWwindow *window)
| Requests user attention to the specified window.
GLFWmonitor * | glfwGetWindowMonitor (GLFWwindow *window)
| Returns the monitor that the window uses for full screen mode.
void | glfwSetWindowMonitor (GLFWwindow *window, GLFWmonitor *monitor, int xpos, int ypos, int width, int height, int refreshRate)
| Sets the mode, monitor, video mode and placement of a window.
int | glfwGetWindowAttrib (GLFWwindow *window, int attrib)
| Returns an attribute of the specified window.
void | glfwSetWindowAttrib (GLFWwindow *window, int attrib, int value)
| Sets an attribute of the specified window.
void | glfwSetWindowUserPointer (GLFWwindow *window, void *pointer)
| Sets the user pointer of the specified window.
void * | glfwGetWindowUserPointer (GLFWwindow *window)
| Returns the user pointer of the specified window.
GLFWwindowposfun | glfwSetWindowPosCallback (GLFWwindow *window, GLFWwindowposfun callback)
| Sets the position callback for the specified window.
GLFWwindowsizefun | glfwSetWindowSizeCallback (GLFWwindow *window, GLFWwindowsizefun callback)
| Sets the size callback for the specified window.
GLFWwindowclosefun | glfwSetWindowCloseCallback (GLFWwindow *window, GLFWwindowclosefun callback)
| Sets the close callback for the specified window.
GLFWwindowrefreshfun | glfwSetWindowRefreshCallback (GLFWwindow *window, GLFWwindowrefreshfun callback)
| Sets the refresh callback for the specified window.
GLFWwindowfocusfun | glfwSetWindowFocusCallback (GLFWwindow *window, GLFWwindowfocusfun callback)
| Sets the focus callback for the specified window.
GLFWwindowiconifyfun | glfwSetWindowIconifyCallback (GLFWwindow *window, GLFWwindowiconifyfun callback)
| Sets the iconify callback for the specified window.
GLFWwindowmaximizefun | glfwSetWindowMaximizeCallback (GLFWwindow *window, GLFWwindowmaximizefun callback)
| Sets the maximize callback for the specified window.
GLFWframebuffersizefun | glfwSetFramebufferSizeCallback (GLFWwindow *window, GLFWframebuffersizefun callback)
| Sets the framebuffer resize callback for the specified window.
GLFWwindowcontentscalefun | glfwSetWindowContentScaleCallback (GLFWwindow *window, GLFWwindowcontentscalefun callback)
| Sets the window content scale callback for the specified window.
void | glfwPollEvents (void)
| Processes all pending events.
void | glfwWaitEvents (void)
| Waits until events are queued and processes them.
void | glfwWaitEventsTimeout (double timeout)
| Waits with timeout until events are queued and processes them.
void | glfwPostEmptyEvent (void)
| Posts an empty event to the event queue.
void | glfwSwapBuffers (GLFWwindow *window)
| Swaps the front and back buffers of the specified window.

## Macro Definition Documentation

## GLFW_FOCUSED

#define GLFW_FOCUSED 0x00020001

Input focus window hint or window attribute.

## GLFW_ICONIFIED

#define GLFW_ICONIFIED 0x00020002

Window iconification window attribute.

## GLFW_RESIZABLE

#define GLFW_RESIZABLE 0x00020003

Window resize-ability window hint and window attribute.

## GLFW_VISIBLE

#define GLFW_VISIBLE 0x00020004

Window visibility window hint and window attribute.

## GLFW_DECORATED

#define GLFW_DECORATED 0x00020005

Window decoration window hint and window attribute.

## GLFW_AUTO_ICONIFY

#define GLFW_AUTO_ICONIFY 0x00020006

Window auto-iconification window hint and window attribute.

## GLFW_FLOATING

#define GLFW_FLOATING 0x00020007

Window decoration window hint and window attribute.

## GLFW_MAXIMIZED

#define GLFW_MAXIMIZED 0x00020008

Window maximization window hint and window attribute.

## GLFW_CENTER_CURSOR

#define GLFW_CENTER_CURSOR 0x00020009

Cursor centering window hint.

## GLFW_TRANSPARENT_FRAMEBUFFER

#define GLFW_TRANSPARENT_FRAMEBUFFER 0x0002000A

Window framebuffer transparency window hint and window attribute.

## GLFW_HOVERED

#define GLFW_HOVERED 0x0002000B

Mouse cursor hover window attribute.

## GLFW_FOCUS_ON_SHOW

#define GLFW_FOCUS_ON_SHOW 0x0002000C

Input focus window hint or window attribute.

## GLFW_MOUSE_PASSTHROUGH

#define GLFW_MOUSE_PASSTHROUGH 0x0002000D

Mouse input transparency window hint or window attribute.

## GLFW_POSITION_X

#define GLFW_POSITION_X 0x0002000E

Initial position x-coordinate window hint.

## GLFW_POSITION_Y

#define GLFW_POSITION_Y 0x0002000F

Initial position y-coordinate window hint.

## GLFW_RED_BITS

#define GLFW_RED_BITS 0x00021001

Framebuffer bit depth hint.

## GLFW_GREEN_BITS

#define GLFW_GREEN_BITS 0x00021002

Framebuffer bit depth hint.

## GLFW_BLUE_BITS

#define GLFW_BLUE_BITS 0x00021003

Framebuffer bit depth hint.

## GLFW_ALPHA_BITS

#define GLFW_ALPHA_BITS 0x00021004

Framebuffer bit depth hint.

## GLFW_DEPTH_BITS

#define GLFW_DEPTH_BITS 0x00021005

Framebuffer bit depth hint.

## GLFW_STENCIL_BITS

#define GLFW_STENCIL_BITS 0x00021006

Framebuffer bit depth hint.

## GLFW_ACCUM_RED_BITS

#define GLFW_ACCUM_RED_BITS 0x00021007

Framebuffer bit depth hint.

## GLFW_ACCUM_GREEN_BITS

#define GLFW_ACCUM_GREEN_BITS 0x00021008

Framebuffer bit depth hint.

## GLFW_ACCUM_BLUE_BITS

#define GLFW_ACCUM_BLUE_BITS 0x00021009

Framebuffer bit depth hint.

## GLFW_ACCUM_ALPHA_BITS

#define GLFW_ACCUM_ALPHA_BITS 0x0002100A

Framebuffer bit depth hint.

## GLFW_AUX_BUFFERS

#define GLFW_AUX_BUFFERS 0x0002100B

Framebuffer auxiliary buffer hint.

## GLFW_STEREO

#define GLFW_STEREO 0x0002100C

OpenGL stereoscopic rendering hint.

## GLFW_SAMPLES

#define GLFW_SAMPLES 0x0002100D

Framebuffer MSAA samples hint.

## GLFW_SRGB_CAPABLE

#define GLFW_SRGB_CAPABLE 0x0002100E

Framebuffer sRGB hint.

## GLFW_REFRESH_RATE

#define GLFW_REFRESH_RATE 0x0002100F

Monitor refresh rate hint.

## GLFW_DOUBLEBUFFER

#define GLFW_DOUBLEBUFFER 0x00021010

Framebuffer double buffering hint and attribute.

## GLFW_CLIENT_API

#define GLFW_CLIENT_API 0x00022001

Context client API hint and attribute.

## GLFW_CONTEXT_VERSION_MAJOR

#define GLFW_CONTEXT_VERSION_MAJOR 0x00022002

Context client API major version hint and attribute.

## GLFW_CONTEXT_VERSION_MINOR

#define GLFW_CONTEXT_VERSION_MINOR 0x00022003

Context client API minor version hint and attribute.

## GLFW_CONTEXT_REVISION

#define GLFW_CONTEXT_REVISION 0x00022004

Context client API revision number attribute.

## GLFW_CONTEXT_ROBUSTNESS

#define GLFW_CONTEXT_ROBUSTNESS 0x00022005

Context client API revision number hint and attribute.

## GLFW_OPENGL_FORWARD_COMPAT

#define GLFW_OPENGL_FORWARD_COMPAT 0x00022006

OpenGL forward-compatibility hint and attribute.

## GLFW_CONTEXT_DEBUG

#define GLFW_CONTEXT_DEBUG 0x00022007

Debug mode context hint and attribute.

## GLFW_OPENGL_DEBUG_CONTEXT

#define GLFW_OPENGL_DEBUG_CONTEXT GLFW_CONTEXT_DEBUG

This is an alias for compatibility with earlier versions.

## GLFW_OPENGL_PROFILE

#define GLFW_OPENGL_PROFILE 0x00022008

OpenGL profile hint and attribute.

## GLFW_CONTEXT_RELEASE_BEHAVIOR

#define GLFW_CONTEXT_RELEASE_BEHAVIOR 0x00022009

Context flush-on-release hint and attribute.

## GLFW_CONTEXT_NO_ERROR

#define GLFW_CONTEXT_NO_ERROR 0x0002200A

Context error suppression hint and attribute.

## GLFW_CONTEXT_CREATION_API

#define GLFW_CONTEXT_CREATION_API 0x0002200B

Context creation API hint and attribute.

## GLFW_SCALE_TO_MONITOR

#define GLFW_SCALE_TO_MONITOR 0x0002200C

## GLFW_SCALE_FRAMEBUFFER

#define GLFW_SCALE_FRAMEBUFFER 0x0002200D

## GLFW_COCOA_RETINA_FRAMEBUFFER

#define GLFW_COCOA_RETINA_FRAMEBUFFER 0x00023001

This is an alias for the GLFW_SCALE_FRAMEBUFFER window hint for compatibility with earlier versions.

## GLFW_COCOA_FRAME_NAME

#define GLFW_COCOA_FRAME_NAME 0x00023002

## GLFW_COCOA_GRAPHICS_SWITCHING

#define GLFW_COCOA_GRAPHICS_SWITCHING 0x00023003

## GLFW_X11_CLASS_NAME

#define GLFW_X11_CLASS_NAME 0x00024001

## GLFW_X11_INSTANCE_NAME

#define GLFW_X11_INSTANCE_NAME 0x00024002

## GLFW_WIN32_KEYBOARD_MENU

#define GLFW_WIN32_KEYBOARD_MENU 0x00025001

## GLFW_WIN32_SHOWDEFAULT

#define GLFW_WIN32_SHOWDEFAULT 0x00025002

## GLFW_WAYLAND_APP_ID

#define GLFW_WAYLAND_APP_ID 0x00026001

Allows specification of the Wayland app_id.

## Typedef Documentation

## GLFWwindow

typedef struct GLFWwindow GLFWwindow

Opaque window object.

See also
  Window objects

Since
  Added in version 3.0.

## GLFWwindowposfun

typedef void(* GLFWwindowposfun) (GLFWwindow *window, int xpos, int ypos)

This is the function pointer type for window position callbacks. A window position callback function has the following signature:

void callback_name(GLFWwindow* window, int xpos, int ypos)
GLFWwindow
struct GLFWwindow GLFWwindow
Opaque window object.
Definition glfw3.h:1408

Parameters

  [in] | window | The window that was moved.
  [in] | xpos | The new x-coordinate, in screen coordinates, of the upper-left corner of the content area of the window.
  [in] | ypos | The new y-coordinate, in screen coordinates, of the upper-left corner of the content area of the window.

See also
  Window position
  glfwSetWindowPosCallback

Since
  Added in version 3.0.

## GLFWwindowsizefun

typedef void(* GLFWwindowsizefun) (GLFWwindow *window, int width, int height)

This is the function pointer type for window size callbacks. A window size callback function has the following signature:

void callback_name(GLFWwindow* window, int width, int height)

Parameters

  [in] | window | The window that was resized.
  [in] | width | The new width, in screen coordinates, of the window.
  [in] | height | The new height, in screen coordinates, of the window.

See also
  Window size
  glfwSetWindowSizeCallback

Since
  Added in version 1.0. GLFW 3: Added window handle parameter.

## GLFWwindowclosefun

typedef void(* GLFWwindowclosefun) (GLFWwindow *window)

This is the function pointer type for window close callbacks. A window close callback function has the following signature:

void function_name(GLFWwindow* window)

Parameters

  [in] | window | The window that the user attempted to close.

See also
  Window closing and close flag
  glfwSetWindowCloseCallback

Since
  Added in version 2.5. GLFW 3: Added window handle parameter.

## GLFWwindowrefreshfun

typedef void(* GLFWwindowrefreshfun) (GLFWwindow *window)

This is the function pointer type for window content refresh callbacks. A window content refresh callback function has the following signature:

void function_name(GLFWwindow* window);

Parameters

  [in] | window | The window whose content needs to be refreshed.

See also
  Window damage and refresh
  glfwSetWindowRefreshCallback

Since
  Added in version 2.5. GLFW 3: Added window handle parameter.

## GLFWwindowfocusfun

typedef void(* GLFWwindowfocusfun) (GLFWwindow *window, int focused)

This is the function pointer type for window focus callbacks. A window focus callback function has the following signature:

void function_name(GLFWwindow* window, int focused)

Parameters

  [in] | window | The window that gained or lost input focus.
  [in] | focused | GLFW_TRUE if the window was given input focus, or GLFW_FALSE if it lost it.

See also
  Window input focus
  glfwSetWindowFocusCallback

Since
  Added in version 3.0.

## GLFWwindowiconifyfun

typedef void(* GLFWwindowiconifyfun) (GLFWwindow *window, int iconified)

This is the function pointer type for window iconify callbacks. A window iconify callback function has the following signature:

void function_name(GLFWwindow* window, int iconified)

Parameters

  [in] | window | The window that was iconified or restored.
  [in] | iconified | GLFW_TRUE if the window was iconified, or GLFW_FALSE if it was restored.

See also
  Window iconification
  glfwSetWindowIconifyCallback

Since
  Added in version 3.0.

## GLFWwindowmaximizefun

typedef void(* GLFWwindowmaximizefun) (GLFWwindow *window, int maximized)

This is the function pointer type for window maximize callbacks. A window maximize callback function has the following signature:

void function_name(GLFWwindow* window, int maximized)

Parameters

  [in] | window | The window that was maximized or restored.
  [in] | maximized | GLFW_TRUE if the window was maximized, or GLFW_FALSE if it was restored.

See also
  Window maximization
  glfwSetWindowMaximizeCallback

Since
  Added in version 3.3.

## GLFWframebuffersizefun

typedef void(* GLFWframebuffersizefun) (GLFWwindow *window, int width, int height)

This is the function pointer type for framebuffer size callbacks. A framebuffer size callback function has the following signature:

void function_name(GLFWwindow* window, int width, int height)

Parameters

  [in] | window | The window whose framebuffer was resized.
  [in] | width | The new width, in pixels, of the framebuffer.
  [in] | height | The new height, in pixels, of the framebuffer.

See also
  Framebuffer size
  glfwSetFramebufferSizeCallback

Since
  Added in version 3.0.

## GLFWwindowcontentscalefun

typedef void(* GLFWwindowcontentscalefun) (GLFWwindow *window, float xscale, float yscale)

This is the function pointer type for window content scale callbacks. A window content scale callback function has the following signature:

void function_name(GLFWwindow* window, float xscale, float yscale)

Parameters

  [in] | window | The window whose content scale changed.
  [in] | xscale | The new x-axis content scale of the window.
  [in] | yscale | The new y-axis content scale of the window.

See also
  Window content scale
  glfwSetWindowContentScaleCallback

Since
  Added in version 3.3.

## GLFWimage

typedef struct GLFWimage GLFWimage

This describes a single 2D image. See the documentation for each related function what the expected pixel format is.

See also
  Custom cursor creation
  Window icon

Since
  Added in version 2.1. GLFW 3: Removed format and bytes-per-pixel members.

## Function Documentation

## glfwDefaultWindowHints()

void glfwDefaultWindowHints | ( | void |  | ) |

This function resets all window hints to their default values.

Errors
  Possible errors include GLFW_NOT_INITIALIZED.

Thread safety
  This function must only be called from the main thread.

See also
  Window creation hints
  glfwWindowHint
  glfwWindowHintString

Since
  Added in version 3.0.

## glfwWindowHint()

void glfwWindowHint | ( | int | hint,
|  | int | value )

This function sets hints for the next call to glfwCreateWindow. The hints, once set, retain their values until changed by a call to this function or glfwDefaultWindowHints, or until the library is terminated.

Only integer value hints can be set with this function. String value hints are set with glfwWindowHintString.

This function does not check whether the specified hint values are valid. If you set hints to invalid values this will instead be reported by the next call to glfwCreateWindow.

Some hints are platform specific. These may be set on any platform but they will only affect their specific platform. Other platforms will ignore them. Setting these hints requires no platform specific headers or functions.

Parameters

  [in] | hint | The window hint to set.
  [in] | value | The new value of the window hint.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_ENUM.

Thread safety
  This function must only be called from the main thread.

See also
  Window creation hints
  glfwWindowHintString
  glfwDefaultWindowHints

Since
  Added in version 3.0. Replaces glfwOpenWindowHint.

## glfwWindowHintString()

void glfwWindowHintString | ( | int | hint,
|  | const char * | value )

This function sets hints for the next call to glfwCreateWindow. The hints, once set, retain their values until changed by a call to this function or glfwDefaultWindowHints, or until the library is terminated.

Only string type hints can be set with this function. Integer value hints are set with glfwWindowHint.

This function does not check whether the specified hint values are valid. If you set hints to invalid values this will instead be reported by the next call to glfwCreateWindow.

Some hints are platform specific. These may be set on any platform but they will only affect their specific platform. Other platforms will ignore them. Setting these hints requires no platform specific headers or functions.

Parameters

  [in] | hint | The window hint to set.
  [in] | value | The new value of the window hint.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_ENUM.

Pointer lifetime
  The specified string is copied before this function returns.

Thread safety
  This function must only be called from the main thread.

See also
  Window creation hints
  glfwWindowHint
  glfwDefaultWindowHints

Since
  Added in version 3.3.

## glfwCreateWindow()

GLFWwindow * glfwCreateWindow | ( | int | width,
|  | int | height,
|  | const char * | title,
|  | GLFWmonitor * | monitor,
|  | GLFWwindow * | share )

This function creates a window and its associated OpenGL or OpenGL ES context. Most of the options controlling how the window and its context should be created are specified with window hints.

Successful creation does not change which context is current. Before you can use the newly created context, you need to make it current. For information about the share parameter, see Context object sharing.

The created window, framebuffer and context may differ from what you requested, as not all parameters and hints are hard constraints. This includes the size of the window, especially for full screen windows. To query the actual attributes of the created window, framebuffer and context, see glfwGetWindowAttrib, glfwGetWindowSize and glfwGetFramebufferSize.

To create a full screen window, you need to specify the monitor the window will cover. If no monitor is specified, the window will be windowed mode. Unless you have a way for the user to choose a specific monitor, it is recommended that you pick the primary monitor. For more information on how to query connected monitors, see Retrieving monitors.

For full screen windows, the specified size becomes the resolution of the window's desired video mode. As long as a full screen window is not iconified, the supported video mode most closely matching the desired video mode is set for the specified monitor. For more information about full screen windows, including the creation of so called windowed full screen or borderless full screen windows, see "Windowed full screen" windows.

Once you have created the window, you can switch it between windowed and full screen mode with glfwSetWindowMonitor. This will not affect its OpenGL or OpenGL ES context.

By default, newly created windows use the placement recommended by the window system. To create the window at a specific position, set the GLFW_POSITION_X and GLFW_POSITION_Y window hints before creation. To restore the default behavior, set either or both hints back to GLFW_ANY_POSITION.

As long as at least one full screen window is not iconified, the screensaver is prohibited from starting.

Window systems put limits on window sizes. Very large or very small window dimensions may be overridden by the window system on creation. Check the actual size after creation.

The swap interval is not set during window creation and the initial value may vary depending on driver settings and defaults.

Parameters

  [in] | width | The desired width, in screen coordinates, of the window. This must be greater than zero.
  [in] | height | The desired height, in screen coordinates, of the window. This must be greater than zero.
  [in] | title | The initial, UTF-8 encoded window title.
  [in] | monitor | The monitor to use for full screen mode, or NULL for windowed mode.
  [in] | share | The window whose context to share resources with, or NULL to not share resources.

Returns
  The handle of the created window, or NULL if an error occurred.

Errors
  Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM, GLFW_INVALID_VALUE, GLFW_API_UNAVAILABLE, GLFW_VERSION_UNAVAILABLE, GLFW_FORMAT_UNAVAILABLE, GLFW_NO_WINDOW_CONTEXT and GLFW_PLATFORM_ERROR.

Remarks
  Win32: Window creation will fail if the Microsoft GDI software OpenGL implementation is the only one available.
  Win32: If the executable has an icon resource named GLFW_ICON, it will be set as the initial icon for the window. If no such icon is present, the IDI_APPLICATION icon will be used instead. To set a different icon, see glfwSetWindowIcon.
  Win32: The context to share resources with must not be current on any other thread.
  macOS: The OS only supports core profile contexts for OpenGL versions 3.2 and later. Before creating an OpenGL context of version 3.2 or later you must set the GLFW_OPENGL_PROFILE hint accordingly. OpenGL 3.0 and 3.1 contexts are not supported at all on macOS.
  macOS: The GLFW window has no icon, as it is not a document window, but the dock icon will be the same as the application bundle's icon. For more information on bundles, see the Bundle Programming Guide in the Mac Developer Library.
  macOS: The window frame will not be rendered at full resolution on Retina displays unless the GLFW_SCALE_FRAMEBUFFER hint is GLFW_TRUE and the NSHighResolutionCapable key is enabled in the application bundle's Info.plist. For more information, see High Resolution Guidelines for OS X in the Mac Developer Library. The GLFW test and example programs use a custom Info.plist template for this, which can be found as CMake/Info.plist.in in the source tree.
  macOS: When activating frame autosaving with GLFW_COCOA_FRAME_NAME, the specified window size and position may be overridden by previously saved values.
  Wayland: GLFW uses libdecor where available to create its window decorations. This in turn uses server-side XDG decorations where available and provides high quality client-side decorations on compositors like GNOME. If both XDG decorations and libdecor are unavailable, GLFW falls back to a very simple set of window decorations that only support moving, resizing and the window manager's right-click menu.
  X11: Some window managers will not respect the placement of initially hidden windows.
  X11: Due to the asynchronous nature of X11, it may take a moment for a window to reach its requested state. This means you may not be able to query the final size, position or other attributes directly after window creation.
  X11: The class part of the WM_CLASS window property will by default be set to the window title passed to this function. The instance part will use the contents of the RESOURCE_NAME environment variable, if present and not empty, or fall back to the window title. Set the GLFW_X11_CLASS_NAME and GLFW_X11_INSTANCE_NAME window hints to override this.

Thread safety
  This function must only be called from the main thread.

See also
  Window creation
  glfwDestroyWindow

Since
  Added in version 3.0. Replaces glfwOpenWindow.

## glfwDestroyWindow()

void glfwDestroyWindow | ( | GLFWwindow * | window | ) |

This function destroys the specified window and its context. On calling this function, no further callbacks will be called for that window.

If the context of the specified window is current on the main thread, it is detached before being destroyed.

Parameters

  [in] | window | The window to destroy.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Note
  The context of the specified window must not be current on any other thread when this function is called.

Reentrancy
  This function must not be called from a callback.

Thread safety
  This function must only be called from the main thread.

See also
  Window creation
  glfwCreateWindow

Since
  Added in version 3.0. Replaces glfwCloseWindow.

## glfwWindowShouldClose()

int glfwWindowShouldClose | ( | GLFWwindow * | window | ) |

This function returns the value of the close flag of the specified window.

Parameters

  [in] | window | The window to query.

Returns
  The value of the close flag.

Errors
  Possible errors include GLFW_NOT_INITIALIZED.

Thread safety
  This function may be called from any thread. Access is not synchronized.

See also
  Window closing and close flag

Since
  Added in version 3.0.

## glfwSetWindowShouldClose()

void glfwSetWindowShouldClose | ( | GLFWwindow * | window,
|  | int | value )

This function sets the value of the close flag of the specified window. This can be used to override the user's attempt to close the window, or to signal that it should be closed.

Parameters

  [in] | window | The window whose flag to change.
  [in] | value | The new value.

Errors
  Possible errors include GLFW_NOT_INITIALIZED.

Thread safety
  This function may be called from any thread. Access is not synchronized.

See also
  Window closing and close flag

Since
  Added in version 3.0.

## glfwGetWindowTitle()

const char * glfwGetWindowTitle | ( | GLFWwindow * | window | ) |

This function returns the window title, encoded as UTF-8, of the specified window. This is the title set previously by glfwCreateWindow or glfwSetWindowTitle.

Parameters

  [in] | window | The window to query.

Returns
  The UTF-8 encoded window title, or NULL if an error occurred.

Errors
  Possible errors include GLFW_NOT_INITIALIZED.

Remarks
  The returned title is currently a copy of the title last set by glfwCreateWindow or glfwSetWindowTitle. It does not include any additional text which may be appended by the platform or another program.

Pointer lifetime
  The returned string is allocated and freed by GLFW. You should not free it yourself. It is valid until the next call to glfwGetWindowTitle or glfwSetWindowTitle, or until the library is terminated.

Thread safety
  This function must only be called from the main thread.

See also
  Window title
  glfwSetWindowTitle

Since
  Added in version 3.4.

## glfwSetWindowTitle()

void glfwSetWindowTitle | ( | GLFWwindow * | window,
|  | const char * | title )

This function sets the window title, encoded as UTF-8, of the specified window.

Parameters

  [in] | window | The window whose title to change.
  [in] | title | The UTF-8 encoded window title.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Remarks
  macOS: The window title will not be updated until the next time you process events.

Thread safety
  This function must only be called from the main thread.

See also
  Window title
  glfwGetWindowTitle

Since
  Added in version 1.0. GLFW 3: Added window handle parameter.

## glfwSetWindowIcon()

void glfwSetWindowIcon | ( | GLFWwindow * | window,
|  | int | count,
|  | const GLFWimage * | images )

This function sets the icon of the specified window. If passed an array of candidate images, those of or closest to the sizes desired by the system are selected. If no images are specified, the window reverts to its default icon.

The pixels are 32-bit, little-endian, non-premultiplied RGBA, i.e. eight bits per channel with the red channel first. They are arranged canonically as packed sequential rows, starting from the top-left corner.

The desired image sizes varies depending on platform and system settings. The selected images will be rescaled as needed. Good sizes include 16x16, 32x32 and 48x48.

Parameters

  [in] | window | The window whose icon to set.
  [in] | count | The number of images in the specified array, or zero to revert to the default window icon.
  [in] | images | The images to create the icon from. This is ignored if count is zero.

Errors
  Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_VALUE, GLFW_PLATFORM_ERROR and GLFW_FEATURE_UNAVAILABLE (see remarks).

Pointer lifetime
  The specified image data is copied before this function returns.

Remarks
  macOS: Regular windows do not have icons on macOS. This function will emit GLFW_FEATURE_UNAVAILABLE. The dock icon will be the same as the application bundle's icon. For more information on bundles, see the Bundle Programming Guide in the Mac Developer Library.
  Wayland: There is no existing protocol to change an icon, the window will thus inherit the one defined in the application's desktop file. This function will emit GLFW_FEATURE_UNAVAILABLE.

Thread safety
  This function must only be called from the main thread.

See also
  Window icon

Since
  Added in version 3.2.

## glfwGetWindowPos()

void glfwGetWindowPos | ( | GLFWwindow * | window,
|  | int * | xpos,
|  | int * | ypos )

This function retrieves the position, in screen coordinates, of the upper-left corner of the content area of the specified window.

Any or all of the position arguments may be NULL. If an error occurs, all non-NULL position arguments will be set to zero.

Parameters

  [in] | window | The window to query.
  [out] | xpos | Where to store the x-coordinate of the upper-left corner of the content area, or NULL.
  [out] | ypos | Where to store the y-coordinate of the upper-left corner of the content area, or NULL.

Errors
  Possible errors include GLFW_NOT_INITIALIZED, GLFW_PLATFORM_ERROR and GLFW_FEATURE_UNAVAILABLE (see remarks).

Remarks
  Wayland: Window positions are not currently part of any common Wayland protocol, so this function cannot be implemented and will emit GLFW_FEATURE_UNAVAILABLE.

Thread safety
  This function must only be called from the main thread.

See also
  Window position
  glfwSetWindowPos

Since
  Added in version 3.0.

## glfwSetWindowPos()

void glfwSetWindowPos | ( | GLFWwindow * | window,
|  | int | xpos,
|  | int | ypos )

This function sets the position, in screen coordinates, of the upper-left corner of the content area of the specified windowed mode window. If the window is a full screen window, this function does nothing.

Do not use this function to move an already visible window unless you have very good reasons for doing so, as it will confuse and annoy the user.

The window manager may put limits on what positions are allowed. GLFW cannot and should not override these limits.

Parameters

  [in] | window | The window to query.
  [in] | xpos | The x-coordinate of the upper-left corner of the content area.
  [in] | ypos | The y-coordinate of the upper-left corner of the content area.

Errors
  Possible errors include GLFW_NOT_INITIALIZED, GLFW_PLATFORM_ERROR and GLFW_FEATURE_UNAVAILABLE (see remarks).

Remarks
  Wayland: Window positions are not currently part of any common Wayland protocol, so this function cannot be implemented and will emit GLFW_FEATURE_UNAVAILABLE.

Thread safety
  This function must only be called from the main thread.

See also
  Window position
  glfwGetWindowPos

Since
  Added in version 1.0. GLFW 3: Added window handle parameter.

## glfwGetWindowSize()

void glfwGetWindowSize | ( | GLFWwindow * | window,
|  | int * | width,
|  | int * | height )

This function retrieves the size, in screen coordinates, of the content area of the specified window. If you wish to retrieve the size of the framebuffer of the window in pixels, see glfwGetFramebufferSize.

Any or all of the size arguments may be NULL. If an error occurs, all non-NULL size arguments will be set to zero.

Parameters

  [in] | window | The window whose size to retrieve.
  [out] | width | Where to store the width, in screen coordinates, of the content area, or NULL.
  [out] | height | Where to store the height, in screen coordinates, of the content area, or NULL.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Thread safety
  This function must only be called from the main thread.

See also
  Window size
  glfwSetWindowSize

Since
  Added in version 1.0. GLFW 3: Added window handle parameter.

## glfwSetWindowSizeLimits()

void glfwSetWindowSizeLimits | ( | GLFWwindow * | window,
|  | int | minwidth,
|  | int | minheight,
|  | int | maxwidth,
|  | int | maxheight )

This function sets the size limits of the content area of the specified window. If the window is full screen, the size limits only take effect once it is made windowed. If the window is not resizable, this function does nothing.

The size limits are applied immediately to a windowed mode window and may cause it to be resized.

The maximum dimensions must be greater than or equal to the minimum dimensions and all must be greater than or equal to zero.

Parameters

  [in] | window | The window to set limits for.
  [in] | minwidth | The minimum width, in screen coordinates, of the content area, or GLFW_DONT_CARE.
  [in] | minheight | The minimum height, in screen coordinates, of the content area, or GLFW_DONT_CARE.
  [in] | maxwidth | The maximum width, in screen coordinates, of the content area, or GLFW_DONT_CARE.
  [in] | maxheight | The maximum height, in screen coordinates, of the content area, or GLFW_DONT_CARE.

Errors
  Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_VALUE and GLFW_PLATFORM_ERROR.

Remarks
  If you set size limits and an aspect ratio that conflict, the results are undefined.
  Wayland: The size limits will not be applied until the window is actually resized, either by the user or by the compositor.

Thread safety
  This function must only be called from the main thread.

See also
  Window size limits
  glfwSetWindowAspectRatio

Since
  Added in version 3.2.

## glfwSetWindowAspectRatio()

void glfwSetWindowAspectRatio | ( | GLFWwindow * | window,
|  | int | numer,
|  | int | denom )

This function sets the required aspect ratio of the content area of the specified window. If the window is full screen, the aspect ratio only takes effect once it is made windowed. If the window is not resizable, this function does nothing.

The aspect ratio is specified as a numerator and a denominator and both values must be greater than zero. For example, the common 16:9 aspect ratio is specified as 16 and 9, respectively.

If the numerator and denominator is set to GLFW_DONT_CARE then the aspect ratio limit is disabled.

The aspect ratio is applied immediately to a windowed mode window and may cause it to be resized.

Parameters

  [in] | window | The window to set limits for.
  [in] | numer | The numerator of the desired aspect ratio, or GLFW_DONT_CARE.
  [in] | denom | The denominator of the desired aspect ratio, or GLFW_DONT_CARE.

Errors
  Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_VALUE and GLFW_PLATFORM_ERROR.

Remarks
  If you set size limits and an aspect ratio that conflict, the results are undefined.
  Wayland: The aspect ratio will not be applied until the window is actually resized, either by the user or by the compositor.

Thread safety
  This function must only be called from the main thread.

See also
  Window size limits
  glfwSetWindowSizeLimits

Since
  Added in version 3.2.

## glfwSetWindowSize()

void glfwSetWindowSize | ( | GLFWwindow * | window,
|  | int | width,
|  | int | height )

This function sets the size, in screen coordinates, of the content area of the specified window.

For full screen windows, this function updates the resolution of its desired video mode and switches to the video mode closest to it, without affecting the window's context. As the context is unaffected, the bit depths of the framebuffer remain unchanged.

If you wish to update the refresh rate of the desired video mode in addition to its resolution, see glfwSetWindowMonitor.

The window manager may put limits on what sizes are allowed. GLFW cannot and should not override these limits.

Parameters

  [in] | window | The window to resize.
  [in] | width | The desired width, in screen coordinates, of the window content area.
  [in] | height | The desired height, in screen coordinates, of the window content area.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Thread safety
  This function must only be called from the main thread.

See also
  Window size
  glfwGetWindowSize
  glfwSetWindowMonitor

Since
  Added in version 1.0. GLFW 3: Added window handle parameter.

## glfwGetFramebufferSize()

void glfwGetFramebufferSize | ( | GLFWwindow * | window,
|  | int * | width,
|  | int * | height )

This function retrieves the size, in pixels, of the framebuffer of the specified window. If you wish to retrieve the size of the window in screen coordinates, see glfwGetWindowSize.

Any or all of the size arguments may be NULL. If an error occurs, all non-NULL size arguments will be set to zero.

Parameters

  [in] | window | The window whose framebuffer to query.
  [out] | width | Where to store the width, in pixels, of the framebuffer, or NULL.
  [out] | height | Where to store the height, in pixels, of the framebuffer, or NULL.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Thread safety
  This function must only be called from the main thread.

See also
  Framebuffer size
  glfwSetFramebufferSizeCallback

Since
  Added in version 3.0.

## glfwGetWindowFrameSize()

void glfwGetWindowFrameSize | ( | GLFWwindow * | window,
|  | int * | left,
|  | int * | top,
|  | int * | right,
|  | int * | bottom )

This function retrieves the size, in screen coordinates, of each edge of the frame of the specified window. This size includes the title bar, if the window has one. The size of the frame may vary depending on the window-related hints used to create it.

Because this function retrieves the size of each window frame edge and not the offset along a particular coordinate axis, the retrieved values will always be zero or positive.

Any or all of the size arguments may be NULL. If an error occurs, all non-NULL size arguments will be set to zero.

Parameters

  [in] | window | The window whose frame size to query.
  [out] | left | Where to store the size, in screen coordinates, of the left edge of the window frame, or NULL.
  [out] | top | Where to store the size, in screen coordinates, of the top edge of the window frame, or NULL.
  [out] | right | Where to store the size, in screen coordinates, of the right edge of the window frame, or NULL.
  [out] | bottom | Where to store the size, in screen coordinates, of the bottom edge of the window frame, or NULL.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Thread safety
  This function must only be called from the main thread.

See also
  Window size

Since
  Added in version 3.1.

## glfwGetWindowContentScale()

void glfwGetWindowContentScale | ( | GLFWwindow * | window,
|  | float * | xscale,
|  | float * | yscale )

This function retrieves the content scale for the specified window. The content scale is the ratio between the current DPI and the platform's default DPI. This is especially important for text and any UI elements. If the pixel dimensions of your UI scaled by this look appropriate on your machine then it should appear at a reasonable size on other machines regardless of their DPI and scaling settings. This relies on the system DPI and scaling settings being somewhat correct.

On platforms where each monitors can have its own content scale, the window content scale will depend on which monitor the system considers the window to be on.

Parameters

  [in] | window | The window to query.
  [out] | xscale | Where to store the x-axis content scale, or NULL.
  [out] | yscale | Where to store the y-axis content scale, or NULL.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Thread safety
  This function must only be called from the main thread.

See also
  Window content scale
  glfwSetWindowContentScaleCallback
  glfwGetMonitorContentScale

Since
  Added in version 3.3.

## glfwGetWindowOpacity()

float glfwGetWindowOpacity | ( | GLFWwindow * | window | ) |

This function returns the opacity of the window, including any decorations.

The opacity (or alpha) value is a positive finite number between zero and one, where zero is fully transparent and one is fully opaque. If the system does not support whole window transparency, this function always returns one.

The initial opacity value for newly created windows is one.

Parameters

  [in] | window | The window to query.

Returns
  The opacity value of the specified window.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Thread safety
  This function must only be called from the main thread.

See also
  Window transparency
  glfwSetWindowOpacity

Since
  Added in version 3.3.

## glfwSetWindowOpacity()

void glfwSetWindowOpacity | ( | GLFWwindow * | window,
|  | float | opacity )

This function sets the opacity of the window, including any decorations.

The opacity (or alpha) value is a positive finite number between zero and one, where zero is fully transparent and one is fully opaque.

The initial opacity value for newly created windows is one.

A window created with framebuffer transparency may not use whole window transparency. The results of doing this are undefined.

Parameters

  [in] | window | The window to set the opacity for.
  [in] | opacity | The desired opacity of the specified window.

Errors
  Possible errors include GLFW_NOT_INITIALIZED, GLFW_PLATFORM_ERROR and GLFW_FEATURE_UNAVAILABLE (see remarks).

Remarks
  Wayland: There is no way to set an opacity factor for a window. This function will emit GLFW_FEATURE_UNAVAILABLE.

Thread safety
  This function must only be called from the main thread.

See also
  Window transparency
  glfwGetWindowOpacity

Since
  Added in version 3.3.

## glfwIconifyWindow()

void glfwIconifyWindow | ( | GLFWwindow * | window | ) |

This function iconifies (minimizes) the specified window if it was previously restored. If the window is already iconified, this function does nothing.

If the specified window is a full screen window, GLFW restores the original video mode of the monitor. The window's desired video mode is set again when the window is restored.

Parameters

  [in] | window | The window to iconify.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Thread safety
  This function must only be called from the main thread.

See also
  Window iconification
  glfwRestoreWindow
  glfwMaximizeWindow

Since
  Added in version 2.1. GLFW 3: Added window handle parameter.

## glfwRestoreWindow()

void glfwRestoreWindow | ( | GLFWwindow * | window | ) |

This function restores the specified window if it was previously iconified (minimized) or maximized. If the window is already restored, this function does nothing.

If the specified window is an iconified full screen window, its desired video mode is set again for its monitor when the window is restored.

Parameters

  [in] | window | The window to restore.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Remarks
  Wayland: Restoring a window from maximization is not currently part of any common Wayland protocol, so this function can only restore windows from maximization.

Thread safety
  This function must only be called from the main thread.

See also
  Window iconification
  glfwIconifyWindow
  glfwMaximizeWindow

Since
  Added in version 2.1. GLFW 3: Added window handle parameter.

## glfwMaximizeWindow()

void glfwMaximizeWindow | ( | GLFWwindow * | window | ) |

This function maximizes the specified window if it was previously not maximized. If the window is already maximized, this function does nothing.

If the specified window is a full screen window, this function does nothing.

Parameters

  [in] | window | The window to maximize.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Thread Safety
  This function may only be called from the main thread.

See also
  Window iconification
  glfwIconifyWindow
  glfwRestoreWindow

Since
  Added in GLFW 3.2.

## glfwShowWindow()

void glfwShowWindow | ( | GLFWwindow * | window | ) |

This function makes the specified window visible if it was previously hidden. If the window is already visible or is in full screen mode, this function does nothing.

By default, windowed mode windows are focused when shown Set the GLFW_FOCUS_ON_SHOW window hint to change this behavior for all newly created windows, or change the behavior for an existing window with glfwSetWindowAttrib.

Parameters

  [in] | window | The window to make visible.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Remarks
  Wayland: Because Wayland wants every frame of the desktop to be complete, this function does not immediately make the window visible. Instead it will become visible the next time the window framebuffer is updated after this call.

Thread safety
  This function must only be called from the main thread.

See also
  Window visibility
  glfwHideWindow

Since
  Added in version 3.0.

## glfwHideWindow()

void glfwHideWindow | ( | GLFWwindow * | window | ) |

This function hides the specified window if it was previously visible. If the window is already hidden or is in full screen mode, this function does nothing.

Parameters

  [in] | window | The window to hide.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Thread safety
  This function must only be called from the main thread.

See also
  Window visibility
  glfwShowWindow

Since
  Added in version 3.0.

## glfwFocusWindow()

void glfwFocusWindow | ( | GLFWwindow * | window | ) |

This function brings the specified window to front and sets input focus. The window should already be visible and not iconified.

By default, both windowed and full screen mode windows are focused when initially created. Set the GLFW_FOCUSED to disable this behavior.

Also by default, windowed mode windows are focused when shown with glfwShowWindow. Set the GLFW_FOCUS_ON_SHOW to disable this behavior.

Do not use this function to steal focus from other applications unless you are certain that is what the user wants. Focus stealing can be extremely disruptive.

For a less disruptive way of getting the user's attention, see attention requests.

Parameters

  [in] | window | The window to give input focus.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Remarks
  Wayland: The compositor will likely ignore focus requests unless another window created by the same application already has input focus.

Thread safety
  This function must only be called from the main thread.

See also
  Window input focus
  Window attention request

Since
  Added in version 3.2.

## glfwRequestWindowAttention()

void glfwRequestWindowAttention | ( | GLFWwindow * | window | ) |

This function requests user attention to the specified window. On platforms where this is not supported, attention is requested to the application as a whole.

Once the user has given attention, usually by focusing the window or application, the system will end the request automatically.

Parameters

  [in] | window | The window to request attention to.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Remarks
  macOS: Attention is requested to the application as a whole, not the specific window.

Thread safety
  This function must only be called from the main thread.

See also
  Window attention request

Since
  Added in version 3.3.

## glfwGetWindowMonitor()

GLFWmonitor * glfwGetWindowMonitor | ( | GLFWwindow * | window | ) |

This function returns the handle of the monitor that the specified window is in full screen on.

Parameters

  [in] | window | The window to query.

Returns
  The monitor, or NULL if the window is in windowed mode or an error occurred.

Errors
  Possible errors include GLFW_NOT_INITIALIZED.

Thread safety
  This function must only be called from the main thread.

See also
  Window monitor
  glfwSetWindowMonitor

Since
  Added in version 3.0.

## glfwSetWindowMonitor()

void glfwSetWindowMonitor | ( | GLFWwindow * | window,
|  | GLFWmonitor * | monitor,
|  | int | xpos,
|  | int | ypos,
|  | int | width,
|  | int | height,
|  | int | refreshRate )

This function sets the monitor that the window uses for full screen mode or, if the monitor is NULL, makes it windowed mode.

When setting a monitor, this function updates the width, height and refresh rate of the desired video mode and switches to the video mode closest to it. The window position is ignored when setting a monitor.

When the monitor is NULL, the position, width and height are used to place the window content area. The refresh rate is ignored when no monitor is specified.

If you only wish to update the resolution of a full screen window or the size of a windowed mode window, see glfwSetWindowSize.

When a window transitions from full screen to windowed mode, this function restores any previous window settings such as whether it is decorated, floating, resizable, has size or aspect ratio limits, etc.

Parameters

  [in] | window | The window whose monitor, size or video mode to set.
  [in] | monitor | The desired monitor, or NULL to set windowed mode.
  [in] | xpos | The desired x-coordinate of the upper-left corner of the content area.
  [in] | ypos | The desired y-coordinate of the upper-left corner of the content area.
  [in] | width | The desired with, in screen coordinates, of the content area or video mode.
  [in] | height | The desired height, in screen coordinates, of the content area or video mode.
  [in] | refreshRate | The desired refresh rate, in Hz, of the video mode, or GLFW_DONT_CARE.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Remarks
  The OpenGL or OpenGL ES context will not be destroyed or otherwise affected by any resizing or mode switching, although you may need to update your viewport if the framebuffer size has changed.
  Wayland: Window positions are not currently part of any common Wayland protocol. The window position arguments are ignored.

Thread safety
  This function must only be called from the main thread.

See also
  Window monitor
  Full screen windows
  glfwGetWindowMonitor
  glfwSetWindowSize

Since
  Added in version 3.2.

## glfwGetWindowAttrib()

int glfwGetWindowAttrib | ( | GLFWwindow * | window,
|  | int | attrib )

This function returns the value of an attribute of the specified window or its OpenGL or OpenGL ES context.

Parameters

  [in] | window | The window to query.
  [in] | attrib | The window attribute whose value to return.

Returns
  The value of the attribute, or zero if an error occurred.

Errors
  Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.

Remarks
  Framebuffer related hints are not window attributes. See Framebuffer related attributes for more information.
  Zero is a valid value for many window and context related attributes so you cannot use a return value of zero as an indication of errors. However, this function should not fail as long as it is passed valid arguments and the library has been initialized.
  Wayland: Checking whether a window is iconified is not currently part of any common Wayland protocol, so the GLFW_ICONIFIED attribute cannot be implemented and is always GLFW_FALSE.

Thread safety
  This function must only be called from the main thread.

See also
  Window attributes
  glfwSetWindowAttrib

Since
  Added in version 3.0. Replaces glfwGetWindowParam and glfwGetGLVersion.

## glfwSetWindowAttrib()

void glfwSetWindowAttrib | ( | GLFWwindow * | window,
|  | int | attrib,
|  | int | value )

This function sets the value of an attribute of the specified window.

The supported attributes are GLFW_DECORATED, GLFW_RESIZABLE, GLFW_FLOATING, GLFW_AUTO_ICONIFY and GLFW_FOCUS_ON_SHOW. GLFW_MOUSE_PASSTHROUGH

Some of these attributes are ignored for full screen windows. The new value will take effect if the window is later made windowed.

Some of these attributes are ignored for windowed mode windows. The new value will take effect if the window is later made full screen.

Parameters

  [in] | window | The window to set the attribute for.
  [in] | attrib | A supported window attribute.
  [in] | value | GLFW_TRUE or GLFW_FALSE.

Errors
  Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM, GLFW_INVALID_VALUE, GLFW_PLATFORM_ERROR and GLFW_FEATURE_UNAVAILABLE (see remarks).

Remarks
  Calling glfwGetWindowAttrib will always return the latest value, even if that value is ignored by the current mode of the window.
  Wayland: The GLFW_FLOATING window attribute is not supported. Setting this will emit GLFW_FEATURE_UNAVAILABLE.

Thread safety
  This function must only be called from the main thread.

See also
  Window attributes
  glfwGetWindowAttrib

Since
  Added in version 3.3.

## glfwSetWindowUserPointer()

void glfwSetWindowUserPointer | ( | GLFWwindow * | window,
|  | void * | pointer )

This function sets the user-defined pointer of the specified window. The current value is retained until the window is destroyed. The initial value is NULL.

Parameters

  [in] | window | The window whose pointer to set.
  [in] | pointer | The new value.

Errors
  Possible errors include GLFW_NOT_INITIALIZED.

Thread safety
  This function may be called from any thread. Access is not synchronized.

See also
  User pointer
  glfwGetWindowUserPointer

Since
  Added in version 3.0.

## glfwGetWindowUserPointer()

void * glfwGetWindowUserPointer | ( | GLFWwindow * | window | ) |

This function returns the current value of the user-defined pointer of the specified window. The initial value is NULL.

Parameters

  [in] | window | The window whose pointer to return.

Errors
  Possible errors include GLFW_NOT_INITIALIZED.

Thread safety
  This function may be called from any thread. Access is not synchronized.

See also
  User pointer
  glfwSetWindowUserPointer

Since
  Added in version 3.0.

## glfwSetWindowPosCallback()

GLFWwindowposfun glfwSetWindowPosCallback | ( | GLFWwindow * | window,
|  | GLFWwindowposfun | callback )

This function sets the position callback of the specified window, which is called when the window is moved. The callback is provided with the position, in screen coordinates, of the upper-left corner of the content area of the window.

Parameters

  [in] | window | The window whose callback to set.
  [in] | callback | The new callback, or NULL to remove the currently set callback.

Returns
  The previously set callback, or NULL if no callback was set or the library had not been initialized.

Callback signature

void function_name(GLFWwindow* window, int xpos, int ypos)

For more information about the callback parameters, see the function pointer type.

Errors
  Possible errors include GLFW_NOT_INITIALIZED.

Remarks
  Wayland: This callback will not be called. The Wayland protocol provides no way to be notified of when a window is moved.

Thread safety
  This function must only be called from the main thread.

See also
  Window position

Since
  Added in version 3.0.

## glfwSetWindowSizeCallback()

GLFWwindowsizefun glfwSetWindowSizeCallback | ( | GLFWwindow * | window,
|  | GLFWwindowsizefun | callback )

This function sets the size callback of the specified window, which is called when the window is resized. The callback is provided with the size, in screen coordinates, of the content area of the window.

Parameters

  [in] | window | The window whose callback to set.
  [in] | callback | The new callback, or NULL to remove the currently set callback.

Returns
  The previously set callback, or NULL if no callback was set or the library had not been initialized.

Callback signature

void function_name(GLFWwindow* window, int width, int height)

For more information about the callback parameters, see the function pointer type.

Errors
  Possible errors include GLFW_NOT_INITIALIZED.

Thread safety
  This function must only be called from the main thread.

See also
  Window size

Since
  Added in version 1.0. GLFW 3: Added window handle parameter and return value.

## glfwSetWindowCloseCallback()

GLFWwindowclosefun glfwSetWindowCloseCallback | ( | GLFWwindow * | window,
|  | GLFWwindowclosefun | callback )

This function sets the close callback of the specified window, which is called when the user attempts to close the window, for example by clicking the close widget in the title bar.

The close flag is set before this callback is called, but you can modify it at any time with glfwSetWindowShouldClose.

The close callback is not triggered by glfwDestroyWindow.

Parameters

  [in] | window | The window whose callback to set.
  [in] | callback | The new callback, or NULL to remove the currently set callback.

Returns
  The previously set callback, or NULL if no callback was set or the library had not been initialized.

Callback signature

void function_name(GLFWwindow* window)

For more information about the callback parameters, see the function pointer type.

Errors
  Possible errors include GLFW_NOT_INITIALIZED.

Remarks
  macOS: Selecting Quit from the application menu will trigger the close callback for all windows.

Thread safety
  This function must only be called from the main thread.

See also
  Window closing and close flag

Since
  Added in version 2.5. GLFW 3: Added window handle parameter and return value.

## glfwSetWindowRefreshCallback()

GLFWwindowrefreshfun glfwSetWindowRefreshCallback | ( | GLFWwindow * | window,
|  | GLFWwindowrefreshfun | callback )

This function sets the refresh callback of the specified window, which is called when the content area of the window needs to be redrawn, for example if the window has been exposed after having been covered by another window.

On compositing window systems such as Aero, Compiz, Aqua or Wayland, where the window contents are saved off-screen, this callback may be called only very infrequently or never at all.

Parameters

  [in] | window | The window whose callback to set.
  [in] | callback | The new callback, or NULL to remove the currently set callback.

Returns
  The previously set callback, or NULL if no callback was set or the library had not been initialized.

Callback signature

void function_name(GLFWwindow* window);

For more information about the callback parameters, see the function pointer type.

Errors
  Possible errors include GLFW_NOT_INITIALIZED.

Thread safety
  This function must only be called from the main thread.

See also
  Window damage and refresh

Since
  Added in version 2.5. GLFW 3: Added window handle parameter and return value.

## glfwSetWindowFocusCallback()

GLFWwindowfocusfun glfwSetWindowFocusCallback | ( | GLFWwindow * | window,
|  | GLFWwindowfocusfun | callback )

This function sets the focus callback of the specified window, which is called when the window gains or loses input focus.

After the focus callback is called for a window that lost input focus, synthetic key and mouse button release events will be generated for all such that had been pressed. For more information, see glfwSetKeyCallback and glfwSetMouseButtonCallback.

Parameters

  [in] | window | The window whose callback to set.
  [in] | callback | The new callback, or NULL to remove the currently set callback.

Returns
  The previously set callback, or NULL if no callback was set or the library had not been initialized.

Callback signature

void function_name(GLFWwindow* window, int focused)

For more information about the callback parameters, see the function pointer type.

Errors
  Possible errors include GLFW_NOT_INITIALIZED.

Thread safety
  This function must only be called from the main thread.

See also
  Window input focus

Since
  Added in version 3.0.

## glfwSetWindowIconifyCallback()

GLFWwindowiconifyfun glfwSetWindowIconifyCallback | ( | GLFWwindow * | window,
|  | GLFWwindowiconifyfun | callback )

This function sets the iconification callback of the specified window, which is called when the window is iconified or restored.

Parameters

  [in] | window | The window whose callback to set.
  [in] | callback | The new callback, or NULL to remove the currently set callback.

Returns
  The previously set callback, or NULL if no callback was set or the library had not been initialized.

Callback signature

void function_name(GLFWwindow* window, int iconified)

For more information about the callback parameters, see the function pointer type.

Errors
  Possible errors include GLFW_NOT_INITIALIZED.

Remarks
  Wayland: This callback will not be called. The Wayland protocol provides no way to be notified of when a window is iconified, and no way to check whether a window is currently iconified.

Thread safety
  This function must only be called from the main thread.

See also
  Window iconification

Since
  Added in version 3.0.

## glfwSetWindowMaximizeCallback()

GLFWwindowmaximizefun glfwSetWindowMaximizeCallback | ( | GLFWwindow * | window,
|  | GLFWwindowmaximizefun | callback )

This function sets the maximization callback of the specified window, which is called when the window is maximized or restored.

Parameters

  [in] | window | The window whose callback to set.
  [in] | callback | The new callback, or NULL to remove the currently set callback.

Returns
  The previously set callback, or NULL if no callback was set or the library had not been initialized.

Callback signature

void function_name(GLFWwindow* window, int maximized)

For more information about the callback parameters, see the function pointer type.

Errors
  Possible errors include GLFW_NOT_INITIALIZED.

Thread safety
  This function must only be called from the main thread.

See also
  Window maximization

Since
  Added in version 3.3.

## glfwSetFramebufferSizeCallback()

GLFWframebuffersizefun glfwSetFramebufferSizeCallback | ( | GLFWwindow * | window,
|  | GLFWframebuffersizefun | callback )

This function sets the framebuffer resize callback of the specified window, which is called when the framebuffer of the specified window is resized.

Parameters

  [in] | window | The window whose callback to set.
  [in] | callback | The new callback, or NULL to remove the currently set callback.

Returns
  The previously set callback, or NULL if no callback was set or the library had not been initialized.

Callback signature

void function_name(GLFWwindow* window, int width, int height)

For more information about the callback parameters, see the function pointer type.

Errors
  Possible errors include GLFW_NOT_INITIALIZED.

Thread safety
  This function must only be called from the main thread.

See also
  Framebuffer size

Since
  Added in version 3.0.

## glfwSetWindowContentScaleCallback()

GLFWwindowcontentscalefun glfwSetWindowContentScaleCallback | ( | GLFWwindow * | window,
|  | GLFWwindowcontentscalefun | callback )

This function sets the window content scale callback of the specified window, which is called when the content scale of the specified window changes.

Parameters

  [in] | window | The window whose callback to set.
  [in] | callback | The new callback, or NULL to remove the currently set callback.

Returns
  The previously set callback, or NULL if no callback was set or the library had not been initialized.

Callback signature

void function_name(GLFWwindow* window, float xscale, float yscale)

For more information about the callback parameters, see the function pointer type.

Errors
  Possible errors include GLFW_NOT_INITIALIZED.

Thread safety
  This function must only be called from the main thread.

See also
  Window content scale
  glfwGetWindowContentScale

Since
  Added in version 3.3.

## glfwPollEvents()

void glfwPollEvents | ( | void |  | ) |

This function processes only those events that are already in the event queue and then returns immediately. Processing events will cause the window and input callbacks associated with those events to be called.

On some platforms, a window move, resize or menu operation will cause event processing to block. This is due to how event processing is designed on those platforms. You can use the window refresh callback to redraw the contents of your window when necessary during such operations.

Do not assume that callbacks you set will only be called in response to event processing functions like this one. While it is necessary to poll for events, window systems that require GLFW to register callbacks of its own can pass events to GLFW in response to many window system function calls. GLFW will pass those events on to the application callbacks before returning.

Event processing is not required to receive joystick input. Joystick state is polled when a joystick input or gamepad input function is called.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Reentrancy
  This function must not be called from a callback.

Thread safety
  This function must only be called from the main thread.

See also
  Event processing
  glfwWaitEvents
  glfwWaitEventsTimeout

Since
  Added in version 1.0.

## glfwWaitEvents()

void glfwWaitEvents | ( | void |  | ) |

This function puts the calling thread to sleep until at least one event is available in the event queue. Once one or more events are available, it behaves exactly like glfwPollEvents, i.e. the events in the queue are processed and the function then returns immediately. Processing events will cause the window and input callbacks associated with those events to be called.

Since not all events are associated with callbacks, this function may return without a callback having been called even if you are monitoring all callbacks.

On some platforms, a window move, resize or menu operation will cause event processing to block. This is due to how event processing is designed on those platforms. You can use the window refresh callback to redraw the contents of your window when necessary during such operations.

Do not assume that callbacks you set will only be called in response to event processing functions like this one. While it is necessary to poll for events, window systems that require GLFW to register callbacks of its own can pass events to GLFW in response to many window system function calls. GLFW will pass those events on to the application callbacks before returning.

Event processing is not required to receive joystick input. Joystick state is polled when a joystick input or gamepad input function is called.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Reentrancy
  This function must not be called from a callback.

Thread safety
  This function must only be called from the main thread.

See also
  Event processing
  glfwPollEvents
  glfwWaitEventsTimeout

Since
  Added in version 2.5.

## glfwWaitEventsTimeout()

void glfwWaitEventsTimeout | ( | double | timeout | ) |

This function puts the calling thread to sleep until at least one event is available in the event queue, or until the specified timeout is reached. If one or more events are available, it behaves exactly like glfwPollEvents, i.e. the events in the queue are processed and the function then returns immediately. Processing events will cause the window and input callbacks associated with those events to be called.

The timeout value must be a positive finite number.

Since not all events are associated with callbacks, this function may return without a callback having been called even if you are monitoring all callbacks.

On some platforms, a window move, resize or menu operation will cause event processing to block. This is due to how event processing is designed on those platforms. You can use the window refresh callback to redraw the contents of your window when necessary during such operations.

Do not assume that callbacks you set will only be called in response to event processing functions like this one. While it is necessary to poll for events, window systems that require GLFW to register callbacks of its own can pass events to GLFW in response to many window system function calls. GLFW will pass those events on to the application callbacks before returning.

Event processing is not required to receive joystick input. Joystick state is polled when a joystick input or gamepad input function is called.

Parameters

  [in] | timeout | The maximum amount of time, in seconds, to wait.

Errors
  Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_VALUE and GLFW_PLATFORM_ERROR.

Reentrancy
  This function must not be called from a callback.

Thread safety
  This function must only be called from the main thread.

See also
  Event processing
  glfwPollEvents
  glfwWaitEvents

Since
  Added in version 3.2.

## glfwPostEmptyEvent()

void glfwPostEmptyEvent | ( | void |  | ) |

This function posts an empty event from the current thread to the event queue, causing glfwWaitEvents or glfwWaitEventsTimeout to return.

Errors
  Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.

Thread safety
  This function may be called from any thread.

See also
  Event processing
  glfwWaitEvents
  glfwWaitEventsTimeout

Since
  Added in version 3.1.

## glfwSwapBuffers()

void glfwSwapBuffers | ( | GLFWwindow * | window | ) |

This function swaps the front and back buffers of the specified window when rendering with OpenGL or OpenGL ES. If the swap interval is greater than zero, the GPU driver waits the specified number of screen updates before swapping the buffers.

The specified window must have an OpenGL or OpenGL ES context. Specifying a window without a context will generate a GLFW_NO_WINDOW_CONTEXT error.

This function does not apply to Vulkan. If you are rendering with Vulkan, see vkQueuePresentKHR instead.

Parameters

  [in] | window | The window whose buffers to swap.

Errors
  Possible errors include GLFW_NOT_INITIALIZED, GLFW_NO_WINDOW_CONTEXT and GLFW_PLATFORM_ERROR.

Remarks
  Wayland: When the swap interval is greater than zero and the window is not in view, this function may take a few extra milliseconds to return.
  EGL: The context of the specified window must be current on the calling thread.

Thread safety
  This function may be called from any thread.

See also
  Buffer swapping
  glfwSwapInterval

Since
  Added in version 1.0. GLFW 3: Added window handle parameter.