The glop Reference Manual

Table of Contents

The glop Reference Manual

This is the glop Reference Manual, version 0.1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 16:13:01 2021 GMT+0.

1 Introduction

Glop

The goal is to provide simple OpenGL window and context manipulation code as well as system input handling (i.e. mouse & keyboard).

Direct FFI bindings to system functions are used so no third party C lib is required except system libraries.

Dependencies

• CFFI

Tested implementations/platforms

The following list is just here for information and is certainly not meant to be exhaustive and/or up-to-date.

Tested platforms:

• Win32: WindowsXP SP2
• X11: Linux64
• OSX: OSX 10.6

The following combinations have been tested sucessfully for GL 2.X:

• CLISP 2.49 / X11
• CLISP 2.48 / Win32
• SBCL 1.1.14 / X11
• SBCL 1.0.46 / OSX (still experimental)
• CCL 1.9-r15756 / X11
• ECL 12.2.1 / X11

The following combination are known to fail:

• CCL / OSX

Running the tests

Make sure glop.asd and glop-test.asd are in a location known to asdf and run:

(asdf:operate 'asdf:load-op :glop-test)

Then you can run an hello world test with:

(glop-test:test-gl-hello)

Available tests are:

• test-manual-create: manual window create/destroy
• test-multiple-contexts: multiple OpenGL contexts for a single window
• test-with-window: glop:with-window macro usage
• test-manual-events: manual event dispatching
• test-gl-hello: cl-opengl hello world example
• test-gl-hello-fullscreen: same in fullscreen
• test-gl-hello-gl3: same with OpenGL 3.x context
• test-multiple-windows: two hello world windows each one with its own GL context
• test-on-event: hello world using the on-event dispatch code
• test-subclassing: how to make your own window class and use it

In all tests except test-manual-events you can press the following keys:

• ESC: close the window
• 'f': toggle fullscreen mode (change display mode)
• 'g': set window to fullscreen state (no display mode change)
• 'h': hide mouse cursor
• 'j': show mouse cursor

Quick start

To use glop, make sure glop.asd is in a location known to asdf and run:

(asdf:operate 'asdf:load-op :glop)

Now you can just do:

(glop:with-window (win "My title" 800 600)
    ;; gl init code here
    (loop while (glop:dispatch-events win :blocking nil) do
       ;; gl code here
       (glop:swap-buffers win)))

The glop:dispatch-events macro will take care of processing glop events and call corresponding methods. Generic functions for these methods are:

• (on-key window pressed keycode keysym string)
• (on-button window pressed button)
• (on-mouse-motion window x y dx dy)
• (on-resize window new-width new-height)
• (on-draw window)
• (on-close window)

None of them have a default definition, so you should implement all these methods in you application.

There's another method based dispatch mechanism with the on-event generic function. To use it just pass :on-foo nil to glop:dispatch-events. In that case the (on-event window event) method will be called instead of on-foo methods.

The glop:dispatch-events macro isn't mandatory and you can use your own event dispatch code, see glop-test:test-manual-events for an example of how to do this.

You may also completely bypass glop's event handling mechanism and use your own, see glop-test:test-custom-event-loop (X11 only) for a simple example of how it may be done. Basically just don't call any of glop's event related functions and do the work yourself.

See test.lisp for more details.

Notes

OsX support is still experimental.

GL 3.x contexts are known to work on Linux and there should be experimental support those on Win32 (not tested).

See also issues on github.

Patches and improvements are welcome :=)

2 Systems

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

2.1 glop

Author

Morgan Veyret

License

MIT

Description

Direct FFI bindings for OpenGL window and context management

Version

0.1.0

Dependencies

• cffi
• trivial-garbage
• split-sequence

Source

glop.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 glop/src

Parent

glop (system)

Location

src/

Components

• package.lisp (file)
• utils.lisp (file)
• x11 (module)
• glop.lisp (file)

3.2 glop/src/x11

Dependency

utils.lisp (file)

Parent

src (module)

Location

src/x11/

Components

• package.lisp (file)
• keysymdef.lisp (file)
• xlib.lisp (file)
• xkb.lisp (file)
• xcomposite.lisp (file)
• glx.lisp (file)
• display-ctrl.lisp (file)
• glop-x11.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 glop.asd

Location

glop.asd

Systems

glop (system)

4.1.2 glop/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

glop

4.1.3 glop/src/utils.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/utils.lisp

Exported Definitions

• *ignore-auto-repeat* (special variable)
• key-pressed (function)
• (setf key-pressed) (setf expander)
• load-libraries (function)
• window (class)
• window-gl-context (method)
• (setf window-gl-context) (method)
• window-height (method)
• window-width (method)
• window-x (method)
• window-y (method)
• x11-window-display (method)
• (setf x11-window-display) (method)
• x11-window-id (method)
• (setf x11-window-id) (method)

Internal Definitions

• %key-states% (special variable)
• %update-geometry (function)
• copy-video-mode (function)
• copy-x11-video-mode (function)
• defdfun (macro)
• defdmacro (macro)
• glop-error (condition)
• make-video-mode (function)
• make-x11-video-mode (function)
• not-implemented (condition)
• parse-gl-version-string-values (function)
• swap-interval-function (method)
• (setf swap-interval-function) (method)
• swap-interval-mixin (class)
• swap-interval-tear (method)
• (setf swap-interval-tear) (method)
• video-mode (structure)
• video-mode-depth (function)
• (setf video-mode-depth) (function)
• video-mode-height (function)
• (setf video-mode-height) (function)
• video-mode-index (function)
• (setf video-mode-index) (function)
• video-mode-p (function)
• video-mode-rate (function)
• (setf video-mode-rate) (function)
• video-mode-width (function)
• (setf video-mode-width) (function)
• window-fullscreen (method)
• (setf window-fullscreen) (method)
• window-previous-video-mode (method)
• (setf window-previous-video-mode) (method)
• window-pushed-event (method)
• (setf window-pushed-event) (method)
• window-title (method)
• (setf window-title) (method)
• without-fp-traps (macro)
• x11-video-mode (structure)
• x11-video-mode-index (function)
• (setf x11-video-mode-index) (function)
• x11-video-mode-p (function)
• x11-video-mode-rate (function)
• (setf x11-video-mode-rate) (function)
• x11-window (class)
• x11-window-cursor (method)
• (setf x11-window-cursor) (method)
• x11-window-fb-config (method)
• (setf x11-window-fb-config) (method)
• x11-window-screen (method)
• (setf x11-window-screen) (method)
• x11-window-visual-infos (method)
• (setf x11-window-visual-infos) (method)

4.1.4 glop/src/x11/package.lisp

Parent

x11 (module)

Location

src/x11/package.lisp

Packages

• glop-glx
• glop-xlib

4.1.5 glop/src/x11/keysymdef.lisp

Dependency

package.lisp (file)

Parent

x11 (module)

Location

src/x11/keysymdef.lisp

4.1.6 glop/src/x11/xlib.lisp

Dependency

keysymdef.lisp (file)

Parent

x11 (module)

Location

src/x11/xlib.lisp

Exported Definitions

• %set-fullscreen (function)
• add-connection-watch (function)
• default-screen (function)
• process-internal-connection (function)
• remove-connection-watch (function)
• x-close-display (function)
• x-create-null-cursor (function)
• x-create-window (function)
• x-default-root-window (function)
• x-define-cursor (function)
• x-destroy-window (function)
• x-flush (function)
• x-free (function)
• x-free-cursor (function)
• x-intern-atom (function)
• x-map-raised (function)
• x-next-event (function)
• x-open-display (function)
• x-set-geometry (function)
• x-set-wm-protocols (function)
• x-store-name (function)
• x-undefine-cursor (function)
• x-unmap-window (function)

Internal Definitions

• %generic-event-dispatch (generic function)
• %generic-event-dispatch (method)
• %x-close-display (function)
• %x-configure-window (function)
• %x-create-gc (function)
• %x-create-pixmap (function)
• %x-create-pixmap-cursor (function)
• %x-create-window (function)
• %x-events-queued (function)
• %x-fill-rectangle (function)
• %x-get-atom-name (function)
• %x-get-geometry (function)
• %x-get-window-attributes (function)
• %x-get-wm-normal-hints (function)
• %x-lookup-string (function)
• %x-next-event (function)
• %x-open-display (function)
• %x-peek-event (function)
• %x-pending (function)
• %x-query-extension (function)
• *display-extensions* (special variable)
• +status-bad-request+ (constant)
• +status-bad-value+ (constant)
• +status-bad-window+ (constant)
• +status-success+ (constant)
• _xdisplay-tclass (class)
• default-depth (function)
• default-visual (function)
• display-height (function)
• display-width (function)
• error-base (method)
• event-base (method)
• extension-data (class)
• get-display-extension-data (function)
• (setf get-display-extension-data) (function)
• get-visual-info (function)
• name (method)
• opcode (method)
• process-event (function)
• process-generic-event (function)
• root-window (function)
• set-window-attributes-tclass (class)
• visual-info-tclass (class)
• visual-tclass (class)
• with-current-display (macro)
• x-button-event-tclass (class)
• x-client-message-event-tclass (class)
• x-compose-status-tclass (class)
• x-configure-event-tclass (class)
• x-create-color-map (function)
• x-create-simple-window (function)
• x-create-window-event-tclass (class)
• x-destroy-window-event-tclass (class)
• x-error-event-tclass (class)
• x-expose-event-tclass (class)
• x-focus-change-event-tclass (class)
• x-free-event-data (function)
• x-free-gc (function)
• x-free-pixmap (function)
• x-generic-event-cookie-tclass (class)
• x-get-atom-name (function)
• x-get-error-text (function)
• x-get-event-data (function)
• x-get-geometry (function)
• x-get-input-focus (function)
• x-get-window-attributes (function)
• x-get-wm-normal-hints (function)
• x-key-event-tclass (class)
• x-lookup-string (function)
• x-map-event-tclass (class)
• x-map-window (function)
• x-motion-event-tclass (class)
• x-pending-p (function)
• x-query-extension (function)
• x-query-tree (function)
• x-reparent-event-tclass (class)
• x-reparent-window (function)
• x-select-input (function)
• x-send-event (function)
• x-set-error-handler (function)
• x-set-input-focus (function)
• x-size-hints-tclass (class)
• x-sync (function)
• x-unmap-event-tclass (class)
• x-visibility-event-tclass (class)
• x-window-attributes-tclass (class)
• x-window-changes-tclass (class)
• xcolor-tclass (class)
• xgcvalues-tclass (class)

4.1.7 glop/src/x11/xkb.lisp

Dependency

xlib.lisp (file)

Parent

x11 (module)

Location

src/x11/xkb.lisp

Exported Definitions

xkb-set-detectable-auto-repeat (function)

4.1.8 glop/src/x11/xcomposite.lisp

Dependency

xkb.lisp (file)

Parent

x11 (module)

Location

src/x11/xcomposite.lisp

Internal Definitions

• %x-composite-query-extension (function)
• %x-composite-query-version (function)
• x-composite-create-region-from-border-clip (function)
• x-composite-get-overlay-window (function)
• x-composite-name-window-pixmap (function)
• x-composite-query-extension (function)
• x-composite-query-version (function)
• x-composite-redirect-subwindows (function)
• x-composite-redirect-window (function)
• x-composite-release-overlay-window (function)
• x-composite-unredirect-subwindows (function)
• x-composite-unredirect-window (function)
• x-composite-version (function)

4.1.9 glop/src/x11/glx.lisp

Dependency

xcomposite.lisp (file)

Parent

x11 (module)

Location

src/x11/glx.lisp

Exported Definitions

• correct-context? (function)
• glx-choose-fb-config (function)
• glx-choose-visual (function)
• glx-create-context (function)
• glx-create-specific-context (function)
• glx-destroy-context (function)
• glx-get-proc-address (function)
• glx-get-version (function)
• glx-get-visual-from-fb-config (function)
• glx-make-current (function)
• glx-release-context (function)
• glx-swap-buffers (function)
• glx-wait-gl (function)

Internal Definitions

• %glx-choose-fb-config (function)
• %glx-choose-visual (function)
• %glx-create-context (function)
• %glx-create-pixmap (function)
• %glx-get-fb-config-attrib (function)
• %glx-get-visual-from-fb-config (function)
• %glx-query-version (function)
• get-string (function)
• glx-create-pixmap (function)
• glx-destroy-pixmap (function)
• glx-get-config (function)
• glx-get-fb-config-attrib (function)

4.1.10 glop/src/x11/display-ctrl.lisp

Dependency

glx.lisp (file)

Parent

x11 (module)

Location

src/x11/display-ctrl.lisp

Exported Definitions

• current-mode (function)
• set-mode (function)
• supported-modes (function)

Internal Definitions

• xrr-config-current-configuration (function)
• xrr-config-current-rate (function)
• xrr-config-sizes (function)
• xrr-free-screen-config-info (function)
• xrr-get-screen-info (function)
• xrr-rates (function)
• xrr-screen-size-tclass (class)
• xrr-set-screen-config (function)
• xrr-set-screen-config-and-rate (function)

4.1.11 glop/src/x11/glop-x11.lisp

Dependency

display-ctrl.lisp (file)

Parent

x11 (module)

Location

src/x11/glop-x11.lisp

Exported Definitions

• attach-gl-context (method)
• close-window (method)
• create-gl-context (method)
• current-video-mode (method)
• destroy-gl-context (method)
• detach-gl-context (method)
• gl-get-proc-address (function)
• hide-cursor (method)
• hide-window (method)
• list-video-modes (method)
• open-window (method)
• set-fullscreen (method)
• set-geometry (method)
• set-video-mode (method)
• set-window-title (method)
• show-cursor (method)
• show-window (method)
• swap-buffers (method)

Internal Definitions

• %next-event (function)
• copy-glx-context (function)
• glx-context (structure)
• glx-context-ctx (function)
• (setf glx-context-ctx) (function)
• glx-context-display (function)
• (setf glx-context-display) (function)
• glx-context-p (function)
• make-glx-context (function)

4.1.12 glop/src/glop.lisp

Dependency

x11 (module)

Parent

src (module)

Location

src/glop.lisp

Exported Definitions

• attach-gl-context (generic function)
• button (method)
• button-event (class)
• button-press-event (class)
• button-release-event (class)
• close-event (class)
• close-window (generic function)
• create-gl-context (generic function)
• create-window (function)
• current-video-mode (generic function)
• destroy-gl-context (generic function)
• destroy-window (function)
• detach-gl-context (generic function)
• dispatch-events (macro)
• dx (method)
• dy (method)
• event (class)
• expose-event (class)
• focus-event (class)
• focus-in-event (class)
• focus-out-event (class)
• focused (method)
• height (method)
• height (method)
• height (method)
• height (method)
• hide-cursor (generic function)
• hide-window (generic function)
• key-event (class)
• key-press-event (class)
• key-release-event (class)
• keycode (method)
• keysym (method)
• list-video-modes (generic function)
• maximize-window (generic function)
• mouse-motion-event (class)
• next-event (generic function)
• next-event (method)
• on-button (generic function)
• on-close (generic function)
• on-draw (generic function)
• on-event (generic function)
• on-event (method)
• on-key (generic function)
• on-mouse-motion (generic function)
• on-resize (generic function)
• open-window (generic function)
• pressed (method)
• pressed (method)
• push-close-event (function)
• push-event (function)
• remove-window-decorations (generic function)
• resize-event (class)
• restore-window (generic function)
• restore-window-decorations (generic function)
• set-fullscreen (generic function)
• set-geometry (generic function)
• set-gl-window (function)
• set-video-mode (generic function)
• set-window-title (generic function)
• show-cursor (generic function)
• show-window (generic function)
• swap-buffers (generic function)
• swap-interval (generic function)
• swap-interval (method)
• text (method)
• toggle-fullscreen (function)
• visibility-event (class)
• visibility-obscured-event (class)
• visibility-unobscured-event (class)
• visible (method)
• visible (method)
• width (method)
• width (method)
• width (method)
• width (method)
• (setf window-height) (method)
• (setf window-width) (method)
• (setf window-x) (method)
• (setf window-y) (method)
• with-idle-forms (macro)
• with-window (macro)
• x (method)
• x (method)
• x (method)
• y (method)
• y (method)
• y (method)

Internal Definitions

• %init-swap-interval (generic function)
• %init-swap-interval (method)
• child (method)
• child-created-event (class)
• child-destroyed-event (class)
• child-event (class)
• child-reparent-event (class)
• child-resize-event (class)
• child-visibility-event (class)
• child-visibility-obscured-event (class)
• child-visibility-unobscured-event (class)
• closest-video-mode (function)
• define-simple-print-object (macro)
• on-focus (generic function)
• on-focus (method)
• on-visibility (generic function)
• on-visibility (method)
• parent (method)
• parent (method)
• parent (method)

5 Packages

Packages are listed by definition order.

5.1 glop

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• *ignore-auto-repeat* (special variable)
• attach-gl-context (generic function)
• attach-gl-context (method)
• button (generic function)
• button (method)
• button-event (class)
• button-press-event (class)
• button-release-event (class)
• close-event (class)
• close-window (generic function)
• close-window (method)
• create-gl-context (generic function)
• create-gl-context (method)
• create-window (function)
• current-video-mode (generic function)
• current-video-mode (method)
• destroy-gl-context (generic function)
• destroy-gl-context (method)
• destroy-window (function)
• detach-gl-context (generic function)
• detach-gl-context (method)
• dispatch-events (macro)
• dx (generic function)
• dx (method)
• dy (generic function)
• dy (method)
• event (class)
• expose-event (class)
• focus-event (class)
• focus-in-event (class)
• focus-out-event (class)
• focused (generic function)
• focused (method)
• gl-get-proc-address (function)
• height (generic function)
• height (method)
• height (method)
• height (method)
• height (method)
• hide-cursor (generic function)
• hide-cursor (method)
• hide-window (generic function)
• hide-window (method)
• key-event (class)
• key-press-event (class)
• key-pressed (function)
• (setf key-pressed) (setf expander)
• key-release-event (class)
• keycode (generic function)
• keycode (method)
• keysym (generic function)
• keysym (method)
• list-video-modes (generic function)
• list-video-modes (method)
• load-libraries (function)
• maximize-window (generic function)
• mouse-motion-event (class)
• next-event (generic function)
• next-event (method)
• on-button (generic function)
• on-close (generic function)
• on-draw (generic function)
• on-event (generic function)
• on-event (method)
• on-key (generic function)
• on-mouse-motion (generic function)
• on-resize (generic function)
• open-window (generic function)
• open-window (method)
• pressed (generic function)
• pressed (method)
• pressed (method)
• push-close-event (function)
• push-event (function)
• remove-window-decorations (generic function)
• resize-event (class)
• restore-window (generic function)
• restore-window-decorations (generic function)
• set-fullscreen (generic function)
• set-fullscreen (method)
• set-geometry (generic function)
• set-geometry (method)
• set-gl-window (function)
• set-video-mode (generic function)
• set-video-mode (method)
• set-window-title (generic function)
• set-window-title (method)
• show-cursor (generic function)
• show-cursor (method)
• show-window (generic function)
• show-window (method)
• swap-buffers (generic function)
• swap-buffers (method)
• swap-interval (generic function)
• swap-interval (method)
• text (generic function)
• text (method)
• toggle-fullscreen (function)
• visibility-event (class)
• visibility-obscured-event (class)
• visibility-unobscured-event (class)
• visible (generic function)
• visible (method)
• visible (method)
• width (generic function)
• width (method)
• width (method)
• width (method)
• width (method)
• window (class)
• window-gl-context (generic function)
• window-gl-context (method)
• (setf window-gl-context) (method)
• (setf window-gl-context) (generic function)
• window-height (generic function)
• window-height (method)
• (setf window-height) (method)
• (setf window-height) (generic function)
• window-width (generic function)
• window-width (method)
• (setf window-width) (method)
• (setf window-width) (generic function)
• window-x (generic function)
• window-x (method)
• (setf window-x) (method)
• (setf window-x) (generic function)
• window-y (generic function)
• window-y (method)
• (setf window-y) (method)
• (setf window-y) (generic function)
• with-idle-forms (macro)
• with-window (macro)
• x (generic function)
• x (method)
• x (method)
• x (method)
• x11-window-display (generic function)
• x11-window-display (method)
• (setf x11-window-display) (method)
• (setf x11-window-display) (generic function)
• x11-window-id (generic function)
• x11-window-id (method)
• (setf x11-window-id) (method)
• (setf x11-window-id) (generic function)
• y (generic function)
• y (method)
• y (method)
• y (method)

Internal Definitions

• %init-swap-interval (generic function)
• %init-swap-interval (method)
• %key-states% (special variable)
• %next-event (function)
• %update-geometry (function)
• child (generic function)
• child (method)
• child-created-event (class)
• child-destroyed-event (class)
• child-event (class)
• child-reparent-event (class)
• child-resize-event (class)
• child-visibility-event (class)
• child-visibility-obscured-event (class)
• child-visibility-unobscured-event (class)
• closest-video-mode (function)
• copy-glx-context (function)
• copy-video-mode (function)
• copy-x11-video-mode (function)
• defdfun (macro)
• defdmacro (macro)
• define-simple-print-object (macro)
• glop-error (condition)
• glx-context (structure)
• glx-context-ctx (function)
• (setf glx-context-ctx) (function)
• glx-context-display (function)
• (setf glx-context-display) (function)
• glx-context-p (function)
• make-glx-context (function)
• make-video-mode (function)
• make-x11-video-mode (function)
• not-implemented (condition)
• on-focus (generic function)
• on-focus (method)
• on-visibility (generic function)
• on-visibility (method)
• parent (generic function)
• parent (method)
• parent (method)
• parent (method)
• parse-gl-version-string-values (function)
• swap-interval-function (generic function)
• swap-interval-function (method)
• (setf swap-interval-function) (method)
• (setf swap-interval-function) (generic function)
• swap-interval-mixin (class)
• swap-interval-tear (generic function)
• swap-interval-tear (method)
• (setf swap-interval-tear) (method)
• (setf swap-interval-tear) (generic function)
• video-mode (structure)
• video-mode-depth (function)
• (setf video-mode-depth) (function)
• video-mode-height (function)
• (setf video-mode-height) (function)
• video-mode-index (function)
• (setf video-mode-index) (function)
• video-mode-p (function)
• video-mode-rate (function)
• (setf video-mode-rate) (function)
• video-mode-width (function)
• (setf video-mode-width) (function)
• window-fullscreen (generic function)
• window-fullscreen (method)
• (setf window-fullscreen) (method)
• (setf window-fullscreen) (generic function)
• window-previous-video-mode (generic function)
• window-previous-video-mode (method)
• (setf window-previous-video-mode) (method)
• (setf window-previous-video-mode) (generic function)
• window-pushed-event (generic function)
• window-pushed-event (method)
• (setf window-pushed-event) (method)
• (setf window-pushed-event) (generic function)
• window-title (generic function)
• window-title (method)
• (setf window-title) (method)
• (setf window-title) (generic function)
• without-fp-traps (macro)
• x11-video-mode (structure)
• x11-video-mode-index (function)
• (setf x11-video-mode-index) (function)
• x11-video-mode-p (function)
• x11-video-mode-rate (function)
• (setf x11-video-mode-rate) (function)
• x11-window (class)
• x11-window-cursor (generic function)
• x11-window-cursor (method)
• (setf x11-window-cursor) (method)
• (setf x11-window-cursor) (generic function)
• x11-window-fb-config (generic function)
• x11-window-fb-config (method)
• (setf x11-window-fb-config) (method)
• (setf x11-window-fb-config) (generic function)
• x11-window-screen (generic function)
• x11-window-screen (method)
• (setf x11-window-screen) (method)
• (setf x11-window-screen) (generic function)
• x11-window-visual-infos (generic function)
• x11-window-visual-infos (method)
• (setf x11-window-visual-infos) (method)
• (setf x11-window-visual-infos) (generic function)

5.2 glop-glx

Source

package.lisp (file)

Use List

• glop-xlib
• cffi
• common-lisp

Exported Definitions

• correct-context? (function)
• glx-choose-fb-config (function)
• glx-choose-visual (function)
• glx-create-context (function)
• glx-create-specific-context (function)
• glx-destroy-context (function)
• glx-get-proc-address (function)
• glx-get-version (function)
• glx-get-visual-from-fb-config (function)
• glx-make-current (function)
• glx-release-context (function)
• glx-swap-buffers (function)
• glx-wait-gl (function)

Internal Definitions

• %glx-choose-fb-config (function)
• %glx-choose-visual (function)
• %glx-create-context (function)
• %glx-create-pixmap (function)
• %glx-get-fb-config-attrib (function)
• %glx-get-visual-from-fb-config (function)
• %glx-query-version (function)
• get-string (function)
• glx-create-pixmap (function)
• glx-destroy-pixmap (function)
• glx-get-config (function)
• glx-get-fb-config-attrib (function)

5.3 glop-xlib

Source

package.lisp (file)

Use List

• cffi
• common-lisp

Used By List

glop-glx

Exported Definitions

• %set-fullscreen (function)
• add-connection-watch (function)
• current-mode (function)
• default-screen (function)
• process-internal-connection (function)
• remove-connection-watch (function)
• set-mode (function)
• supported-modes (function)
• x-close-display (function)
• x-create-null-cursor (function)
• x-create-window (function)
• x-default-root-window (function)
• x-define-cursor (function)
• x-destroy-window (function)
• x-flush (function)
• x-free (function)
• x-free-cursor (function)
• x-intern-atom (function)
• x-map-raised (function)
• x-next-event (function)
• x-open-display (function)
• x-set-geometry (function)
• x-set-wm-protocols (function)
• x-store-name (function)
• x-undefine-cursor (function)
• x-unmap-window (function)
• xkb-set-detectable-auto-repeat (function)

Internal Definitions

• %generic-event-dispatch (generic function)
• %generic-event-dispatch (method)
• %x-close-display (function)
• %x-composite-query-extension (function)
• %x-composite-query-version (function)
• %x-configure-window (function)
• %x-create-gc (function)
• %x-create-pixmap (function)
• %x-create-pixmap-cursor (function)
• %x-create-window (function)
• %x-events-queued (function)
• %x-fill-rectangle (function)
• %x-get-atom-name (function)
• %x-get-geometry (function)
• %x-get-window-attributes (function)
• %x-get-wm-normal-hints (function)
• %x-lookup-string (function)
• %x-next-event (function)
• %x-open-display (function)
• %x-peek-event (function)
• %x-pending (function)
• %x-query-extension (function)
• *display-extensions* (special variable)
• +status-bad-request+ (constant)
• +status-bad-value+ (constant)
• +status-bad-window+ (constant)
• +status-success+ (constant)
• _xdisplay-tclass (class)
• default-depth (function)
• default-visual (function)
• display-height (function)
• display-width (function)
• error-base (generic function)
• error-base (method)
• event-base (generic function)
• event-base (method)
• extension-data (class)
• get-display-extension-data (function)
• (setf get-display-extension-data) (function)
• get-visual-info (function)
• name (generic function)
• name (method)
• opcode (generic function)
• opcode (method)
• process-event (function)
• process-generic-event (function)
• root-window (function)
• set-window-attributes-tclass (class)
• visual-info-tclass (class)
• visual-tclass (class)
• with-current-display (macro)
• x-button-event-tclass (class)
• x-client-message-event-tclass (class)
• x-compose-status-tclass (class)
• x-composite-create-region-from-border-clip (function)
• x-composite-get-overlay-window (function)
• x-composite-name-window-pixmap (function)
• x-composite-query-extension (function)
• x-composite-query-version (function)
• x-composite-redirect-subwindows (function)
• x-composite-redirect-window (function)
• x-composite-release-overlay-window (function)
• x-composite-unredirect-subwindows (function)
• x-composite-unredirect-window (function)
• x-composite-version (function)
• x-configure-event-tclass (class)
• x-create-color-map (function)
• x-create-simple-window (function)
• x-create-window-event-tclass (class)
• x-destroy-window-event-tclass (class)
• x-error-event-tclass (class)
• x-expose-event-tclass (class)
• x-focus-change-event-tclass (class)
• x-free-event-data (function)
• x-free-gc (function)
• x-free-pixmap (function)
• x-generic-event-cookie-tclass (class)
• x-get-atom-name (function)
• x-get-error-text (function)
• x-get-event-data (function)
• x-get-geometry (function)
• x-get-input-focus (function)
• x-get-window-attributes (function)
• x-get-wm-normal-hints (function)
• x-key-event-tclass (class)
• x-lookup-string (function)
• x-map-event-tclass (class)
• x-map-window (function)
• x-motion-event-tclass (class)
• x-pending-p (function)
• x-query-extension (function)
• x-query-tree (function)
• x-reparent-event-tclass (class)
• x-reparent-window (function)
• x-select-input (function)
• x-send-event (function)
• x-set-error-handler (function)
• x-set-input-focus (function)
• x-size-hints-tclass (class)
• x-sync (function)
• x-unmap-event-tclass (class)
• x-visibility-event-tclass (class)
• x-window-attributes-tclass (class)
• x-window-changes-tclass (class)
• xcolor-tclass (class)
• xgcvalues-tclass (class)
• xrr-config-current-configuration (function)
• xrr-config-current-rate (function)
• xrr-config-sizes (function)
• xrr-free-screen-config-info (function)
• xrr-get-screen-info (function)
• xrr-rates (function)
• xrr-screen-size-tclass (class)
• xrr-set-screen-config (function)
• xrr-set-screen-config-and-rate (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *ignore-auto-repeat*

When set to NIL, holding a key press will generate a sequence of key-press events. Otherwise, only one key-press event will be triggered.

Package

glop

Source

utils.lisp (file)

6.1.2 Macros

Macro: dispatch-events WINDOW &key BLOCKING ON-FOO

Process all pending system events and call corresponding methods. When :blocking is non-nil calls event handling func that will block until an event occurs.
Returns NIL on :CLOSE event, T otherwise.

Package

glop

Source

glop.lisp (file)

Macro: with-idle-forms WINDOW &body IDLE-FORMS

Package

glop

Source

glop.lisp (file)

Macro: with-window (WIN-SYM TITLE WIDTH HEIGHT &rest ATTRIBS) &body BODY

Creates a window and binds it to WIN-SYM. The window is detroyed when body exits.

Package

glop

Source

glop.lisp (file)

6.1.3 Functions

Function: %set-fullscreen WINDOW DPY BE-FULLSCREEN

Package

glop-xlib

Source

xlib.lisp (file)

Function: add-connection-watch DISPLAY PROCEDURE CLIENT-DATA

Package

glop-xlib

Source

xlib.lisp (file)

Function: correct-context? MAJOR-DESIRED MINOR-DESIRED

Package

glop-glx

Source

glx.lisp (file)

Function: create-window TITLE WIDTH HEIGHT &key X Y MAJOR MINOR FULLSCREEN WIN-CLASS DOUBLE-BUFFER STEREO RED-SIZE GREEN-SIZE BLUE-SIZE ALPHA-SIZE DEPTH-SIZE ACCUM-BUFFER ACCUM-RED-SIZE ACCUM-GREEN-SIZE ACCUM-BLUE-SIZE STENCIL-BUFFER STENCIL-SIZE PROFILE GL

Creates a new window with an attached GL context using the provided visual attributes.

Major and minor arguments specify the context version to use. When NIL (default value) old style gl context creation is used. Some combinations of platforms and drivers may require :PROFILE :CORE to use versions newer than 2.1, while others will use newest version even if version is not specified.

The created window will be of the WINDOW class, you can override this by specifying your own class using :WIN-CLASS.

Package

glop

Source

glop.lisp (file)

Function: current-mode DPY SCREEN

Package

glop-xlib

Source

display-ctrl.lisp (file)

Function: default-screen DISPLAY-PTR

Package

glop-xlib

Source

xlib.lisp (file)

Function: destroy-window WINDOW

Destroy the provided window and any attached GL context.

Package

glop

Source

glop.lisp (file)

Function: gl-get-proc-address PROC-NAME

Get foreign pointer to the GL extension designed by PROC-NAME.

Package

glop

Source

glop-x11.lisp (file)

Function: glx-choose-fb-config DPY SCREEN ATTRIBS

Package

glop-glx

Source

glx.lisp (file)

Function: glx-choose-visual DPY SCREEN ATTRIBS

Package

glop-glx

Source

glx.lisp (file)

Function: glx-create-context DPY VISUAL

Package

glop-glx

Source

glx.lisp (file)

Function: glx-create-specific-context DPY FBC CONTEXT-ATTRIBS

Package

glop-glx

Source

glx.lisp (file)

Function: glx-destroy-context DISPLAY-PTR CONTEXT

Package

glop-glx

Source

glx.lisp (file)

Function: glx-get-proc-address PROC-NAME

Package

glop-glx

Source

glx.lisp (file)

Function: glx-get-version DPY

Package

glop-glx

Source

glx.lisp (file)

Function: glx-get-visual-from-fb-config DISPLAY-PTR FB-CONFIG

Package

glop-glx

Source

glx.lisp (file)

Function: glx-make-current DISPLAY-PTR DRAWABLE CONTEXT

Package

glop-glx

Source

glx.lisp (file)

Function: glx-release-context DPY

Package

glop-glx

Source

glx.lisp (file)

Function: glx-swap-buffers DISPLAY-PTR DRAWABLE

Package

glop-glx

Source

glx.lisp (file)

Function: glx-wait-gl ()

Package

glop-glx

Source

glx.lisp (file)

Function: key-pressed KEYCODE

Package

glop

Source

utils.lisp (file)

Setf Expander

(setf key-pressed) (setf expander)

Setf Expander: (setf key-pressed) KEYCODE

Package

glop

Source

utils.lisp (file)

Reader

key-pressed (function)

Function: load-libraries ()

Package

glop

Source

utils.lisp (file)

Function: process-internal-connection DISPLAY FD

Package

glop-xlib

Source

xlib.lisp (file)

Function: push-close-event WINDOW

Push an artificial :close event into the event processing system.

Package

glop

Source

glop.lisp (file)

Function: push-event WINDOW EVT

Push an artificial event into the event processing system. Note that this has no effect on the underlying window system.

Package

glop

Source

glop.lisp (file)

Function: remove-connection-watch DISPLAY PROCEDURE CLIENT-DATA

Package

glop-xlib

Source

xlib.lisp (file)

Function: set-gl-window WINDOW

Make WINDOW current for GL rendering.

Package

glop

Source

glop.lisp (file)

Function: set-mode DPY SCREEN MODE-INDEX &optional RATE

Package

glop-xlib

Source

display-ctrl.lisp (file)

Function: supported-modes DPY SCREEN

Package

glop-xlib

Source

display-ctrl.lisp (file)

Function: toggle-fullscreen WINDOW

Attempt to change display mode to the mode closest to geometry and set window fullscreen state.

Package

glop

Source

glop.lisp (file)

Function: x-close-display DISPLAY

Package

glop-xlib

Source

xlib.lisp (file)

Function: x-create-null-cursor DPY WIN

Package

glop-xlib

Source

xlib.lisp (file)

Function: x-create-window DPY PARENT X Y WIDTH HEIGHT VISUAL-INFOS

Package

glop-xlib

Source

xlib.lisp (file)

Function: x-default-root-window DISPLAY-PTR

Package

glop-xlib

Source

xlib.lisp (file)

Function: x-define-cursor DISPLAY-PTR WIN CURSOR

Package

glop-xlib

Source

xlib.lisp (file)

Function: x-destroy-window DISPLAY-PTR WIN

Package

glop-xlib

Source

xlib.lisp (file)

Function: x-flush DISPLAY-PTR

Package

glop-xlib

Source

xlib.lisp (file)

Function: x-free DATA

Package

glop-xlib

Source

xlib.lisp (file)

Function: x-free-cursor DISPLAY-PTR CURSOR

Package

glop-xlib

Source

xlib.lisp (file)

Function: x-intern-atom DISPLAY-PTR ATOM-NAME ONLY-IF-EXISTS

Package

glop-xlib

Source

xlib.lisp (file)

Function: x-map-raised DISPLAY-PTR WIN

Package

glop-xlib

Source

xlib.lisp (file)

Function: x-next-event WIN DPY &optional BLOCKING

Package

glop-xlib

Source

xlib.lisp (file)

Function: x-open-display &optional DISPLAY-NAME

Package

glop-xlib

Source

xlib.lisp (file)

Function: x-set-geometry DPY WIN X Y WIDTH HEIGHT

Package

glop-xlib

Source

xlib.lisp (file)

Function: x-set-wm-protocols DISPLAY-PTR WIN ATOMS COUNT

Package

glop-xlib

Source

xlib.lisp (file)

Function: x-store-name DISPLAY-PTR WIN NAME

Package

glop-xlib

Source

xlib.lisp (file)

Function: x-undefine-cursor DISPLAY-PTR WIN

Package

glop-xlib

Source

xlib.lisp (file)

Function: x-unmap-window DISPLAY-PTR WIN

Package

glop-xlib

Source

xlib.lisp (file)

Function: xkb-set-detectable-auto-repeat DISPLAY-PTR DETECTABLE SUPPORTED-RETURN

Package

glop-xlib

Source

xkb.lisp (file)

6.1.4 Generic functions

Generic Function: attach-gl-context WINDOW CTX

Makes CTX the current OpenGL context and attach it to WINDOW.

Package

glop

Source

glop.lisp (file)

Methods

Method: attach-gl-context (WIN x11-window) (CTX glx-context)

Source

glop-x11.lisp (file)

Generic Function: button OBJECT

Package

glop

Methods

Method: button (BUTTON-EVENT button-event)

automatically generated reader method

Source

glop.lisp (file)

Generic Function: close-window WINDOW

Closes the provided window *without* releasing any attached GL context.

Package

glop

Source

glop.lisp (file)

Methods

Method: close-window (WIN x11-window)

Source

glop-x11.lisp (file)

Generic Function: create-gl-context WINDOW &key MAKE-CURRENT MAJOR MINOR FORWARD-COMPAT DEBUG PROFILE

Creates a new OpenGL context of the specified version for the provided window
and optionally make it current (default). If major and minor are NIL old style context creation is used. Otherwise a context compatible with minimum major.minor version is created.
If you request a specific context version, you may use the additional arguments to setup context options.
The foward-compat argument specify whether to disallow legacy functionalities (only for
GL version >= 3.0). The debug argument specify whether a debug context should be created. You may request a specific context profile by specifiying either
:core or :compat as the profile argument value.

Package

glop

Source

glop.lisp (file)

Methods

Method: create-gl-context (WIN x11-window) &key MAKE-CURRENT MAJOR MINOR FORWARD-COMPAT DEBUG PROFILE

Source

glop-x11.lisp (file)

Generic Function: current-video-mode ()

Returns the current video mode.

Package

glop

Source

glop.lisp (file)

Methods

Method: current-video-mode ()

Source

glop-x11.lisp (file)

Generic Function: destroy-gl-context CTX

Detach and release the provided OpenGL context.

Package

glop

Source

glop.lisp (file)

Methods

Method: destroy-gl-context (CTX glx-context)

Source

glop-x11.lisp (file)

Generic Function: detach-gl-context CTX

Make the provided OpenGL context no longer current.

Package

glop

Source

glop.lisp (file)

Methods

Method: detach-gl-context (CTX glx-context)

Source

glop-x11.lisp (file)

Generic Function: dx OBJECT

Package

glop

Methods

Method: dx (MOUSE-MOTION-EVENT mouse-motion-event)

automatically generated reader method

Source

glop.lisp (file)

Generic Function: dy OBJECT

Package

glop

Methods

Method: dy (MOUSE-MOTION-EVENT mouse-motion-event)

automatically generated reader method

Source

glop.lisp (file)

Generic Function: focused OBJECT

Package

glop

Methods

Method: focused (FOCUS-EVENT focus-event)

automatically generated reader method

Source

glop.lisp (file)

Generic Function: height OBJECT

Package

glop

Methods

Method: height (CHILD-RESIZE-EVENT child-resize-event)

automatically generated reader method

Source

glop.lisp (file)

Method: height (CHILD-CREATED-EVENT child-created-event)

automatically generated reader method

Source

glop.lisp (file)

Method: height (RESIZE-EVENT resize-event)

automatically generated reader method

Source

glop.lisp (file)

Method: height (EXPOSE-EVENT expose-event)

automatically generated reader method

Source

glop.lisp (file)

Generic Function: hide-cursor WINDOW

Disable cursor display for WINDOW

Package

glop

Source

glop.lisp (file)

Methods

Method: hide-cursor (WIN x11-window)

Source

glop-x11.lisp (file)

Generic Function: hide-window WINDOW

Make WINDOW not visible.

Package

glop

Source

glop.lisp (file)

Methods

Method: hide-window (WIN x11-window)

Source

glop-x11.lisp (file)

Generic Function: keycode OBJECT

Package

glop

Methods

Method: keycode (KEY-EVENT key-event)

automatically generated reader method

Source

glop.lisp (file)

Generic Function: keysym OBJECT

Package

glop

Methods

Method: keysym (KEY-EVENT key-event)

automatically generated reader method

Source

glop.lisp (file)

Generic Function: list-video-modes ()

Returns a list of all available video modes as a list video-mode structs.

Package

glop

Source

glop.lisp (file)

Methods

Method: list-video-modes ()

Source

glop-x11.lisp (file)

Generic Function: maximize-window WINDOW

’Maximize’ a window to fill screen, without changing screen mode or window decoractions.

Package

glop

Source

glop.lisp (file)

Generic Function: next-event WINDOW &key BLOCKING

Returns next available event for manual processing. If :blocking is true, wait for an event.

Package

glop

Source

glop.lisp (file)

Methods

Method: next-event (WIN window) &key BLOCKING

Generic Function: on-button WINDOW PRESSED BUTTON

Package

glop

Source

glop.lisp (file)

Generic Function: on-close WINDOW

Package

glop

Source

glop.lisp (file)

Generic Function: on-draw WINDOW

Package

glop

Source

glop.lisp (file)

Generic Function: on-event WINDOW EVENT

Package

glop

Source

glop.lisp (file)

Methods

Method: on-event WINDOW EVENT

Generic Function: on-key WINDOW PRESSED KEYCODE KEYSYM STRING

Package

glop

Source

glop.lisp (file)

Generic Function: on-mouse-motion WINDOW X Y DX DY

Package

glop

Source

glop.lisp (file)

Generic Function: on-resize WINDOW W H

Package

glop

Source

glop.lisp (file)

Generic Function: open-window WINDOW TITLE WIDTH HEIGHT &key X Y RGBA DOUBLE-BUFFER STEREO RED-SIZE GREEN-SIZE BLUE-SIZE ALPHA-SIZE DEPTH-SIZE ACCUM-BUFFER ACCUM-RED-SIZE ACCUM-GREEN-SIZE ACCUM-BLUE-SIZE STENCIL-BUFFER STENCIL-SIZE PARENT

Creates a new window *without* any GL context.

Package

glop

Source

glop.lisp (file)

Methods

Method: open-window (WIN x11-window) TITLE WIDTH HEIGHT &key X Y RGBA DOUBLE-BUFFER STEREO RED-SIZE GREEN-SIZE BLUE-SIZE ALPHA-SIZE DEPTH-SIZE ACCUM-BUFFER ACCUM-RED-SIZE ACCUM-GREEN-SIZE ACCUM-BLUE-SIZE STENCIL-BUFFER STENCIL-SIZE PARENT

Source

glop-x11.lisp (file)

Generic Function: pressed OBJECT

Package

glop

Methods

Method: pressed (BUTTON-EVENT button-event)

automatically generated reader method

Source

glop.lisp (file)

Method: pressed (KEY-EVENT key-event)

automatically generated reader method

Source

glop.lisp (file)

Generic Function: remove-window-decorations WINDOW

Remove window border, title, etc. if possible.

Package

glop

Source

glop.lisp (file)

Generic Function: restore-window WINDOW

Undo the effects of MAXIMIZE-WINDOW

Package

glop

Source

glop.lisp (file)

Generic Function: restore-window-decorations WINDOW

Restore window border, title, etc.

Package

glop

Source

glop.lisp (file)

Generic Function: set-fullscreen WINDOW &optional STATE

Set window to fullscreen state.

Package

glop

Source

glop.lisp (file)

Methods

Method: set-fullscreen (WIN x11-window) &optional STATE

Source

glop-x11.lisp (file)

Generic Function: set-geometry WINDOW X Y WIDTH HEIGHT

Configure window geometry.

Package

glop

Source

glop.lisp (file)

Methods

Method: set-geometry (WIN x11-window) X Y WIDTH HEIGHT

Source

glop-x11.lisp (file)

Generic Function: set-video-mode MODE

Attempts to set the provided video mode.

Package

glop

Source

glop.lisp (file)

Methods

Method: set-video-mode (MODE video-mode)

Source

glop-x11.lisp (file)

Generic Function: set-window-title WINDOW TITLE

Set WINDOW title to TITLE.

Package

glop

Source

glop.lisp (file)

Methods

Method: set-window-title (WIN x11-window) TITLE

Source

glop-x11.lisp (file)

Generic Function: show-cursor WINDOW

Enable cursor display for WINDOW

Package

glop

Source

glop.lisp (file)

Methods

Method: show-cursor (WIN x11-window)

Source

glop-x11.lisp (file)

Generic Function: show-window WINDOW

Make WINDOW visible. (may need to be called twice when window is shown for the first time on Windows.)

Package

glop

Source

glop.lisp (file)

Methods

Method: show-window (WIN x11-window)

Source

glop-x11.lisp (file)

Generic Function: swap-buffers WINDOW

Swaps GL buffers.

Package

glop

Source

glop.lisp (file)

Methods

Method: swap-buffers (WIN x11-window)

Source

glop-x11.lisp (file)

Generic Function: swap-interval WINDOW INTERVAL

Specify number of vsync intervals to wait before swap-buffers takes effect.

Use 0 for no vsync, 1 for normal vsync, 2 for 1/2 monitor refresh rate, etc.

If INTERVAL is negativem the absolute value is used, and when
supported swap won’t wait for vsync if specified interval has already elapsed.

May be ignored or only partially supported depending on platform and user settings.

Package

glop

Source

glop.lisp (file)

Methods

Method: swap-interval W I

Generic Function: text OBJECT

Package

glop

Methods

Method: text (KEY-EVENT key-event)

automatically generated reader method

Source

glop.lisp (file)

Generic Function: visible OBJECT

Package

glop

Methods

Method: visible (CHILD-VISIBILITY-EVENT child-visibility-event)

automatically generated reader method

Source

glop.lisp (file)

Method: visible (VISIBILITY-EVENT visibility-event)

automatically generated reader method

Source

glop.lisp (file)

Generic Function: width OBJECT

Package

glop

Methods

Method: width (CHILD-RESIZE-EVENT child-resize-event)

automatically generated reader method

Source

glop.lisp (file)

Method: width (CHILD-CREATED-EVENT child-created-event)

automatically generated reader method

Source

glop.lisp (file)

Method: width (RESIZE-EVENT resize-event)

automatically generated reader method

Source

glop.lisp (file)

Method: width (EXPOSE-EVENT expose-event)

automatically generated reader method

Source

glop.lisp (file)

Generic Function: window-gl-context OBJECT

Generic Function: (setf window-gl-context) NEW-VALUE OBJECT

Package

glop

Methods

Method: window-gl-context (WINDOW window)

automatically generated reader method

Source

utils.lisp (file)

Method: (setf window-gl-context) NEW-VALUE (WINDOW window)

automatically generated writer method

Source

utils.lisp (file)

Generic Function: window-height OBJECT

Generic Function: (setf window-height) NEW-VALUE OBJECT

Package

glop

Methods

Method: window-height (WINDOW window)

automatically generated reader method

Source

utils.lisp (file)

Method: (setf window-height) HEIGHT (WIN window)

Source

glop.lisp (file)

Generic Function: window-width OBJECT

Generic Function: (setf window-width) NEW-VALUE OBJECT

Package

glop

Methods

Method: window-width (WINDOW window)

automatically generated reader method

Source

utils.lisp (file)

Method: (setf window-width) WIDTH (WIN window)

Source

glop.lisp (file)

Generic Function: window-x OBJECT

Generic Function: (setf window-x) NEW-VALUE OBJECT

Package

glop

Methods

Method: window-x (WINDOW window)

automatically generated reader method

Source

utils.lisp (file)

Method: (setf window-x) X (WIN window)

Source

glop.lisp (file)

Generic Function: window-y OBJECT

Generic Function: (setf window-y) NEW-VALUE OBJECT

Package

glop

Methods

Method: window-y (WINDOW window)

automatically generated reader method

Source

utils.lisp (file)

Method: (setf window-y) Y (WIN window)

Source

glop.lisp (file)

Generic Function: x OBJECT

Package

glop

Methods

Method: x (CHILD-REPARENT-EVENT child-reparent-event)

automatically generated reader method

Source

glop.lisp (file)

Method: x (CHILD-CREATED-EVENT child-created-event)

automatically generated reader method

Source

glop.lisp (file)

Method: x (MOUSE-MOTION-EVENT mouse-motion-event)

automatically generated reader method

Source

glop.lisp (file)

Generic Function: x11-window-display OBJECT

Generic Function: (setf x11-window-display) NEW-VALUE OBJECT

Package

glop

Methods

Method: x11-window-display (X11-WINDOW x11-window)

automatically generated reader method

Source

utils.lisp (file)

Method: (setf x11-window-display) NEW-VALUE (X11-WINDOW x11-window)

automatically generated writer method

Source

utils.lisp (file)

Generic Function: x11-window-id OBJECT

Generic Function: (setf x11-window-id) NEW-VALUE OBJECT

Package

glop

Methods

Method: x11-window-id (X11-WINDOW x11-window)

automatically generated reader method

Source

utils.lisp (file)

Method: (setf x11-window-id) NEW-VALUE (X11-WINDOW x11-window)

automatically generated writer method

Source

utils.lisp (file)

Generic Function: y OBJECT

Package

glop

Methods

Method: y (CHILD-REPARENT-EVENT child-reparent-event)

automatically generated reader method

Source

glop.lisp (file)

Method: y (CHILD-CREATED-EVENT child-created-event)

automatically generated reader method

Source

glop.lisp (file)

Method: y (MOUSE-MOTION-EVENT mouse-motion-event)

automatically generated reader method

Source

glop.lisp (file)

6.1.5 Classes

Class: button-event ()

Mouse button press or release.

Package

glop

Source

glop.lisp (file)

Direct superclasses

event (class)

Direct subclasses

• button-press-event (class)
• button-release-event (class)

Direct methods

• print-object (method)
• pressed (method)
• button (method)

Direct slots

Slot: button

Initargs

:button

Readers

button (generic function)

Slot: pressed

Initargs

:pressed

Readers

pressed (generic function)

Class: button-press-event ()

Mouse button press.

Package

glop

Source

glop.lisp (file)

Direct superclasses

button-event (class)

Direct Default Initargs

Initarg	Value
:pressed	t

Class: button-release-event ()

Mouse button release.

Package

glop

Source

glop.lisp (file)

Direct superclasses

button-event (class)

Direct Default Initargs

Initarg	Value
:pressed	nil

Class: close-event ()

Window closed.

Package

glop

Source

glop.lisp (file)

Direct superclasses

event (class)

Class: event ()

Common ancestor for all events.

Package

glop

Source

glop.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• key-event (class)
• button-event (class)
• mouse-motion-event (class)
• expose-event (class)
• resize-event (class)
• close-event (class)
• visibility-event (class)
• focus-event (class)
• child-event (class)

Class: expose-event ()

Window expose.

Package

glop

Source

glop.lisp (file)

Direct superclasses

event (class)

Direct methods

• print-object (method)
• height (method)
• width (method)

Direct slots

Slot: width

Initargs

:width

Readers

width (generic function)

Slot: height

Initargs

:height

Readers

height (generic function)

Class: focus-event ()

Window focus state changed.

Package

glop

Source

glop.lisp (file)

Direct superclasses

event (class)

Direct subclasses

• focus-in-event (class)
• focus-out-event (class)

Direct methods

• print-object (method)
• focused (method)

Direct slots

Slot: focused

Initargs

:focused

Readers

focused (generic function)

Class: focus-in-event ()

Window received focus.

Package

glop

Source

glop.lisp (file)

Direct superclasses

focus-event (class)

Direct Default Initargs

Initarg	Value
:focused	t

Class: focus-out-event ()

Window lost focus.

Package

glop

Source

glop.lisp (file)

Direct superclasses

focus-event (class)

Direct Default Initargs

Initarg	Value
:focused	nil

Class: key-event ()

Keyboard key press or release.

Package

glop

Source

glop.lisp (file)

Direct superclasses

event (class)

Direct subclasses

• key-press-event (class)
• key-release-event (class)

Direct methods

• print-object (method)
• pressed (method)
• text (method)
• keysym (method)
• keycode (method)

Direct slots

Slot: keycode

Initargs

:keycode

Readers

keycode (generic function)

Slot: keysym

Initargs

:keysym

Readers

keysym (generic function)

Slot: text

Initargs

:text

Readers

text (generic function)

Slot: pressed

Initargs

:pressed

Readers

pressed (generic function)

Class: key-press-event ()

Keyboard key press.

Package

glop

Source

glop.lisp (file)

Direct superclasses

key-event (class)

Direct Default Initargs

Initarg	Value
:pressed	t

Class: key-release-event ()

Keyboard key release.

Package

glop

Source

glop.lisp (file)

Direct superclasses

key-event (class)

Direct Default Initargs

Initarg	Value
:pressed	nil

Class: mouse-motion-event ()

Mouse motion.

Package

glop

Source

glop.lisp (file)

Direct superclasses

event (class)

Direct methods

• print-object (method)
• dy (method)
• dx (method)
• y (method)
• x (method)

Direct slots

Slot: x

Initargs

:x

Readers

x (generic function)

Slot: y

Initargs

:y

Readers

y (generic function)

Slot: dx

Initargs

:dx

Readers

dx (generic function)

Slot: dy

Initargs

:dy

Readers

dy (generic function)

Class: resize-event ()

Window resized.

Package

glop

Source

glop.lisp (file)

Direct superclasses

event (class)

Direct methods

• print-object (method)
• height (method)
• width (method)

Direct slots

Slot: width

Initargs

:width

Readers

width (generic function)

Slot: height

Initargs

:height

Readers

height (generic function)

Class: visibility-event ()

Window visibility changed.

Package

glop

Source

glop.lisp (file)

Direct superclasses

event (class)

Direct subclasses

• visibility-obscured-event (class)
• visibility-unobscured-event (class)

Direct methods

• print-object (method)
• visible (method)

Direct slots

Slot: visible

Initargs

:visible

Readers

visible (generic function)

Class: visibility-obscured-event ()

Window was fully obscured.

Package

glop

Source

glop.lisp (file)

Direct superclasses

visibility-event (class)

Direct Default Initargs

Initarg	Value
:visible	nil

Class: visibility-unobscured-event ()

Window was unobscured.

Package

glop

Source

glop.lisp (file)

Direct superclasses

visibility-event (class)

Direct Default Initargs

Initarg	Value
:visible	t

Class: window ()

Package

glop

Source

utils.lisp (file)

Direct superclasses

x11-window (class)

Direct methods

• next-event (method)
• window-height (method)
• window-width (method)
• window-y (method)
• window-x (method)
• window-previous-video-mode (method)
• window-previous-video-mode (method)
• window-fullscreen (method)
• window-fullscreen (method)
• window-pushed-event (method)
• window-pushed-event (method)
• window-gl-context (method)
• window-gl-context (method)
• window-title (method)
• window-title (method)
• window-height (method)
• window-width (method)
• window-y (method)
• window-x (method)

Direct slots

Slot: x

Initargs

:x

Initform

0

Readers

window-x (generic function)

Writers

(setf window-x) (generic function)

Slot: y

Initargs

:y

Initform

0

Readers

window-y (generic function)

Writers

(setf window-y) (generic function)

Slot: width

Initargs

:width

Initform

100

Readers

window-width (generic function)

Writers

(setf window-width) (generic function)

Slot: height

Initargs

:height

Initform

100

Readers

window-height (generic function)

Writers

(setf window-height) (generic function)

Slot: title

Initargs

:title

Initform

"glop"

Readers

window-title (generic function)

Writers

(setf window-title) (generic function)

Slot: gl-context

Readers

window-gl-context (generic function)

Writers

(setf window-gl-context) (generic function)

Slot: pushed-event

Readers

window-pushed-event (generic function)

Writers

(setf window-pushed-event) (generic function)

Slot: fullscreen

Readers

window-fullscreen (generic function)

Writers

(setf window-fullscreen) (generic function)

Slot: previous-video-mode

Readers

window-previous-video-mode (generic function)

Writers

(setf window-previous-video-mode) (generic function)