The cepl.sdl2 Reference Manual
Table of Contents
The cepl.sdl2 Reference Manual
This is the cepl.sdl2 Reference Manual,
generated automatically by Declt version 3.0 "Montgomery Scott"
on Tue Dec 22 11:57:40 2020 GMT+0.
1 Introduction
Cepl.SDL2
This package lets SDL2 act as a host for cepl
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 cepl.sdl2
- Author
Chris Bagley (Baggers) <techsnuffle@gmail.com>
- License
BSD 2 Clause
- Description
SDL2 host for cepl
- Dependencies
-
- Source
cepl.sdl2.asd (file)
- Components
-
3 Files
Files are sorted by type and then listed depth-first from the systems
components trees.
3.1 Lisp
3.1.1 cepl.sdl2.asd
- Location
cepl.sdl2.asd
- Systems
cepl.sdl2 (system)
3.1.2 cepl.sdl2/package.lisp
- Parent
cepl.sdl2 (system)
- Location
package.lisp
- Packages
cepl.sdl2
3.1.3 cepl.sdl2/cepl.sdl2.lisp
- Dependency
package.lisp (file)
- Parent
cepl.sdl2 (system)
- Location
cepl.sdl2.lisp
- Internal Definitions
-
4 Packages
Packages are listed by definition order.
4.1 cepl.sdl2
- Source
package.lisp (file)
- Use List
-
- Internal Definitions
-
5 Definitions
Definitions are sorted by export status, category, package, and then by
lexicographic order.
5.1 Internal definitions
5.1.1 Special variables
- Special Variable: *core-context*
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Special Variable: *initd*
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
5.1.2 Macros
- Macro: %case-events (EVENT &key METHOD TIMEOUT) &body EVENT-HANDLERS
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
5.1.3 Functions
- Function: create-context-by-version SURFACE VERSION
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: destroy-sdl-surface SURFACE
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: init-sdl2-low-level &rest SDL-INIT-FLAGS
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: lisp->sdl-time LISP-TIME
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: low-level-quit ()
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: make-sdl-context SURFACE VERSION DOUBLE-BUFFER ALPHA-SIZE DEPTH-SIZE STENCIL-SIZE BUFFER-SIZE RED-SIZE GREEN-SIZE BLUE-SIZE
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: make-sdl-surface WIDTH HEIGHT TITLE FULLSCREEN NO-FRAME ALPHA-SIZE DEPTH-SIZE STENCIL-SIZE RED-SIZE GREEN-SIZE BLUE-SIZE BUFFER-SIZE DOUBLE-BUFFER HIDDEN RESIZABLE
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: make-shared-sdl-context CURRENT-GL-CONTEXT SURFACE VERSION DOUBLE-BUFFER ALPHA-SIZE DEPTH-SIZE STENCIL-SIZE BUFFER-SIZE RED-SIZE GREEN-SIZE BLUE-SIZE
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: sdl->lisp-time SDL-TIME
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: sdl-make-current CONTEXT SURFACE
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: sdl-register-listener FUNC
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: sdl-set-surface-fullscreen SURFACE STATE
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: sdl-set-surface-size WIN-HANDLE WIDTH HEIGHT
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: sdl-set-surface-title SURFACE TITLE
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: sdl-shutdown ()
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: sdl-step-v1 SURFACE
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: sdl-surface-fullscreen-p SURFACE
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: sdl-surface-size WIN-HANDLE
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: sdl-surface-title SURFACE
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: sdl-swap HANDLE
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: search-for-context SURFACE
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: set-sdl->lisp-time-offset ()
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Function: vsync ()
-
- Function: (setf vsync) BOOLEAN
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
5.1.4 Generic functions
- Generic Function: sdl-init &rest INIT-FLAGS
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Methods
- Method: sdl-init &rest INIT-FLAGS
-
5.1.5 Classes
- Class: sdl-api ()
-
- Package
cepl.sdl2
- Source
cepl.sdl2.lisp (file)
- Direct superclasses
api-2 (class)
- Direct slots
- Slot: supports-multiple-contexts-p
-
- Slot: supports-multiple-surfaces-p
-
- Initform
t
- Slot: init-function
-
- Initform
(function cepl.sdl2::sdl-init)
- Slot: shutdown-function
-
- Initform
(function cepl.sdl2::sdl-shutdown)
- Slot: make-surface-function
-
- Initform
(function cepl.sdl2::make-sdl-surface)
- Slot: destroy-surface-function
-
- Initform
(function cepl.sdl2::destroy-sdl-surface)
- Slot: make-context-function
-
- Initform
(function cepl.sdl2::make-sdl-context)
- Slot: step-function
-
- Initform
(function cepl.sdl2::sdl-step-v1)
- Slot: register-event-callback-function
-
- Initform
(function cepl.sdl2::sdl-register-listener)
- Slot: swap-function
-
- Initform
(function cepl.sdl2::sdl-swap)
- Slot: surface-size-function
-
- Initform
(function cepl.sdl2::sdl-surface-size)
- Slot: make-context-current-function
-
- Initform
(function cepl.sdl2::sdl-make-current)
- Slot: set-surface-size-function
-
- Initform
(function cepl.sdl2::sdl-set-surface-size)
- Slot: surface-fullscreen-p-function
-
- Initform
(function cepl.sdl2::sdl-surface-fullscreen-p)
- Slot: set-surface-fullscreen-function
-
- Initform
(function cepl.sdl2::sdl-set-surface-fullscreen)
- Slot: surface-title-function
-
- Initform
(function cepl.sdl2::sdl-surface-title)
- Slot: set-surface-title-function
-
- Initform
(function cepl.sdl2::sdl-set-surface-title)
- Slot: make-gl-context-shared-with-current-context-function
-
- Initform
(function cepl.sdl2::make-shared-sdl-context)
Appendix A Indexes
A.1 Concepts
A.2 Functions
| Index Entry | | Section |
|
% | | |
| %case-events : | | Internal macros |
|
( | | |
| (setf vsync) : | | Internal functions |
|
C | | |
| create-context-by-version : | | Internal functions |
|
D | | |
| destroy-sdl-surface : | | Internal functions |
|
F | | |
| Function, (setf vsync) : | | Internal functions |
| Function, create-context-by-version : | | Internal functions |
| Function, destroy-sdl-surface : | | Internal functions |
| Function, init-sdl2-low-level : | | Internal functions |
| Function, lisp->sdl-time : | | Internal functions |
| Function, low-level-quit : | | Internal functions |
| Function, make-sdl-context : | | Internal functions |
| Function, make-sdl-surface : | | Internal functions |
| Function, make-shared-sdl-context : | | Internal functions |
| Function, sdl->lisp-time : | | Internal functions |
| Function, sdl-make-current : | | Internal functions |
| Function, sdl-register-listener : | | Internal functions |
| Function, sdl-set-surface-fullscreen : | | Internal functions |
| Function, sdl-set-surface-size : | | Internal functions |
| Function, sdl-set-surface-title : | | Internal functions |
| Function, sdl-shutdown : | | Internal functions |
| Function, sdl-step-v1 : | | Internal functions |
| Function, sdl-surface-fullscreen-p : | | Internal functions |
| Function, sdl-surface-size : | | Internal functions |
| Function, sdl-surface-title : | | Internal functions |
| Function, sdl-swap : | | Internal functions |
| Function, search-for-context : | | Internal functions |
| Function, set-sdl->lisp-time-offset : | | Internal functions |
| Function, vsync : | | Internal functions |
|
G | | |
| Generic Function, sdl-init : | | Internal generic functions |
|
I | | |
| init-sdl2-low-level : | | Internal functions |
|
L | | |
| lisp->sdl-time : | | Internal functions |
| low-level-quit : | | Internal functions |
|
M | | |
| Macro, %case-events : | | Internal macros |
| make-sdl-context : | | Internal functions |
| make-sdl-surface : | | Internal functions |
| make-shared-sdl-context : | | Internal functions |
| Method, sdl-init : | | Internal generic functions |
|
S | | |
| sdl->lisp-time : | | Internal functions |
| sdl-init : | | Internal generic functions |
| sdl-init : | | Internal generic functions |
| sdl-make-current : | | Internal functions |
| sdl-register-listener : | | Internal functions |
| sdl-set-surface-fullscreen : | | Internal functions |
| sdl-set-surface-size : | | Internal functions |
| sdl-set-surface-title : | | Internal functions |
| sdl-shutdown : | | Internal functions |
| sdl-step-v1 : | | Internal functions |
| sdl-surface-fullscreen-p : | | Internal functions |
| sdl-surface-size : | | Internal functions |
| sdl-surface-title : | | Internal functions |
| sdl-swap : | | Internal functions |
| search-for-context : | | Internal functions |
| set-sdl->lisp-time-offset : | | Internal functions |
|
V | | |
| vsync : | | Internal functions |
|
A.3 Variables
| Index Entry | | Section |
|
* | | |
| *core-context* : | | Internal special variables |
| *initd* : | | Internal special variables |
|
D | | |
| destroy-surface-function : | | Internal classes |
|
I | | |
| init-function : | | Internal classes |
|
M | | |
| make-context-current-function : | | Internal classes |
| make-context-function : | | Internal classes |
| make-gl-context-shared-with-current-context-function : | | Internal classes |
| make-surface-function : | | Internal classes |
|
R | | |
| register-event-callback-function : | | Internal classes |
|
S | | |
| set-surface-fullscreen-function : | | Internal classes |
| set-surface-size-function : | | Internal classes |
| set-surface-title-function : | | Internal classes |
| shutdown-function : | | Internal classes |
| Slot, destroy-surface-function : | | Internal classes |
| Slot, init-function : | | Internal classes |
| Slot, make-context-current-function : | | Internal classes |
| Slot, make-context-function : | | Internal classes |
| Slot, make-gl-context-shared-with-current-context-function : | | Internal classes |
| Slot, make-surface-function : | | Internal classes |
| Slot, register-event-callback-function : | | Internal classes |
| Slot, set-surface-fullscreen-function : | | Internal classes |
| Slot, set-surface-size-function : | | Internal classes |
| Slot, set-surface-title-function : | | Internal classes |
| Slot, shutdown-function : | | Internal classes |
| Slot, step-function : | | Internal classes |
| Slot, supports-multiple-contexts-p : | | Internal classes |
| Slot, supports-multiple-surfaces-p : | | Internal classes |
| Slot, surface-fullscreen-p-function : | | Internal classes |
| Slot, surface-size-function : | | Internal classes |
| Slot, surface-title-function : | | Internal classes |
| Slot, swap-function : | | Internal classes |
| Special Variable, *core-context* : | | Internal special variables |
| Special Variable, *initd* : | | Internal special variables |
| step-function : | | Internal classes |
| supports-multiple-contexts-p : | | Internal classes |
| supports-multiple-surfaces-p : | | Internal classes |
| surface-fullscreen-p-function : | | Internal classes |
| surface-size-function : | | Internal classes |
| surface-title-function : | | Internal classes |
| swap-function : | | Internal classes |
|
A.4 Data types