This is the cl-gamepad Reference Manual, version 3.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 04:05:12 2025 GMT+0.
cl-gamepad/cl-gamepad.asdcl-gamepad/package.lispcl-gamepad/protocol.lispcl-gamepad/mapping.lispcl-gamepad/configurator.lispcl-gamepad/common.lispcl-gamepad/evdev-cffi.lispcl-gamepad/linux.lispcl-gamepad/win32-cffi.lispcl-gamepad/xinput-cffi.lispcl-gamepad/dinput-cffi.lispcl-gamepad/windows.lispcl-gamepad/corefoundation-cffi.lispcl-gamepad/iokit-cffi.lispcl-gamepad/darwin.lispcl-gamepad/nx-cffi.lispcl-gamepad/nx.lispcl-gamepad/default-device-mappings.lispcl-gamepad/documentation.lispThe main system appears first, followed by any subsystem dependency.
cl-gamepadPortability library for gamepad and joystick access.
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/Shirakumo/cl-gamepad.git)
zlib
3.0.0
trivial-features (system).
cffi (system).
documentation-utils (system).
package.lisp (file).
protocol.lisp (file).
mapping.lisp (file).
configurator.lisp (file).
common.lisp (file).
evdev-cffi.lisp (file).
linux.lisp (file).
win32-cffi.lisp (file).
xinput-cffi.lisp (file).
dinput-cffi.lisp (file).
windows.lisp (file).
corefoundation-cffi.lisp (file).
iokit-cffi.lisp (file).
darwin.lisp (file).
nx-cffi.lisp (file).
nx.lisp (file).
default-device-mappings.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-gamepad/cl-gamepad.asdcl-gamepad/package.lispcl-gamepad/protocol.lispcl-gamepad/mapping.lispcl-gamepad/configurator.lispcl-gamepad/common.lispcl-gamepad/evdev-cffi.lispcl-gamepad/linux.lispcl-gamepad/win32-cffi.lispcl-gamepad/xinput-cffi.lispcl-gamepad/dinput-cffi.lispcl-gamepad/windows.lispcl-gamepad/corefoundation-cffi.lispcl-gamepad/iokit-cffi.lispcl-gamepad/darwin.lispcl-gamepad/nx-cffi.lispcl-gamepad/nx.lispcl-gamepad/default-device-mappings.lispcl-gamepad/documentation.lispcl-gamepad/protocol.lisppackage.lisp (file).
cl-gamepad (system).
axis (compiler macro).
axis (function).
axis-move (structure).
button (compiler macro).
button (function).
button-down (structure).
button-up (structure).
dead-zone (function).
(setf dead-zone) (function).
device (class).
driver (reader method).
ensure-device (function).
event (structure).
event-code (reader).
(setf event-code) (writer).
event-device (reader).
(setf event-device) (writer).
event-label (reader).
(setf event-label) (writer).
event-old-value (reader).
(setf event-old-value) (writer).
event-time (reader).
(setf event-time) (writer).
event-value (reader).
(setf event-value) (writer).
gamepad-error (condition).
icon-type (reader method).
(setf icon-type) (writer method).
name (reader method).
print-object (method).
print-object (method).
print-object (method).
product (reader method).
ramp (function).
(setf ramp) (function).
vendor (reader method).
version (reader method).
axis-dead-zones (reader method).
(setf axis-dead-zones) (writer method).
axis-map (reader method).
(setf axis-map) (writer method).
axis-move-p (function).
axis-ramps (reader method).
(setf axis-ramps) (writer method).
axis-raw-states (reader method).
(setf axis-raw-states) (writer method).
axis-states (reader method).
(setf axis-states) (writer method).
button-down-code (function).
(setf button-down-code) (function).
button-down-device (function).
(setf button-down-device) (function).
button-down-label (function).
(setf button-down-label) (function).
button-down-p (function).
button-down-time (function).
(setf button-down-time) (function).
button-map (reader method).
(setf button-map) (writer method).
button-states (reader method).
(setf button-states) (writer method).
button-up-code (function).
(setf button-up-code) (function).
button-up-device (function).
(setf button-up-device) (function).
button-up-label (function).
(setf button-up-label) (function).
button-up-p (function).
button-up-time (function).
(setf button-up-time) (function).
copy-axis-move (function).
copy-button-down (function).
copy-button-up (function).
copy-event (function).
define-global (macro).
event-p (function).
id-label (compiler macro).
id-label (function).
label-id (compiler macro).
label-id (function).
make-axis-move (function).
make-button-down (function).
make-button-up (function).
make-event (function).
orientation-map (reader method).
(setf orientation-map) (writer method).
cl-gamepad/mapping.lispprotocol.lisp (file).
cl-gamepad (system).
*default-mappings-file* (special variable).
blacklisted-p (function).
(setf blacklisted-p) (function).
define-device-mapping (macro).
device-mapping (function).
(setf device-mapping) (function).
initialize-instance (method).
remove-device-mapping (function).
save-device-mappings (function).
*blacklist* (special variable).
*device-mappings* (special variable).
*here* (special variable).
copyhash (function).
map-plist (function).
mapping-id< (function).
normalize-mapping-id (function).
plist-map (function).
update-mapping-in-device (function).
cl-gamepad/configurator.lispmapping.lisp (file).
cl-gamepad (system).
configure-device (function).
monitor-device (function).
configurator-main (function).
inverse-gethash (function).
note-event (function).
out (function).
query-labels (function).
cl-gamepad/common.lispconfigurator.lisp (file).
cl-gamepad (system).
%with-updated-event (macro).
*here* (special variable).
*static* (special variable).
axis-to-float (function).
circular-rezone (function).
clamp (function).
ensure-function (function).
sibling-id (function).
signal-axis-move (function).
signal-button-down (function).
signal-button-up (function).
square-rezone (function).
with-device-failures (macro).
cl-gamepad/evdev-cffi.lisp:linux
common.lisp (file).
cl-gamepad (system).
%var-accessor-errno (function).
(setf %var-accessor-errno) (function).
add-watch (function).
axis-info-flat (function).
(setf axis-info-flat) (function).
axis-info-fuzz (function).
(setf axis-info-fuzz) (function).
axis-info-maximum (function).
(setf axis-info-maximum) (function).
axis-info-minimum (function).
(setf axis-info-minimum) (function).
axis-info-resolution (function).
(setf axis-info-resolution) (function).
axis-info-tclass (class).
axis-info-value (function).
(setf axis-info-value) (function).
change-fd (function).
check-errno (macro).
code (reader method).
effect-data (function).
(setf effect-data) (function).
effect-direction (function).
(setf effect-direction) (function).
effect-id (function).
(setf effect-id) (function).
effect-replay (function).
(setf effect-replay) (function).
effect-tclass (class).
effect-trigger (function).
(setf effect-trigger) (function).
effect-type (function).
(setf effect-type) (function).
errno (symbol macro).
error-message (function).
event-code (function).
(setf event-code) (function).
event-sec (function).
(setf event-sec) (function).
event-tclass (class).
event-type (function).
(setf event-type) (function).
event-usec (function).
(setf event-usec) (function).
event-value (function).
(setf event-value) (function).
ff-condition-center (function).
(setf ff-condition-center) (function).
ff-condition-deadband (function).
(setf ff-condition-deadband) (function).
ff-condition-left-coefficient (function).
(setf ff-condition-left-coefficient) (function).
ff-condition-left-saturation (function).
(setf ff-condition-left-saturation) (function).
ff-condition-right-coefficient (function).
(setf ff-condition-right-coefficient) (function).
ff-condition-right-saturation (function).
(setf ff-condition-right-saturation) (function).
ff-condition-tclass (class).
ff-constant-envelope (function).
(setf ff-constant-envelope) (function).
ff-constant-level (function).
(setf ff-constant-level) (function).
ff-constant-tclass (class).
ff-envelope-attack-length (function).
(setf ff-envelope-attack-length) (function).
ff-envelope-attack-level (function).
(setf ff-envelope-attack-level) (function).
ff-envelope-fade-length (function).
(setf ff-envelope-fade-length) (function).
ff-envelope-fade-level (function).
(setf ff-envelope-fade-level) (function).
ff-envelope-tclass (class).
ff-periodic-custom-data (function).
(setf ff-periodic-custom-data) (function).
ff-periodic-custom-length (function).
(setf ff-periodic-custom-length) (function).
ff-periodic-envelope (function).
(setf ff-periodic-envelope) (function).
ff-periodic-magnitude (function).
(setf ff-periodic-magnitude) (function).
ff-periodic-offset (function).
(setf ff-periodic-offset) (function).
ff-periodic-period (function).
(setf ff-periodic-period) (function).
ff-periodic-phase (function).
(setf ff-periodic-phase) (function).
ff-periodic-tclass (class).
ff-periodic-waveform (function).
(setf ff-periodic-waveform) (function).
ff-ramp-end-level (function).
(setf ff-ramp-end-level) (function).
ff-ramp-envelope (function).
(setf ff-ramp-envelope) (function).
ff-ramp-start-level (function).
(setf ff-ramp-start-level) (function).
ff-ramp-tclass (class).
ff-replay-delay (function).
(setf ff-replay-delay) (function).
ff-replay-length (function).
(setf ff-replay-length) (function).
ff-replay-tclass (class).
ff-rumble-strong-magnitude (function).
(setf ff-rumble-strong-magnitude) (function).
ff-rumble-tclass (class).
ff-rumble-weak-magnitude (function).
(setf ff-rumble-weak-magnitude) (function).
ff-trigger-button (function).
(setf ff-trigger-button) (function).
ff-trigger-interval (function).
(setf ff-trigger-interval) (function).
ff-trigger-tclass (class).
free-device (function).
function-name (reader method).
get-axis-info (function).
get-driver-version (function).
get-id-bustype (function).
get-id-product (function).
get-id-vendor (function).
get-id-version (function).
get-name (function).
get-uniq (function).
has-event-code (function).
has-event-pending (function).
has-event-type (function).
has-property (function).
inotify-cookie (function).
(setf inotify-cookie) (function).
inotify-length (function).
(setf inotify-length) (function).
inotify-mask (function).
(setf inotify-mask) (function).
inotify-name (function).
(setf inotify-name) (function).
inotify-tclass (class).
inotify-wd (function).
(setf inotify-wd) (function).
ioctl (function).
linux-error (function).
linux-error (condition).
memset (function).
message (reader method).
new-from-fd (function).
new-inotify (function).
next-event (function).
poll (function).
pollfd-events (function).
(setf pollfd-events) (function).
pollfd-fd (function).
(setf pollfd-fd) (function).
pollfd-revents (function).
(setf pollfd-revents) (function).
pollfd-tclass (class).
u-close (function).
u-open (function).
u-read (function).
u-write (function).
cl-gamepad/linux.lisp:linux
evdev-cffi.lisp (file).
common.lisp (file).
cl-gamepad (system).
call-with-devices (function).
init (function).
list-devices (function).
poll-devices (function).
poll-events (function).
rumble (function).
shutdown (function).
*device-notify* (special variable).
*device-table* (special variable).
call-with-device-events (function).
call-with-polling (function).
close-device (function).
dev (reader method).
dev-gamepad-p (function).
device (class).
device-axis-map (function).
device-button-map (function).
effect (reader method).
ensure-device (function).
fd (reader method).
id (reader method).
make-device-from-path (function).
prefix-p (function).
probe-device-effect (function).
process-connect-events (function).
refresh-devices (function).
translate-event (function).
cl-gamepad/win32-cffi.lisp:windows
linux.lisp (file).
evdev-cffi.lisp (file).
common.lisp (file).
cl-gamepad (system).
cl-gamepad/xinput-cffi.lisp:windows
win32-cffi.lisp (file).
linux.lisp (file).
evdev-cffi.lisp (file).
common.lisp (file).
cl-gamepad (system).
cl-gamepad/dinput-cffi.lisp:windows
xinput-cffi.lisp (file).
win32-cffi.lisp (file).
linux.lisp (file).
evdev-cffi.lisp (file).
common.lisp (file).
cl-gamepad (system).
cl-gamepad/windows.lisp:windows
dinput-cffi.lisp (file).
xinput-cffi.lisp (file).
win32-cffi.lisp (file).
linux.lisp (file).
evdev-cffi.lisp (file).
common.lisp (file).
cl-gamepad (system).
cl-gamepad/corefoundation-cffi.lisp:darwin
windows.lisp (file).
dinput-cffi.lisp (file).
xinput-cffi.lisp (file).
win32-cffi.lisp (file).
linux.lisp (file).
evdev-cffi.lisp (file).
common.lisp (file).
cl-gamepad (system).
cl-gamepad/iokit-cffi.lisp:darwin
corefoundation-cffi.lisp (file).
windows.lisp (file).
dinput-cffi.lisp (file).
xinput-cffi.lisp (file).
win32-cffi.lisp (file).
linux.lisp (file).
evdev-cffi.lisp (file).
common.lisp (file).
cl-gamepad (system).
cl-gamepad/darwin.lisp:darwin
iokit-cffi.lisp (file).
corefoundation-cffi.lisp (file).
windows.lisp (file).
dinput-cffi.lisp (file).
xinput-cffi.lisp (file).
win32-cffi.lisp (file).
linux.lisp (file).
evdev-cffi.lisp (file).
common.lisp (file).
cl-gamepad (system).
cl-gamepad/nx-cffi.lisp:nx
darwin.lisp (file).
iokit-cffi.lisp (file).
corefoundation-cffi.lisp (file).
windows.lisp (file).
dinput-cffi.lisp (file).
xinput-cffi.lisp (file).
win32-cffi.lisp (file).
linux.lisp (file).
evdev-cffi.lisp (file).
common.lisp (file).
cl-gamepad (system).
cl-gamepad/nx.lisp:nx
nx-cffi.lisp (file).
darwin.lisp (file).
iokit-cffi.lisp (file).
corefoundation-cffi.lisp (file).
windows.lisp (file).
dinput-cffi.lisp (file).
xinput-cffi.lisp (file).
win32-cffi.lisp (file).
linux.lisp (file).
evdev-cffi.lisp (file).
common.lisp (file).
cl-gamepad (system).
cl-gamepad/default-device-mappings.lispnx.lisp (file).
nx-cffi.lisp (file).
darwin.lisp (file).
iokit-cffi.lisp (file).
corefoundation-cffi.lisp (file).
windows.lisp (file).
dinput-cffi.lisp (file).
xinput-cffi.lisp (file).
win32-cffi.lisp (file).
linux.lisp (file).
evdev-cffi.lisp (file).
common.lisp (file).
cl-gamepad (system).
cl-gamepad/documentation.lispdefault-device-mappings.lisp (file).
cl-gamepad (system).
Packages are listed by definition order.
org.shirakumo.fraf.gamepadcommon-lisp.
*default-mappings-file* (special variable).
axis (compiler macro).
axis (function).
axis-move (structure).
blacklisted-p (function).
(setf blacklisted-p) (function).
button (compiler macro).
button (function).
button-down (structure).
button-up (structure).
call-with-devices (function).
configure-device (function).
dead-zone (function).
(setf dead-zone) (function).
define-device-mapping (macro).
device (class).
device-mapping (function).
(setf device-mapping) (function).
driver (generic reader).
ensure-device (function).
event (structure).
event-code (reader).
(setf event-code) (writer).
event-device (reader).
(setf event-device) (writer).
event-label (reader).
(setf event-label) (writer).
event-old-value (reader).
(setf event-old-value) (writer).
event-time (reader).
(setf event-time) (writer).
event-value (reader).
(setf event-value) (writer).
gamepad-error (condition).
icon-type (generic reader).
(setf icon-type) (generic writer).
init (function).
list-devices (function).
monitor-device (function).
name (generic reader).
poll-devices (function).
poll-events (function).
product (generic reader).
ramp (function).
(setf ramp) (function).
remove-device-mapping (function).
rumble (function).
save-device-mappings (function).
shutdown (function).
vendor (generic reader).
version (generic reader).
*blacklist* (special variable).
*device-mappings* (special variable).
*here* (special variable).
axis-dead-zones (generic reader).
(setf axis-dead-zones) (generic writer).
axis-map (generic reader).
(setf axis-map) (generic writer).
axis-move-p (function).
axis-ramps (generic reader).
(setf axis-ramps) (generic writer).
axis-raw-states (generic reader).
(setf axis-raw-states) (generic writer).
axis-states (generic reader).
(setf axis-states) (generic writer).
button-down-code (function).
(setf button-down-code) (function).
button-down-device (function).
(setf button-down-device) (function).
button-down-label (function).
(setf button-down-label) (function).
button-down-p (function).
button-down-time (function).
(setf button-down-time) (function).
button-map (generic reader).
(setf button-map) (generic writer).
button-states (generic reader).
(setf button-states) (generic writer).
button-up-code (function).
(setf button-up-code) (function).
button-up-device (function).
(setf button-up-device) (function).
button-up-label (function).
(setf button-up-label) (function).
button-up-p (function).
button-up-time (function).
(setf button-up-time) (function).
configurator-main (function).
copy-axis-move (function).
copy-button-down (function).
copy-button-up (function).
copy-event (function).
copyhash (function).
define-global (macro).
event-p (function).
id-label (compiler macro).
id-label (function).
inverse-gethash (function).
label-id (compiler macro).
label-id (function).
make-axis-move (function).
make-button-down (function).
make-button-up (function).
make-event (function).
map-plist (function).
mapping-id< (function).
normalize-mapping-id (function).
note-event (function).
orientation-map (generic reader).
(setf orientation-map) (generic writer).
out (function).
plist-map (function).
query-labels (function).
update-mapping-in-device (function).
org.shirakumo.fraf.gamepad.implcommon-lisp.
%var-accessor-errno (function).
(setf %var-accessor-errno) (function).
%with-updated-event (macro).
*device-notify* (special variable).
*device-table* (special variable).
*here* (special variable).
*static* (special variable).
add-watch (function).
axis-info-flat (function).
(setf axis-info-flat) (function).
axis-info-fuzz (function).
(setf axis-info-fuzz) (function).
axis-info-maximum (function).
(setf axis-info-maximum) (function).
axis-info-minimum (function).
(setf axis-info-minimum) (function).
axis-info-resolution (function).
(setf axis-info-resolution) (function).
axis-info-tclass (class).
axis-info-value (function).
(setf axis-info-value) (function).
axis-to-float (function).
call-with-device-events (function).
call-with-polling (function).
change-fd (function).
check-errno (macro).
circular-rezone (function).
clamp (function).
close-device (function).
code (generic reader).
dev (generic reader).
dev-gamepad-p (function).
device (class).
device-axis-map (function).
device-button-map (function).
effect (generic reader).
effect-data (function).
(setf effect-data) (function).
effect-direction (function).
(setf effect-direction) (function).
effect-id (function).
(setf effect-id) (function).
effect-replay (function).
(setf effect-replay) (function).
effect-tclass (class).
effect-trigger (function).
(setf effect-trigger) (function).
effect-type (function).
(setf effect-type) (function).
ensure-device (function).
ensure-function (function).
errno (symbol macro).
error-message (function).
event-code (function).
(setf event-code) (function).
event-sec (function).
(setf event-sec) (function).
event-tclass (class).
event-type (function).
(setf event-type) (function).
event-usec (function).
(setf event-usec) (function).
event-value (function).
(setf event-value) (function).
fd (generic reader).
ff-condition-center (function).
(setf ff-condition-center) (function).
ff-condition-deadband (function).
(setf ff-condition-deadband) (function).
ff-condition-left-coefficient (function).
(setf ff-condition-left-coefficient) (function).
ff-condition-left-saturation (function).
(setf ff-condition-left-saturation) (function).
ff-condition-right-coefficient (function).
(setf ff-condition-right-coefficient) (function).
ff-condition-right-saturation (function).
(setf ff-condition-right-saturation) (function).
ff-condition-tclass (class).
ff-constant-envelope (function).
(setf ff-constant-envelope) (function).
ff-constant-level (function).
(setf ff-constant-level) (function).
ff-constant-tclass (class).
ff-envelope-attack-length (function).
(setf ff-envelope-attack-length) (function).
ff-envelope-attack-level (function).
(setf ff-envelope-attack-level) (function).
ff-envelope-fade-length (function).
(setf ff-envelope-fade-length) (function).
ff-envelope-fade-level (function).
(setf ff-envelope-fade-level) (function).
ff-envelope-tclass (class).
ff-periodic-custom-data (function).
(setf ff-periodic-custom-data) (function).
ff-periodic-custom-length (function).
(setf ff-periodic-custom-length) (function).
ff-periodic-envelope (function).
(setf ff-periodic-envelope) (function).
ff-periodic-magnitude (function).
(setf ff-periodic-magnitude) (function).
ff-periodic-offset (function).
(setf ff-periodic-offset) (function).
ff-periodic-period (function).
(setf ff-periodic-period) (function).
ff-periodic-phase (function).
(setf ff-periodic-phase) (function).
ff-periodic-tclass (class).
ff-periodic-waveform (function).
(setf ff-periodic-waveform) (function).
ff-ramp-end-level (function).
(setf ff-ramp-end-level) (function).
ff-ramp-envelope (function).
(setf ff-ramp-envelope) (function).
ff-ramp-start-level (function).
(setf ff-ramp-start-level) (function).
ff-ramp-tclass (class).
ff-replay-delay (function).
(setf ff-replay-delay) (function).
ff-replay-length (function).
(setf ff-replay-length) (function).
ff-replay-tclass (class).
ff-rumble-strong-magnitude (function).
(setf ff-rumble-strong-magnitude) (function).
ff-rumble-tclass (class).
ff-rumble-weak-magnitude (function).
(setf ff-rumble-weak-magnitude) (function).
ff-trigger-button (function).
(setf ff-trigger-button) (function).
ff-trigger-interval (function).
(setf ff-trigger-interval) (function).
ff-trigger-tclass (class).
free-device (function).
function-name (generic reader).
get-axis-info (function).
get-driver-version (function).
get-id-bustype (function).
get-id-product (function).
get-id-vendor (function).
get-id-version (function).
get-name (function).
get-uniq (function).
has-event-code (function).
has-event-pending (function).
has-event-type (function).
has-property (function).
id (generic reader).
inotify-cookie (function).
(setf inotify-cookie) (function).
inotify-length (function).
(setf inotify-length) (function).
inotify-mask (function).
(setf inotify-mask) (function).
inotify-name (function).
(setf inotify-name) (function).
inotify-tclass (class).
inotify-wd (function).
(setf inotify-wd) (function).
ioctl (function).
linux-error (function).
linux-error (condition).
make-device-from-path (function).
memset (function).
message (generic reader).
new-from-fd (function).
new-inotify (function).
next-event (function).
poll (function).
pollfd-events (function).
(setf pollfd-events) (function).
pollfd-fd (function).
(setf pollfd-fd) (function).
pollfd-revents (function).
(setf pollfd-revents) (function).
pollfd-tclass (class).
prefix-p (function).
probe-device-effect (function).
process-connect-events (function).
refresh-devices (function).
sibling-id (function).
signal-axis-move (function).
signal-button-down (function).
signal-button-up (function).
square-rezone (function).
translate-event (function).
u-close (function).
u-open (function).
u-read (function).
u-write (function).
with-device-failures (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Defines a new device mapping for the named device type.
This is a shorthand around (SETF DEVICE-MAPPING). The BODY should be a
plist with :NAME :BUTTONS and :AXES keys. For buttons and axes, the
value should be a plist from device IDs to labels.
See DEVICE-MAPPING
Returns the last known value of the axis.
Returns a single-float representing the axis state.
This state is automatically updated when POLL-EVENTS is called.
The axis name must be a known and mapped keyword from +LABELS+.
See AXIS-MOVE
See POLL-EVENTS
See DEVICE
See +LABELS+
A place accessing whether the device is blacklisted or not.
If T, the device will not be recognised on future initialisations of the library or future POLL-DEVICES calls.
Returns the last known value of the button.
Returns T if the button is pressed, NIL if it is released. This state is automatically updated when POLL-EVENTS is called. The button name must be a known and mapped keyword from +LABELS+.
See BUTTON-DOWN
See BUTTON-UP
See POLL-EVENTS
See DEVICE
See +LABELS+
Run an interactive configuration wizard to determine the proper button mappings.
This will interactively ask you to press the correct buttons and axes
corresponding to the prompted labels.
You can use this to configure a device’s button and axis mappings if
the default mapping is not correct.
You can pass the desired axis and button labels.
If the device reports faulty axes that interfere with the axis mapping
mechanism, you can ignore them by passing their IDs with the IGNORED-AXES
argument.
See +COMMON-BUTTONS+
See +COMMON-AXES+
See SAVE-DEVICE-MAPPINGS
Accessor for the dead zone of the axis on the device.
The dead zone can be defined on a combination of horizontal and vertical axes, or a single axis. When applied to a combination, the axis name must be :L, or :R, in which case the dead zone is circular.
See +LABELS+
See DEVICE
A place accessing the device mapping associated with the given ID.
An ID can either be a DEVICE instance, or a list with the following
members:
DRIVER — The name of the underlying driver for the device.
One of :DINPUT :XINPUT :EVDEV :IOKIT
VENDOR — The vendor ID of the device.
PRODUCT — The product ID of the device.
Returns NIL if no mapping is known, or a plist with the following
members:
:NAME — A string identifying the device in a hopefully
human-readable way.
:BUTTONS — A hash table mapping backend-specific button IDs to the
standardised button labels from +LABELS+
:AXES — A hash table mapping backend-specific axis IDs to the
standardised axis labels from +LABELS+
Setting a device mapping will automatically update all known
devices that match the mapping.
See REMOVE-DEVICE-MAPPING
See CONFIGURE-DEVICE
Returns the underlying code of the feature on the device that caused the event.
The code is a positive integer that has a device and driver specific
meaning.
This field is always set.
See EVENT
code.
Returns the device the event came from.
This field is always set.
See EVENT
See DEVICE
Returns the standardised label associated with the axis or button that caused the event.
If the feature is unknown or not properly mapped, NIL is
returned. Otherwise the returned symbol must be one contained in
+LABELS+.
See EVENT
See +LABELS+
Returns the previous axis value as a single-float in [-1,+1]
See EVENT-VALUE
See AXIS-MOVE
Returns some form of time identifier for the event.
The actual time resolution is dependent on the driver. This is mostly
useful to gauge whether events happened simultaneously or not.
This field is always set.
See EVENT
time.
Returns the axis value as a single-float in [-1,+1].
For a horizontal axis, -1 means left, +1 means right.
For a vertical axis, -1 means down, +1 means up.
This field is only accessible for AXIS-MOVEs.
See AXIS-MOVE
Initialises the library for use.
This will cause system shared objects to be loaded and will cause certain support structures to be allocated and initialised. Only call this function on a target system where the gamepads should be queried.
You MUST call this function before calling any other device functions.
It is safe to call this function multiple times.
Returns the list of currently known devices.
See SHUTDOWN
Returns a fresh list of all known gamepad devices.
This will not query for device updates, and only represents the
currently known state of the system.
On an uninitialised system this will return NIL.
See POLL-DEVICES
Queries for device changes.
TIMEOUT can be a one of the following:
T — Continuously poll for device changes indefinitely.
NIL — Immediately return if no changes are pending.
REAL — Wait up to the given number of seconds until a change is
noticed. Returns as soon as a change happened, or some
time until the timeout runs out.
FUNCTION can be a function designator, which is called with two
arguments:
ACTION — Either :ADD or :REMOVE.
DEVICE — The DEVICE object that has been changed. If ACTION was
:REMOVE, you should not query the device anymore, and
instead ensure that it is no longer referenced from
your program.
You should call this function whenever you want to allow changing the connected devices, or whenever an existing device is disconnected.
You must have called INIT prior to calling this function.
See INIT
See LIST-DEVICES
Queries the device for events.
The FUNCTION is called with any new device events that arrive during
querying. The events are not guaranteed to be fresh and you MUST NOT
store them anywhere. You should instead translate the event into a
format more suitable for your use case or consume it on the spot.
TIMEOUT can be of one of the following:
T — Continuously poll for device events indefinitely.
NIL — Immediately return if no events are pending.
REAL — Wait up to the given number of seconds until an event is
noticed. Returns as soon as an event happened, or some
time until the timeout runs out.
You should call this function whenever you wish to query the gamepad
for new changes in its buttons or axes.
This function may signal an error of type GAMEPAD-ERROR. When this
happens the device has become unavailable for some reason. You should
remove the device from your own references and invoke the restart
DROP-DEVICE which will remove the device from the internal library and
abort the query.
You must have called INIT prior to calling this function.
See INIT
See DEVICE
See EVENT
Accessor for the ramp of the axis on the device.
The ramp descriptor must be a function of a single argument that takes
a basic, linear axis value, and returns the mapped axis value.
See +LABELS+
See DEVICE
Removes the device mapping associated with the given ID.
See DEVICE-MAPPING
Causes haptic feedback on the controller.
STRENGTH should be a number in [0,1] denoting the strength of the
haptic feedback.
PAN should be a number in [-1,+1] denoting where (from left to right)
to rumble.
Note that haptic feedback is wildly inconsistent across devices and
drivers, and may be completely unsupported, or not behave exactly as
described here.
If the haptic feedback is unsupported, this function returns
:UNSUPPORTED.
The rumbling will last at least 0.1 seconds, and may go on
indefinitely. You must modulate the rumbling manually, or stop it
completely by setting the strength to zero.
You must have called INIT prior to calling this function.
See INIT
See DEVICE
Saves all known device mappings to a lisp source file.
The source file can simply be LOADed in to restore the mappings.
See *DEFAULT-MAPPINGS-FILE*
Uninitialises the library and closes all used resources.
This will not unload system shared objects, but it will close all used
devices and other services and deallocate them. You should call this
function when shutting down on a target system.
After calling this function you MUST NOT call any other device
functions without first calling INIT again.
It is safe to call this function multiple times.
See INIT
Returns a symbol identifying the driver underlying the device.
May be one of:
:EVDEV — (Linux evdev)
:DINPUT — (Windows DirectInput)
:XINPUT — (Windows XInput)
:IOKIT — (Apple IOKit)
See DEVICE
Returns a symbol identifying what icons to use for the buttons.
May be one of:
:GENERIC-NINTENDO
:GENERIC-XBOX
:GENERIC-PLAYSTATION
:NINTENDO-SWITCH
:DUALSHOCK-4
or another kind of label. You should be prepared to default to
:GENERIC-XBOX on encountering an unknown icon type.
See DEVICE
Returns a human-readable name for the device.
No guarantees can be made about the quality or descriptiveness of the
name.
See DEVICE
Returns an integer ID identifying the device product.
See DEVICE
Returns an integer ID identifying the vendor of the device.
See DEVICE
Returns an integer denoting the version of the device.
See DEVICE
Error signalled when an underlying operating system, driver, or device problem occurs.
Depending on the driver used the actual type of error signalled may be
a subtype of this condition with more information available about the
error specifics.
error.
Event issued when an axis moves.
This event may be signalled many times with very similar values.
It will NOT be issued if the combined axis (horizontal and vertical)
has a dead zone set and the axis falls within the dead zone.
If a ramp is defined on the axis, the value is already ramp-adjusted.
See EVENT-VALUE
see EVENT-OLD-VALUE
See EVENT
Event issued when a button is pressed down.
This event is only signalled once on the rising edge.
See EVENT
Event issued when a button is released.
This event is only signalled once on the falling edge.
See EVENT
Base type for device events.
An event denotes a change in the device’s buttons or axes.
See POLL-EVENTS
See BUTTON-DOWN
See BUTTON-UP
See AXIS-MOVE
See EVENT-DEVICE
See EVENT-TIME
See EVENT-CODE
See EVENT-LABEL
See EVENT-VALUE
See EVENT-OLD-VALUE
structure-object.
common-lisp.
(unsigned-byte 64)
0
(unsigned-byte 32)
0
symbol
Representation of a physical gamepad device.
The actual type of instances may be a subtype of this with internal
features relevant to the driver.
See NAME
See VENDOR
See PRODUCT
See VERSION
See DRIVER
See ICON-TYPE
(setf axis-dead-zones).
axis-dead-zones.
(setf axis-map).
axis-map.
(setf axis-ramps).
axis-ramps.
(setf axis-raw-states).
axis-raw-states.
(setf axis-states).
axis-states.
(setf button-map).
button-map.
(setf button-states).
button-states.
driver.
(setf icon-type).
icon-type.
initialize-instance.
name.
(setf orientation-map).
orientation-map.
print-object.
product.
vendor.
version.
:generic-xbox
:icon-type
(make-hash-table :test (quote eql))
:button-map
(make-hash-table :test (quote eql))
:axis-map
(make-hash-table :test (quote eql))
:orientation-map
(make-array (length org.shirakumo.fraf.gamepad:+labels+) :element-type (quote bit) :initial-element 0)
(make-array (length org.shirakumo.fraf.gamepad:+labels+) :element-type (quote single-float) :initial-element 0.0)
(make-array (length org.shirakumo.fraf.gamepad:+labels+) :element-type (quote single-float) :initial-element 0.0)
(make-array (length org.shirakumo.fraf.gamepad:+labels+) :initial-element (function identity))
(make-array (+ 2 (length org.shirakumo.fraf.gamepad:+labels+)) :element-type (quote single-float) :initial-element 0.0)
linux-error)) ¶code.
linux-error)) ¶linux-error)) ¶(quote nil)
:function-name
This slot is read-only.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
| Jump to: | %
(
A B C D E F G H I L M N O P Q R S T U V W |
|---|
| Jump to: | %
(
A B C D E F G H I L M N O P Q R S T U V W |
|---|
| Jump to: | *
A B C D E F I L M N O P S T V |
|---|
| Jump to: | *
A B C D E F I L M N O P S T V |
|---|
| Jump to: | A B C D E F G I L M N O P S W X |
|---|
| Jump to: | A B C D E F G I L M N O P S W X |
|---|