The glfw Reference Manual

This is the glfw Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 05:26:19 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 glfw

An up-to-date bindings library to the most recent GLFW OpenGL context management library

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

https://shirakumo.github.io/glfw/

Source Control

(GIT https://github.com/shirakumo/glfw.git)

Bug Tracker

https://github.com/shirakumo/glfw/issues

License

zlib

Version

1.0.0

Dependencies
  • documentation-utils (system).
  • float-features (system).
  • cffi (system).
Source

glfw.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 glfw/glfw.asd

Source

glfw.asd.

Parent Component

glfw (system).

ASDF Systems

glfw.


3.1.2 glfw/package.lisp

Source

glfw.asd.

Parent Component

glfw (system).

Packages

3.1.3 glfw/low-level.lisp

Dependency

package.lisp (file).

Source

glfw.asd.

Parent Component

glfw (system).

Public Interface
Internals

3.1.4 glfw/wrapper.lisp

Dependency

low-level.lisp (file).

Source

glfw.asd.

Parent Component

glfw (system).

Public Interface
Internals

3.1.5 glfw/documentation.lisp

Dependency

wrapper.lisp (file).

Source

glfw.asd.

Parent Component

glfw (system).


4 Packages

Packages are listed by definition order.


4.1 org.shirakumo.fraf.glfw

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

4.2 org.shirakumo.fraf.glfw.cffi

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Macros

Macro: with-game-loop ((window dt &rest initargs) &body body)

Convenience macro to provide a basic single-threaded game loop.

This does the following:
1. Call INIT
2. Create a window instance with the given initargs as WINDOW
3. In a loop perform the following until SHOULD-CLOSE-P:
1. Call POLL-EVENTS to handle input events
2. Compute the time difference since the last iteration as DT 3. Evaluate BODY
4. Call SWAP-BUFFERS to display graphics
4. Call FINALIZE

This provides a standard variable frame rate game loop. You must use DT in all your physics steps, or manually slow down the thread to a fixed timestep. Please note that correctly implementing physics and graphics timestepping can be quite involved however, and this macro is only meant for simple tests. You’ll want to implement your own system based on it at some point.

See WINDOW (type)
See TIMESTAMP
See TIMESTAMP-RESOLUTION
See INIT
See FINALIZE
See POLL-EVENTS
See SWAP-BUFFERS
See SHOULD-CLOSE-P

Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.


5.1.2 Ordinary functions

Function: allocator-allocate (pointer-to-allocator)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: (setf allocator-allocate) (pointer-to-allocator)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: allocator-deallocate (pointer-to-allocator)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: (setf allocator-deallocate) (pointer-to-allocator)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: allocator-reallocate (pointer-to-allocator)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: (setf allocator-reallocate) (pointer-to-allocator)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: allocator-user (pointer-to-allocator)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: (setf allocator-user) (pointer-to-allocator)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: create-cursor (image xhot yhot)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: create-standard-cursor (shape)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: create-window (width height title monitor share)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: create-window-surface (instance window allocator surface)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: default-window-hints ()
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: destroy-cursor (cursor)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: destroy-window (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: error (code description)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: extension-supported (extension)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: focus-window (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: gamepad-state-axes (pointer-to-gamepad-state)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: (setf gamepad-state-axes) (pointer-to-gamepad-state)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: gamepad-state-buttons (pointer-to-gamepad-state)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: (setf gamepad-state-buttons) (pointer-to-gamepad-state)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: gamma-ramp-blue (pointer-to-gamma-ramp)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: (setf gamma-ramp-blue) (pointer-to-gamma-ramp)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: gamma-ramp-green (pointer-to-gamma-ramp)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: (setf gamma-ramp-green) (pointer-to-gamma-ramp)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: gamma-ramp-red (pointer-to-gamma-ramp)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: (setf gamma-ramp-red) (pointer-to-gamma-ramp)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: gamma-ramp-size (pointer-to-gamma-ramp)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: (setf gamma-ramp-size) (pointer-to-gamma-ramp)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-clipboard-string (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-cocoa-monitor (monitor)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-cocoa-window (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-current-context ()
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-cursor-pos (window xpos ypos)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-eglcontext (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-egldisplay ()
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-eglsurface (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-error (description)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-framebuffer-size (window width height)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-gamepad-name (jid)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-gamepad-state (jid state)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-gamma-ramp (monitor)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-glxcontext (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-glxwindow (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-input-mode (window mode)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-instance-proc-address (instance procname)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-joystick-axes (jid count)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-joystick-buttons (jid count)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-joystick-guid (jid)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-joystick-hats (jid count)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-joystick-name (jid)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-joystick-user-pointer (jid)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-key (window key)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-key-name (key scancode)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-key-scancode (key)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-monitor-content-scale (monitor xscale yscale)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-monitor-name (monitor)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-monitor-physical-size (monitor widthmm heightmm)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-monitor-pos (monitor xpos ypos)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-monitor-user-pointer (monitor)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-monitor-workarea (monitor xpos ypos width height)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-monitors (count)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-mouse-button (window button)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-nsglcontext (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-osmesa-color-buffer (window width height format buffer)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-osmesa-context (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-osmesa-depth-buffer (window width height bytespervalue buffer)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-physical-device-presentation-support (instance device queuefamily)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-platform ()
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-primary-monitor ()
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-proc-address (procname)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-required-instance-extensions (count)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-time ()
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-timer-frequency ()
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-timer-value ()
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-version (major minor rev)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-version-string ()
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-video-mode (monitor)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-video-modes (monitor count)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-wayland-display ()
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-wayland-monitor (monitor)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-wayland-window (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-wglcontext (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-win32-adapter (monitor)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-win32-monitor (monitor)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-win32-window (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-window-attrib (window attrib)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-window-content-scale (window xscale yscale)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-window-frame-size (window left top right bottom)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-window-monitor (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-window-opacity (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-window-pos (window xpos ypos)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-window-size (window width height)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-window-user-pointer (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-x11-adapter (monitor)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-x11-display ()
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-x11-monitor (monitor)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-x11-selection-string ()
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: get-x11-window (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: hide-window (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: iconify-window (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: image-height (pointer-to-image)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: (setf image-height) (pointer-to-image)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: image-pixels (pointer-to-image)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: (setf image-pixels) (pointer-to-image)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: image-width (pointer-to-image)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: (setf image-width) (pointer-to-image)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: init (&rest args &key platform joystick-hat-buttons angle-platform-type cocoa-chdir-resources cocoa-menubar x11-xcb-vulkan-surface)

Initialise the library.

This will load libglfw and initialize it. You may pass keyword arguments to control the library initialization. You can find more information on the initialization options and their effects in the GLFW documentation:

https://www.glfw.org/docs/latest/intro_guide.html#init_hints

It is safe to call this function multiple times. Once you are done with the library, you should call SHUTDOWN to clean things up.

Calling any other function in the library before INIT is called will lead to undefined behaviour.

See SHUTDOWN

Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Function: init ()
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: init-allocator (allocator)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: init-hint (hint value)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: init-vulkan-loader (loader)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: joystick-connected (id)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: joystick-disconnected (id)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: joystick-is-gamepad (jid)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: joystick-present (jid)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: list-monitors (&key refresh)

List all available monitors.

This returns a fresh list of available MONITOR instances.

If REFRESH is passed, the list of available monitors is refreshed directly. This is typically not necessary, as changes in the monitor listing are instead dynamically monitored and the value of LIST-MONITORS should always be accurate.

INIT must be called before this function returns anything useful.

See MONITOR (type)

Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Function: make-context-current (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: maximize-window (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: monitor-connected (ptr)
Package

org.shirakumo.fraf.glfw.cffi.

Source

wrapper.lisp.

Function: monitor-disconnected (ptr)
Package

org.shirakumo.fraf.glfw.cffi.

Source

wrapper.lisp.

Function: platform ()

Returns the currently used platform.

This may be one of:
:WIN32
:COCOA
:WAYLAND
:X11
:NULL-PLATFORM

Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Function: platform-supported (platform)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: poll-events (&key timeout)

Process new events synchronously.

Returns after processing events. This will cause event callbacks to be called in the same thread.

The TIMEOUT may be one of:
T — Blocks until *some* events have been processed
NIL — Returns immediately if there are no events to process REAL — Blocks until some events were processed or at most the given number of seconds have elapsed

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Function: poll-events ()
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: post-empty-event ()
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: primary-monitor ()

Returns the monitor that is configured as the "primary".

See MONITOR (type)

Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Function: raw-mouse-motion-supported ()
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: request-window-attention (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: resolve-window (ptr)
Package

org.shirakumo.fraf.glfw.cffi.

Source

wrapper.lisp.

Function: restore-window (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-char-callback (window callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-char-mods-callback (window callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-clipboard-string (window string)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-cursor (window cursor)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-cursor-enter-callback (window callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-cursor-pos (window xpos ypos)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-cursor-pos-callback (window callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-drop-callback (window callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-error-callback (callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-framebuffer-size-callback (window callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-gamma (monitor gamma)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-gamma-ramp (monitor ramp)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-input-mode (window mode value)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-joystick-callback (callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-joystick-user-pointer (jid pointer)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-key-callback (window callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-monitor-callback (callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-monitor-user-pointer (monitor pointer)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-mouse-button-callback (window callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-scroll-callback (window callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-time (time)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-window-aspect-ratio (window numer denom)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-window-attrib (window attrib value)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-window-close-callback (window callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-window-content-scale-callback (window callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-window-focus-callback (window callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-window-icon (window count images)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-window-iconify-callback (window callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-window-maximize-callback (window callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-window-monitor (window monitor xpos ypos width height refreshrate)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-window-opacity (window opacity)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-window-pos (window xpos ypos)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-window-pos-callback (window callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-window-refresh-callback (window callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-window-should-close (window value)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-window-size (window width height)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-window-size-callback (window callback)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-window-size-limits (window minwidth minheight maxwidth maxheight)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-window-title (window title)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-window-user-pointer (window pointer)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: set-x11-selection-string (string)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: show-window (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: shutdown ()

Shuts the library down.

This will clean up all the windows and other objects, and call GLFW’s terminate function.

It is safe to call this function multiple times.

Calling any other function in the library after SHUTDOWN is called and before INIT is called again will lead to undefined behaviour.

See INIT

Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Function: swap-buffers (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: swap-interval (interval)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: terminate ()
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: time ()

Accesses the current time in seconds as a double-float.

If this was not explicitly set, the time is measured since INIT has been called.

Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Function: (setf time) ()
Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Function: timestamp ()

Returns a monotonically increasing timestamp.

See TIMESTAMP-RESOLUTION

Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Function: timestamp-resolution ()

Returns the resolution of the timestamp in units/second.

See TIMESTAMP

Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Function: update-gamepad-mappings (string)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: version ()

Returns the version of the GLFW library.

This is a list of (MAJOR MINOR REVISION)

Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Function: video-mode-blue-bits (pointer-to-video-mode)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: (setf video-mode-blue-bits) (pointer-to-video-mode)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: video-mode-green-bits (pointer-to-video-mode)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: (setf video-mode-green-bits) (pointer-to-video-mode)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: video-mode-height (pointer-to-video-mode)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: (setf video-mode-height) (pointer-to-video-mode)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: video-mode-red-bits (pointer-to-video-mode)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: (setf video-mode-red-bits) (pointer-to-video-mode)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: video-mode-refresh-rate (pointer-to-video-mode)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: (setf video-mode-refresh-rate) (pointer-to-video-mode)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: video-mode-width (pointer-to-video-mode)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: (setf video-mode-width) (pointer-to-video-mode)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: vulkan-supported ()
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: wait-events ()
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: wait-events-timeout (timeout)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: window-hint (hint value)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: window-hint-string (hint value)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Function: window-should-close (window)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.


5.1.3 Generic functions

Generic Function: allocate (size window)

Allocate a block of memory.

This callback is only used if the window is initialised as an allocator.

Should return pointer to the allocated block if successful, or a null pointer if not.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Methods
Method: allocate (size (window window))
Source

wrapper.lisp.

Generic Reader: aspect-ratio (object)

Accesses the forced aspect ratio of the window.

If NIL, no aspect ratio is enforced.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Reader Method: aspect-ratio ((window window))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

aspect-ratio.

Generic Function: (setf aspect-ratio) (object)
Package

org.shirakumo.fraf.glfw.

Methods
Writer Method: (setf aspect-ratio) :before ((window window))
Source

wrapper.lisp.

Target Slot

aspect-ratio.

Method: (setf aspect-ratio) :before ((window window))
Source

wrapper.lisp.

Method: (setf aspect-ratio) ((window window))

automatically generated writer method

Source

wrapper.lisp.

Generic Function: attribute (attribute window)

Access an attribute of the window.

The attribute may be one of:

:DECORATED — Whether the window has a border :RESIZABLE — Whether the window is resizable :FLOATING — Whether the window should be "always on top" :AUTO-ICONIFY — Whether the window should iconify on focus loss
:FOCUS-ON-SHOW — Whether to request focus when the window is made visible.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: attribute (attribute (window window))
Source

wrapper.lisp.

Generic Function: (setf attribute) (attribute window)
Package

org.shirakumo.fraf.glfw.

Methods
Method: (setf attribute) (attribute (window window))
Source

wrapper.lisp.

Generic Function: center (window &optional monitor)

Centers the window on the given monitor.

If no monitor is passed, the window’s current monitor is used.

See WINDOW (type)
See MONITOR (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: center ((window window) &optional monitor)
Source

wrapper.lisp.

Generic Function: char-entered (window code-point)

Callback for when text has been entered.

The CODE-POINT is the unicode code point of the character that has been entered. You may convert it to a CHARACTER via CL:CODE-CHAR.

The MODIFIERS is a list of active modifier keys at the time, which may include:

:SHIFT
:CONTROL
:ALT
:SUPER
:CAPS-LOCK
:NUM-LOCK

Users may implement a primary method on this function to react to the event.

See CL:CODE-CHAR
See WINDOW (type)

Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Methods
Method: char-entered ((window window) code-point)
Source

wrapper.lisp.

Generic Function: clipboard-string (window)

Accesses the current clipboard contents.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: clipboard-string ((window window))
Source

wrapper.lisp.

Generic Function: (setf clipboard-string) (window)
Package

org.shirakumo.fraf.glfw.

Methods
Method: (setf clipboard-string) ((window window))
Source

wrapper.lisp.

Generic Reader: code (condition)

Returns the error code that was returned.

See GLFW-ERROR

Package

org.shirakumo.fraf.glfw.

Methods
Reader Method: code ((condition glfw-error))
Source

wrapper.lisp.

Target Slot

code.

Generic Function: content-scale (monitor)

Returns the window’s content scaling factor.

This is a list of (X Y).

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: content-scale ((window window))
Source

wrapper.lisp.

Method: content-scale ((monitor monitor))
Source

wrapper.lisp.

Generic Function: cursor (window)

Accesses the cursor of the window

You may also call this function with a keyword to retrieve one of several standard cursor shapes, or directly set a keyword to set one of those shapes.

See WINDOW (type)
See CURSOR (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: cursor ((window window))
Source

wrapper.lisp.

Generic Function: (setf cursor) (window)
Package

org.shirakumo.fraf.glfw.

Methods
Method: (setf cursor) ((window window))
Source

wrapper.lisp.

Method: (setf cursor) ((window window))
Source

wrapper.lisp.

Generic Function: cursor-location (window)

Accesses the current location of the mouse cursor.

This is a list of (X Y).

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: cursor-location ((window window))
Source

wrapper.lisp.

Generic Function: (setf cursor-location) (window)
Package

org.shirakumo.fraf.glfw.

Methods
Method: (setf cursor-location) ((window window))
Source

wrapper.lisp.

Generic Function: deallocate (ptr size window)

Free a block of memory.

This callback is only used if the window is initialised as an allocator.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Methods
Method: deallocate (ptr size (window window))
Source

wrapper.lisp.

Generic Function: destroy (foreign-object)

Finalize and clean up the object.

After this function has been called, the POINTER will be NIL.
It is safe to call this function multiple times.

Using the object in any other way after DESTROY has been called on it will lead to undefined behaviour.

See POINTER
See FOREIGN-OBJECT (type)

Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Methods
Method: destroy ((window window))
Method: destroy ((monitor monitor))
Method: destroy ((cursor standard-cursor))
Method: destroy ((cursor cursor))
Generic Function: file-dropped (window paths)

Callback for when one or more files have been dropped onto the window.

PATHS is a list of the dropped files’ paths as strings, typically in the format of a native namestring.

Users may implement a primary method on this function to react to the event.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Methods
Method: file-dropped ((window window) paths)
Source

wrapper.lisp.

Generic Function: focus (window)

Request the window to gain focus.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: focus ((window window))
Source

wrapper.lisp.

Generic Function: frame-size (window)

Returns the window’s frame size including decorations.

This is a list of (LEFT TOP RIGHT BOTTOM)

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: frame-size ((window window))
Source

wrapper.lisp.

Generic Function: framebuffer-resized (window width height)

Callback for when the underlying framebuffer has been resized.

Users may implement a primary method on this function to react to the event.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Methods
Method: framebuffer-resized ((window window) width height)
Source

wrapper.lisp.

Generic Function: framebuffer-size (window)

Returns the window’s backing framebuffer resolution.

This is a list of (W H).

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: framebuffer-size ((window window))
Source

wrapper.lisp.

Generic Function: gamma (monitor)

Accesses the gamma of the monitor.

Note that this is in addition to any operating system gamma ramping. This function is a simplified version of the more detailed GAMMA-RAMP function. The returned GAMMA is estimated based on the ramp’s midpoint.

See GAMMA-RAMP
See MONITOR (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: gamma ((monitor monitor))
Source

wrapper.lisp.

Generic Function: (setf gamma) (monitor)
Package

org.shirakumo.fraf.glfw.

Methods
Method: (setf gamma) ((monitor monitor))
Source

wrapper.lisp.

Generic Function: gamma-ramp (monitor)

Accesses the gamma ramp of the monitor.

Note that this is in addition to any operating system gamma ramping. The value must be a plist composed of the following entries:

:RED
:GREEN
:BLUE

Each entry must be a (vector (unsigned-byte 16)) of the same length. Which length is acceptable and whether the ramp can be set depends on the operating system. A safe length is 256 entries.

See GAMMA
See MONITOR (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: gamma-ramp ((monitor monitor))
Source

wrapper.lisp.

Generic Function: (setf gamma-ramp) (monitor)
Package

org.shirakumo.fraf.glfw.

Methods
Method: (setf gamma-ramp) ((monitor monitor))
Source

wrapper.lisp.

Generic Function: get-current ()

Retrieves the current window of the calling thread, if any.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: get-current ()
Source

wrapper.lisp.

Generic Function: height (monitor)

Accesses the height of the window or monitor in pixels.

See SIZE
See MONITOR (type)
See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Reader Method: height ((window window))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

height.

Method: height ((monitor monitor))
Source

wrapper.lisp.

Generic Function: (setf height) (window)
Package

org.shirakumo.fraf.glfw.

Methods
Method: (setf height) ((window window))
Source

wrapper.lisp.

Generic Function: hide (window)

Request to make the window invisible.

see SHOW
See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: hide ((window window))
Source

wrapper.lisp.

Generic Reader: icon (object)

Access the icons of the application.

Should be a list of images, where each icon image is a list of the format (PIXELS WIDTH HEIGHT), and where pixels is a
(simple-array (unsigned-byte 8) (*)) with the length (* width height 4) holding the RGBA encoded pixel data of the icon, top-left aligned.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Reader Method: icon ((window window))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

icon.

Generic Function: (setf icon) (object)
Package

org.shirakumo.fraf.glfw.

Methods
Writer Method: (setf icon) :before ((window window))
Source

wrapper.lisp.

Target Slot

icon.

Method: (setf icon) ((window window))

automatically generated writer method

Source

wrapper.lisp.

Generic Function: iconified-p (window)

Accesses whether the window is iconified.

See ICONIFY
See RESTORE
See STATE
See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: iconified-p ((window window))
Source

wrapper.lisp.

Generic Function: (setf iconified-p) (window)
Package

org.shirakumo.fraf.glfw.

Methods
Method: (setf iconified-p) ((window window))
Source

wrapper.lisp.

Generic Function: iconify (window)

Request the window to be iconified.

See RESTORE
See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: iconify ((window window))
Source

wrapper.lisp.

Generic Function: input-mode (mode window)

Access the state of an input mode of the window.

The mode may be one of:

:CURSOR — Set the cursor state:
:cursor-normal — Show the cursor and unlock it. :cursor-disabled — Hide the cursor and lock it into the window. :cursor-hidden — Just make the cursor invisible. :STICKY-KEYS — Whether a key’s press state should be retained until KEY-STATE is called for that key. :STICKY-MOUSE-BUTTONS
— Whether a button’s press state should be retained until MOUSE-BUTTON-STATE is called for that button.
:LOCK-KEY-MODS — This will enable tracking caps lock and num lock for the modifier key sets. :RAW-MOUSE-MOTION — Whether to supply the window with mouse motion data that’s closer to the driver, unaffected by desktop cursor smoothing and so on.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: input-mode (mode (window window))
Source

wrapper.lisp.

Generic Function: (setf input-mode) (mode window)
Package

org.shirakumo.fraf.glfw.

Methods
Method: (setf input-mode) (mode (window window))
Source

wrapper.lisp.

Generic Function: key-changed (window key scan-code action modifiers)

Callback for when a keyboard keys’s state has changed.

The ACTION may be one of:

:PRESS
:RELEASE
:REPEAT

The MODIFIERS is a list of active modifier keys at the time, which may include:

:SHIFT
:CONTROL
:ALT
:SUPER
:CAPS-LOCK
:NUM-LOCK

Users may implement a primary method on this function to react to the event.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Methods
Method: key-changed ((window window) key scan-code action modifiers)
Source

wrapper.lisp.

Generic Function: key-state (key window)

Returns the current state of the requested key.

May be one of:
:RELEASE
:PRESS
:REPEAT

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: key-state (key (window window))
Source

wrapper.lisp.

Generic Function: location (monitor)

Accesess the window’s location on screen.

This is a list of (X Y).

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: location ((window window))
Source

wrapper.lisp.

Method: location ((monitor monitor))
Source

wrapper.lisp.

Generic Function: (setf location) (window)
Package

org.shirakumo.fraf.glfw.

Methods
Method: (setf location) ((window window))
Source

wrapper.lisp.

Generic Function: make-current (window)

Makes the context current in the calling thread.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: make-current ((null null))
Source

wrapper.lisp.

Method: make-current ((window window))
Source

wrapper.lisp.

Generic Function: maximize (window)

Request to maximize the window.

See RESTORE
See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: maximize ((window window))
Source

wrapper.lisp.

Generic Function: maximized-p (window)

Accesses whether the window is maximized.

See MAXIMIZE
See RESTORE
See STATE
See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: maximized-p ((window window))
Source

wrapper.lisp.

Generic Function: (setf maximized-p) (window)
Package

org.shirakumo.fraf.glfw.

Methods
Method: (setf maximized-p) ((window window))
Source

wrapper.lisp.

Generic Reader: message (condition)

Returns the error message that was returned.

See GLFW-ERROR

Package

org.shirakumo.fraf.glfw.

Methods
Reader Method: message ((condition glfw-error))
Source

wrapper.lisp.

Target Slot

message.

Generic Function: monitor (window)

Access the current monitor the window resides on.

When a monitor is set, the monitor’s current video mode is retained and the window is instead fullscreened to that monitor’s resolution. If you need to set the video mode of the monitor as well, you must supply a list as the value fitting this lambda-list:

(MONITOR &key WIDTH HEIGHT X Y REFRESH-RATE)

WIDTH, HEIGHT, and REFRESH-RATE default to the values of the monitor’s current video mode. X and Y default to 0.

MONITOR may also be T in which case the primary monitor is used.

See MONITOR (type)
See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: monitor ((window window))
Source

wrapper.lisp.

Generic Function: (setf monitor) (window)
Package

org.shirakumo.fraf.glfw.

Methods
Method: (setf monitor) ((window window))
Source

wrapper.lisp.

Method: (setf monitor) ((window window))
Source

wrapper.lisp.

Method: (setf monitor) ((window window))
Source

wrapper.lisp.

Method: (setf monitor) ((window window))
Source

wrapper.lisp.

Generic Function: mouse-button-changed (window button action modifiers)

Callback for when a mouse button’s state has changed.

The ACTION may be one of:

:PRESS
:RELEASE

The MODIFIERS is a list of active modifier keys at the time, which may include:

:SHIFT
:CONTROL
:ALT
:SUPER
:CAPS-LOCK
:NUM-LOCK

Users may implement a primary method on this function to react to the event.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Methods
Method: mouse-button-changed ((window window) button action modifiers)
Source

wrapper.lisp.

Generic Function: mouse-button-state (button window)

Returns the current state of the requested mouse button.

May be one of:
:RELEASE
:PRESS

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: mouse-button-state (button (window window))
Source

wrapper.lisp.

Generic Function: mouse-entered (window entered)

Callback for when the cursor has entered or left the window.

Users may implement a primary method on this function to react to the event.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Methods
Method: mouse-entered ((window window) entered)
Source

wrapper.lisp.

Generic Function: mouse-moved (window xpos ypos)

Callback for when the mouse cursor has been moved.

Users may implement a primary method on this function to react to the event.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Methods
Method: mouse-moved ((window window) xpos ypos)
Source

wrapper.lisp.

Generic Function: mouse-scrolled (window xoffset yoffset)

Callback for when the mouse wheel has scrolled.

Users may implement a primary method on this function to react to the event.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Methods
Method: mouse-scrolled ((window window) xoffset yoffset)
Source

wrapper.lisp.

Generic Function: name (object)

Returns a human-readable description of the monitor.

See MONITOR (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: name ((monitor monitor))
Source

wrapper.lisp.

Reader Method: name ((standard-cursor standard-cursor))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

name.

Generic Function: opacity (window)

Accesses the window’s opacity factor.

This should be a float in the range [0,1].

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: opacity ((window window))
Source

wrapper.lisp.

Generic Function: (setf opacity) (window)
Package

org.shirakumo.fraf.glfw.

Methods
Method: (setf opacity) ((window window))
Source

wrapper.lisp.

Generic Reader: operation (condition)

Returns the operation that failed to execute.

See GLFW-ERROR

Package

org.shirakumo.fraf.glfw.

Methods
Reader Method: operation ((condition glfw-error))
Source

wrapper.lisp.

Target Slot

operation.

Generic Function: physical-size (monitor)

Returns the physical size of the monitor in mm.

This is a LIST of (W H).

See MONITOR (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: physical-size ((monitor monitor))
Source

wrapper.lisp.

Generic Reader: pointer (object)

Accesses the pointer that ties the object to the foreign resource.

This may be NIL if the object has been destroyed.

See DESTROY
See FOREIGN-OBJECT (type)

Package

org.shirakumo.fraf.glfw.

Methods
Reader Method: pointer ((foreign-object foreign-object))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

pointer.

Generic Writer: (setf pointer) (object)
Package

org.shirakumo.fraf.glfw.

Methods
Writer Method: (setf pointer) ((foreign-object foreign-object))

automatically generated writer method

Source

wrapper.lisp.

Target Slot

pointer.

Generic Function: reallocate (ptr size window)

Resize a block of memory.

This callback is only used if the window is initialised as an allocator.

Should return pointer to the allocated block if successful, or a null pointer if not.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Methods
Method: reallocate (ptr size (window window))
Source

wrapper.lisp.

Generic Function: refresh-rate (monitor)

Returns the current refresh rate of the monitor.

See VIDEO-MODE
See MONITOR (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: refresh-rate ((monitor monitor))
Source

wrapper.lisp.

Generic Function: register-callbacks (window)

This function is used to register all of the GLFW callback functions.

If for some reason you need to override a callback, you should define a method on this function to do so.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: register-callbacks ((window window))
Source

wrapper.lisp.

Generic Function: request-attention (window)

Request attention for the window.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: request-attention ((window window))
Source

wrapper.lisp.

Generic Function: restore (window)

Request to restore the window.

See ICONIFY
See MAXIMIZE
See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: restore ((window window))
Source

wrapper.lisp.

Generic Function: should-close-p (window)

Accesses whether the window should be closed and destroyed.

This flag by itself does nothing. You should read it out in your event loop and depending on it and possibly other factors, decide to close and DESTROY the window, or do whatever else is considered appropriate at the time.

See DESTROY
See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: should-close-p ((window window))
Source

wrapper.lisp.

Generic Function: (setf should-close-p) (window)
Package

org.shirakumo.fraf.glfw.

Methods
Method: (setf should-close-p) ((window window))
Source

wrapper.lisp.

Generic Function: show (window)

Request to make the window visible.

See HIDE
See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: show ((window window))
Source

wrapper.lisp.

Generic Function: size (monitor)

Accesses the window or monitor’s size on screen.

This is a list of (W H).

See WIDTH
See HEIGHT
See MONITOR (type)
See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: size ((window window))
Source

wrapper.lisp.

Method: size ((monitor monitor))
Source

wrapper.lisp.

Generic Function: (setf size) (window)
Package

org.shirakumo.fraf.glfw.

Methods
Method: (setf size) ((window window))
Source

wrapper.lisp.

Generic Reader: size-limits (object)

Accesses the size limits of the window.

This should be a list of four elements:

MIN-WIDTH
MIN-HEIGHT
MAX-WIDTH
MAX-HEIGHT

If any element is NIL, it is considered to have no limit.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Reader Method: size-limits ((window window))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

size-limits.

Generic Function: (setf size-limits) (object)
Package

org.shirakumo.fraf.glfw.

Methods
Writer Method: (setf size-limits) :before ((window window))
Source

wrapper.lisp.

Target Slot

size-limits.

Method: (setf size-limits) ((window window))

automatically generated writer method

Source

wrapper.lisp.

Generic Function: state (window)

Accesses the current state of the window.

The state may be one of the following:

:ICONIFIED
:HIDDEN
:MAXIMIZED
:FULLSCREEN
:NORMAL

See ICONIFIED-P
See MAXIMIZED-P
See VISIBLE-P
See MONITOR
See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: state ((window window))
Source

wrapper.lisp.

Generic Function: (setf state) (window)
Package

org.shirakumo.fraf.glfw.

Methods
Method: (setf state) ((window window))
Source

wrapper.lisp.

Generic Function: swap-buffers (window)

Swaps the back buffers to make the drawn content visible.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: swap-buffers ((window window))
Source

wrapper.lisp.

Generic Reader: swap-interval (object)

Accesses the swap synchronisation interval.

A value of 1 is typically called "vsync".
May be negative on some drivers, which allows "adaptive vsync".

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Reader Method: swap-interval ((window window))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

swap-interval.

Generic Function: (setf swap-interval) (object)
Package

org.shirakumo.fraf.glfw.

Methods
Writer Method: (setf swap-interval) :before ((window window))
Source

wrapper.lisp.

Target Slot

swap-interval.

Method: (setf swap-interval) ((window window))

automatically generated writer method

Source

wrapper.lisp.

Generic Reader: title (object)

Accesses the window title.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Reader Method: title ((window window))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

title.

Generic Function: (setf title) (object)
Package

org.shirakumo.fraf.glfw.

Methods
Writer Method: (setf title) :before ((window window))
Source

wrapper.lisp.

Target Slot

title.

Method: (setf title) ((window window))

automatically generated writer method

Source

wrapper.lisp.

Generic Function: video-mode (monitor)

Returns the current video-mode of the monitor.

See VIDEO-MODES
See MONITOR (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: video-mode ((monitor monitor))
Source

wrapper.lisp.

Generic Reader: video-modes (object)

Returns a list of available video modes for the monitor.

Each video mode is a list list with the following elements:

WIDTH — The width in pixels
HEIGHT — The height in pixels
REFRESH-RATE — The refresh rate in Hertz
RED-BITS — The bit-depth of the red channel (usually 8) GREEN-BITS — The bit-depth of the green channel (usually 8) BLUE-BITS — The bit-depth of the blue channel (usually 8)

See MONITOR (type)

Package

org.shirakumo.fraf.glfw.

Methods
Reader Method: video-modes ((monitor monitor))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

video-modes.

Generic Function: visible-p (window)

Accesses whether the window is visible.

Note that an iconified window may also be treated as invisible.

See SHOW
See HIDE
See STATE
See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: visible-p ((window window))
Source

wrapper.lisp.

Generic Function: (setf visible-p) (window)
Package

org.shirakumo.fraf.glfw.

Methods
Method: (setf visible-p) ((window window))
Source

wrapper.lisp.

Generic Function: width (monitor)

Accesses the width of the window or monitor in pixels.

See SIZE
See MONITOR (type)
See WINDOW (type)

Package

org.shirakumo.fraf.glfw.

Methods
Reader Method: width ((window window))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

width.

Method: width ((monitor monitor))
Source

wrapper.lisp.

Generic Function: (setf width) (window)
Package

org.shirakumo.fraf.glfw.

Methods
Method: (setf width) ((window window))
Source

wrapper.lisp.

Generic Function: window-closed (window)

Callback for when the user requested the window to close.

Users may implement a primary method on this function to react to the event. The default primary method sets the SHOULD-CLOSE-P flag to T.

See SHOULD-CLOSE-P
See WINDOW (type)

Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Methods
Method: window-closed ((window window))
Source

wrapper.lisp.

Generic Function: window-content-scale-changed (window xscale yscale)

Callback for when the window’s DPI scaling factor has changed.

Users may implement a primary method on this function to react to the event.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Methods
Method: window-content-scale-changed ((window window) xscale yscale)
Source

wrapper.lisp.

Generic Function: window-focused (window focused)

Callback for when the window has changed focus.

Users may implement a primary method on this function to react to the event.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Methods
Method: window-focused ((window window) focused)
Source

wrapper.lisp.

Generic Function: window-iconified (window iconified)

Callback for when the window has changed iconified status.

Users may implement a primary method on this function to react to the event.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Methods
Method: window-iconified ((window window) iconified)
Source

wrapper.lisp.

Generic Function: window-maximized (window maximized)

Callback for when the window has changed maximized status.

Users may implement a primary method on this function to react to the event.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Methods
Method: window-maximized ((window window) maximized)
Source

wrapper.lisp.

Generic Function: window-moved (window xpos ypos)

Callback for when the window has been moved.

Users may implement a primary method on this function to react to the event.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Methods
Method: window-moved ((window window) xpos ypos)
Source

wrapper.lisp.

Generic Function: window-refreshed (window)

Callback for when the system has requested the window contents be refreshed.

Users may implement a primary method on this function to react to the event.

See WINDOW (type)

Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Methods
Method: window-refreshed ((window window))
Source

wrapper.lisp.

Generic Function: window-resized (window width height)

Callback for when the window has been resized.

Users may implement a primary method on this function to react to the event.

See FRAMEBUFFER-RESIZED
See WINDOW (type)

Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Methods
Method: window-resized ((window window) width height)
Source

wrapper.lisp.

Method: window-resized :before ((window window) width height)
Source

wrapper.lisp.

Generic Function: work-area (monitor)

Returns the work area of the monitor.

This is a LIST of (X Y W H).

See MONITOR (type)

Package

org.shirakumo.fraf.glfw.

Methods
Method: work-area ((monitor monitor))
Source

wrapper.lisp.


5.1.4 Standalone methods

Method: initialize-instance :after ((cursor cursor) &key pixels width height xhot yhot)
Source

wrapper.lisp.

Method: initialize-instance :after ((monitor monitor) &key)
Source

wrapper.lisp.

Method: initialize-instance :around ((window window) &rest args &key initialize-context &allow-other-keys)
Source

wrapper.lisp.

Method: initialize-instance :after ((cursor standard-cursor) &key)
Source

wrapper.lisp.

Method: print-object ((monitor monitor) stream)
Source

wrapper.lisp.

Method: print-object ((object foreign-object) stream)
Source

wrapper.lisp.

Method: print-object ((window window) stream)
Source

wrapper.lisp.

Method: print-object ((cursor standard-cursor) stream)
Source

wrapper.lisp.

Method: shared-initialize :after ((window window) slots &rest args &key initialize-context monitor share resizable visible decorated focused auto-iconify floating maximized center-cursor transparent-framebuffer focus-on-show scale-to-monitor mouse-passthrough 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 stereo samples srgb-capable doublebuffer refresh-rate client-api context-creation-api context-version-major context-version-minor opengl-forward-compat context-debug opengl-profile context-robustness context-release-behavior context-no-error win32-keyboard-menu cocoa-retina-framebuffer cocoa-frame-name cocoa-graphics-switching x11-class-name x11-instance-name wayland-app-id allow-other-keys)
Source

wrapper.lisp.


5.1.5 Conditions

Condition: glfw-error

Error signalled when GLFW fails to execute an operation.

See OPERATION
See CODE
See MESSAGE

Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: operation
Initform

(quote nil)

Initargs

:operation

Readers

operation.

Writers

This slot is read-only.

Slot: code
Initform

(quote nil)

Initargs

:code

Readers

code.

Writers

This slot is read-only.

Slot: message
Initform

(quote nil)

Initargs

:message

Readers

message.

Writers

This slot is read-only.


5.1.6 Classes

Class: cursor

Representation of a cursor.

When constructing a pointer, you should pass PIXELS, WIDTH, HEIGHT, and optionally XHOT and YHOT. WIDTH and HEIGHT should be the size of the image in PIXELS, and PIXELS should be a
(simple-array (unsigned-byte 8) (*)) with the size (* width height 4) this is the RGBA encoded pixel data of the cursor, top-left aligned.

See FOREIGN-OBJECT (type)
See CURSOR

Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Direct superclasses

foreign-object.

Direct subclasses

standard-cursor.

Direct methods
Class: foreign-object

Base class for all objects wrapping a foreign GLFW object.

Usually a foreign-object can be allocated simply by calling MAKE-INSTANCE, which will construct the GLFW object as well.

See POINTER
See DESTROY

Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: pointer
Initargs

:pointer

Readers

pointer.

Writers

(setf pointer).

Class: monitor

Representation of a display monitor.

You should not directly create instances of this class. Instead use LIST-MONITORS, PRIMARY-MONITOR, and MONITOR to access existing ones.

See FOREIGN-OBJECT (type)
See VIDEO-MODES
See LIST-MONITORS
See PRIMARY-MONITOR
See LOCATION
See WORK-AREA
See PHYSICAL-SIZE
See CONTENT-SCALE
See NAME
See VIDEO-MODE
See SIZE
See WIDTH
See HEIGHT
See REFRESH-RATE
See GAMMA
See GAMMA-RAMP
See MONITOR

Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Direct superclasses

foreign-object.

Direct methods
Direct slots
Slot: video-modes
Readers

video-modes.

Writers

This slot is read-only.

Class: window

Representation of a window and its context.

The properties of the window and the context are configured via initargs:

:RESIZABLE — Whether the user can resize the window :VISIBLE — Whether the window starts visible :DECORATED — Whether the window has borders
:FOCUSED — Whether the window starts focused :AUTO-ICONIFY — Whether the window should iconify on focus loss
:FLOATING — Whether the window should be "always on top" :MAXIMIZED — Whether the window starts maximized :CENTER-CURSOR — Whether to center the mouse cursor :TRANSPARENT-FRAMEBUFFER
— Whether the framebuffer is transparent :FOCUS-ON-SHOW — Whether to request focus when the window is made visible
:SCALE-TO-MONITOR — Whether to resize the window area based on DPI scaling factors of the monitor :MOUSE-PASSTHROUGH —
:RED-BITS :GREEN-BITS :BLUE-BITS :ALPHA-BITS :DEPTH-BITS :STENCIL-BITS — The bit depth of the back buffer :ACCUM-RED-BITS :ACCUM-GREEN-BITS :ACCUM-BLUE-BITS :ACCUM-ALPHA-BITS — The bit depth of the accumulation buffer :AUX-BUFFERS — The desired number of auxiliary buffers :STEREO — Whether to enable stereo rendering
:SAMPLES — The MSAA value to use for the back buffer :SRGB-CAPABLE — Whether the back buffer is srgb scaled :DOUBLEBUFFER — Whether to double-buffer the back buffer :REFRESH-RATE — The intended refresh rate to use :CLIENT-API — Which OpenGL API to use. May be one of: :no-api
:opengl-api
:opengl-es-api
:CONTEXT-CREATION-API
— Which API to use to create the context: :native-context-api
:egl-context-api
:osmesa-context-api
:CONTEXT-VERSION-MAJOR :CONTEXT-VERSION-MINOR
— The version of the context to request :OPENGL-FORWARD-COMPAT
— Whether the context should be forward-compatible.
:CONTEXT-DEBUG — Whether to enable context debugging info :OPENGL-PROFILE — The profile of the context to request: :opengl-any-profile
:opengl-core-profile
:opengl-compat-profile
:CONTEXT-ROBUSTNESS— The robustness strategy of the context: :no-robustness
:no-reset-notification
:lose-context-on-reset
:CONTEXT-RELEASE-BEHAVIOR
— The release behaviour of the context: :any-release-behavior
:release-behavior-flush
:release-behavior-none
:CONTEXT-NO-ERROR — Whether to generate errors on failures :COCOA-RETINA-FRAMEBUFFER
— Whether to use full-resolution framebuffers on retina displays
:COCOA-FRAME-NAME — The frame name to use for Cocoa :COCOA-GRAPHICS-SWITCHING
— Whether to allow Cocoa to move the context between different GPUs.
:X11-CLASS-NAME — The window class name to use for X11 :X11-INSTANCE-NAME — The window instance name to use for X11 :WAYLAND-APP-ID — The App ID to pass to Wayland

You can find more information on the available initialisation flags and their effects can be found in the GLFW documentation:

https://www.glfw.org/docs/latest/window_guide.html#window_hints

In addition to the window hints described, the following initargs may be passed:

:WIDTH — The initial width of the window. Defaults to 800 :HEIGHT — The initial height of the window. Defaults to 600 :TITLE — The title of the window. Defaults to "GLFW"
:MONITOR — The monitor on which to full-screen the window
:SHARE — The context to share with

If you pass the initarg :INITIALIZE-CONTEXT NIL, then the window is not initialized, and instead a dead window object is created. You must then later call REINITIALIZE-INSTANCE with :INITIALIZE-CONTEXT T before the window can be used.

In order to react to events sent to the window, you should create a subclass and implement methods on the following functions. By default the corresponding events are simply discarded.

WINDOW-RESIZED — When the window size has been changed WINDOW-CLOSED — When a close is requested
WINDOW-MOVED — When the window was moved
WINDOW-REFRESHED — When a refresh of the window is requested WINDOW-FOCUSED — When the window changes focus WINDOW-ICONIFIED — When the window’s icon status changes WINDOW-MAXIMIZED — When the window’s maximization status changes FRAMEBUFFER-RESIZED
— When the back framebuffer’s size changed WINDOW-CONTENT-SCALE-CHANGED
— When the window’s DPI scaling factors changed MOUSE-BUTTON-CHANGED
— When a mouse button’s active state changed MOUSE-MOVED — When the mouse has been moved
MOUSE-ENTERED — When the mouse has entered or left the window MOUSE-SCROLLED — When the mouse scrolled
KEY-CHANGED — When a keyboard key’s active state changed CHAR-ENTERED — When a text entry is made
FILE-DROPPED — When one or more files are dropped onto the window

See FOREIGN-OBJECT (type)
See REGISTER-CALLBACKS
See ALLOCATE
See REALLOCATE
See DEALLOCATE
See WINDOW-RESIZED
See WINDOW-CLOSED
See WINDOW-MOVED
See WINDOW-REFRESHED
See WINDOW-FOCUSED
See WINDOW-ICONIFIED
See WINDOW-MAXIMIZED
See FRAMEBUFFER-RESIZED
See WINDOW-CONTENT-SCALE-CHANGED
See MOUSE-BUTTON-CHANGED
See MOUSE-MOVED
See MOUSE-ENTERED
See MOUSE-SCROLLED
See KEY-CHANGED
See CHAR-ENTERED
See FILE-DROPPED
See SHOULD-CLOSE-P
See TITLE
See LOCATION
See SIZE
See WIDTH
See HEIGHT
See SIZE-LIMITS
See ASPECT-RATIO
See FRAMEBUFFER-SIZE
See FRAME-SIZE
See CONTENT-SCALE
See OPACITY
See ICONIFIED-P
See MAXIMIZED-P
See VISIBLE-P
See STATE
See ICONIFY
See RESTORE
See MAXIMIZE
See SHOW
See HIDE
See FOCUS
See REQUEST-ATTENTION
See MONITOR
See ATTRIBUTE
See INPUT-MODE
See KEY-STATE
See MOUSE-BUTTON-STATE
See CURSOR-LOCATION
See CLIPBOARD-STRING
See MAKE-CURRENT
See GET-CURRENT
See SWAP-BUFFERS
See SWAP-INTERVAL
See CURSOR

Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Direct superclasses

foreign-object.

Direct methods
Direct slots
Slot: width
Initform

800

Initargs

:width

Readers

width.

Writers

This slot is read-only.

Slot: height
Initform

600

Initargs

:height

Readers

height.

Writers

This slot is read-only.

Slot: aspect-ratio
Readers

aspect-ratio.

Writers

(setf aspect-ratio).

Slot: size-limits
Initform

(list -1 -1 -1 -1)

Readers

size-limits.

Writers

(setf size-limits).

Slot: swap-interval
Initform

0

Readers

swap-interval.

Writers

(setf swap-interval).

Slot: title
Initform

"glfw"

Initargs

:title

Readers

title.

Writers

(setf title).

Slot: cursor
Slot: cursor-table
Initform

(make-hash-table :test (quote eql))

Readers

cursor-table.

Writers

(setf cursor-table).

Slot: icon
Readers

icon.

Writers

(setf icon).


5.2 Internals


5.2.1 Special variables

Special Variable: *here*
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Special Variable: *initialized*
Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Special Variable: *monitors*
Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Special Variable: *object-table*
Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Special Variable: *static*
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.


5.2.2 Macros

Macro: defglfwcallback (name return args)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Macro: defglfwfun (name return args)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Macro: extract-values (bindings &body body)
Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Macro: glfw (call &rest args)
Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.


5.2.3 Ordinary functions

Function: find-window-monitor (window)
Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Function: flag-value (value)
Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Function: ptr-object (ptr)
Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Function: (setf ptr-object) (ptr)
Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Function: translate-name (name)
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.


5.2.4 Generic functions

Generic Reader: cursor-table (object)
Package

org.shirakumo.fraf.glfw.

Methods
Reader Method: cursor-table ((window window))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

cursor-table.

Generic Writer: (setf cursor-table) (object)
Package

org.shirakumo.fraf.glfw.

Methods
Writer Method: (setf cursor-table) ((window window))

automatically generated writer method

Source

wrapper.lisp.

Target Slot

cursor-table.

Generic Function: list-video-modes (monitor)
Package

org.shirakumo.fraf.glfw.

Methods
Method: list-video-modes ((monitor monitor))
Source

wrapper.lisp.


5.2.5 Classes

Class: allocator-tclass
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: gamepad-state-tclass
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: gamma-ramp-tclass
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: image-tclass
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: standard-cursor
Package

org.shirakumo.fraf.glfw.

Source

wrapper.lisp.

Direct superclasses

cursor.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name.

Writers

This slot is read-only.

Class: video-mode-tclass
Package

org.shirakumo.fraf.glfw.cffi.

Source

low-level.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   C   D   E   F   G   H   I   J   K   L   M   N   O   P   R   S   T   U   V   W  
Index Entry  Section

(
(setf allocator-allocate): Public ordinary functions
(setf allocator-deallocate): Public ordinary functions
(setf allocator-reallocate): Public ordinary functions
(setf allocator-user): Public ordinary functions
(setf aspect-ratio): Public generic functions
(setf aspect-ratio): Public generic functions
(setf aspect-ratio): Public generic functions
(setf aspect-ratio): Public generic functions
(setf attribute): Public generic functions
(setf attribute): Public generic functions
(setf clipboard-string): Public generic functions
(setf clipboard-string): Public generic functions
(setf cursor): Public generic functions
(setf cursor): Public generic functions
(setf cursor): Public generic functions
(setf cursor-location): Public generic functions
(setf cursor-location): Public generic functions
(setf cursor-table): Private generic functions
(setf cursor-table): Private generic functions
(setf gamepad-state-axes): Public ordinary functions
(setf gamepad-state-buttons): Public ordinary functions
(setf gamma): Public generic functions
(setf gamma): Public generic functions
(setf gamma-ramp): Public generic functions
(setf gamma-ramp): Public generic functions
(setf gamma-ramp-blue): Public ordinary functions
(setf gamma-ramp-green): Public ordinary functions
(setf gamma-ramp-red): Public ordinary functions
(setf gamma-ramp-size): Public ordinary functions
(setf height): Public generic functions
(setf height): Public generic functions
(setf icon): Public generic functions
(setf icon): Public generic functions
(setf icon): Public generic functions
(setf iconified-p): Public generic functions
(setf iconified-p): Public generic functions
(setf image-height): Public ordinary functions
(setf image-pixels): Public ordinary functions
(setf image-width): Public ordinary functions
(setf input-mode): Public generic functions
(setf input-mode): Public generic functions
(setf location): Public generic functions
(setf location): Public generic functions
(setf maximized-p): Public generic functions
(setf maximized-p): Public generic functions
(setf monitor): Public generic functions
(setf monitor): Public generic functions
(setf monitor): Public generic functions
(setf monitor): Public generic functions
(setf monitor): Public generic functions
(setf opacity): Public generic functions
(setf opacity): Public generic functions
(setf pointer): Public generic functions
(setf pointer): Public generic functions
(setf ptr-object): Private ordinary functions
(setf should-close-p): Public generic functions
(setf should-close-p): Public generic functions
(setf size): Public generic functions
(setf size): Public generic functions
(setf size-limits): Public generic functions
(setf size-limits): Public generic functions
(setf size-limits): Public generic functions
(setf state): Public generic functions
(setf state): Public generic functions
(setf swap-interval): Public generic functions
(setf swap-interval): Public generic functions
(setf swap-interval): Public generic functions
(setf time): Public ordinary functions
(setf title): Public generic functions
(setf title): Public generic functions
(setf title): Public generic functions
(setf video-mode-blue-bits): Public ordinary functions
(setf video-mode-green-bits): Public ordinary functions
(setf video-mode-height): Public ordinary functions
(setf video-mode-red-bits): Public ordinary functions
(setf video-mode-refresh-rate): Public ordinary functions
(setf video-mode-width): Public ordinary functions
(setf visible-p): Public generic functions
(setf visible-p): Public generic functions
(setf width): Public generic functions
(setf width): Public generic functions

A
allocate: Public generic functions
allocate: Public generic functions
allocator-allocate: Public ordinary functions
allocator-deallocate: Public ordinary functions
allocator-reallocate: Public ordinary functions
allocator-user: Public ordinary functions
aspect-ratio: Public generic functions
aspect-ratio: Public generic functions
attribute: Public generic functions
attribute: Public generic functions

C
center: Public generic functions
center: Public generic functions
char-entered: Public generic functions
char-entered: Public generic functions
clipboard-string: Public generic functions
clipboard-string: Public generic functions
code: Public generic functions
code: Public generic functions
content-scale: Public generic functions
content-scale: Public generic functions
content-scale: Public generic functions
create-cursor: Public ordinary functions
create-standard-cursor: Public ordinary functions
create-window: Public ordinary functions
create-window-surface: Public ordinary functions
cursor: Public generic functions
cursor: Public generic functions
cursor-location: Public generic functions
cursor-location: Public generic functions
cursor-table: Private generic functions
cursor-table: Private generic functions

D
deallocate: Public generic functions
deallocate: Public generic functions
default-window-hints: Public ordinary functions
defglfwcallback: Private macros
defglfwfun: Private macros
destroy: Public generic functions
destroy: Public generic functions
destroy: Public generic functions
destroy: Public generic functions
destroy: Public generic functions
destroy-cursor: Public ordinary functions
destroy-window: Public ordinary functions

E
error: Public ordinary functions
extension-supported: Public ordinary functions
extract-values: Private macros

F
file-dropped: Public generic functions
file-dropped: Public generic functions
find-window-monitor: Private ordinary functions
flag-value: Private ordinary functions
focus: Public generic functions
focus: Public generic functions
focus-window: Public ordinary functions
frame-size: Public generic functions
frame-size: Public generic functions
framebuffer-resized: Public generic functions
framebuffer-resized: Public generic functions
framebuffer-size: Public generic functions
framebuffer-size: Public generic functions
Function, (setf allocator-allocate): Public ordinary functions
Function, (setf allocator-deallocate): Public ordinary functions
Function, (setf allocator-reallocate): Public ordinary functions
Function, (setf allocator-user): Public ordinary functions
Function, (setf gamepad-state-axes): Public ordinary functions
Function, (setf gamepad-state-buttons): Public ordinary functions
Function, (setf gamma-ramp-blue): Public ordinary functions
Function, (setf gamma-ramp-green): Public ordinary functions
Function, (setf gamma-ramp-red): Public ordinary functions
Function, (setf gamma-ramp-size): Public ordinary functions
Function, (setf image-height): Public ordinary functions
Function, (setf image-pixels): Public ordinary functions
Function, (setf image-width): Public ordinary functions
Function, (setf ptr-object): Private ordinary functions
Function, (setf time): Public ordinary functions
Function, (setf video-mode-blue-bits): Public ordinary functions
Function, (setf video-mode-green-bits): Public ordinary functions
Function, (setf video-mode-height): Public ordinary functions
Function, (setf video-mode-red-bits): Public ordinary functions
Function, (setf video-mode-refresh-rate): Public ordinary functions
Function, (setf video-mode-width): Public ordinary functions
Function, allocator-allocate: Public ordinary functions
Function, allocator-deallocate: Public ordinary functions
Function, allocator-reallocate: Public ordinary functions
Function, allocator-user: Public ordinary functions
Function, create-cursor: Public ordinary functions
Function, create-standard-cursor: Public ordinary functions
Function, create-window: Public ordinary functions
Function, create-window-surface: Public ordinary functions
Function, default-window-hints: Public ordinary functions
Function, destroy-cursor: Public ordinary functions
Function, destroy-window: Public ordinary functions
Function, error: Public ordinary functions
Function, extension-supported: Public ordinary functions
Function, find-window-monitor: Private ordinary functions
Function, flag-value: Private ordinary functions
Function, focus-window: Public ordinary functions
Function, gamepad-state-axes: Public ordinary functions
Function, gamepad-state-buttons: Public ordinary functions
Function, gamma-ramp-blue: Public ordinary functions
Function, gamma-ramp-green: Public ordinary functions
Function, gamma-ramp-red: Public ordinary functions
Function, gamma-ramp-size: Public ordinary functions
Function, get-clipboard-string: Public ordinary functions
Function, get-cocoa-monitor: Public ordinary functions
Function, get-cocoa-window: Public ordinary functions
Function, get-current-context: Public ordinary functions
Function, get-cursor-pos: Public ordinary functions
Function, get-eglcontext: Public ordinary functions
Function, get-egldisplay: Public ordinary functions
Function, get-eglsurface: Public ordinary functions
Function, get-error: Public ordinary functions
Function, get-framebuffer-size: Public ordinary functions
Function, get-gamepad-name: Public ordinary functions
Function, get-gamepad-state: Public ordinary functions
Function, get-gamma-ramp: Public ordinary functions
Function, get-glxcontext: Public ordinary functions
Function, get-glxwindow: Public ordinary functions
Function, get-input-mode: Public ordinary functions
Function, get-instance-proc-address: Public ordinary functions
Function, get-joystick-axes: Public ordinary functions
Function, get-joystick-buttons: Public ordinary functions
Function, get-joystick-guid: Public ordinary functions
Function, get-joystick-hats: Public ordinary functions
Function, get-joystick-name: Public ordinary functions
Function, get-joystick-user-pointer: Public ordinary functions
Function, get-key: Public ordinary functions
Function, get-key-name: Public ordinary functions
Function, get-key-scancode: Public ordinary functions
Function, get-monitor-content-scale: Public ordinary functions
Function, get-monitor-name: Public ordinary functions
Function, get-monitor-physical-size: Public ordinary functions
Function, get-monitor-pos: Public ordinary functions
Function, get-monitor-user-pointer: Public ordinary functions
Function, get-monitor-workarea: Public ordinary functions
Function, get-monitors: Public ordinary functions
Function, get-mouse-button: Public ordinary functions
Function, get-nsglcontext: Public ordinary functions
Function, get-osmesa-color-buffer: Public ordinary functions
Function, get-osmesa-context: Public ordinary functions
Function, get-osmesa-depth-buffer: Public ordinary functions
Function, get-physical-device-presentation-support: Public ordinary functions
Function, get-platform: Public ordinary functions
Function, get-primary-monitor: Public ordinary functions
Function, get-proc-address: Public ordinary functions
Function, get-required-instance-extensions: Public ordinary functions
Function, get-time: Public ordinary functions
Function, get-timer-frequency: Public ordinary functions
Function, get-timer-value: Public ordinary functions
Function, get-version: Public ordinary functions
Function, get-version-string: Public ordinary functions
Function, get-video-mode: Public ordinary functions
Function, get-video-modes: Public ordinary functions
Function, get-wayland-display: Public ordinary functions
Function, get-wayland-monitor: Public ordinary functions
Function, get-wayland-window: Public ordinary functions
Function, get-wglcontext: Public ordinary functions
Function, get-win32-adapter: Public ordinary functions
Function, get-win32-monitor: Public ordinary functions
Function, get-win32-window: Public ordinary functions
Function, get-window-attrib: Public ordinary functions
Function, get-window-content-scale: Public ordinary functions
Function, get-window-frame-size: Public ordinary functions
Function, get-window-monitor: Public ordinary functions
Function, get-window-opacity: Public ordinary functions
Function, get-window-pos: Public ordinary functions
Function, get-window-size: Public ordinary functions
Function, get-window-user-pointer: Public ordinary functions
Function, get-x11-adapter: Public ordinary functions
Function, get-x11-display: Public ordinary functions
Function, get-x11-monitor: Public ordinary functions
Function, get-x11-selection-string: Public ordinary functions
Function, get-x11-window: Public ordinary functions
Function, hide-window: Public ordinary functions
Function, iconify-window: Public ordinary functions
Function, image-height: Public ordinary functions
Function, image-pixels: Public ordinary functions
Function, image-width: Public ordinary functions
Function, init: Public ordinary functions
Function, init: Public ordinary functions
Function, init-allocator: Public ordinary functions
Function, init-hint: Public ordinary functions
Function, init-vulkan-loader: Public ordinary functions
Function, joystick-connected: Public ordinary functions
Function, joystick-disconnected: Public ordinary functions
Function, joystick-is-gamepad: Public ordinary functions
Function, joystick-present: Public ordinary functions
Function, list-monitors: Public ordinary functions
Function, make-context-current: Public ordinary functions
Function, maximize-window: Public ordinary functions
Function, monitor-connected: Public ordinary functions
Function, monitor-disconnected: Public ordinary functions
Function, platform: Public ordinary functions
Function, platform-supported: Public ordinary functions
Function, poll-events: Public ordinary functions
Function, poll-events: Public ordinary functions
Function, post-empty-event: Public ordinary functions
Function, primary-monitor: Public ordinary functions
Function, ptr-object: Private ordinary functions
Function, raw-mouse-motion-supported: Public ordinary functions
Function, request-window-attention: Public ordinary functions
Function, resolve-window: Public ordinary functions
Function, restore-window: Public ordinary functions
Function, set-char-callback: Public ordinary functions
Function, set-char-mods-callback: Public ordinary functions
Function, set-clipboard-string: Public ordinary functions
Function, set-cursor: Public ordinary functions
Function, set-cursor-enter-callback: Public ordinary functions
Function, set-cursor-pos: Public ordinary functions
Function, set-cursor-pos-callback: Public ordinary functions
Function, set-drop-callback: Public ordinary functions
Function, set-error-callback: Public ordinary functions
Function, set-framebuffer-size-callback: Public ordinary functions
Function, set-gamma: Public ordinary functions
Function, set-gamma-ramp: Public ordinary functions
Function, set-input-mode: Public ordinary functions
Function, set-joystick-callback: Public ordinary functions
Function, set-joystick-user-pointer: Public ordinary functions
Function, set-key-callback: Public ordinary functions
Function, set-monitor-callback: Public ordinary functions
Function, set-monitor-user-pointer: Public ordinary functions
Function, set-mouse-button-callback: Public ordinary functions
Function, set-scroll-callback: Public ordinary functions
Function, set-time: Public ordinary functions
Function, set-window-aspect-ratio: Public ordinary functions
Function, set-window-attrib: Public ordinary functions
Function, set-window-close-callback: Public ordinary functions
Function, set-window-content-scale-callback: Public ordinary functions
Function, set-window-focus-callback: Public ordinary functions
Function, set-window-icon: Public ordinary functions
Function, set-window-iconify-callback: Public ordinary functions
Function, set-window-maximize-callback: Public ordinary functions
Function, set-window-monitor: Public ordinary functions
Function, set-window-opacity: Public ordinary functions
Function, set-window-pos: Public ordinary functions
Function, set-window-pos-callback: Public ordinary functions
Function, set-window-refresh-callback: Public ordinary functions
Function, set-window-should-close: Public ordinary functions
Function, set-window-size: Public ordinary functions
Function, set-window-size-callback: Public ordinary functions
Function, set-window-size-limits: Public ordinary functions
Function, set-window-title: Public ordinary functions
Function, set-window-user-pointer: Public ordinary functions
Function, set-x11-selection-string: Public ordinary functions
Function, show-window: Public ordinary functions
Function, shutdown: Public ordinary functions
Function, swap-buffers: Public ordinary functions
Function, swap-interval: Public ordinary functions
Function, terminate: Public ordinary functions
Function, time: Public ordinary functions
Function, timestamp: Public ordinary functions
Function, timestamp-resolution: Public ordinary functions
Function, translate-name: Private ordinary functions
Function, update-gamepad-mappings: Public ordinary functions
Function, version: Public ordinary functions
Function, video-mode-blue-bits: Public ordinary functions
Function, video-mode-green-bits: Public ordinary functions
Function, video-mode-height: Public ordinary functions
Function, video-mode-red-bits: Public ordinary functions
Function, video-mode-refresh-rate: Public ordinary functions
Function, video-mode-width: Public ordinary functions
Function, vulkan-supported: Public ordinary functions
Function, wait-events: Public ordinary functions
Function, wait-events-timeout: Public ordinary functions
Function, window-hint: Public ordinary functions
Function, window-hint-string: Public ordinary functions
Function, window-should-close: Public ordinary functions

G
gamepad-state-axes: Public ordinary functions
gamepad-state-buttons: Public ordinary functions
gamma: Public generic functions
gamma: Public generic functions
gamma-ramp: Public generic functions
gamma-ramp: Public generic functions
gamma-ramp-blue: Public ordinary functions
gamma-ramp-green: Public ordinary functions
gamma-ramp-red: Public ordinary functions
gamma-ramp-size: Public ordinary functions
Generic Function, (setf aspect-ratio): Public generic functions
Generic Function, (setf attribute): Public generic functions
Generic Function, (setf clipboard-string): Public generic functions
Generic Function, (setf cursor): Public generic functions
Generic Function, (setf cursor-location): Public generic functions
Generic Function, (setf cursor-table): Private generic functions
Generic Function, (setf gamma): Public generic functions
Generic Function, (setf gamma-ramp): Public generic functions
Generic Function, (setf height): Public generic functions
Generic Function, (setf icon): Public generic functions
Generic Function, (setf iconified-p): Public generic functions
Generic Function, (setf input-mode): Public generic functions
Generic Function, (setf location): Public generic functions
Generic Function, (setf maximized-p): Public generic functions
Generic Function, (setf monitor): Public generic functions
Generic Function, (setf opacity): Public generic functions
Generic Function, (setf pointer): Public generic functions
Generic Function, (setf should-close-p): Public generic functions
Generic Function, (setf size): Public generic functions
Generic Function, (setf size-limits): Public generic functions
Generic Function, (setf state): Public generic functions
Generic Function, (setf swap-interval): Public generic functions
Generic Function, (setf title): Public generic functions
Generic Function, (setf visible-p): Public generic functions
Generic Function, (setf width): Public generic functions
Generic Function, allocate: Public generic functions
Generic Function, aspect-ratio: Public generic functions
Generic Function, attribute: Public generic functions
Generic Function, center: Public generic functions
Generic Function, char-entered: Public generic functions
Generic Function, clipboard-string: Public generic functions
Generic Function, code: Public generic functions
Generic Function, content-scale: Public generic functions
Generic Function, cursor: Public generic functions
Generic Function, cursor-location: Public generic functions
Generic Function, cursor-table: Private generic functions
Generic Function, deallocate: Public generic functions
Generic Function, destroy: Public generic functions
Generic Function, file-dropped: Public generic functions
Generic Function, focus: Public generic functions
Generic Function, frame-size: Public generic functions
Generic Function, framebuffer-resized: Public generic functions
Generic Function, framebuffer-size: Public generic functions
Generic Function, gamma: Public generic functions
Generic Function, gamma-ramp: Public generic functions
Generic Function, get-current: Public generic functions
Generic Function, height: Public generic functions
Generic Function, hide: Public generic functions
Generic Function, icon: Public generic functions
Generic Function, iconified-p: Public generic functions
Generic Function, iconify: Public generic functions
Generic Function, input-mode: Public generic functions
Generic Function, key-changed: Public generic functions
Generic Function, key-state: Public generic functions
Generic Function, list-video-modes: Private generic functions
Generic Function, location: Public generic functions
Generic Function, make-current: Public generic functions
Generic Function, maximize: Public generic functions
Generic Function, maximized-p: Public generic functions
Generic Function, message: Public generic functions
Generic Function, monitor: Public generic functions
Generic Function, mouse-button-changed: Public generic functions
Generic Function, mouse-button-state: Public generic functions
Generic Function, mouse-entered: Public generic functions
Generic Function, mouse-moved: Public generic functions
Generic Function, mouse-scrolled: Public generic functions
Generic Function, name: Public generic functions
Generic Function, opacity: Public generic functions
Generic Function, operation: Public generic functions
Generic Function, physical-size: Public generic functions
Generic Function, pointer: Public generic functions
Generic Function, reallocate: Public generic functions
Generic Function, refresh-rate: Public generic functions
Generic Function, register-callbacks: Public generic functions
Generic Function, request-attention: Public generic functions
Generic Function, restore: Public generic functions
Generic Function, should-close-p: Public generic functions
Generic Function, show: Public generic functions
Generic Function, size: Public generic functions
Generic Function, size-limits: Public generic functions
Generic Function, state: Public generic functions
Generic Function, swap-buffers: Public generic functions
Generic Function, swap-interval: Public generic functions
Generic Function, title: Public generic functions
Generic Function, video-mode: Public generic functions
Generic Function, video-modes: Public generic functions
Generic Function, visible-p: Public generic functions
Generic Function, width: Public generic functions
Generic Function, window-closed: Public generic functions
Generic Function, window-content-scale-changed: Public generic functions
Generic Function, window-focused: Public generic functions
Generic Function, window-iconified: Public generic functions
Generic Function, window-maximized: Public generic functions
Generic Function, window-moved: Public generic functions
Generic Function, window-refreshed: Public generic functions
Generic Function, window-resized: Public generic functions
Generic Function, work-area: Public generic functions
get-clipboard-string: Public ordinary functions
get-cocoa-monitor: Public ordinary functions
get-cocoa-window: Public ordinary functions
get-current: Public generic functions
get-current: Public generic functions
get-current-context: Public ordinary functions
get-cursor-pos: Public ordinary functions
get-eglcontext: Public ordinary functions
get-egldisplay: Public ordinary functions
get-eglsurface: Public ordinary functions
get-error: Public ordinary functions
get-framebuffer-size: Public ordinary functions
get-gamepad-name: Public ordinary functions
get-gamepad-state: Public ordinary functions
get-gamma-ramp: Public ordinary functions
get-glxcontext: Public ordinary functions
get-glxwindow: Public ordinary functions
get-input-mode: Public ordinary functions
get-instance-proc-address: Public ordinary functions
get-joystick-axes: Public ordinary functions
get-joystick-buttons: Public ordinary functions
get-joystick-guid: Public ordinary functions
get-joystick-hats: Public ordinary functions
get-joystick-name: Public ordinary functions
get-joystick-user-pointer: Public ordinary functions
get-key: Public ordinary functions
get-key-name: Public ordinary functions
get-key-scancode: Public ordinary functions
get-monitor-content-scale: Public ordinary functions
get-monitor-name: Public ordinary functions
get-monitor-physical-size: Public ordinary functions
get-monitor-pos: Public ordinary functions
get-monitor-user-pointer: Public ordinary functions
get-monitor-workarea: Public ordinary functions
get-monitors: Public ordinary functions
get-mouse-button: Public ordinary functions
get-nsglcontext: Public ordinary functions
get-osmesa-color-buffer: Public ordinary functions
get-osmesa-context: Public ordinary functions
get-osmesa-depth-buffer: Public ordinary functions
get-physical-device-presentation-support: Public ordinary functions
get-platform: Public ordinary functions
get-primary-monitor: Public ordinary functions
get-proc-address: Public ordinary functions
get-required-instance-extensions: Public ordinary functions
get-time: Public ordinary functions
get-timer-frequency: Public ordinary functions
get-timer-value: Public ordinary functions
get-version: Public ordinary functions
get-version-string: Public ordinary functions
get-video-mode: Public ordinary functions
get-video-modes: Public ordinary functions
get-wayland-display: Public ordinary functions
get-wayland-monitor: Public ordinary functions
get-wayland-window: Public ordinary functions
get-wglcontext: Public ordinary functions
get-win32-adapter: Public ordinary functions
get-win32-monitor: Public ordinary functions
get-win32-window: Public ordinary functions
get-window-attrib: Public ordinary functions
get-window-content-scale: Public ordinary functions
get-window-frame-size: Public ordinary functions
get-window-monitor: Public ordinary functions
get-window-opacity: Public ordinary functions
get-window-pos: Public ordinary functions
get-window-size: Public ordinary functions
get-window-user-pointer: Public ordinary functions
get-x11-adapter: Public ordinary functions
get-x11-display: Public ordinary functions
get-x11-monitor: Public ordinary functions
get-x11-selection-string: Public ordinary functions
get-x11-window: Public ordinary functions
glfw: Private macros

H
height: Public generic functions
height: Public generic functions
height: Public generic functions
hide: Public generic functions
hide: Public generic functions
hide-window: Public ordinary functions

I
icon: Public generic functions
icon: Public generic functions
iconified-p: Public generic functions
iconified-p: Public generic functions
iconify: Public generic functions
iconify: Public generic functions
iconify-window: Public ordinary functions
image-height: Public ordinary functions
image-pixels: Public ordinary functions
image-width: Public ordinary functions
init: Public ordinary functions
init: Public ordinary functions
init-allocator: Public ordinary functions
init-hint: Public ordinary functions
init-vulkan-loader: Public ordinary functions
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
input-mode: Public generic functions
input-mode: Public generic functions

J
joystick-connected: Public ordinary functions
joystick-disconnected: Public ordinary functions
joystick-is-gamepad: Public ordinary functions
joystick-present: Public ordinary functions

K
key-changed: Public generic functions
key-changed: Public generic functions
key-state: Public generic functions
key-state: Public generic functions

L
list-monitors: Public ordinary functions
list-video-modes: Private generic functions
list-video-modes: Private generic functions
location: Public generic functions
location: Public generic functions
location: Public generic functions

M
Macro, defglfwcallback: Private macros
Macro, defglfwfun: Private macros
Macro, extract-values: Private macros
Macro, glfw: Private macros
Macro, with-game-loop: Public macros
make-context-current: Public ordinary functions
make-current: Public generic functions
make-current: Public generic functions
make-current: Public generic functions
maximize: Public generic functions
maximize: Public generic functions
maximize-window: Public ordinary functions
maximized-p: Public generic functions
maximized-p: Public generic functions
message: Public generic functions
message: Public generic functions
Method, (setf aspect-ratio): Public generic functions
Method, (setf aspect-ratio): Public generic functions
Method, (setf aspect-ratio): Public generic functions
Method, (setf attribute): Public generic functions
Method, (setf clipboard-string): Public generic functions
Method, (setf cursor): Public generic functions
Method, (setf cursor): Public generic functions
Method, (setf cursor-location): Public generic functions
Method, (setf cursor-table): Private generic functions
Method, (setf gamma): Public generic functions
Method, (setf gamma-ramp): Public generic functions
Method, (setf height): Public generic functions
Method, (setf icon): Public generic functions
Method, (setf icon): Public generic functions
Method, (setf iconified-p): Public generic functions
Method, (setf input-mode): Public generic functions
Method, (setf location): Public generic functions
Method, (setf maximized-p): Public generic functions
Method, (setf monitor): Public generic functions
Method, (setf monitor): Public generic functions
Method, (setf monitor): Public generic functions
Method, (setf monitor): Public generic functions
Method, (setf opacity): Public generic functions
Method, (setf pointer): Public generic functions
Method, (setf should-close-p): Public generic functions
Method, (setf size): Public generic functions
Method, (setf size-limits): Public generic functions
Method, (setf size-limits): Public generic functions
Method, (setf state): Public generic functions
Method, (setf swap-interval): Public generic functions
Method, (setf swap-interval): Public generic functions
Method, (setf title): Public generic functions
Method, (setf title): Public generic functions
Method, (setf visible-p): Public generic functions
Method, (setf width): Public generic functions
Method, allocate: Public generic functions
Method, aspect-ratio: Public generic functions
Method, attribute: Public generic functions
Method, center: Public generic functions
Method, char-entered: Public generic functions
Method, clipboard-string: Public generic functions
Method, code: Public generic functions
Method, content-scale: Public generic functions
Method, content-scale: Public generic functions
Method, cursor: Public generic functions
Method, cursor-location: Public generic functions
Method, cursor-table: Private generic functions
Method, deallocate: Public generic functions
Method, destroy: Public generic functions
Method, destroy: Public generic functions
Method, destroy: Public generic functions
Method, destroy: Public generic functions
Method, file-dropped: Public generic functions
Method, focus: Public generic functions
Method, frame-size: Public generic functions
Method, framebuffer-resized: Public generic functions
Method, framebuffer-size: Public generic functions
Method, gamma: Public generic functions
Method, gamma-ramp: Public generic functions
Method, get-current: Public generic functions
Method, height: Public generic functions
Method, height: Public generic functions
Method, hide: Public generic functions
Method, icon: Public generic functions
Method, iconified-p: Public generic functions
Method, iconify: Public generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, input-mode: Public generic functions
Method, key-changed: Public generic functions
Method, key-state: Public generic functions
Method, list-video-modes: Private generic functions
Method, location: Public generic functions
Method, location: Public generic functions
Method, make-current: Public generic functions
Method, make-current: Public generic functions
Method, maximize: Public generic functions
Method, maximized-p: Public generic functions
Method, message: Public generic functions
Method, monitor: Public generic functions
Method, mouse-button-changed: Public generic functions
Method, mouse-button-state: Public generic functions
Method, mouse-entered: Public generic functions
Method, mouse-moved: Public generic functions
Method, mouse-scrolled: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, opacity: Public generic functions
Method, operation: Public generic functions
Method, physical-size: Public generic functions
Method, pointer: Public generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, reallocate: Public generic functions
Method, refresh-rate: Public generic functions
Method, register-callbacks: Public generic functions
Method, request-attention: Public generic functions
Method, restore: Public generic functions
Method, shared-initialize: Public standalone methods
Method, should-close-p: Public generic functions
Method, show: Public generic functions
Method, size: Public generic functions
Method, size: Public generic functions
Method, size-limits: Public generic functions
Method, state: Public generic functions
Method, swap-buffers: Public generic functions
Method, swap-interval: Public generic functions
Method, title: Public generic functions
Method, video-mode: Public generic functions
Method, video-modes: Public generic functions
Method, visible-p: Public generic functions
Method, width: Public generic functions
Method, width: Public generic functions
Method, window-closed: Public generic functions
Method, window-content-scale-changed: Public generic functions
Method, window-focused: Public generic functions
Method, window-iconified: Public generic functions
Method, window-maximized: Public generic functions
Method, window-moved: Public generic functions
Method, window-refreshed: Public generic functions
Method, window-resized: Public generic functions
Method, window-resized: Public generic functions
Method, work-area: Public generic functions
monitor: Public generic functions
monitor: Public generic functions
monitor-connected: Public ordinary functions
monitor-disconnected: Public ordinary functions
mouse-button-changed: Public generic functions
mouse-button-changed: Public generic functions
mouse-button-state: Public generic functions
mouse-button-state: Public generic functions
mouse-entered: Public generic functions
mouse-entered: Public generic functions
mouse-moved: Public generic functions
mouse-moved: Public generic functions
mouse-scrolled: Public generic functions
mouse-scrolled: Public generic functions

N
name: Public generic functions
name: Public generic functions
name: Public generic functions

O
opacity: Public generic functions
opacity: Public generic functions
operation: Public generic functions
operation: Public generic functions

P
physical-size: Public generic functions
physical-size: Public generic functions
platform: Public ordinary functions
platform-supported: Public ordinary functions
pointer: Public generic functions
pointer: Public generic functions
poll-events: Public ordinary functions
poll-events: Public ordinary functions
post-empty-event: Public ordinary functions
primary-monitor: Public ordinary functions
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
ptr-object: Private ordinary functions

R
raw-mouse-motion-supported: Public ordinary functions
reallocate: Public generic functions
reallocate: Public generic functions
refresh-rate: Public generic functions
refresh-rate: Public generic functions
register-callbacks: Public generic functions
register-callbacks: Public generic functions
request-attention: Public generic functions
request-attention: Public generic functions
request-window-attention: Public ordinary functions
resolve-window: Public ordinary functions
restore: Public generic functions
restore: Public generic functions
restore-window: Public ordinary functions

S
set-char-callback: Public ordinary functions
set-char-mods-callback: Public ordinary functions
set-clipboard-string: Public ordinary functions
set-cursor: Public ordinary functions
set-cursor-enter-callback: Public ordinary functions
set-cursor-pos: Public ordinary functions
set-cursor-pos-callback: Public ordinary functions
set-drop-callback: Public ordinary functions
set-error-callback: Public ordinary functions
set-framebuffer-size-callback: Public ordinary functions
set-gamma: Public ordinary functions
set-gamma-ramp: Public ordinary functions
set-input-mode: Public ordinary functions
set-joystick-callback: Public ordinary functions
set-joystick-user-pointer: Public ordinary functions
set-key-callback: Public ordinary functions
set-monitor-callback: Public ordinary functions
set-monitor-user-pointer: Public ordinary functions
set-mouse-button-callback: Public ordinary functions
set-scroll-callback: Public ordinary functions
set-time: Public ordinary functions
set-window-aspect-ratio: Public ordinary functions
set-window-attrib: Public ordinary functions
set-window-close-callback: Public ordinary functions
set-window-content-scale-callback: Public ordinary functions
set-window-focus-callback: Public ordinary functions
set-window-icon: Public ordinary functions
set-window-iconify-callback: Public ordinary functions
set-window-maximize-callback: Public ordinary functions
set-window-monitor: Public ordinary functions
set-window-opacity: Public ordinary functions
set-window-pos: Public ordinary functions
set-window-pos-callback: Public ordinary functions
set-window-refresh-callback: Public ordinary functions
set-window-should-close: Public ordinary functions
set-window-size: Public ordinary functions
set-window-size-callback: Public ordinary functions
set-window-size-limits: Public ordinary functions
set-window-title: Public ordinary functions
set-window-user-pointer: Public ordinary functions
set-x11-selection-string: Public ordinary functions
shared-initialize: Public standalone methods
should-close-p: Public generic functions
should-close-p: Public generic functions
show: Public generic functions
show: Public generic functions
show-window: Public ordinary functions
shutdown: Public ordinary functions
size: Public generic functions
size: Public generic functions
size: Public generic functions
size-limits: Public generic functions
size-limits: Public generic functions
state: Public generic functions
state: Public generic functions
swap-buffers: Public ordinary functions
swap-buffers: Public generic functions
swap-buffers: Public generic functions
swap-interval: Public ordinary functions
swap-interval: Public generic functions
swap-interval: Public generic functions

T
terminate: Public ordinary functions
time: Public ordinary functions
timestamp: Public ordinary functions
timestamp-resolution: Public ordinary functions
title: Public generic functions
title: Public generic functions
translate-name: Private ordinary functions

U
update-gamepad-mappings: Public ordinary functions

V
version: Public ordinary functions
video-mode: Public generic functions
video-mode: Public generic functions
video-mode-blue-bits: Public ordinary functions
video-mode-green-bits: Public ordinary functions
video-mode-height: Public ordinary functions
video-mode-red-bits: Public ordinary functions
video-mode-refresh-rate: Public ordinary functions
video-mode-width: Public ordinary functions
video-modes: Public generic functions
video-modes: Public generic functions
visible-p: Public generic functions
visible-p: Public generic functions
vulkan-supported: Public ordinary functions

W
wait-events: Public ordinary functions
wait-events-timeout: Public ordinary functions
width: Public generic functions
width: Public generic functions
width: Public generic functions
window-closed: Public generic functions
window-closed: Public generic functions
window-content-scale-changed: Public generic functions
window-content-scale-changed: Public generic functions
window-focused: Public generic functions
window-focused: Public generic functions
window-hint: Public ordinary functions
window-hint-string: Public ordinary functions
window-iconified: Public generic functions
window-iconified: Public generic functions
window-maximized: Public generic functions
window-maximized: Public generic functions
window-moved: Public generic functions
window-moved: Public generic functions
window-refreshed: Public generic functions
window-refreshed: Public generic functions
window-resized: Public generic functions
window-resized: Public generic functions
window-resized: Public generic functions
window-should-close: Public ordinary functions
with-game-loop: Public macros
work-area: Public generic functions
work-area: Public generic functions


A.3 Variables

Jump to:   *  
A   C   H   I   M   N   O   P   S   T   V   W  
Index Entry  Section

*
*here*: Private special variables
*initialized*: Private special variables
*monitors*: Private special variables
*object-table*: Private special variables
*static*: Private special variables

A
aspect-ratio: Public classes

C
code: Public conditions
cursor: Public classes
cursor-table: Public classes

H
height: Public classes

I
icon: Public classes

M
message: Public conditions

N
name: Private classes

O
operation: Public conditions

P
pointer: Public classes

S
size-limits: Public classes
Slot, aspect-ratio: Public classes
Slot, code: Public conditions
Slot, cursor: Public classes
Slot, cursor-table: Public classes
Slot, height: Public classes
Slot, icon: Public classes
Slot, message: Public conditions
Slot, name: Private classes
Slot, operation: Public conditions
Slot, pointer: Public classes
Slot, size-limits: Public classes
Slot, swap-interval: Public classes
Slot, title: Public classes
Slot, video-modes: Public classes
Slot, width: Public classes
Special Variable, *here*: Private special variables
Special Variable, *initialized*: Private special variables
Special Variable, *monitors*: Private special variables
Special Variable, *object-table*: Private special variables
Special Variable, *static*: Private special variables
swap-interval: Public classes

T
title: Public classes

V
video-modes: Public classes

W
width: Public classes


A.4 Data types

Jump to:   A   C   D   F   G   I   L   M   O   P   S   V   W  
Index Entry  Section

A
allocator-tclass: Private classes

C
Class, allocator-tclass: Private classes
Class, cursor: Public classes
Class, foreign-object: Public classes
Class, gamepad-state-tclass: Private classes
Class, gamma-ramp-tclass: Private classes
Class, image-tclass: Private classes
Class, monitor: Public classes
Class, standard-cursor: Private classes
Class, video-mode-tclass: Private classes
Class, window: Public classes
Condition, glfw-error: Public conditions
cursor: Public classes

D
documentation.lisp: The glfw/documentation․lisp file

F
File, documentation.lisp: The glfw/documentation․lisp file
File, glfw.asd: The glfw/glfw․asd file
File, low-level.lisp: The glfw/low-level․lisp file
File, package.lisp: The glfw/package․lisp file
File, wrapper.lisp: The glfw/wrapper․lisp file
foreign-object: Public classes

G
gamepad-state-tclass: Private classes
gamma-ramp-tclass: Private classes
glfw: The glfw system
glfw-error: Public conditions
glfw.asd: The glfw/glfw․asd file

I
image-tclass: Private classes

L
low-level.lisp: The glfw/low-level․lisp file

M
monitor: Public classes

O
org.shirakumo.fraf.glfw: The org․shirakumo․fraf․glfw package
org.shirakumo.fraf.glfw.cffi: The org․shirakumo․fraf․glfw․cffi package

P
Package, org.shirakumo.fraf.glfw: The org․shirakumo․fraf․glfw package
Package, org.shirakumo.fraf.glfw.cffi: The org․shirakumo․fraf․glfw․cffi package
package.lisp: The glfw/package․lisp file

S
standard-cursor: Private classes
System, glfw: The glfw system

V
video-mode-tclass: Private classes

W
window: Public classes
wrapper.lisp: The glfw/wrapper․lisp file