Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the hu.dwim.sdl Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 05:02:47 2022 GMT+0.
Next: Systems, Previous: The hu.dwim.sdl Reference Manual, Up: The hu.dwim.sdl Reference Manual [Contents][Index]
It's a Common Lisp FFI for http://libsdl.org/ (SDL2).
The alternative projects are partial, while this one uses cffi/c2ffi to automatically generate the complete CFFI bindings for the various subsystems of SDL2.
It only requires vanilla CFFI when used, no extra dependencies.
Written by attila@lendvai.name.
The primary communication channel is the facilities on the project's GitHub page.
This project uses CFFI/C2FFI, whose ASDF extension does two things:
When needed, it can invoke c2ffi to process a C header file and emit a c2ffi spec file (a json file) that contains every detail needed to generate an FFI for a given platform. But yours truely has run this phase, and checked in the resulting spec files into the c2ffi-spec/ directory. This way users don't need to have a working c2ffi executable, nor the SDL dev headers installed.
Based on the above mentioned spec file, it generates the CFFI forms into a lisp file (placed next to the spec file), and continues as if it was just another lisp file written by hand. (These lisp files could also be committed into the repo, but for now they are not, because their regeneration is automatic and painless.)
This should only be done when the SDL API has some new functionality
that is needed on the Lisp side. Once the *.spec files got
regenerated, they should be pushed into the git repo; i.e. the users
of hu.dwim.sdl shouldn't need to do this normally.
This should work, assuming that you have a working c2ffi in the
path:
sudo apt-get install curl sbcl libsdl2-dev
rm -f c2ffi-spec/*.spec && ./bin/generate-spec-files.sh
$ nix-shell --pure
$ rm -f c2ffi-spec/*.spec && ./bin/generate-spec-files.sh
It contains a complete FFI for sdl.h, sdl-gfx.h, sdl-ttf.h, and sdl-image.h.
Not much has been added yet to lispify the SDL API, but the CFFI binding part is complete.
Next: Modules, Previous: Introduction, Up: The hu.dwim.sdl Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Common Lisp FFI wrapper for libSDL2.
Attila Lendvai
BSD or Bugroff
0.1
cffi/c2ffi (system).
Next: Files, Previous: Systems, Up: The hu.dwim.sdl Reference Manual [Contents][Index]
Modules are listed depth-first from the system components tree.
Next: hu.dwim.sdl/c2ffi-spec, Previous: Modules, Up: Modules [Contents][Index]
hu.dwim.sdl (system).
Previous: hu.dwim.sdl/source, Up: Modules [Contents][Index]
ffi-prelude.lisp (file).
hu.dwim.sdl (system).
sdl.h (file).
Next: Packages, Previous: Modules, Up: The hu.dwim.sdl Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: hu.dwim.sdl/package-stage-1.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
hu.dwim.sdl (system).
Next: hu.dwim.sdl/ffi-prelude.lisp, Previous: hu.dwim.sdl/hu.dwim.sdl.asd, Up: Lisp [Contents][Index]
hu.dwim.sdl (system).
Next: hu.dwim.sdl/source/package-stage-2.lisp, Previous: hu.dwim.sdl/package-stage-1.lisp, Up: Lisp [Contents][Index]
package-stage-1.lisp (file).
hu.dwim.sdl (system).
Next: hu.dwim.sdl/source/package-stage-3.lisp, Previous: hu.dwim.sdl/ffi-prelude.lisp, Up: Lisp [Contents][Index]
source (module).
import-all-owned-symbols (function).
Next: hu.dwim.sdl/source/sdl.lisp, Previous: hu.dwim.sdl/source/package-stage-2.lisp, Up: Lisp [Contents][Index]
package-stage-2.lisp (file).
source (module).
Next: hu.dwim.sdl/c2ffi-spec/sdl.h, Previous: hu.dwim.sdl/source/package-stage-3.lisp, Up: Lisp [Contents][Index]
package-stage-3.lisp (file).
source (module).
Previous: hu.dwim.sdl/source/sdl.lisp, Up: Lisp [Contents][Index]
c2ffi-spec (module).
Next: Definitions, Previous: Files, Up: The hu.dwim.sdl Reference Manual [Contents][Index]
Packages are listed by definition order.
Next: Indexes, Previous: Packages, Up: The hu.dwim.sdl Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Standalone methods, Previous: Public Interface, Up: Public Interface [Contents][Index]
Next: Conditions, Previous: Macros, Up: Public Interface [Contents][Index]
cffi.
Previous: Standalone methods, Up: Public Interface [Contents][Index]
error.
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Generic functions, Previous: Internals, Up: Internals [Contents][Index]
Next: Conditions, Previous: Ordinary functions, Up: Internals [Contents][Index]
Next: Classes, Previous: Generic functions, Up: Internals [Contents][Index]
Previous: Conditions, Up: Internals [Contents][Index]
foreign-type-alias.
| Initarg | Value |
|---|---|
| :actual-type | (parse-type int) |
Previous: Definitions, Up: The hu.dwim.sdl Reference Manual [Contents][Index]
| Jump to: | %
(
C E F G I M |
|---|
| Jump to: | %
(
C E F G I M |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
| Jump to: | E S |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| E | |||
error-code: | Private conditions | ||
| | |||
| S | |||
Slot, error-code: | Private conditions | ||
| | |||
| Jump to: | E S |
|---|
| Jump to: | C F H M P S |
|---|
| Jump to: | C F H M P S |
|---|