The cepl.sdl2 Reference Manual

This is the cepl.sdl2 Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:51:46 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cepl.sdl2

SDL2 host for cepl

Author

Chris Bagley (Baggers) <>

License

BSD 2 Clause

Dependencies
  • cepl (system).
  • sdl2 (system).
Source

cepl.sdl2.asd.

Child 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/cepl.sdl2.asd

Source

cepl.sdl2.asd.

Parent Component

cepl.sdl2 (system).

ASDF Systems

cepl.sdl2.


3.1.2 cepl.sdl2/package.lisp

Source

cepl.sdl2.asd.

Parent Component

cepl.sdl2 (system).

Packages

cepl.sdl2.


3.1.3 cepl.sdl2/cepl.sdl2.lisp

Dependency

package.lisp (file).

Source

cepl.sdl2.asd.

Parent Component

cepl.sdl2 (system).

Internals

4 Packages

Packages are listed by definition order.


4.1 cepl.sdl2

Source

package.lisp.

Use List
  • cepl.host.
  • common-lisp.
Internals

5 Definitions

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


5.1 Public Interface


5.2 Internals


5.2.1 Special variables

Special Variable: *core-context*
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Special Variable: *initd*
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.


5.2.2 Macros

Macro: %case-events ((event &key method timeout) &body event-handlers)
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.


5.2.3 Ordinary functions

Function: create-context-by-version (surface version)
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Function: destroy-sdl-surface (surface)
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Function: init-sdl2-low-level (&rest sdl-init-flags)
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Function: lisp->sdl-time (lisp-time)
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Function: low-level-quit ()
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

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.

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.

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.

Function: sdl->lisp-time (sdl-time)
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Function: sdl-make-current (context surface)
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Function: sdl-register-listener (func)
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Function: sdl-set-surface-fullscreen (surface state)
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Function: sdl-set-surface-size (win-handle width height)
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Function: sdl-set-surface-title (surface title)
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Function: sdl-shutdown ()
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Function: sdl-step-v1 (surface)
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Function: sdl-surface-fullscreen-p (surface)
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Function: sdl-surface-size (win-handle)
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Function: sdl-surface-title (surface)
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Function: sdl-swap (handle)
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Function: search-for-context (surface)
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Function: set-sdl->lisp-time-offset ()
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Function: vsync ()
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Function: (setf vsync) ()
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.


5.2.4 Generic functions

Generic Function: sdl-init (&rest init-flags)
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Methods
Method: sdl-init (&rest init-flags)

5.2.5 Classes

Class: sdl-api
Package

cepl.sdl2.

Source

cepl.sdl2.lisp.

Direct superclasses

api-2.

Direct slots
Slot: supports-multiple-contexts-p
Package

cepl.host.

Slot: supports-multiple-surfaces-p
Package

cepl.host.

Initform

t

Slot: init-function
Package

cepl.host.

Initform

(function cepl.sdl2::sdl-init)

Slot: shutdown-function
Package

cepl.host.

Initform

(function cepl.sdl2::sdl-shutdown)

Slot: make-surface-function
Package

cepl.host.

Initform

(function cepl.sdl2::make-sdl-surface)

Slot: destroy-surface-function
Package

cepl.host.

Initform

(function cepl.sdl2::destroy-sdl-surface)

Slot: make-context-function
Package

cepl.host.

Initform

(function cepl.sdl2::make-sdl-context)

Slot: step-function
Package

cepl.host.

Initform

(function cepl.sdl2::sdl-step-v1)

Slot: register-event-callback-function
Package

cepl.host.

Initform

(function cepl.sdl2::sdl-register-listener)

Slot: swap-function
Package

cepl.host.

Initform

(function cepl.sdl2::sdl-swap)

Slot: surface-size-function
Package

cepl.host.

Initform

(function cepl.sdl2::sdl-surface-size)

Slot: make-context-current-function
Package

cepl.host.

Initform

(function cepl.sdl2::sdl-make-current)

Slot: set-surface-size-function
Package

cepl.host.

Initform

(function cepl.sdl2::sdl-set-surface-size)

Slot: surface-fullscreen-p-function
Package

cepl.host.

Initform

(function cepl.sdl2::sdl-surface-fullscreen-p)

Slot: set-surface-fullscreen-function
Package

cepl.host.

Initform

(function cepl.sdl2::sdl-set-surface-fullscreen)

Slot: surface-title-function
Package

cepl.host.

Initform

(function cepl.sdl2::sdl-surface-title)

Slot: set-surface-title-function
Package

cepl.host.

Initform

(function cepl.sdl2::sdl-set-surface-title)

Slot: make-gl-context-shared-with-current-context-function
Package

cepl.host.

Initform

(function cepl.sdl2::make-shared-sdl-context)


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
C   D   F   G   I   L   M   S   V  
Index Entry  Section

%
%case-events: Private macros

(
(setf vsync): Private ordinary functions

C
create-context-by-version: Private ordinary functions

D
destroy-sdl-surface: Private ordinary functions

F
Function, (setf vsync): Private ordinary functions
Function, create-context-by-version: Private ordinary functions
Function, destroy-sdl-surface: Private ordinary functions
Function, init-sdl2-low-level: Private ordinary functions
Function, lisp->sdl-time: Private ordinary functions
Function, low-level-quit: Private ordinary functions
Function, make-sdl-context: Private ordinary functions
Function, make-sdl-surface: Private ordinary functions
Function, make-shared-sdl-context: Private ordinary functions
Function, sdl->lisp-time: Private ordinary functions
Function, sdl-make-current: Private ordinary functions
Function, sdl-register-listener: Private ordinary functions
Function, sdl-set-surface-fullscreen: Private ordinary functions
Function, sdl-set-surface-size: Private ordinary functions
Function, sdl-set-surface-title: Private ordinary functions
Function, sdl-shutdown: Private ordinary functions
Function, sdl-step-v1: Private ordinary functions
Function, sdl-surface-fullscreen-p: Private ordinary functions
Function, sdl-surface-size: Private ordinary functions
Function, sdl-surface-title: Private ordinary functions
Function, sdl-swap: Private ordinary functions
Function, search-for-context: Private ordinary functions
Function, set-sdl->lisp-time-offset: Private ordinary functions
Function, vsync: Private ordinary functions

G
Generic Function, sdl-init: Private generic functions

I
init-sdl2-low-level: Private ordinary functions

L
lisp->sdl-time: Private ordinary functions
low-level-quit: Private ordinary functions

M
Macro, %case-events: Private macros
make-sdl-context: Private ordinary functions
make-sdl-surface: Private ordinary functions
make-shared-sdl-context: Private ordinary functions
Method, sdl-init: Private generic functions

S
sdl->lisp-time: Private ordinary functions
sdl-init: Private generic functions
sdl-init: Private generic functions
sdl-make-current: Private ordinary functions
sdl-register-listener: Private ordinary functions
sdl-set-surface-fullscreen: Private ordinary functions
sdl-set-surface-size: Private ordinary functions
sdl-set-surface-title: Private ordinary functions
sdl-shutdown: Private ordinary functions
sdl-step-v1: Private ordinary functions
sdl-surface-fullscreen-p: Private ordinary functions
sdl-surface-size: Private ordinary functions
sdl-surface-title: Private ordinary functions
sdl-swap: Private ordinary functions
search-for-context: Private ordinary functions
set-sdl->lisp-time-offset: Private ordinary functions

V
vsync: Private ordinary functions


A.3 Variables

Jump to:   *  
D   I   M   R   S  
Index Entry  Section

*
*core-context*: Private special variables
*initd*: Private special variables

D
destroy-surface-function: Private classes

I
init-function: Private classes

M
make-context-current-function: Private classes
make-context-function: Private classes
make-gl-context-shared-with-current-context-function: Private classes
make-surface-function: Private classes

R
register-event-callback-function: Private classes

S
set-surface-fullscreen-function: Private classes
set-surface-size-function: Private classes
set-surface-title-function: Private classes
shutdown-function: Private classes
Slot, destroy-surface-function: Private classes
Slot, init-function: Private classes
Slot, make-context-current-function: Private classes
Slot, make-context-function: Private classes
Slot, make-gl-context-shared-with-current-context-function: Private classes
Slot, make-surface-function: Private classes
Slot, register-event-callback-function: Private classes
Slot, set-surface-fullscreen-function: Private classes
Slot, set-surface-size-function: Private classes
Slot, set-surface-title-function: Private classes
Slot, shutdown-function: Private classes
Slot, step-function: Private classes
Slot, supports-multiple-contexts-p: Private classes
Slot, supports-multiple-surfaces-p: Private classes
Slot, surface-fullscreen-p-function: Private classes
Slot, surface-size-function: Private classes
Slot, surface-title-function: Private classes
Slot, swap-function: Private classes
Special Variable, *core-context*: Private special variables
Special Variable, *initd*: Private special variables
step-function: Private classes
supports-multiple-contexts-p: Private classes
supports-multiple-surfaces-p: Private classes
surface-fullscreen-p-function: Private classes
surface-size-function: Private classes
surface-title-function: Private classes
swap-function: Private classes