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 Thu Mar 11 11:42:32 2021 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

• cepl
• sdl2

Source

cepl.sdl2.asd (file)

Components

• package.lisp (file)
• cepl.sdl2.lisp (file)

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

• %case-events (macro)
• *core-context* (special variable)
• *initd* (special variable)
• create-context-by-version (function)
• destroy-sdl-surface (function)
• init-sdl2-low-level (function)
• lisp->sdl-time (function)
• low-level-quit (function)
• make-sdl-context (function)
• make-sdl-surface (function)
• make-shared-sdl-context (function)
• sdl->lisp-time (function)
• sdl-api (class)
• sdl-init (generic function)
• sdl-init (method)
• sdl-make-current (function)
• sdl-register-listener (function)
• sdl-set-surface-fullscreen (function)
• sdl-set-surface-size (function)
• sdl-set-surface-title (function)
• sdl-shutdown (function)
• sdl-step-v1 (function)
• sdl-surface-fullscreen-p (function)
• sdl-surface-size (function)
• sdl-surface-title (function)
• sdl-swap (function)
• search-for-context (function)
• set-sdl->lisp-time-offset (function)
• vsync (function)
• (setf vsync) (function)

4 Packages

Packages are listed by definition order.

4.1 cepl.sdl2

Source

package.lisp (file)

Use List

• cepl.host
• common-lisp

Internal Definitions

• %case-events (macro)
• *core-context* (special variable)
• *initd* (special variable)
• create-context-by-version (function)
• destroy-sdl-surface (function)
• init-sdl2-low-level (function)
• lisp->sdl-time (function)
• low-level-quit (function)
• make-sdl-context (function)
• make-sdl-surface (function)
• make-shared-sdl-context (function)
• sdl->lisp-time (function)
• sdl-api (class)
• sdl-init (generic function)
• sdl-init (method)
• sdl-make-current (function)
• sdl-register-listener (function)
• sdl-set-surface-fullscreen (function)
• sdl-set-surface-size (function)
• sdl-set-surface-title (function)
• sdl-shutdown (function)
• sdl-step-v1 (function)
• sdl-surface-fullscreen-p (function)
• sdl-surface-size (function)
• sdl-surface-title (function)
• sdl-swap (function)
• search-for-context (function)
• set-sdl->lisp-time-offset (function)
• vsync (function)
• (setf vsync) (function)

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

A.3 Variables

A.4 Data types