glfw3

  1. glfw3
    1. Description
    2. Requirements
    3. Documentation
      1. High-level interface
      2. Callbacks
      3. Modified functions
    4. Example
    5. Version history
      1. Version 0.6.1
      2. Version 0.5.2
      3. Version 0.4.1
      4. Version 0.3.0
      5. Version 0.2.0
      6. Version 0.1.0
    6. Source repository
    7. Author
    8. Licence

Description

Bindings to the GLFW OpenGL window and event management library, version 3.X. Version 3 of GLFW is not backwards compatible with previous major versions of GLFW.

This egg has been tested and /should/ work with Linux, OS X, Windows, and OpenGL ES.

When using with ES, make sure GLFW is appropriately compiled (e.g.: cmake -DGLFW_USE_EGL=ON -DGLFW_CLIENT_LIBRARY=glesv2). If ES support is desired on a non-ARM platform, compile this egg with the feature gles (e.g.: chicken-install -D gles glfw3). Also, for ES, do not call make-window with client-api set, or else bad things.

Requirements

Documentation

glf3 is separated into two modules: glfw3-bindingw and glfw3. For almost all purposes, only glfw3 should be needed.

glfw3-bindings provides direct bindings to GLFW generated by bind. Names have been converted from camelCase to hyphenated, with GLFW prefixes removed. Constants are surrounded by +s (e.g. +alpha-bits+).

glfw3 is the high-level interface that should be used in most cases. At the moment it is largely re-exporting glfw3-bindings, although many of these functions could still use wrappers (patches welcome!). The not-exactly-the-same-as-the-glfw-api functions are described in the section High-level interface.

For information regarding the GLFW API, see the official GLFW documentation.

High-level interface

[procedure] (init)

Initializes glfw. Not needed when using with-window.

[parameter] window

Contains the window associated with the current context.

[procedure] (make-context-current WINDOW)

Performs glfwMakeContextCurrent while setting window.

[procedure] (make-window WIDTH HEIGHT NAME #!key (fullscreen? #f) (swap-interval 1) resizable visible decorated red-bits green-bits blue-bits alpha-bits depth-bits stencil-bits accum-red-bits accum-green-bits accum-blue-bits accum-alpha-bits aux-buffers samples refresh-rate sterio srgb-capable client-api context-version-major context-version-minor context-robustness opengl-forward-compat opengl-debug-context opengl-profile)

Create a window with title string NAME and dimensions WIDTH by HEIGHT. The keys correspond to the available GLFW window hints. resizable, visible, decorated, sterio, srgb-capable, opengl-forward-compat, opengl-debug-context accept boolean arguments, while all other accept either an integer or an appropriate GLFW constant as per the documentation.

Sets the current context to the window that was created. The swap interval of the window is set to the value of theswap-interval key. Finally, this initializes all of the window-specific callbacks.

When using with OS X, make sure you ask for the right context. Only OS X 10.7+ support core contexts, and only limited contexts are supported. See the GLFW FAQ. For instance:

   (make-window WIDTH HEIGHT NAME
                context-version-major: 3
                context-version-minor: 2
                opengl-forward-compat: #t
                opengl-profile: +opengl-core-profile+)
   
   
[syntax] (with-window (WIDTH HEIGHT NAME . KEYS) BODY ...)

Initializes GLFW, creates a window as per make-window, and runs BODY before cleaning up.

Callbacks

glfw3 provides parameters which contain the functions that are called from GLFW callbacks. The GLFW callbacks are initialized to call these parameters when init and make-window or with-window are used, but they can be changed with the callback setter functions.

[parameter] window-position-callback

Called when a window is moved. Expects a function with the signature (lambda (WINDOW X Y) ...). WINDOW is the window that was moved. X and Y are the coordinates of the upper-left corner of the window.

[parameter] window-size-callback

Called when a window is resized. Expects a function with the signature (lambda (WINDOW W H) ...). WINDOW is the window that was resized. W and H are the new dimensions of the window.

[parameter] window-close-callback

Called when a window is closed. Expects a function with the signature (lambda (WINDOW) ...). WINDOW is the window that was closed.

[parameter] window-focus-callback

Called when a window comes into or goes out of focus. Expects a function with the signature (lambda (WINDOW FOCUSED?) ...). WINDOW is the affected window, while FOCUSED? is true when the window has been focused and false otherwise.

[parameter] window-iconify-callback

Called when a window is iconified or restored. Expects a function with the signature (lambda (WINDOW ICONIFIED?) ...). WINDOW is the affected window, while ICONIFIED? is true when the window has been iconified and false otherwise.

[parameter] framebuffer-size-callback

Called when a framebuffer is resized. Expects a function with the signature (lambda (WINDOW W H) ...). WINDOW is the window whose framebuffer was resized. W and H are the new dimensions, in pixels, of the framebuffer.

[parameter] mouse-button-callback

Called when a mouse button is pressed or released. Expects a function with the signature (lambda (WINDOW BUTTON ACTION MODS) ...). WINDOW is the window where the button was pressed, BUTTON is the name of the mouse button (one of +mouse-button-1+ through +mouse-button-8+, +mouse-button-last+, +mouse-button-left+, +mouse-button-right+, +mouse-button-middle+), ACTION is one of +press+ or +release+, and MODS is a bit field describing the modifier keys that were held down (any of +mod-shift+, +mod-control+, +mod-alt+, or +mod-super+).

[parameter] cursor-enter-callback

Called when a cursor enters or leaves a window. Expects a function with the signature (lambda (WINDOW ENTERED?) ...). WINDOW is the affected window, and ENTERED? is true when the window was entered and false otherwise.

[parameter] cursor-position-callback

Called when a cursor moves. Expects a function with the signature (lambda (WINDOW X Y) ...). WINDOW is the affected window. X and Y is the new coordinates of the cursor.

[parameter] scroll-callback

Called when a scroll occurs. Expects a function with the signature (lambda (WINDOW X Y) ...). WINDOW is the affected window. X and Y are the scroll offsets.

[parameter] key-callback

Called when a key is pressed or released. Expects a function with the signature (lambda (WINDOW KEY SCANCODE ACTION MODS) ...). WINDOW is the window where the button was pressed, KEY is the name of the key, SCANCODE is the system-specific scancode of the key, ACTION is one of +press+, +release+ or +repeat+, and MODS is a bit field describing the modifier keys that were held down (any of +mod-shift+, +mod-control+, +mod-alt+, or +mod-super+).

[parameter] char-callback

Called when character is entered. Expects a function with the signature (lambda (WINDOW CHAR) ...). WINDOW is the affected window, and CHAR is the unicode code point of the character.

[parameter] monitor-callback

Called when a monitor is connected or disconnected. Expects a function with the signature (lambda (MONITOR EVENT) ...). MONITOR is a pointer to the affected monitor, EVENT is either +connected+ or +disconnected+.

[procedure] (set-window-position-callback! [WINDOW [CALLBACK]])
[procedure] (set-window-size-callback! [WINDOW [CALLBACK]])
[procedure] (set-window-close-callback! [WINDOW [CALLBACK]])
[procedure] (set-window-focus-callback! [WINDOW [CALLBACK]])
[procedure] (set-window-iconify-callback! [WINDOW [CALLBACK]])
[procedure] (set-framebuffer-size-callback! [WINDOW [CALLBACK]])
[procedure] (set-mouse-button-callback! [WINDOW [CALLBACK]])
[procedure] (set-cursor-enter-callback! [WINDOW [CALLBACK]])
[procedure] (set-cursor-position-callback! [WINDOW [CALLBACK]])
[procedure] (set-scroll-callback! [WINDOW [CALLBACK]])
[procedure] (set-key-callback! [WINDOW [CALLBACK]])
[procedure] (set-char-callback! [WINDOW [CALLBACK]])
[procedure] (set-monitor-callback! [WINDOW [CALLBACK]])

Set the callback functions associated with WINDOW. Used when the callback parameters are not desired. WINDOW defaults to window. CALLBACK defaults to an external function that calls the corresponding callback parameter.

Modified functions

The following functions take a different number of arguments than their GLFW counterparts. This is because the original function accepted values passed by reference for modification.

[procedure] (get-version)

Returns three values: the major version , minor version , and revision number of the GLFW library.

[procedure] (get-monitors)

Returns two values: A pointer to an array of GLFWmonitor references, and the number of values in the array.

[procedure] (get-monitor-position MONITOR)

Returns two values: the x and y position, in screen coordinates, of the upper-left corner of the MONITOR’s viewport on the virtual screen.

[procedure] (get-monitor-physical-size MONITOR)

Returns two values: the physical width and height, in millimetres, of the MONITOR.

[procedure] (get-video-modes MONITOR)

Returns two values: A pointer to an array of video modes, and the number of values in the array.

[procedure] (get-window-position WINDOW)

Returns two values: the x and y position, in screen coordinates, of the upper-left corner of the WINDOW.

[procedure] (set-window-position WINDOW X Y)

Set the position of the upper-left corner of the WINDOW.

[procedure] (get-window-size WINDOW)

Returns two values: the width and height, in screen coordinates, of the WINDOW.

[procedure] (get-framebuffer-size WINDOW)

Returns two values: the width and height, in pixels, of the framebuffer of WINDOW.

[procedure] (get-cursor-position WINDOW)

Returns two values: the x and y position of the cursor, relative to the upper-left edge of the client area of the WINDOW.

[procedure] (set-cursor-position WINDOW X Y)

Set the position of the cursor, relative to the upper-left edge of the client area of the WINDOW.

[procedure] (get-joystick-axes JOYSTICK)

Returns two values: a pointer to an array of floats representing the values of all axes of the specified joystick, and the number of values in the array.

[procedure] (get-joystick-buttons JOYSTICK)

Returns two values: a pointer to an array of bytes representing the state of all buttons on the specified joystick, and the number of values in the array.

Example

    
(use (prefix glfw3 glfw:))

(glfw:key-callback (lambda (window key scancode action mods)
                     (cond
                      [(and (eq? key glfw:+key-escape+) (eq? action glfw:+press+))
                       (glfw:set-window-should-close window #t)])))

(glfw:with-window (640 480 "Example" resizable: #f)
    (let loop ()
      (glfw:swap-buffers (glfw:window))
      (glfw:poll-events)
      (unless (glfw:window-should-close (glfw:window))
        (loop))))

Version history

Version 0.6.1

20 November 2014

Version 0.5.2

20 October 2014

Version 0.5.1

11 June 2014

Version 0.5.0

10 June 2014

Version 0.4.1

23 May 2014

Version 0.4.0

22 May 2014

Version 0.3.0

Version 0.2.0

Version 0.1.0

Source repository

Source available on GitHub.

Bug reports and patches welcome! Bugs can be reported via GitHub or to alex.n.charlton at gmail.

Author

Alex Charlton

Licence

BSD