Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the hu.dwim.sdl Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 13:48:22 2020 GMT+0.
• Introduction | What hu.dwim.sdl is all about | |
• Systems | The systems documentation | |
• Modules | The modules documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
It's a Common Lisp FFI for http://libsdl.org/ (SDL2).
The alternative FFI bindings are partial, while this one already includes the CFFI bindings for the various subsystems of SDL2. It is also based on vanilla CFFI, without any extra dependencies.
Written by attila@lendvai.name. The primary communication channel is the facilities on the project's GitHub page.
The project uses CFFI/C2FFI. Its ASDF extension does two things:
If needed it can invoke c2ffi to process a C header file and emit a json spec file that contains every detail needed for a given platform to generate its FFI. Yours truely has run this phase and checked in the resulting spec files into the c2ffi-spec/ directory, so that users don't need to have a working c2ffi executable and the SDL dev headers installed.
It generates the needed CFFI forms into a lisp file next to the spec file and continues as if it was just another lisp file written by hand. (These lisp files could also be checked in the repo, but for now they are not.)
It contains a complete FFI for sdl.h
, sdl-gfx.h
, sdl-ttf.h
, and sdl-image.h
.
At the time of writing it requires a very recent CFFI.
There's not much yet that lispify the API, but the CFFI binding part is complete.
Next: Modules, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The hu.dwim.sdl system |
Attila Lendvai
BSD or Bugroff
Common Lisp FFI wrapper for libSDL2.
0.1
cffi/c2ffi
hu.dwim.sdl.asd (file)
Modules are listed depth-first from the system components tree.
• The hu.dwim.sdl/source module | ||
• The hu.dwim.sdl/c2ffi-spec module |
Next: The hu․dwim․sdl/c2ffi-spec module, Previous: Modules, Up: Modules [Contents][Index]
hu.dwim.sdl (system)
source/
Previous: The hu․dwim․sdl/source module, Up: Modules [Contents][Index]
ffi-prelude.lisp (file)
hu.dwim.sdl (system)
c2ffi-spec/
sdl.h (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
Next: The hu․dwim․sdl/package-stage-1․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
hu.dwim.sdl.asd
hu.dwim.sdl (system)
Next: The hu․dwim․sdl/ffi-prelude․lisp file, Previous: The hu․dwim․sdl․asd file, Up: Lisp files [Contents][Index]
hu.dwim.sdl (system)
source/package-stage-1.lisp
Next: The hu․dwim․sdl/source/package-stage-2․lisp file, Previous: The hu․dwim․sdl/package-stage-1․lisp file, Up: Lisp files [Contents][Index]
package-stage-1.lisp (file)
hu.dwim.sdl (system)
source/ffi-prelude.lisp
sdl-error (condition)
Next: The hu․dwim․sdl/source/package-stage-3․lisp file, Previous: The hu․dwim․sdl/ffi-prelude․lisp file, Up: Lisp files [Contents][Index]
source (module)
source/package-stage-2.lisp
import-all-owned-symbols (function)
Next: The hu․dwim․sdl/source/sdl․lisp file, Previous: The hu․dwim․sdl/source/package-stage-2․lisp file, Up: Lisp files [Contents][Index]
package-stage-2.lisp (file)
source (module)
source/package-stage-3.lisp
Next: The hu․dwim․sdl/c2ffi-spec/sdl․h file, Previous: The hu․dwim․sdl/source/package-stage-3․lisp file, Up: Lisp files [Contents][Index]
package-stage-3.lisp (file)
source (module)
source/sdl.lisp
Previous: The hu․dwim․sdl/source/sdl․lisp file, Up: Lisp files [Contents][Index]
c2ffi-spec (module)
c2ffi-spec/sdl.h
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The hu.dwim.sdl package |
package-stage-1.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported macros | ||
• Exported conditions |
Next: Exported conditions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
sdl.lisp (file)
sdl.lisp (file)
Previous: Exported macros, Up: Exported definitions [Contents][Index]
ffi-prelude.lisp (file)
error (condition)
sdl-error/negative-return-code (condition)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal functions | ||
• Internal generic functions | ||
• Internal conditions | ||
• Internal classes |
Next: Internal generic functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
sdl.lisp (file)
sdl.lisp (file)
ffi-prelude.lisp (file)
ffi-prelude.lisp (file)
package-stage-2.lisp (file)
Next: Internal conditions, Previous: Internal functions, Up: Internal definitions [Contents][Index]
ffi-prelude.lisp (file)
Next: Internal classes, Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
ffi-prelude.lisp (file)
:error-code
(quote (error "must specify error-code."))
error-code-of (generic function)
(setf error-code-of) (generic function)
Previous: Internal conditions, Up: Internal definitions [Contents][Index]
ffi-prelude.lisp (file)
foreign-type-alias (class)
expand-from-foreign (method)
Initarg | Value |
---|---|
:actual-type | (cffi::parse-type :int) |
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | F H L M |
---|
Jump to: | F H L M |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | %
(
C E F G I M |
---|
Jump to: | %
(
C E F G I M |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | E S |
---|
Index Entry | Section | ||
---|---|---|---|
| |||
E | |||
error-code : | Internal conditions | ||
| |||
S | |||
Slot, error-code : | Internal conditions | ||
|
Jump to: | E S |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C H P S |
---|
Jump to: | C H P S |
---|