The bodge-host Reference Manual

1 Introduction
2 Systems
- 2.1 bodge-host
3 Files
- 3.1 Lisp
4 Packages
- 4.1 bodge-host
5 Definitions
- 5.1 Exported definitions
- 5.2 Internal definitions
Appendix A Indexes

The bodge-host Reference Manual

This is the bodge-host Reference Manual, version 1.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 11:50:00 2020 GMT+0.

1 Introduction

bodge-host

High-level lispy cross-platform interface to host OS.

2 Systems

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

2.1 `bodge-host`

Author

Pavel Korolev

Contact

dev@borodust.org

License

MIT

Description

OS-dependent routines

Version

1.0.0

Dependencies

bodge-utilities
cffi-c-ref
claw
bodge-libc-essentials
bodge-concurrency
bodge-math
bodge-glfw
glfw-blob
float-features

Source

bodge-host.asd (file)

Components

packages.lisp (file)
utils.lisp (file)
cursor.lisp (file)
monitor.lisp (file)
window.lisp (file)
controller.lisp (file)
host.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 `bodge-host.asd`

Location: /home/quickref/quicklisp/dists/quicklisp/software/bodge-host-stable-git/bodge-host.asd
Systems: bodge-host (system)

3.1.2 `bodge-host/packages.lisp`

Parent: bodge-host (system)
Location: packages.lisp
Packages: bodge-host

3.1.3 `bodge-host/utils.lisp`

Dependency

packages.lisp (file)

Parent

bodge-host (system)

Location

utils.lisp

Exported Definitions

bind-main-rendering-context (function)

Internal Definitions

*host-thread-p* (special variable)
*key-map* (special variable)
*mouse-button-map* (special variable)
+button-state-values+ (constant)
+expected-dpi+ (constant)
+keyboard-key-modifier-values+ (constant)
+keyboard-key-values+ (constant)
+mouse-button-values+ (constant)
button-state (type)
button-state-p (function)
check-host-thread (function)
find-window-by-handle (function)
glfw-enumval->button-state (function)
glfw-enumval->keyboard-key (function)
glfw-enumval->mouse-button (function)
keyboard-key (type)
keyboard-key->glfw-enumval (function)
keyboard-key-modifier (type)
keyboard-key-modifier-p (function)
keyboard-key-p (function)
mouse-button (type)
mouse-button->glfw-enumval (function)
mouse-button-p (function)
window-table-of (generic function)

3.1.4 `bodge-host/cursor.lisp`

Dependency

utils.lisp (file)

Parent

bodge-host (system)

Location

cursor.lisp

Exported Definitions

destroy-cursor (function)
make-standard-cursor (function)

Internal Definitions

+cursor-type-values+ (constant)
cursor-type (type)
cursor-type->glfw (function)
cursor-type-p (function)

3.1.5 `bodge-host/monitor.lisp`

Dependency

cursor.lisp (file)

Parent

bodge-host (system)

Location

monitor.lisp

Exported Definitions

available-monitors (function)
monitor-name (function)
monitor-position (function)
monitor-video-mode (function)
primary-monitor (function)
video-mode-blue-bits (function)
video-mode-green-bits (function)
video-mode-height (function)
video-mode-red-bits (function)
video-mode-refresh-rate (function)
video-mode-width (function)

Internal Definitions

monitor-content-scale (function)
primary-monitor-content-scale (function)

3.1.6 `bodge-host/window.lisp`

Dependency

monitor.lisp (file)

Parent

bodge-host (system)

Location

window.lisp

Exported Definitions

bind-shared-rendering-context (function)
cursor (function)
(setf cursor) (function)
cursor-position (function)
destroy-shared-rendering-context (function)
framebuffer-size (function)
(setf fullscreen-viewport-p) (function)
hide-window (function)
keyboard-button-state (function)
lock-cursor (function)
make-shared-rendering-context (function)
mouse-button-state (function)
on-character-input (generic function)
on-character-input (method)
on-controller-connect (generic function)
on-controller-connect (method)
on-controller-disconnect (generic function)
on-controller-disconnect (method)
on-cursor-movement (generic function)
on-cursor-movement (method)
on-destroy (generic function)
on-destroy (method)
on-dpad-action (generic function)
on-dpad-action (method)
on-framebuffer-size-change (generic function)
on-framebuffer-size-change (method)
on-gamepad-action (generic function)
on-gamepad-action (method)
on-gamepad-connect (generic function)
on-gamepad-connect (method)
on-gamepad-disconnect (generic function)
on-gamepad-disconnect (method)
on-hide (generic function)
on-hide (method)
on-init (generic function)
on-init (method)
on-key-action (generic function)
on-key-action (method)
on-left-stick-movement (generic function)
on-left-stick-movement (method)
on-left-trigger (generic function)
on-left-trigger (method)
on-log (generic function)
on-log (method)
on-mouse-action (generic function)
on-mouse-action (method)
on-right-stick-movement (generic function)
on-right-stick-movement (method)
on-right-trigger (generic function)
on-right-trigger (method)
on-scroll (generic function)
on-scroll (method)
on-viewport-size-change (generic function)
on-viewport-size-change (method)
release-rendering-context (function)
show-window (function)
swap-buffers (function)
unlock-cursor (function)
viewport-autoscaled-p (method)
viewport-position (function)
(setf viewport-position) (function)
viewport-scale (function)
viewport-size (function)
(setf viewport-size) (function)
(setf viewport-title) (function)
window (class)
window-monitor (function)
with-framebuffer-dimensions (macro)
with-viewport-dimensions (macro)

Internal Definitions

%bool (function)
%framebuffer-dimensions (function)
%handle-of (method)
%viewport-autoscale (function)
%viewport-dimensions (function)
%window-monitor (function)
+default-window-height+ (constant)
+default-window-width+ (constant)
calc-dpi-scale (function)
calc-scale (function)
create-window (function)
destroy-window (function)
init-callbacks (function)
init-window (function)
make-shared-context (function)
select-monitor (function)

3.1.7 `bodge-host/controller.lisp`

Dependency

window.lisp (file)

Parent

bodge-host (system)

Location

controller.lisp

Exported Definitions

controller-axes (function)
controller-axis-value (function)
controller-button-pressed-p (function)
controller-buttons (function)
controller-guid (function)
(setf controller-guid) (function)
controller-hat-state (function)
controller-hats (function)
controller-name (function)
gamepad-guid (function)
(setf gamepad-guid) (function)
gamepad-name (function)
(setf gamepad-name) (function)
gamepad-state (function)
gamepad-state-button-pressed-p (function)
gamepad-state-dpad (function)
gamepad-state-left-stick (function)
gamepad-state-left-trigger (function)
gamepad-state-right-stick (function)
gamepad-state-right-trigger (function)

Internal Definitions

%gamepad-button-pressed-p (function)
%make-axis (function)
%make-button (function)
%make-controller (function)
%make-gamepad (function)
%make-hat (function)
axis (structure)
axis-controller-id (function)
axis-id (function)
axis-p (function)
button (structure)
button-controller-id (function)
button-id (function)
button-p (function)
controller (structure)
controller-hub-controllers (function)
controller-hub-gamepads (function)
controller-id (function)
controller-p (function)
copy-axis (function)
copy-button (function)
copy-controller (function)
copy-gamepad (function)
copy-hat (function)
destroy-controller-hub (function)
destroy-gamepad (function)
find-controller (function)
find-gamepad (function)
for-each-updated-gamepad (function)
gamepad (structure)
gamepad-%state (function)
(setf gamepad-%state) (function)
gamepad-button->nk (function)
gamepad-id (function)
(setf gamepad-id) (function)
gamepad-p (function)
glfw->hat-state (function)
hat (structure)
hat-controller-id (function)
hat-id (function)
hat-p (function)
make-controller (function)
make-controller-hub (function)
make-gamepad (function)
register-controller (function)
remove-controller (function)

3.1.8 `bodge-host/host.lisp`

Dependency

controller.lisp (file)

Parent

bodge-host (system)

Location

host.lisp

Exported Definitions

*event-wait-timeout* (special variable)
close-window (function)
list-controllers (function)
list-gamepads (function)
open-window (function)
progm (macro)
push-to-main-thread (function)
swap-interval (function)
(setf swap-interval) (function)
update-gamepad-mappings (function)

Internal Definitions

%update-gamepad-mappings (function)
*context* (special variable)
*gamepad-buttons* (special variable)
context-enabled-p (function)
do-windows (macro)
ensure-context (function)
for-each-window (function)
host-context (class)
init-context (function)
init-main-loop (function)
invoke-controller-listeners (function)
register-window (function)
release-context (function)
remove-window (function)
run-main-loop (function)
sweep-context (function)
update-gamepads (function)
window-table-of (method)
with-context-locked (macro)

4 Packages

Packages are listed by definition order.

4.1 `bodge-host`

Source

packages.lisp (file)

Use List

cffi-c-ref
bodge-math
bodge-util
bodge-concurrency
common-lisp

Exported Definitions

*event-wait-timeout* (special variable)
available-monitors (function)
bind-main-rendering-context (function)
bind-shared-rendering-context (function)
close-window (function)
controller-axes (function)
controller-axis-value (function)
controller-button-pressed-p (function)
controller-buttons (function)
controller-guid (function)
(setf controller-guid) (function)
controller-hat-state (function)
controller-hats (function)
controller-name (function)
cursor (function)
(setf cursor) (function)
cursor-position (function)
destroy-cursor (function)
destroy-shared-rendering-context (function)
framebuffer-size (function)
(setf fullscreen-viewport-p) (function)
gamepad-guid (function)
(setf gamepad-guid) (function)
gamepad-name (function)
(setf gamepad-name) (function)
gamepad-state (function)
gamepad-state-button-pressed-p (function)
gamepad-state-dpad (function)
gamepad-state-left-stick (function)
gamepad-state-left-trigger (function)
gamepad-state-right-stick (function)
gamepad-state-right-trigger (function)
hide-window (function)
keyboard-button-state (function)
list-controllers (function)
list-gamepads (function)
lock-cursor (function)
make-shared-rendering-context (function)
make-standard-cursor (function)
monitor-name (function)
monitor-position (function)
monitor-video-mode (function)
mouse-button-state (function)
on-character-input (generic function)
on-character-input (method)
on-controller-connect (generic function)
on-controller-connect (method)
on-controller-disconnect (generic function)
on-controller-disconnect (method)
on-cursor-movement (generic function)
on-cursor-movement (method)
on-destroy (generic function)
on-destroy (method)
on-dpad-action (generic function)
on-dpad-action (method)
on-framebuffer-size-change (generic function)
on-framebuffer-size-change (method)
on-gamepad-action (generic function)
on-gamepad-action (method)
on-gamepad-connect (generic function)
on-gamepad-connect (method)
on-gamepad-disconnect (generic function)
on-gamepad-disconnect (method)
on-hide (generic function)
on-hide (method)
on-init (generic function)
on-init (method)
on-key-action (generic function)
on-key-action (method)
on-left-stick-movement (generic function)
on-left-stick-movement (method)
on-left-trigger (generic function)
on-left-trigger (method)
on-log (generic function)
on-log (method)
on-mouse-action (generic function)
on-mouse-action (method)
on-right-stick-movement (generic function)
on-right-stick-movement (method)
on-right-trigger (generic function)
on-right-trigger (method)
on-scroll (generic function)
on-scroll (method)
on-viewport-size-change (generic function)
on-viewport-size-change (method)
open-window (function)
primary-monitor (function)
progm (macro)
push-to-main-thread (function)
release-rendering-context (function)
show-window (function)
swap-buffers (function)
swap-interval (function)
(setf swap-interval) (function)
unlock-cursor (function)
update-gamepad-mappings (function)
video-mode-blue-bits (function)
video-mode-green-bits (function)
video-mode-height (function)
video-mode-red-bits (function)
video-mode-refresh-rate (function)
video-mode-width (function)
viewport-autoscaled-p (generic function)
viewport-autoscaled-p (method)
viewport-position (function)
(setf viewport-position) (function)
viewport-scale (function)
viewport-size (function)
(setf viewport-size) (function)
(setf viewport-title) (function)
window (class)
window-monitor (function)
with-framebuffer-dimensions (macro)
with-viewport-dimensions (macro)

Internal Definitions

%bool (function)
%framebuffer-dimensions (function)
%gamepad-button-pressed-p (function)
%handle-of (generic function)
%handle-of (method)
%make-axis (function)
%make-button (function)
%make-controller (function)
%make-gamepad (function)
%make-hat (function)
%update-gamepad-mappings (function)
%viewport-autoscale (function)
%viewport-dimensions (function)
%window-monitor (function)
*context* (special variable)
*gamepad-buttons* (special variable)
*host-thread-p* (special variable)
*key-map* (special variable)
*mouse-button-map* (special variable)
*window* (special variable)
+button-state-values+ (constant)
+cursor-type-values+ (constant)
+default-window-height+ (constant)
+default-window-width+ (constant)
+expected-dpi+ (constant)
+keyboard-key-modifier-values+ (constant)
+keyboard-key-values+ (constant)
+mouse-button-values+ (constant)
axis (structure)
axis-controller-id (function)
axis-id (function)
axis-p (function)
button (structure)
button-controller-id (function)
button-id (function)
button-p (function)
button-state (type)
button-state-p (function)
calc-dpi-scale (function)
calc-scale (function)
check-host-thread (function)
context-enabled-p (function)
controller (structure)
controller-hub-controllers (function)
controller-hub-gamepads (function)
controller-id (function)
controller-p (function)
copy-axis (function)
copy-button (function)
copy-controller (function)
copy-gamepad (function)
copy-hat (function)
create-window (function)
cursor-type (type)
cursor-type->glfw (function)
cursor-type-p (function)
destroy-controller-hub (function)
destroy-gamepad (function)
destroy-window (function)
do-windows (macro)
ensure-context (function)
find-controller (function)
find-gamepad (function)
find-window-by-handle (function)
for-each-updated-gamepad (function)
for-each-window (function)
gamepad (structure)
gamepad-%state (function)
(setf gamepad-%state) (function)
gamepad-button->nk (function)
gamepad-id (function)
(setf gamepad-id) (function)
gamepad-p (function)
glfw->hat-state (function)
glfw-enumval->button-state (function)
glfw-enumval->keyboard-key (function)
glfw-enumval->mouse-button (function)
hat (structure)
hat-controller-id (function)
hat-id (function)
hat-p (function)
host-context (class)
init-callbacks (function)
init-context (function)
init-main-loop (function)
init-window (function)
invoke-controller-listeners (function)
keyboard-key (type)
keyboard-key->glfw-enumval (function)
keyboard-key-modifier (type)
keyboard-key-modifier-p (function)
keyboard-key-p (function)
make-controller (function)
make-controller-hub (function)
make-gamepad (function)
make-shared-context (function)
monitor-content-scale (function)
mouse-button (type)
mouse-button->glfw-enumval (function)
mouse-button-p (function)
primary-monitor-content-scale (function)
register-controller (function)
register-window (function)
release-context (function)
remove-controller (function)
remove-window (function)
run-main-loop (function)
select-monitor (function)
sweep-context (function)
update-gamepads (function)
window-table-of (generic function)
window-table-of (method)
with-context-locked (macro)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *event-wait-timeout*

Package: bodge-host
Source: host.lisp (file)

5.1.2 Macros

Macro: progm &body BODY

Package: bodge-host
Source: host.lisp (file)

Macro: with-framebuffer-dimensions (WIDTH HEIGHT) WINDOW &body BODY

Package: bodge-host
Source: window.lisp (file)

Macro: with-viewport-dimensions (WIDTH HEIGHT) WINDOW &body BODY

Package: bodge-host
Source: window.lisp (file)

5.1.3 Functions

Function: available-monitors ()

Package: bodge-host
Source: monitor.lisp (file)

Function: bind-main-rendering-context WINDOW

Package: bodge-host
Source: utils.lisp (file)

Function: bind-shared-rendering-context SHARED-CONTEXT

Package: bodge-host
Source: window.lisp (file)

Function: close-window WINDOW

Package: bodge-host
Source: host.lisp (file)

Function: controller-axes INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: controller-axis-value AXIS

Package: bodge-host
Source: controller.lisp (file)

Function: controller-button-pressed-p BUTTON

Package: bodge-host
Source: controller.lisp (file)

Function: controller-buttons INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: controller-guid INSTANCE

Function: (setf controller-guid) VALUE INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: controller-hat-state HAT

Package: bodge-host
Source: controller.lisp (file)

Function: controller-hats INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: controller-name INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: cursor WINDOW

Function: (setf cursor) CURSOR WINDOW

Package: bodge-host
Source: window.lisp (file)

Function: cursor-position WINDOW &optional RESULT-VEC

Package: bodge-host
Source: window.lisp (file)

Function: destroy-cursor CURSOR

Must be run from main thread (see progm macro)

Package: bodge-host
Source: cursor.lisp (file)

Function: destroy-shared-rendering-context CONTEXT

Package: bodge-host
Source: window.lisp (file)

Function: framebuffer-size WINDOW &optional RESULT-VEC

Package: bodge-host
Source: window.lisp (file)

Function: (setf fullscreen-viewport-p) VALUE WINDOW

Package: bodge-host
Source: window.lisp (file)

Function: gamepad-guid INSTANCE

Function: (setf gamepad-guid) VALUE INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: gamepad-name INSTANCE

Function: (setf gamepad-name) VALUE INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: gamepad-state GAMEPAD

Package: bodge-host
Source: controller.lisp (file)

Function: gamepad-state-button-pressed-p GAMEPAD-STATE BUTTON

Package: bodge-host
Source: controller.lisp (file)

Function: gamepad-state-dpad GAMEPAD-STATE

Package: bodge-host
Source: controller.lisp (file)

Function: gamepad-state-left-stick GAMEPAD-STATE &optional RESULT

Package: bodge-host
Source: controller.lisp (file)

Function: gamepad-state-left-trigger GAMEPAD-STATE

Package: bodge-host
Source: controller.lisp (file)

Function: gamepad-state-right-stick GAMEPAD-STATE &optional RESULT

Package: bodge-host
Source: controller.lisp (file)

Function: gamepad-state-right-trigger GAMEPAD-STATE

Package: bodge-host
Source: controller.lisp (file)

Function: hide-window WINDOW

Package: bodge-host
Source: window.lisp (file)

Function: keyboard-button-state WINDOW BUTTON

Package: bodge-host
Source: window.lisp (file)

Function: list-controllers ()

Package: bodge-host
Source: host.lisp (file)

Function: list-gamepads ()

Package: bodge-host
Source: host.lisp (file)

Function: lock-cursor WINDOW

Package: bodge-host
Source: window.lisp (file)

Function: make-shared-rendering-context WINDOW

Package: bodge-host
Source: window.lisp (file)

Function: make-standard-cursor CURSOR-TYPE

Must be run from main thread (see progm macro)

Package: bodge-host
Source: cursor.lisp (file)

Function: monitor-name MONITOR

Package: bodge-host
Source: monitor.lisp (file)

Function: monitor-position MONITOR &optional RESULT-VEC

Package: bodge-host
Source: monitor.lisp (file)

Function: monitor-video-mode MONITOR

Package: bodge-host
Source: monitor.lisp (file)

Function: mouse-button-state WINDOW BUTTON

Package: bodge-host
Source: window.lisp (file)

Function: open-window WINDOW

Package: bodge-host
Source: host.lisp (file)

Function: primary-monitor ()

Package: bodge-host
Source: monitor.lisp (file)

Function: push-to-main-thread FN

Package: bodge-host
Source: host.lisp (file)

Function: release-rendering-context ()

Package: bodge-host
Source: window.lisp (file)

Function: show-window WINDOW

Package: bodge-host
Source: window.lisp (file)

Function: swap-buffers WINDOW

Package: bodge-host
Source: window.lisp (file)

Function: swap-interval ()

Function: (setf swap-interval) VALUE

Package: bodge-host
Source: host.lisp (file)

Function: unlock-cursor WINDOW

Package: bodge-host
Source: window.lisp (file)

Function: update-gamepad-mappings MAPPINGS

Package: bodge-host
Source: host.lisp (file)

Function: video-mode-blue-bits VIDEO-MODE

Package: bodge-host
Source: monitor.lisp (file)

Function: video-mode-green-bits VIDEO-MODE

Package: bodge-host
Source: monitor.lisp (file)

Function: video-mode-height VIDEO-MODE

Package: bodge-host
Source: monitor.lisp (file)

Function: video-mode-red-bits VIDEO-MODE

Package: bodge-host
Source: monitor.lisp (file)

Function: video-mode-refresh-rate VIDEO-MODE

Package: bodge-host
Source: monitor.lisp (file)

Function: video-mode-width VIDEO-MODE

Package: bodge-host
Source: monitor.lisp (file)

Function: viewport-position WINDOW &optional RESULT-VEC

Function: (setf viewport-position) VALUE WINDOW

Package: bodge-host
Source: window.lisp (file)

Function: viewport-scale WINDOW &optional EXPECTED-DPI

Package: bodge-host
Source: window.lisp (file)

Function: viewport-size WINDOW &optional RESULT-VEC

Function: (setf viewport-size) VALUE WINDOW

Package: bodge-host
Source: window.lisp (file)

Function: (setf viewport-title) VALUE WINDOW

Package: bodge-host
Source: window.lisp (file)

Function: window-monitor WINDOW

Package: bodge-host
Source: window.lisp (file)

5.1.4 Generic functions

Generic Function: on-character-input WINDOW CHARACTER

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-character-input APP C

Generic Function: on-controller-connect WINDOW CONTROLLER

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-controller-connect WINDOW CONTROLLER

Generic Function: on-controller-disconnect WINDOW CONTROLLER

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-controller-disconnect WINDOW CONTROLLER

Generic Function: on-cursor-movement WINDOW X Y

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-cursor-movement APP X Y

Generic Function: on-destroy WINDOW

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-destroy APP

Generic Function: on-dpad-action WINDOW GAMEPAD STATE

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-dpad-action WINDOW GAMEPAD STATE

Generic Function: on-framebuffer-size-change WINDOW WIDTH HEIGHT

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-framebuffer-size-change APP W H

Generic Function: on-gamepad-action WINDOW GAMEPAD BUTTON STATE

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-gamepad-action WINDOW GAMEPAD BUTTON STATE

Generic Function: on-gamepad-connect WINDOW GAMEPAD

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-gamepad-connect WINDOW GAMEPAD

Generic Function: on-gamepad-disconnect WINDOW GAMEPAD

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-gamepad-disconnect WINDOW GAMEPAD

Generic Function: on-hide WINDOW

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-hide APP

Generic Function: on-init WINDOW

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-init APP

Generic Function: on-key-action WINDOW KEY STATE

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-key-action APP KEY STATE

Generic Function: on-left-stick-movement WINDOW GAMEPAD X Y

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-left-stick-movement WINDOW GAMEPAD X Y

Generic Function: on-left-trigger WINDOW GAMEPAD VALUE

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-left-trigger WINDOW GAMEPAD VALUE

Generic Function: on-log WINDOW LEVEL CONTROL-STRING &rest ARGUMENTS

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-log HANDLE LEVEL CONTROL-STRING &rest ARGUMENTS

Generic Function: on-mouse-action WINDOW BUTTON STATE

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-mouse-action APP KEY STATE

Generic Function: on-right-stick-movement WINDOW GAMEPAD X Y

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-right-stick-movement WINDOW GAMEPAD X Y

Generic Function: on-right-trigger WINDOW GAMEPAD VALUE

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-right-trigger WINDOW GAMEPAD VALUE

Generic Function: on-scroll WINDOW X-OFFSET Y-OFFSET

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-scroll APP X Y

Generic Function: on-viewport-size-change WINDOW WIDTH HEIGHT

Package

bodge-host

Source

window.lisp (file)

Methods

Method: on-viewport-size-change APP W H

Generic Function: viewport-autoscaled-p OBJECT

Package

bodge-host

Methods

Method: viewport-autoscaled-p (WINDOW window)

automatically generated reader method

Source: window.lisp (file)

5.1.5 Classes

Class: window ()

Package

bodge-host

Source

window.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

initialize-instance (method)
viewport-autoscaled-p (method)
%handle-of (method)

Direct slots

Slot: handle

Readers: %handle-of (generic function)

Slot: cursor

Slot: gl-major-version

Initform: 3

Slot: gl-minor-version

Initform: 3

Slot: title

Initargs: :title

Slot: height

Initargs: :height

Slot: width

Initargs: :width

Slot: resizable

Initargs: :resizable

Slot: decorated

Initargs: :decorated
Initform: t

Slot: transparent

Initargs: :transparent

Slot: floating

Initargs: :floating

Slot: maximized

Initargs: :maximized

Slot: samples

Initargs: :samples

Slot: position

Initargs: :position

Slot: autoscaled

Initargs: :autoscaled
Initform: t
Readers: viewport-autoscaled-p (generic function)

5.2 Internal definitions

5.2.1 Constants

Constant: +button-state-values+

Package: bodge-host
Source: utils.lisp (file)

Constant: +cursor-type-values+

Package: bodge-host
Source: cursor.lisp (file)

Constant: +default-window-height+

Package: bodge-host
Source: window.lisp (file)

Constant: +default-window-width+

Package: bodge-host
Source: window.lisp (file)

Constant: +expected-dpi+

Package: bodge-host
Source: utils.lisp (file)

Constant: +keyboard-key-modifier-values+

Package: bodge-host
Source: utils.lisp (file)

Constant: +keyboard-key-values+

Package: bodge-host
Source: utils.lisp (file)

Constant: +mouse-button-values+

Package: bodge-host
Source: utils.lisp (file)

5.2.2 Special variables

Special Variable: *context*

Package: bodge-host
Source: host.lisp (file)

Special Variable: *gamepad-buttons*

Package: bodge-host
Source: host.lisp (file)

Special Variable: *host-thread-p*

Package: bodge-host
Source: utils.lisp (file)

Special Variable: *key-map*

Package: bodge-host
Source: utils.lisp (file)

Special Variable: *mouse-button-map*

Package: bodge-host
Source: utils.lisp (file)

Special Variable: *window*

Package: bodge-host

5.2.3 Macros

Macro: do-windows (WIN) &body BODY

Package: bodge-host
Source: host.lisp (file)

Macro: with-context-locked &body BODY

Package: bodge-host
Source: host.lisp (file)

5.2.4 Functions

Function: %bool VAL

Package: bodge-host
Source: window.lisp (file)

Function: %framebuffer-dimensions WINDOW

Package: bodge-host
Source: window.lisp (file)

Function: %gamepad-button-pressed-p STATE BUTTON-ID

Package: bodge-host
Source: controller.lisp (file)

Function: %make-axis ID CONTROLLER-ID

Package: bodge-host
Source: controller.lisp (file)

Function: %make-button ID CONTROLLER-ID

Package: bodge-host
Source: controller.lisp (file)

Function: %make-controller ID NAME GUID AXES BUTTONS HATS

Package: bodge-host
Source: controller.lisp (file)

Function: %make-gamepad ID NAME GUID %STATE

Package: bodge-host
Source: controller.lisp (file)

Function: %make-hat ID CONTROLLER-ID

Package: bodge-host
Source: controller.lisp (file)

Function: %update-gamepad-mappings ()

Package: bodge-host
Source: host.lisp (file)

Function: %viewport-autoscale WINDOW

Package: bodge-host
Source: window.lisp (file)

Function: %viewport-dimensions WINDOW

Package: bodge-host
Source: window.lisp (file)

Function: %window-monitor WIN-HANDLE

Package: bodge-host
Source: window.lisp (file)

Function: axis-controller-id INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: axis-id INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: axis-p OBJECT

Package: bodge-host
Source: controller.lisp (file)

Function: button-controller-id INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: button-id INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: button-p OBJECT

Package: bodge-host
Source: controller.lisp (file)

Function: button-state-p VALUE0

Package: bodge-host
Source: utils.lisp (file)

Function: calc-dpi-scale MONITOR EXPECTED-DPI

Package: bodge-host
Source: window.lisp (file)

Function: calc-scale HANDLE EXPECTED-DPI

Package: bodge-host
Source: window.lisp (file)

Function: check-host-thread ()

Package: bodge-host
Source: utils.lisp (file)

Function: context-enabled-p ()

Package: bodge-host
Source: host.lisp (file)

Function: controller-hub-controllers HUB

Package: bodge-host
Source: controller.lisp (file)

Function: controller-hub-gamepads HUB

Package: bodge-host
Source: controller.lisp (file)

Function: controller-id INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: controller-p OBJECT

Package: bodge-host
Source: controller.lisp (file)

Function: copy-axis INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: copy-button INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: copy-controller INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: copy-gamepad INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: copy-hat INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: create-window WIDTH HEIGHT TITLE GL-MAJOR-VERSION GL-MINOR-VERSION &key SHARED VISIBLE SAMPLES DECORATED RESIZABLE TRANSPARENT FLOATING MAXIMIZED FOCUSED

Package: bodge-host
Source: window.lisp (file)

Function: cursor-type->glfw CURSOR-TYPE

Package: bodge-host
Source: cursor.lisp (file)

Function: cursor-type-p VALUE0

Package: bodge-host
Source: cursor.lisp (file)

Function: destroy-controller-hub HUB

Package: bodge-host
Source: controller.lisp (file)

Function: destroy-gamepad GAMEPAD

Package: bodge-host
Source: controller.lisp (file)

Function: destroy-window WINDOW

Package: bodge-host
Source: window.lisp (file)

Function: ensure-context INIT-TASK

Package: bodge-host
Source: host.lisp (file)

Function: find-controller HUB CONTROLLER-ID

Package: bodge-host
Source: controller.lisp (file)

Function: find-gamepad HUB GAMEPAD-ID

Package: bodge-host
Source: controller.lisp (file)

Function: find-window-by-handle WIN-HANDLE

Package: bodge-host
Source: utils.lisp (file)

Function: for-each-updated-gamepad HUB FU

Package: bodge-host
Source: controller.lisp (file)

Function: for-each-window FU

Package: bodge-host
Source: host.lisp (file)

Function: gamepad-%state INSTANCE

Function: (setf gamepad-%state) VALUE INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: gamepad-button->nk BUTTON

Package: bodge-host
Source: controller.lisp (file)

Function: gamepad-id INSTANCE

Function: (setf gamepad-id) VALUE INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: gamepad-p OBJECT

Package: bodge-host
Source: controller.lisp (file)

Function: glfw->hat-state STATE

Package: bodge-host
Source: controller.lisp (file)

Function: glfw-enumval->button-state VALUE

Package: bodge-host
Source: utils.lisp (file)

Function: glfw-enumval->keyboard-key VALUE

Package: bodge-host
Source: utils.lisp (file)

Function: glfw-enumval->mouse-button VALUE

Package: bodge-host
Source: utils.lisp (file)

Function: hat-controller-id INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: hat-id INSTANCE

Package: bodge-host
Source: controller.lisp (file)

Function: hat-p OBJECT

Package: bodge-host
Source: controller.lisp (file)

Function: init-callbacks WINDOW

Package: bodge-host
Source: window.lisp (file)

Function: init-context INIT-TASK

Package: bodge-host
Source: host.lisp (file)

Function: init-main-loop INIT-TASK

Package: bodge-host
Source: host.lisp (file)

Function: init-window WINDOW

Package: bodge-host
Source: window.lisp (file)

Function: invoke-controller-listeners CONTROLLER-FU GAMEPAD-FU JOYSTICK-ID

Package: bodge-host
Source: host.lisp (file)

Function: keyboard-key->glfw-enumval VALUE

Package: bodge-host
Source: utils.lisp (file)

Function: keyboard-key-modifier-p VALUE0

Package: bodge-host
Source: utils.lisp (file)

Function: keyboard-key-p VALUE0

Package: bodge-host
Source: utils.lisp (file)

Function: make-controller ID

Package: bodge-host
Source: controller.lisp (file)

Function: make-controller-hub ()

Package: bodge-host
Source: controller.lisp (file)

Function: make-gamepad JOYSTICK-ID

Package: bodge-host
Source: controller.lisp (file)

Function: make-shared-context WINDOW GL-MAJOR-VERSION GL-MINOR-VERSION

Package: bodge-host
Source: window.lisp (file)

Function: monitor-content-scale MONITOR

Package: bodge-host
Source: monitor.lisp (file)

Function: mouse-button->glfw-enumval VALUE

Package: bodge-host
Source: utils.lisp (file)

Function: mouse-button-p VALUE0

Package: bodge-host
Source: utils.lisp (file)

Function: primary-monitor-content-scale ()

Package: bodge-host
Source: monitor.lisp (file)

Function: register-controller HUB JOYSTICK-ID

Package: bodge-host
Source: controller.lisp (file)

Function: register-window WINDOW

Package: bodge-host
Source: host.lisp (file)

Function: release-context ()

Package: bodge-host
Source: host.lisp (file)

Function: remove-controller HUB JOYSTICK-ID

Package: bodge-host
Source: controller.lisp (file)

Function: remove-window WINDOW

Package: bodge-host
Source: host.lisp (file)

Function: run-main-loop ()

Package: bodge-host
Source: host.lisp (file)

Function: select-monitor X-WIN Y-WIN

Package: bodge-host
Source: window.lisp (file)

Function: sweep-context ()

Package: bodge-host
Source: host.lisp (file)

Function: update-gamepads ()

Package: bodge-host
Source: host.lisp (file)

5.2.5 Generic functions

Generic Function: %handle-of OBJECT

Package

bodge-host

Methods

Method: %handle-of (WINDOW window)

automatically generated reader method

Source: window.lisp (file)

Generic Function: window-table-of CONTEXT

Package

bodge-host

Source

utils.lisp (file)

Methods

Method: window-table-of (HOST-CONTEXT host-context)

automatically generated reader method

Source: host.lisp (file)

5.2.6 Structures

Structure: axis ()

Package

bodge-host

Source

controller.lisp (file)

Direct superclasses

structure-object (structure)

Direct subclasses

button (structure)
hat (structure)

Direct slots

Slot: id

Type: fixnum
Initform: 0
Readers: axis-id (function)
Writers: (setf axis-id) (function)

Slot: controller-id

Type: fixnum
Initform: 0
Readers: axis-controller-id (function)
Writers: (setf axis-controller-id) (function)

Structure: button ()

Package: bodge-host
Source: controller.lisp (file)
Direct superclasses: axis (structure)

Structure: controller ()

Package

bodge-host

Source

controller.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: id

Initform: 0
Readers: controller-id (function)
Writers: (setf controller-id) (function)

Slot: name

Type: string
Initform: ""
Readers: controller-name (function)
Writers: (setf controller-name) (function)

Slot: guid

Type: string
Initform: ""
Readers: controller-guid (function)
Writers: (setf controller-guid) (function)

Slot: axes

Type: list
Readers: controller-axes (function)
Writers: (setf controller-axes) (function)

Slot: buttons

Type: list
Readers: controller-buttons (function)
Writers: (setf controller-buttons) (function)

Slot: hats

Type: list
Readers: controller-hats (function)
Writers: (setf controller-hats) (function)

Structure: gamepad ()

Package

bodge-host

Source

controller.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: id

Type: fixnum
Initform: 0
Readers: gamepad-id (function)
Writers: (setf gamepad-id) (function)

Slot: name

Type: string
Initform: ""
Readers: gamepad-name (function)
Writers: (setf gamepad-name) (function)

Slot: guid

Type: string
Initform: ""
Readers: gamepad-guid (function)
Writers: (setf gamepad-guid) (function)

Slot: %state

Readers: gamepad-%state (function)
Writers: (setf gamepad-%state) (function)

Structure: hat ()

Package: bodge-host
Source: controller.lisp (file)
Direct superclasses: axis (structure)

5.2.7 Classes

Class: host-context ()

Package

bodge-host

Source

host.lisp (file)

Direct superclasses

lockable (class)

Direct methods

window-table-of (method)

Direct slots

Slot: task-queue

Initform: (bodge-concurrency:make-task-queue)

Slot: enabled-p

Slot: swap-interval

Initform: 0

Slot: window-table

Initform: (make-hash-table)
Readers: window-table-of (generic function)

Slot: controller-hub

5.2.8 Types

Type: button-state ()

Package: bodge-host
Source: utils.lisp (file)

Type: cursor-type ()

Package: bodge-host
Source: cursor.lisp (file)

Type: keyboard-key ()

Package: bodge-host
Source: utils.lisp (file)

Type: keyboard-key-modifier ()

Package: bodge-host
Source: utils.lisp (file)

Type: mouse-button ()

Package: bodge-host
Source: utils.lisp (file)

Appendix A Indexes

A.1 Concepts

Jump to:	B F L

	Index Entry	Section

B
	`bodge-host.asd`:	The bodge-host․asd file
	`bodge-host/controller.lisp`:	The bodge-host/controller․lisp file
	`bodge-host/cursor.lisp`:	The bodge-host/cursor․lisp file
	`bodge-host/host.lisp`:	The bodge-host/host․lisp file
	`bodge-host/monitor.lisp`:	The bodge-host/monitor․lisp file
	`bodge-host/packages.lisp`:	The bodge-host/packages․lisp file
	`bodge-host/utils.lisp`:	The bodge-host/utils․lisp file
	`bodge-host/window.lisp`:	The bodge-host/window․lisp file

F
	File, Lisp, `bodge-host.asd`:	The bodge-host․asd file
	File, Lisp, `bodge-host/controller.lisp`:	The bodge-host/controller․lisp file
	File, Lisp, `bodge-host/cursor.lisp`:	The bodge-host/cursor․lisp file
	File, Lisp, `bodge-host/host.lisp`:	The bodge-host/host․lisp file
	File, Lisp, `bodge-host/monitor.lisp`:	The bodge-host/monitor․lisp file
	File, Lisp, `bodge-host/packages.lisp`:	The bodge-host/packages․lisp file
	File, Lisp, `bodge-host/utils.lisp`:	The bodge-host/utils․lisp file
	File, Lisp, `bodge-host/window.lisp`:	The bodge-host/window․lisp file

L
	Lisp File, `bodge-host.asd`:	The bodge-host․asd file
	Lisp File, `bodge-host/controller.lisp`:	The bodge-host/controller․lisp file
	Lisp File, `bodge-host/cursor.lisp`:	The bodge-host/cursor․lisp file
	Lisp File, `bodge-host/host.lisp`:	The bodge-host/host․lisp file
	Lisp File, `bodge-host/monitor.lisp`:	The bodge-host/monitor․lisp file
	Lisp File, `bodge-host/packages.lisp`:	The bodge-host/packages․lisp file
	Lisp File, `bodge-host/utils.lisp`:	The bodge-host/utils․lisp file
	Lisp File, `bodge-host/window.lisp`:	The bodge-host/window․lisp file

Jump to:	B F L

A.2 Functions

Jump to:	% ( A B C D E F G H I K L M O P R S U V W

	Index Entry	Section

%
	`%bool`:	Internal functions
	`%framebuffer-dimensions`:	Internal functions
	`%gamepad-button-pressed-p`:	Internal functions
	`%handle-of`:	Internal generic functions
	`%handle-of`:	Internal generic functions
	`%make-axis`:	Internal functions
	`%make-button`:	Internal functions
	`%make-controller`:	Internal functions
	`%make-gamepad`:	Internal functions
	`%make-hat`:	Internal functions
	`%update-gamepad-mappings`:	Internal functions
	`%viewport-autoscale`:	Internal functions
	`%viewport-dimensions`:	Internal functions
	`%window-monitor`:	Internal functions

(
	`(setf controller-guid)`:	Exported functions
	`(setf cursor)`:	Exported functions
	`(setf fullscreen-viewport-p)`:	Exported functions
	`(setf gamepad-%state)`:	Internal functions
	`(setf gamepad-guid)`:	Exported functions
	`(setf gamepad-id)`:	Internal functions
	`(setf gamepad-name)`:	Exported functions
	`(setf swap-interval)`:	Exported functions
	`(setf viewport-position)`:	Exported functions
	`(setf viewport-size)`:	Exported functions
	`(setf viewport-title)`:	Exported functions

A
	`available-monitors`:	Exported functions
	`axis-controller-id`:	Internal functions
	`axis-id`:	Internal functions
	`axis-p`:	Internal functions

B
	`bind-main-rendering-context`:	Exported functions
	`bind-shared-rendering-context`:	Exported functions
	`button-controller-id`:	Internal functions
	`button-id`:	Internal functions
	`button-p`:	Internal functions
	`button-state-p`:	Internal functions

C
	`calc-dpi-scale`:	Internal functions
	`calc-scale`:	Internal functions
	`check-host-thread`:	Internal functions
	`close-window`:	Exported functions
	`context-enabled-p`:	Internal functions
	`controller-axes`:	Exported functions
	`controller-axis-value`:	Exported functions
	`controller-button-pressed-p`:	Exported functions
	`controller-buttons`:	Exported functions
	`controller-guid`:	Exported functions
	`controller-hat-state`:	Exported functions
	`controller-hats`:	Exported functions
	`controller-hub-controllers`:	Internal functions
	`controller-hub-gamepads`:	Internal functions
	`controller-id`:	Internal functions
	`controller-name`:	Exported functions
	`controller-p`:	Internal functions
	`copy-axis`:	Internal functions
	`copy-button`:	Internal functions
	`copy-controller`:	Internal functions
	`copy-gamepad`:	Internal functions
	`copy-hat`:	Internal functions
	`create-window`:	Internal functions
	`cursor`:	Exported functions
	`cursor-position`:	Exported functions
	`cursor-type->glfw`:	Internal functions
	`cursor-type-p`:	Internal functions

D
	`destroy-controller-hub`:	Internal functions
	`destroy-cursor`:	Exported functions
	`destroy-gamepad`:	Internal functions
	`destroy-shared-rendering-context`:	Exported functions
	`destroy-window`:	Internal functions
	`do-windows`:	Internal macros

E
	`ensure-context`:	Internal functions

F
	`find-controller`:	Internal functions
	`find-gamepad`:	Internal functions
	`find-window-by-handle`:	Internal functions
	`for-each-updated-gamepad`:	Internal functions
	`for-each-window`:	Internal functions
	`framebuffer-size`:	Exported functions
	`Function, %bool`:	Internal functions
	`Function, %framebuffer-dimensions`:	Internal functions
	`Function, %gamepad-button-pressed-p`:	Internal functions
	`Function, %make-axis`:	Internal functions
	`Function, %make-button`:	Internal functions
	`Function, %make-controller`:	Internal functions
	`Function, %make-gamepad`:	Internal functions
	`Function, %make-hat`:	Internal functions
	`Function, %update-gamepad-mappings`:	Internal functions
	`Function, %viewport-autoscale`:	Internal functions
	`Function, %viewport-dimensions`:	Internal functions
	`Function, %window-monitor`:	Internal functions
	`Function, (setf controller-guid)`:	Exported functions
	`Function, (setf cursor)`:	Exported functions
	`Function, (setf fullscreen-viewport-p)`:	Exported functions
	`Function, (setf gamepad-%state)`:	Internal functions
	`Function, (setf gamepad-guid)`:	Exported functions
	`Function, (setf gamepad-id)`:	Internal functions
	`Function, (setf gamepad-name)`:	Exported functions
	`Function, (setf swap-interval)`:	Exported functions
	`Function, (setf viewport-position)`:	Exported functions
	`Function, (setf viewport-size)`:	Exported functions
	`Function, (setf viewport-title)`:	Exported functions
	`Function, available-monitors`:	Exported functions
	`Function, axis-controller-id`:	Internal functions
	`Function, axis-id`:	Internal functions
	`Function, axis-p`:	Internal functions
	`Function, bind-main-rendering-context`:	Exported functions
	`Function, bind-shared-rendering-context`:	Exported functions
	`Function, button-controller-id`:	Internal functions
	`Function, button-id`:	Internal functions
	`Function, button-p`:	Internal functions
	`Function, button-state-p`:	Internal functions
	`Function, calc-dpi-scale`:	Internal functions
	`Function, calc-scale`:	Internal functions
	`Function, check-host-thread`:	Internal functions
	`Function, close-window`:	Exported functions
	`Function, context-enabled-p`:	Internal functions
	`Function, controller-axes`:	Exported functions
	`Function, controller-axis-value`:	Exported functions
	`Function, controller-button-pressed-p`:	Exported functions
	`Function, controller-buttons`:	Exported functions
	`Function, controller-guid`:	Exported functions
	`Function, controller-hat-state`:	Exported functions
	`Function, controller-hats`:	Exported functions
	`Function, controller-hub-controllers`:	Internal functions
	`Function, controller-hub-gamepads`:	Internal functions
	`Function, controller-id`:	Internal functions
	`Function, controller-name`:	Exported functions
	`Function, controller-p`:	Internal functions
	`Function, copy-axis`:	Internal functions
	`Function, copy-button`:	Internal functions
	`Function, copy-controller`:	Internal functions
	`Function, copy-gamepad`:	Internal functions
	`Function, copy-hat`:	Internal functions
	`Function, create-window`:	Internal functions
	`Function, cursor`:	Exported functions
	`Function, cursor-position`:	Exported functions
	`Function, cursor-type->glfw`:	Internal functions
	`Function, cursor-type-p`:	Internal functions
	`Function, destroy-controller-hub`:	Internal functions
	`Function, destroy-cursor`:	Exported functions
	`Function, destroy-gamepad`:	Internal functions
	`Function, destroy-shared-rendering-context`:	Exported functions
	`Function, destroy-window`:	Internal functions
	`Function, ensure-context`:	Internal functions
	`Function, find-controller`:	Internal functions
	`Function, find-gamepad`:	Internal functions
	`Function, find-window-by-handle`:	Internal functions
	`Function, for-each-updated-gamepad`:	Internal functions
	`Function, for-each-window`:	Internal functions
	`Function, framebuffer-size`:	Exported functions
	`Function, gamepad-%state`:	Internal functions
	`Function, gamepad-button->nk`:	Internal functions
	`Function, gamepad-guid`:	Exported functions
	`Function, gamepad-id`:	Internal functions
	`Function, gamepad-name`:	Exported functions
	`Function, gamepad-p`:	Internal functions
	`Function, gamepad-state`:	Exported functions
	`Function, gamepad-state-button-pressed-p`:	Exported functions
	`Function, gamepad-state-dpad`:	Exported functions
	`Function, gamepad-state-left-stick`:	Exported functions
	`Function, gamepad-state-left-trigger`:	Exported functions
	`Function, gamepad-state-right-stick`:	Exported functions
	`Function, gamepad-state-right-trigger`:	Exported functions
	`Function, glfw->hat-state`:	Internal functions
	`Function, glfw-enumval->button-state`:	Internal functions
	`Function, glfw-enumval->keyboard-key`:	Internal functions
	`Function, glfw-enumval->mouse-button`:	Internal functions
	`Function, hat-controller-id`:	Internal functions
	`Function, hat-id`:	Internal functions
	`Function, hat-p`:	Internal functions
	`Function, hide-window`:	Exported functions
	`Function, init-callbacks`:	Internal functions
	`Function, init-context`:	Internal functions
	`Function, init-main-loop`:	Internal functions
	`Function, init-window`:	Internal functions
	`Function, invoke-controller-listeners`:	Internal functions
	`Function, keyboard-button-state`:	Exported functions
	`Function, keyboard-key->glfw-enumval`:	Internal functions
	`Function, keyboard-key-modifier-p`:	Internal functions
	`Function, keyboard-key-p`:	Internal functions
	`Function, list-controllers`:	Exported functions
	`Function, list-gamepads`:	Exported functions
	`Function, lock-cursor`:	Exported functions
	`Function, make-controller`:	Internal functions
	`Function, make-controller-hub`:	Internal functions
	`Function, make-gamepad`:	Internal functions
	`Function, make-shared-context`:	Internal functions
	`Function, make-shared-rendering-context`:	Exported functions
	`Function, make-standard-cursor`:	Exported functions
	`Function, monitor-content-scale`:	Internal functions
	`Function, monitor-name`:	Exported functions
	`Function, monitor-position`:	Exported functions
	`Function, monitor-video-mode`:	Exported functions
	`Function, mouse-button->glfw-enumval`:	Internal functions
	`Function, mouse-button-p`:	Internal functions
	`Function, mouse-button-state`:	Exported functions
	`Function, open-window`:	Exported functions
	`Function, primary-monitor`:	Exported functions
	`Function, primary-monitor-content-scale`:	Internal functions
	`Function, push-to-main-thread`:	Exported functions
	`Function, register-controller`:	Internal functions
	`Function, register-window`:	Internal functions
	`Function, release-context`:	Internal functions
	`Function, release-rendering-context`:	Exported functions
	`Function, remove-controller`:	Internal functions
	`Function, remove-window`:	Internal functions
	`Function, run-main-loop`:	Internal functions
	`Function, select-monitor`:	Internal functions
	`Function, show-window`:	Exported functions
	`Function, swap-buffers`:	Exported functions
	`Function, swap-interval`:	Exported functions
	`Function, sweep-context`:	Internal functions
	`Function, unlock-cursor`:	Exported functions
	`Function, update-gamepad-mappings`:	Exported functions
	`Function, update-gamepads`:	Internal functions
	`Function, video-mode-blue-bits`:	Exported functions
	`Function, video-mode-green-bits`:	Exported functions
	`Function, video-mode-height`:	Exported functions
	`Function, video-mode-red-bits`:	Exported functions
	`Function, video-mode-refresh-rate`:	Exported functions
	`Function, video-mode-width`:	Exported functions
	`Function, viewport-position`:	Exported functions
	`Function, viewport-scale`:	Exported functions
	`Function, viewport-size`:	Exported functions
	`Function, window-monitor`:	Exported functions

G
	`gamepad-%state`:	Internal functions
	`gamepad-button->nk`:	Internal functions
	`gamepad-guid`:	Exported functions
	`gamepad-id`:	Internal functions
	`gamepad-name`:	Exported functions
	`gamepad-p`:	Internal functions
	`gamepad-state`:	Exported functions
	`gamepad-state-button-pressed-p`:	Exported functions
	`gamepad-state-dpad`:	Exported functions
	`gamepad-state-left-stick`:	Exported functions
	`gamepad-state-left-trigger`:	Exported functions
	`gamepad-state-right-stick`:	Exported functions
	`gamepad-state-right-trigger`:	Exported functions
	`Generic Function, %handle-of`:	Internal generic functions
	`Generic Function, on-character-input`:	Exported generic functions
	`Generic Function, on-controller-connect`:	Exported generic functions
	`Generic Function, on-controller-disconnect`:	Exported generic functions
	`Generic Function, on-cursor-movement`:	Exported generic functions
	`Generic Function, on-destroy`:	Exported generic functions
	`Generic Function, on-dpad-action`:	Exported generic functions
	`Generic Function, on-framebuffer-size-change`:	Exported generic functions
	`Generic Function, on-gamepad-action`:	Exported generic functions
	`Generic Function, on-gamepad-connect`:	Exported generic functions
	`Generic Function, on-gamepad-disconnect`:	Exported generic functions
	`Generic Function, on-hide`:	Exported generic functions
	`Generic Function, on-init`:	Exported generic functions
	`Generic Function, on-key-action`:	Exported generic functions
	`Generic Function, on-left-stick-movement`:	Exported generic functions
	`Generic Function, on-left-trigger`:	Exported generic functions
	`Generic Function, on-log`:	Exported generic functions
	`Generic Function, on-mouse-action`:	Exported generic functions
	`Generic Function, on-right-stick-movement`:	Exported generic functions
	`Generic Function, on-right-trigger`:	Exported generic functions
	`Generic Function, on-scroll`:	Exported generic functions
	`Generic Function, on-viewport-size-change`:	Exported generic functions
	`Generic Function, viewport-autoscaled-p`:	Exported generic functions
	`Generic Function, window-table-of`:	Internal generic functions
	`glfw->hat-state`:	Internal functions
	`glfw-enumval->button-state`:	Internal functions
	`glfw-enumval->keyboard-key`:	Internal functions
	`glfw-enumval->mouse-button`:	Internal functions

H
	`hat-controller-id`:	Internal functions
	`hat-id`:	Internal functions
	`hat-p`:	Internal functions
	`hide-window`:	Exported functions

I
	`init-callbacks`:	Internal functions
	`init-context`:	Internal functions
	`init-main-loop`:	Internal functions
	`init-window`:	Internal functions
	`invoke-controller-listeners`:	Internal functions

K
	`keyboard-button-state`:	Exported functions
	`keyboard-key->glfw-enumval`:	Internal functions
	`keyboard-key-modifier-p`:	Internal functions
	`keyboard-key-p`:	Internal functions

L
	`list-controllers`:	Exported functions
	`list-gamepads`:	Exported functions
	`lock-cursor`:	Exported functions

M
	`Macro, do-windows`:	Internal macros
	`Macro, progm`:	Exported macros
	`Macro, with-context-locked`:	Internal macros
	`Macro, with-framebuffer-dimensions`:	Exported macros
	`Macro, with-viewport-dimensions`:	Exported macros
	`make-controller`:	Internal functions
	`make-controller-hub`:	Internal functions
	`make-gamepad`:	Internal functions
	`make-shared-context`:	Internal functions
	`make-shared-rendering-context`:	Exported functions
	`make-standard-cursor`:	Exported functions
	`Method, %handle-of`:	Internal generic functions
	`Method, on-character-input`:	Exported generic functions
	`Method, on-controller-connect`:	Exported generic functions
	`Method, on-controller-disconnect`:	Exported generic functions
	`Method, on-cursor-movement`:	Exported generic functions
	`Method, on-destroy`:	Exported generic functions
	`Method, on-dpad-action`:	Exported generic functions
	`Method, on-framebuffer-size-change`:	Exported generic functions
	`Method, on-gamepad-action`:	Exported generic functions
	`Method, on-gamepad-connect`:	Exported generic functions
	`Method, on-gamepad-disconnect`:	Exported generic functions
	`Method, on-hide`:	Exported generic functions
	`Method, on-init`:	Exported generic functions
	`Method, on-key-action`:	Exported generic functions
	`Method, on-left-stick-movement`:	Exported generic functions
	`Method, on-left-trigger`:	Exported generic functions
	`Method, on-log`:	Exported generic functions
	`Method, on-mouse-action`:	Exported generic functions
	`Method, on-right-stick-movement`:	Exported generic functions
	`Method, on-right-trigger`:	Exported generic functions
	`Method, on-scroll`:	Exported generic functions
	`Method, on-viewport-size-change`:	Exported generic functions
	`Method, viewport-autoscaled-p`:	Exported generic functions
	`Method, window-table-of`:	Internal generic functions
	`monitor-content-scale`:	Internal functions
	`monitor-name`:	Exported functions
	`monitor-position`:	Exported functions
	`monitor-video-mode`:	Exported functions
	`mouse-button->glfw-enumval`:	Internal functions
	`mouse-button-p`:	Internal functions
	`mouse-button-state`:	Exported functions

O
	`on-character-input`:	Exported generic functions
	`on-character-input`:	Exported generic functions
	`on-controller-connect`:	Exported generic functions
	`on-controller-connect`:	Exported generic functions
	`on-controller-disconnect`:	Exported generic functions
	`on-controller-disconnect`:	Exported generic functions
	`on-cursor-movement`:	Exported generic functions
	`on-cursor-movement`:	Exported generic functions
	`on-destroy`:	Exported generic functions
	`on-destroy`:	Exported generic functions
	`on-dpad-action`:	Exported generic functions
	`on-dpad-action`:	Exported generic functions
	`on-framebuffer-size-change`:	Exported generic functions
	`on-framebuffer-size-change`:	Exported generic functions
	`on-gamepad-action`:	Exported generic functions
	`on-gamepad-action`:	Exported generic functions
	`on-gamepad-connect`:	Exported generic functions
	`on-gamepad-connect`:	Exported generic functions
	`on-gamepad-disconnect`:	Exported generic functions
	`on-gamepad-disconnect`:	Exported generic functions
	`on-hide`:	Exported generic functions
	`on-hide`:	Exported generic functions
	`on-init`:	Exported generic functions
	`on-init`:	Exported generic functions
	`on-key-action`:	Exported generic functions
	`on-key-action`:	Exported generic functions
	`on-left-stick-movement`:	Exported generic functions
	`on-left-stick-movement`:	Exported generic functions
	`on-left-trigger`:	Exported generic functions
	`on-left-trigger`:	Exported generic functions
	`on-log`:	Exported generic functions
	`on-log`:	Exported generic functions
	`on-mouse-action`:	Exported generic functions
	`on-mouse-action`:	Exported generic functions
	`on-right-stick-movement`:	Exported generic functions
	`on-right-stick-movement`:	Exported generic functions
	`on-right-trigger`:	Exported generic functions
	`on-right-trigger`:	Exported generic functions
	`on-scroll`:	Exported generic functions
	`on-scroll`:	Exported generic functions
	`on-viewport-size-change`:	Exported generic functions
	`on-viewport-size-change`:	Exported generic functions
	`open-window`:	Exported functions

P
	`primary-monitor`:	Exported functions
	`primary-monitor-content-scale`:	Internal functions
	`progm`:	Exported macros
	`push-to-main-thread`:	Exported functions

R
	`register-controller`:	Internal functions
	`register-window`:	Internal functions
	`release-context`:	Internal functions
	`release-rendering-context`:	Exported functions
	`remove-controller`:	Internal functions
	`remove-window`:	Internal functions
	`run-main-loop`:	Internal functions

S
	`select-monitor`:	Internal functions
	`show-window`:	Exported functions
	`swap-buffers`:	Exported functions
	`swap-interval`:	Exported functions
	`sweep-context`:	Internal functions

U
	`unlock-cursor`:	Exported functions
	`update-gamepad-mappings`:	Exported functions
	`update-gamepads`:	Internal functions

V
	`video-mode-blue-bits`:	Exported functions
	`video-mode-green-bits`:	Exported functions
	`video-mode-height`:	Exported functions
	`video-mode-red-bits`:	Exported functions
	`video-mode-refresh-rate`:	Exported functions
	`video-mode-width`:	Exported functions
	`viewport-autoscaled-p`:	Exported generic functions
	`viewport-autoscaled-p`:	Exported generic functions
	`viewport-position`:	Exported functions
	`viewport-scale`:	Exported functions
	`viewport-size`:	Exported functions

W
	`window-monitor`:	Exported functions
	`window-table-of`:	Internal generic functions
	`window-table-of`:	Internal generic functions
	`with-context-locked`:	Internal macros
	`with-framebuffer-dimensions`:	Exported macros
	`with-viewport-dimensions`:	Exported macros

Jump to:	% ( A B C D E F G H I K L M O P R S U V W

A.3 Variables

Jump to:	% * + A B C D E F G H I M N P R S T W

	Index Entry	Section

%
	`%state`:	Internal structures

*
	`context`:	Internal special variables
	`event-wait-timeout`:	Exported special variables
	`gamepad-buttons`:	Internal special variables
	`host-thread-p`:	Internal special variables
	`key-map`:	Internal special variables
	`mouse-button-map`:	Internal special variables
	`window`:	Internal special variables

+
	`+button-state-values+`:	Internal constants
	`+cursor-type-values+`:	Internal constants
	`+default-window-height+`:	Internal constants
	`+default-window-width+`:	Internal constants
	`+expected-dpi+`:	Internal constants
	`+keyboard-key-modifier-values+`:	Internal constants
	`+keyboard-key-values+`:	Internal constants
	`+mouse-button-values+`:	Internal constants

A
	`autoscaled`:	Exported classes
	`axes`:	Internal structures

B
	`buttons`:	Internal structures

C
	`Constant, +button-state-values+`:	Internal constants
	`Constant, +cursor-type-values+`:	Internal constants
	`Constant, +default-window-height+`:	Internal constants
	`Constant, +default-window-width+`:	Internal constants
	`Constant, +expected-dpi+`:	Internal constants
	`Constant, +keyboard-key-modifier-values+`:	Internal constants
	`Constant, +keyboard-key-values+`:	Internal constants
	`Constant, +mouse-button-values+`:	Internal constants
	`controller-hub`:	Internal classes
	`controller-id`:	Internal structures
	`cursor`:	Exported classes

D
	`decorated`:	Exported classes

E
	`enabled-p`:	Internal classes

F
	`floating`:	Exported classes

G
	`gl-major-version`:	Exported classes
	`gl-minor-version`:	Exported classes
	`guid`:	Internal structures
	`guid`:	Internal structures

H
	`handle`:	Exported classes
	`hats`:	Internal structures
	`height`:	Exported classes

I
	`id`:	Internal structures
	`id`:	Internal structures
	`id`:	Internal structures

M
	`maximized`:	Exported classes

N
	`name`:	Internal structures
	`name`:	Internal structures

P
	`position`:	Exported classes

R
	`resizable`:	Exported classes

S
	`samples`:	Exported classes
	`Slot, %state`:	Internal structures
	`Slot, autoscaled`:	Exported classes
	`Slot, axes`:	Internal structures
	`Slot, buttons`:	Internal structures
	`Slot, controller-hub`:	Internal classes
	`Slot, controller-id`:	Internal structures
	`Slot, cursor`:	Exported classes
	`Slot, decorated`:	Exported classes
	`Slot, enabled-p`:	Internal classes
	`Slot, floating`:	Exported classes
	`Slot, gl-major-version`:	Exported classes
	`Slot, gl-minor-version`:	Exported classes
	`Slot, guid`:	Internal structures
	`Slot, guid`:	Internal structures
	`Slot, handle`:	Exported classes
	`Slot, hats`:	Internal structures
	`Slot, height`:	Exported classes
	`Slot, id`:	Internal structures
	`Slot, id`:	Internal structures
	`Slot, id`:	Internal structures
	`Slot, maximized`:	Exported classes
	`Slot, name`:	Internal structures
	`Slot, name`:	Internal structures
	`Slot, position`:	Exported classes
	`Slot, resizable`:	Exported classes
	`Slot, samples`:	Exported classes
	`Slot, swap-interval`:	Internal classes
	`Slot, task-queue`:	Internal classes
	`Slot, title`:	Exported classes
	`Slot, transparent`:	Exported classes
	`Slot, width`:	Exported classes
	`Slot, window-table`:	Internal classes
	`Special Variable, context`:	Internal special variables
	`Special Variable, event-wait-timeout`:	Exported special variables
	`Special Variable, gamepad-buttons`:	Internal special variables
	`Special Variable, host-thread-p`:	Internal special variables
	`Special Variable, key-map`:	Internal special variables
	`Special Variable, mouse-button-map`:	Internal special variables
	`Special Variable, window`:	Internal special variables
	`swap-interval`:	Internal classes

T
	`task-queue`:	Internal classes
	`title`:	Exported classes
	`transparent`:	Exported classes

W
	`width`:	Exported classes
	`window-table`:	Internal classes

Jump to:	% * + A B C D E F G H I M N P R S T W

A.4 Data types

Jump to:	A B C G H K M P S T W

	Index Entry	Section

A
	`axis`:	Internal structures

B
	`bodge-host`:	The bodge-host system
	`bodge-host`:	The bodge-host package
	`button`:	Internal structures
	`button-state`:	Internal types

C
	`Class, host-context`:	Internal classes
	`Class, window`:	Exported classes
	`controller`:	Internal structures
	`cursor-type`:	Internal types

G
	`gamepad`:	Internal structures

H
	`hat`:	Internal structures
	`host-context`:	Internal classes

K
	`keyboard-key`:	Internal types
	`keyboard-key-modifier`:	Internal types

M
	`mouse-button`:	Internal types

P
	`Package, bodge-host`:	The bodge-host package

S
	`Structure, axis`:	Internal structures
	`Structure, button`:	Internal structures
	`Structure, controller`:	Internal structures
	`Structure, gamepad`:	Internal structures
	`Structure, hat`:	Internal structures
	`System, bodge-host`:	The bodge-host system

T
	`Type, button-state`:	Internal types
	`Type, cursor-type`:	Internal types
	`Type, keyboard-key`:	Internal types
	`Type, keyboard-key-modifier`:	Internal types
	`Type, mouse-button`:	Internal types

W
	`window`:	Exported classes

Jump to:	A B C G H K M P S T W

• Introduction		What bodge-host is all about
• Systems		The systems documentation
• Files		The files documentation
• Packages		The packages documentation
• Definitions		The symbols documentation
• Indexes		Concepts, functions, variables and data types

• The bodge-host.asd file
• The bodge-host/packages.lisp file
• The bodge-host/utils.lisp file
• The bodge-host/cursor.lisp file
• The bodge-host/monitor.lisp file
• The bodge-host/window.lisp file
• The bodge-host/controller.lisp file
• The bodge-host/host.lisp file

• Exported special variables
• Exported macros
• Exported functions
• Exported generic functions
• Exported classes

• Internal constants
• Internal special variables
• Internal macros
• Internal functions
• Internal generic functions
• Internal structures
• Internal classes
• Internal types

• Concept index
• Function index
• Variable index
• Data type index

The bodge-host Reference Manual

Table of Contents

The bodge-host Reference Manual

1 Introduction

bodge-host

2 Systems

2.1 bodge-host

3 Files

3.1 Lisp

3.1.1 bodge-host.asd

3.1.2 bodge-host/packages.lisp

3.1.3 bodge-host/utils.lisp

3.1.4 bodge-host/cursor.lisp

3.1.5 bodge-host/monitor.lisp

3.1.6 bodge-host/window.lisp

3.1.7 bodge-host/controller.lisp

3.1.8 bodge-host/host.lisp

4 Packages

4.1 bodge-host

5 Definitions

5.1 Exported definitions

5.1.1 Special variables

5.1.2 Macros

5.1.3 Functions

5.1.4 Generic functions

5.1.5 Classes

5.2 Internal definitions

5.2.1 Constants

5.2.2 Special variables

5.2.3 Macros

5.2.4 Functions

5.2.5 Generic functions

5.2.6 Structures

5.2.7 Classes

5.2.8 Types

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `bodge-host`

3.1.1 `bodge-host.asd`

3.1.2 `bodge-host/packages.lisp`

3.1.3 `bodge-host/utils.lisp`

3.1.4 `bodge-host/cursor.lisp`

3.1.5 `bodge-host/monitor.lisp`

3.1.6 `bodge-host/window.lisp`

3.1.7 `bodge-host/controller.lisp`

3.1.8 `bodge-host/host.lisp`

4.1 `bodge-host`