The cl-sdl2 Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-sdl2 Reference Manual

This is the cl-sdl2 Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Jan 09 14:01:05 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

cl-sdl2

cl-sdl2 is a Common Lisp wrapper for the SDL 2.0 C Library, with many contributors, maintained primarily by the following:

It is licensed under the MIT license.

Installation

sdl2 is in Quicklisp, see below for instructions.

SDL 2.0 C Library Install

See https://wiki.libsdl.org/Installation

On Linux, you can probably find SDL2 in your distribution's package set. For other platforms, or for building manually, download the source.

Package

sudo apt-get install libsdl2-2.0
sudo pacman -S sdl2

Compilation

If you need to compile from source for your Linux platform:

  1. Download source code
  2. Compile
  3. Install

For example:

cd /tmp
wget https://www.libsdl.org/release/SDL2-2.0.4.tar.gz
tar -xzvf SDL2-2.?.?.tar.gz
cd SDL2-2.?.?
./configure
make
sudo make install

This will install the SDL-2.0.x C Library into your /usr/local location.

It's generally a good idea to install at a minimum the version of SDL2 that was wrapped; however, sub revisions should not introduce binary incompatibility and should be fine. If you install a different version, certain features may not be available or may not work correctly.

Quicklisp Install

sdl2 is best installed via QuickLisp, though for cutting-edge changes, you may want to install from github as below.

If you don't have Quicklisp, then follow the directions to install it. We assume you placed the Quicklisp repository in the default place as indicated by the directions and have added it to your lisp init file.

github install

cd $HOME/quicklisp/local-projects
git clone https://github.com/rpav/cl-autowrap.git
git clone https://github.com/lispgames/cl-sdl2.git

Then, use quicklisp to install the libraries required by cl-sdl2:

Start your lisp. Then, just:

(ql:quickload "sdl2")

Swank/Slynk features

sdl2 enables certain restarts for friendly interaction with SLIME or Sly if you have either properly installed. "Proper installation" in this case means swank.asd or slynk.asd is linked such that ASDF can find and load it.

Note this is easily achieved even if you have installed them from github or some other non-Quicklisp repository:

Similarly you could just clone into ~/quicklisp/local-projects as well; this should work on Windows as well. There are numerous other options for configuring and managing ASDs, as well.

Running the sdl2 examples

Start your lisp:

(ql:quickload :sdl2/examples)
(sdl2-examples:basic-test)

This example will open a window with an opengl primitive in it. Any mouse movements or keystrokes are recorded in the terminal (or emacs SLIME output buffer *inferior-lisp*). Hitting the ESCAPE key will terminate the example.

OSX

Newer versions of OSX have had some difficulties as calls which require nextEventMatchingMask must be called from the main thread of your program.

This is especially relevant to SBCL, although issues have also been noticed in CCL.

Currently, initialisation must take place on your main thread:

(ql:quickload :sdl2/examples)

;; We should be able to run examples as normal on CCL
#-sbcl (sdl2-examples:basic-test)

;; SBCL requires that we initialise in the main thread
#+sbcl (sdl2:make-this-thread-main #'sdl2-examples:basic-test)

Thank you for using sdl2!


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 sdl2

Author

Chip Collier <photex@lofidelitygames.com>

License

MIT

Description

Bindings for SDL2 using c2ffi.

Dependencies
Source

sdl2.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.


Previous: , Up: Modules   [Contents][Index]

3.1 sdl2/autowrap-spec

Parent

sdl2 (system)

Location

spec/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Next: , Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 sdl2.asd

Location

/home/quickbuilder/quicklisp/dists/quicklisp/software/cl-sdl2-20171130-git/sdl2.asd

Systems

sdl2 (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 sdl2/package.lisp

Dependency

autowrap-spec (module)

Parent

sdl2 (system)

Location

package.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 sdl2/optional-deps.lisp

Dependency

package.lisp (file)

Parent

sdl2 (system)

Location

optional-deps.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 sdl2/library.lisp

Dependency

optional-deps.lisp (file)

Parent

sdl2 (system)

Location

library.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.5 sdl2/autowrap.lisp

Dependency

library.lisp (file)

Parent

sdl2 (system)

Location

autowrap.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.6 sdl2/util.lisp

Dependency

autowrap.lisp (file)

Parent

sdl2 (system)

Location

util.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.7 sdl2/sdl2.lisp

Dependency

util.lisp (file)

Parent

sdl2 (system)

Location

sdl2.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.8 sdl2/rect.lisp

Dependency

sdl2.lisp (file)

Parent

sdl2 (system)

Location

rect.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.9 sdl2/video.lisp

Dependency

rect.lisp (file)

Parent

sdl2 (system)

Location

video.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.10 sdl2/events.lisp

Dependency

video.lisp (file)

Parent

sdl2 (system)

Location

events.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.11 sdl2/keyboard.lisp

Dependency

events.lisp (file)

Parent

sdl2 (system)

Location

keyboard.lisp

Exported Definitions
Internal Definitions

c-keysym (macro)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.12 sdl2/mouse.lisp

Dependency

keyboard.lisp (file)

Parent

sdl2 (system)

Location

mouse.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.13 sdl2/syswm.lisp

Dependency

mouse.lisp (file)

Parent

sdl2 (system)

Location

syswm.lisp

Exported Definitions

get-window-wm-info (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.14 sdl2/joystick.lisp

Dependency

syswm.lisp (file)

Parent

sdl2 (system)

Location

joystick.lisp

Exported Definitions
Internal Definitions

joystick-caps-query (macro)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.15 sdl2/gamecontroller.lisp

Dependency

joystick.lisp (file)

Parent

sdl2 (system)

Location

gamecontroller.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.16 sdl2/haptic.lisp

Dependency

gamecontroller.lisp (file)

Parent

sdl2 (system)

Location

haptic.lisp

Exported Definitions
Internal Definitions

%haptic-open (macro)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.17 sdl2/timer.lisp

Dependency

haptic.lisp (file)

Parent

sdl2 (system)

Location

timer.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.18 sdl2/audio.lisp

Dependency

timer.lisp (file)

Parent

sdl2 (system)

Location

audio.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.19 sdl2/platform.lisp

Dependency

audio.lisp (file)

Parent

sdl2 (system)

Location

platform.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.20 sdl2/pixels.lisp

Dependency

platform.lisp (file)

Parent

sdl2 (system)

Location

pixels.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.21 sdl2/surface.lisp

Dependency

pixels.lisp (file)

Parent

sdl2 (system)

Location

surface.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.22 sdl2/rwops.lisp

Dependency

surface.lisp (file)

Parent

sdl2 (system)

Location

rwops.lisp

Exported Definitions
Internal Definitions

%sdl-rw-close (function)


Previous: , Up: Lisp files   [Contents][Index]

4.1.23 sdl2/render.lisp

Dependencies
Parent

sdl2 (system)

Location

render.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Files   [Contents][Index]

4.2 Other


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.1 sdl2/autowrap-spec/SDL2.h

Parent

autowrap-spec (module)

Location

spec/SDL2.h


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.2 sdl2/autowrap-spec/SDL2.arm-pc-linux-gnu.spec

Parent

autowrap-spec (module)

Location

spec/SDL2.arm-pc-linux-gnu.spec


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.3 sdl2/autowrap-spec/SDL2.i386-unknown-freebsd.spec

Parent

autowrap-spec (module)

Location

spec/SDL2.i386-unknown-freebsd.spec


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.4 sdl2/autowrap-spec/SDL2.i386-unknown-openbsd.spec

Parent

autowrap-spec (module)

Location

spec/SDL2.i386-unknown-openbsd.spec


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.5 sdl2/autowrap-spec/SDL2.i686-apple-darwin9.spec

Parent

autowrap-spec (module)

Location

spec/SDL2.i686-apple-darwin9.spec


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.6 sdl2/autowrap-spec/SDL2.i686-pc-linux-gnu.spec

Parent

autowrap-spec (module)

Location

spec/SDL2.i686-pc-linux-gnu.spec


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.7 sdl2/autowrap-spec/SDL2.i686-pc-windows-msvc.spec

Parent

autowrap-spec (module)

Location

spec/SDL2.i686-pc-windows-msvc.spec


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.8 sdl2/autowrap-spec/SDL2.x86_64-apple-darwin9.spec

Parent

autowrap-spec (module)

Location

spec/SDL2.x86_64-apple-darwin9.spec


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.9 sdl2/autowrap-spec/SDL2.x86_64-pc-linux-gnu.spec

Parent

autowrap-spec (module)

Location

spec/SDL2.x86_64-pc-linux-gnu.spec


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.10 sdl2/autowrap-spec/SDL2.x86_64-pc-windows-msvc.spec

Parent

autowrap-spec (module)

Location

spec/SDL2.x86_64-pc-windows-msvc.spec


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.11 sdl2/autowrap-spec/SDL2.x86_64-unknown-freebsd.spec

Parent

autowrap-spec (module)

Location

spec/SDL2.x86_64-unknown-freebsd.spec


Previous: , Up: Other files   [Contents][Index]

4.2.12 sdl2/autowrap-spec/SDL2.x86_64-unknown-openbsd.spec

Parent

autowrap-spec (module)

Location

spec/SDL2.x86_64-unknown-openbsd.spec


Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 sdl2-examples

Source

package.lisp (file)

Use List

Previous: , Up: Packages   [Contents][Index]

5.2 sdl2

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Macros

Macro: alti-vec-p ()

Returns t if CPU has MMX features, nil if not.

Package

sdl2

Source

platform.lisp (file)

Macro: cpu-cache-line-size ()

Returns the L1 cache line size of the CPU.
This is useful for determining multi-threaded structure padding or SIMD prefetch sizes.

Package

sdl2

Source

platform.lisp (file)

Macro: cpu-count ()

Returns the total number of logical CPU cores.
On CPUs that include technologies such as hyperthreading,
the number of logical cores may be more than the number of physical cores.

Package

sdl2

Source

platform.lisp (file)

Macro: delay MS

This function waits a specified number of milliseconds before returning. It waits at least the specified time, but possibly longer due to OS scheduling

Package

sdl2

Source

timer.lisp (file)

Macro: get-performance-counter ()

This function is typically used for profiling.
The counter values are only meaningful relative to each other. Differences between values can be converted to times
by using ’get-performance-frequency’.

Package

sdl2

Source

timer.lisp (file)

Macro: get-performance-frequency ()

Returns a platform-specific count per second.

Package

sdl2

Source

timer.lisp (file)

Macro: get-ticks ()

Returns an unsigned 32-bit value representing the number of milliseconds since the SDL library initialized.

Package

sdl2

Source

timer.lisp (file)

Macro: in-main-thread (&key BACKGROUND NO-EVENT) &body B
Package

sdl2

Source

sdl2.lisp (file)

Macro: joystick-update ()

Use this function to update the current state of the open joysticks. This function is called automatically by the event loop if joystick events are enabled.

Package

sdl2

Source

joystick.lisp (file)

Macro: mmx-p ()

Returns t if CPU has MMX features, nil if not.

Package

sdl2

Source

platform.lisp (file)

Macro: rdtsc-p ()

Returns t if CPU has the RDTSC instruction, nil if not.

Package

sdl2

Source

platform.lisp (file)

Macro: sse-p ()

Returns t if CPU has SSE features, nil if not.

Package

sdl2

Source

platform.lisp (file)

Macro: sse2-p ()

Returns t if CPU has SSE 2 features, nil if not.

Package

sdl2

Source

platform.lisp (file)

Macro: sse3-p ()

Returns t if CPU has SSE 3 features, nil if not.

Package

sdl2

Source

platform.lisp (file)

Macro: sse41-p ()

Returns t if CPU has SSE 4.1 features, nil if not.

Package

sdl2

Source

platform.lisp (file)

Macro: sse42-p ()

Returns t if CPU has SSE 4.2 features, nil if not.

Package

sdl2

Source

platform.lisp (file)

Macro: warp-mouse-in-window WIN X Y

Use this function to move the mouse to the given position within the window.

Package

sdl2

Source

mouse.lisp (file)

Macro: with-event-loop (&key BACKGROUND METHOD TIMEOUT RECURSIVE) &body EVENT-HANDLERS
Package

sdl2

Source

events.lisp (file)

Macro: with-everything (&key WINDOW GL) &body BODY
Package

sdl2

Source

video.lisp (file)

Macro: with-gl-context (GL-CONTEXT-SYM WIN) &body BODY
Package

sdl2

Source

video.lisp (file)

Macro: with-init (&rest SDL-INIT-FLAGS) &body BODY
Package

sdl2

Source

sdl2.lisp (file)

Macro: with-points BINDINGS &body BODY

A LET-like convenient bindings facility for SDL_point structures. Raw symbols are bound to (make-point 0 0).

Example:

(let ((a 1) (b 2))
(with-points (foo
(qux 5 10)
(bar (1+ a) b)
(list foo qux bar))))

-> (#<SDL-FFI:SDL-POINT x 0 y 0> #<SDL-FFI:SDL-POINT x 5 y 10> #<SDL-FFI:SDL-POINT x 2 y 2>)

Package

sdl2

Source

rect.lisp (file)

Macro: with-rects BINDINGS &body BODY

A LET-like convenient bindings facility for SDL_Rect structures. Raw symbols are bound to (make-rect 0 0 0 0).

Example:

(let ((a 1) (b 2) (c 3) (d 4))
(with-rects (foo
(qux 5 10 15 20)
(bar (1+ a) b c (* d 10)))
(list foo qux bar)))

-> (#<SDL-FFI:SDL-RECT x 0 y 0 w 0 z 0> #<SDL-FFI:SDL-RECT x 5 y 10 w 15 h 20> #<SDL-FFI:SDL-RECT x 2 y 2 w 3 d 40>)

Package

sdl2

Source

rect.lisp (file)

Macro: with-renderer (RENDERER-SYM WINDOW &key INDEX FLAGS) &body BODY
Package

sdl2

Source

render.lisp (file)

Macro: with-sdl-event (EVENT &optional EVENT-TYPE) &body BODY

Allocate and automatically free an sdl event struct.

Package

sdl2

Source

events.lisp (file)

Macro: with-window (WIN &key TITLE X Y W H FLAGS) &body BODY
Package

sdl2

Source

video.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Functions

Function: add-timer INTERVAL FN ARGS

Use this function to set up a callback function to be run on a
separate thread after the specified number of milliseconds has elapsed.

The callback function is passed the current timer interval and the
user supplied parameter from the ’add-timer’ call and returns the next timer interval. If the returned value from the callback is 0, the timer is canceled.

Package

sdl2

Source

timer.lisp (file)

Function: blit-scaled SURFACE-SRC SRC-RECT SURFACE-DST DST-RECT
Package

sdl2

Source

surface.lisp (file)

Function: blit-surface SURFACE-SRC SRC-RECT SURFACE-DST DST-RECT
Package

sdl2

Source

surface.lisp (file)

Function: convert-surface SURFACE FORMAT &key FLAGS
Package

sdl2

Source

surface.lisp (file)

Function: convert-surface-format SURFACE PIXEL-FORMAT-ENUM &key FLAGS
Package

sdl2

Source

surface.lisp (file)

Function: copy-into-point DEST-POINT SRC-POINT

Copy the information from the SDL_Point src-point into the SDL_Point dest-point. Return the dest-point.

Package

sdl2

Source

rect.lisp (file)

Function: copy-into-rect DEST-RECT SRC-RECT

Copy the information from the SDL_Rect src-rect into the SDL_Rect dest-rect. Return the dest-rect.

Package

sdl2

Source

rect.lisp (file)

Function: copy-point POINT

Allocate and return a new SDL_Point and make its slots be equal to the passed in SDL_Point.

Package

sdl2

Source

rect.lisp (file)

Function: copy-rect RECT

Allocate and return a new SDL_Rect and make its slots be equal to the passed in SDL_Rect.

Package

sdl2

Source

rect.lisp (file)

Function: create-renderer WINDOW &optional INDEX FLAGS

Create a 2D rendering context for a window.

Package

sdl2

Source

render.lisp (file)

Function: create-rgb-surface WIDTH HEIGHT DEPTH &key R-MASK G-MASK B-MASK A-MASK FLAGS
Package

sdl2

Source

surface.lisp (file)

Function: create-rgb-surface-from PIXELS WIDTH HEIGHT DEPTH PITCH &key R-MASK G-MASK B-MASK A-MASK
Package

sdl2

Source

surface.lisp (file)

Function: create-software-renderer SURFACE

Create and return a 2D software rendering context for the surface.

Package

sdl2

Source

render.lisp (file)

Function: create-texture RENDERER PIXEL-FORMAT ACCESS WIDTH HEIGHT

Use this function to create a texture for a rendering context.

Package

sdl2

Source

render.lisp (file)

Function: create-texture-from-surface RENDERER SURFACE

Use this function to create a texture from sdl2 surface for a rendering context.

Package

sdl2

Source

render.lisp (file)

Function: create-window &key TITLE X Y W H FLAGS
Package

sdl2

Source

video.lisp (file)

Function: create-window-and-renderer WIDTH HEIGHT FLAGS
Package

sdl2

Source

render.lisp (file)

Function: destroy-renderer R
Package

sdl2

Source

render.lisp (file)

Function: destroy-texture TEXTURE

Use this function to destroy the specified texture.

Package

sdl2

Source

render.lisp (file)

Function: destroy-window WIN
Package

sdl2

Source

video.lisp (file)

Function: disable-screensaver ()
Package

sdl2

Source

video.lisp (file)

Function: enable-screensaver ()
Package

sdl2

Source

video.lisp (file)

Function: fill-rect SURFACE-DST RECT COLOR
Package

sdl2

Source

surface.lisp (file)

Function: free-event EVENT
Package

sdl2

Source

events.lisp (file)

Function: free-point POINT

Specifically free the SDL_Point structure which will do the right thing with respect to the garbage collector. This is not required, but may make garbage collection performance better if used in tight SDL_Point allocating loops.

Package

sdl2

Source

rect.lisp (file)

Function: free-rect RECT

Specifically free the SDL_Rect structure which will do the right thing with respect to the garbage collector. This is not required, but may make garbage collection performance better if used in tight SDL_Rect allocating loops.

Package

sdl2

Source

rect.lisp (file)

Function: free-surface SURFACE
Package

sdl2

Source

surface.lisp (file)

Function: game-controller-add-mapping MAPPING-STRING

Use this function to add support for controllers that SDL is unaware of or to cause an existing controller to have a different binding.

Package

sdl2

Source

gamecontroller.lisp (file)

Function: game-controller-attached-p GAMECONTROLLER
Package

sdl2

Source

gamecontroller.lisp (file)

Function: game-controller-close GAMECONTROLLER
Package

sdl2

Source

gamecontroller.lisp (file)

Function: game-controller-get-joystick GAMECONTROLLER
Package

sdl2

Source

gamecontroller.lisp (file)

Function: game-controller-instance-id C
Package

sdl2

Source

gamecontroller.lisp (file)

Function: game-controller-name-for-index DEVICE-INDEX

Return the human readable name for the device-index provided.

Package

sdl2

Source

gamecontroller.lisp (file)

Function: game-controller-open DEVICE-INDEX
Package

sdl2

Source

gamecontroller.lisp (file)

Function: game-controller-p DEVICE-INDEX

Returns t if the device-index provided belongs to a joystick with a known gamecontroller mapping.

Package

sdl2

Source

gamecontroller.lisp (file)

Function: get-alpha-mod SURFACE

Use this function to get the additional alpha value used in blit operations.

Package

sdl2

Source

surface.lisp (file)

Function: get-color-key SURFACE

Use this function to get the color key (transparent pixel) for a surface.

Package

sdl2

Source

surface.lisp (file)

Function: get-color-mod SURFACE

Use this function to get the additional color value multiplied into blit operations.

Package

sdl2

Source

surface.lisp (file)

Function: get-current-display-mode DISPLAY-INDEX
Package

sdl2

Source

video.lisp (file)

Function: get-current-video-driver ()
Package

sdl2

Source

video.lisp (file)

Function: get-display-bounds DISPLAY-INDEX

Use this function to get the desktop area represented by a display, with the primary display located at 0,0.

Package

sdl2

Source

video.lisp (file)

Function: get-display-mode DISPLAY-INDEX MODE-INDEX
Package

sdl2

Source

video.lisp (file)

Function: get-display-name DISPLAY-INDEX
Package

sdl2

Source

video.lisp (file)

Function: get-event-type EVENT
Package

sdl2

Source

events.lisp (file)

Function: get-key-from-scancode SCANCODE
Package

sdl2

Source

keyboard.lisp (file)

Function: get-key-name KEY
Package

sdl2

Source

keyboard.lisp (file)

Function: get-num-display-modes DISPLAY-INDEX
Package

sdl2

Source

video.lisp (file)

Function: get-num-render-drivers ()

Return the number of 2D rendering drivers available for the current display.

Package

sdl2

Source

render.lisp (file)

Function: get-num-video-displays ()
Package

sdl2

Source

video.lisp (file)

Function: get-num-video-drivers ()
Package

sdl2

Source

video.lisp (file)

Function: get-pixel-format-name FORMAT-INTEGER

Returns the human readable name for a surface’s pixel format, useful for debugging.

Package

sdl2

Source

pixels.lisp (file)

Function: get-render-driver-info INDEX

Allocate and return a new SDL_RendererInfo structure and fill it with information relating to the specific 2D rendering driver specified in the index.

Package

sdl2

Source

render.lisp (file)

Function: get-renderer WINDOW

Return NIL if there is no renderer associated with the window, or otherwise the SDL_Renderer structure.

Package

sdl2

Source

render.lisp (file)

Function: get-renderer-info RENDERER

Allocate a new SDL_RendererInfo structure, fill it in with information about the specified renderer, and return it.

Package

sdl2

Source

render.lisp (file)

Function: get-renderer-output-size RENDERER
Package

sdl2

Source

render.lisp (file)

Function: get-texture-alpha-mod TEXTURE

Use this function to get the additional alpha value multiplied into render copy operations.

Package

sdl2

Source

render.lisp (file)

Function: get-texture-color-mod TEXTURE

Use this function to get the additional color value multiplied into render copy operations.

Package

sdl2

Source

render.lisp (file)

Function: get-video-driver DRIVER-INDEX
Package

sdl2

Source

video.lisp (file)

Function: get-window-aspect-ratio WIN
Package

sdl2

Source

video.lisp (file)

Function: get-window-flags WIN
Package

sdl2

Source

video.lisp (file)

Function: get-window-id WIN
Package

sdl2

Source

video.lisp (file)

Function: get-window-pixel-format WIN

Use this function to get the pixel format associated with the window.

Package

sdl2

Source

video.lisp (file)

Function: get-window-position WIN
Package

sdl2

Source

video.lisp (file)

Function: get-window-size WIN
Package

sdl2

Source

video.lisp (file)

Function: get-window-surface WIN
Package

sdl2

Source

video.lisp (file)

Function: get-window-title WIN
Package

sdl2

Source

video.lisp (file)

Function: get-window-wm-info WINDOW
Package

sdl2

Source

syswm.lisp (file)

Function: gl-bind-texture TEXTURE
Package

sdl2

Source

render.lisp (file)

Function: gl-create-context WIN
Package

sdl2

Source

video.lisp (file)

Function: gl-delete-context GL-CONTEXT
Package

sdl2

Source

video.lisp (file)

Function: gl-extension-supported-p EXTENSION
Package

sdl2

Source

video.lisp (file)

Function: gl-get-attr ATTR
Package

sdl2

Source

video.lisp (file)

Function: gl-get-attrs &rest ATTRS
Package

sdl2

Source

video.lisp (file)

Function: gl-get-proc-address PROC-NAME
Package

sdl2

Source

video.lisp (file)

Function: gl-get-swap-interval ()
Package

sdl2

Source

video.lisp (file)

Function: gl-make-current WIN GL-CONTEXT
Package

sdl2

Source

video.lisp (file)

Function: gl-set-attr ATTR VALUE
Package

sdl2

Source

video.lisp (file)

Function: gl-set-attrs &rest ATTR-PLIST
Package

sdl2

Source

video.lisp (file)

Function: gl-set-swap-interval INTERVAL

0 for immediate updates, 1 for updates synchronized with the vertical retrace

Package

sdl2

Source

video.lisp (file)

Function: gl-swap-window WIN
Package

sdl2

Source

video.lisp (file)

Function: gl-unbind-texture TEXTURE
Package

sdl2

Source

render.lisp (file)

Function: haptic-close HAPTIC

Use this function to close an opened haptic device.

Package

sdl2

Source

haptic.lisp (file)

Function: haptic-index HAPTIC
Package

sdl2

Source

haptic.lisp (file)

Function: haptic-open SOURCE

Use this function to open the N’th haptic device for use.

Package

sdl2

Source

haptic.lisp (file)

Function: haptic-open-from-joystick SOURCE

Use this function to open a joystick haptic device for use

Package

sdl2

Source

haptic.lisp (file)

Function: haptic-open-from-mouse ()

Use this function to open the mouses haptic device for use.

Package

sdl2

Source

haptic.lisp (file)

Function: haptic-opened-p HAPTIC
Package

sdl2

Source

haptic.lisp (file)

Function: has-intersect FIRST-RECT &rest RECTS

Return T if every SDL_Rect structure intersects every other SDL_Rect structure.

Package

sdl2

Source

rect.lisp (file)

Function: hide-cursor ()
Package

sdl2

Source

mouse.lisp (file)

Function: hide-window WIN
Package

sdl2

Source

video.lisp (file)

Function: init &rest SDL-INIT-FLAGS

Initialize SDL2 with the specified subsystems. Initializes everything by default.

Package

sdl2

Source

sdl2.lisp (file)

Function: intersect-rect FIRST-RECT &rest RECTS

Return two values. The first one is T if the intersection of ALL rectangles results in a non-empty intersection. The second value is the SDL_Rect of the intersection rectangle. If an empty intersection is discovered, then NIL and an empty rectangle at the origin is returned. The second value is always a newly allocated SDL_Rect structure.

Package

sdl2

Source

rect.lisp (file)

Function: joystick-axis-count JOYSTICK
Package

sdl2

Source

joystick.lisp (file)

Function: joystick-ball-count JOYSTICK
Package

sdl2

Source

joystick.lisp (file)

Function: joystick-button-count JOYSTICK
Package

sdl2

Source

joystick.lisp (file)

Function: joystick-close JOYSTICK
Package

sdl2

Source

joystick.lisp (file)

Function: joystick-count ()
Package

sdl2

Source

joystick.lisp (file)

Function: joystick-hat-count JOYSTICK
Package

sdl2

Source

joystick.lisp (file)

Function: joystick-instance-id JOYSTICK
Package

sdl2

Source

joystick.lisp (file)

Function: joystick-is-haptic-p JOYSTICK
Package

sdl2

Source

haptic.lisp (file)

Function: joystick-name JOYSTICK
Package

sdl2

Source

joystick.lisp (file)

Function: joystick-name-for-index DEVICE-INDEX
Package

sdl2

Source

joystick.lisp (file)

Function: joystick-open DEVICE-INDEX
Package

sdl2

Source

joystick.lisp (file)

Function: key-down-p STATE
Package

sdl2

Source

keyboard.lisp (file)

Function: key-up-p STATE
Package

sdl2

Source

keyboard.lisp (file)

Function: keyboard-state-p SCANCODE

Whether the key corresponding to the given scancode is currently pressed.

Package

sdl2

Source

keyboard.lisp (file)

Function: load-bmp FILENAME
Package

sdl2

Source

surface.lisp (file)

Function: lock-texture TEXTURE &optional RECT

Use this function to lock a portion of the texture for write-only pixel access.

Package

sdl2

Source

render.lisp (file)

Function: make-point X Y

Return an SDL_Point filled in with the arguments. It will be garbage collected as needed.

Package

sdl2

Source

rect.lisp (file)

Function: make-rect X Y W H

Allocate and return a new SDL_Rect filled in with the arguments. It will be garbage collected as needed.

Package

sdl2

Source

rect.lisp (file)

Function: make-this-thread-main &optional FUNCTION

Designate the current thread as the SDL2 main thread. This function will not return until ‘SDL2:QUIT‘ is handled. Users of this function will need to start other threads before this call, or specify ‘FUNCTION‘.

If ‘FUNCTION‘ is specified, it will be called when the main thread channel is ensured. This is like calling ‘IN-MAIN-THREAD‘, except it allows for a potentially single-threaded application. This function does **not** return just because ‘FUNCTION‘ returns; it still requires ‘SDL2:QUIT‘ be processed.

This does **not** call ‘SDL2:INIT‘ by itself. Do this either with ‘FUNCTION‘, or from a separate thread.

Package

sdl2

Source

sdl2.lisp (file)

Function: map-rgb PIXEL-FORMAT R G B
Package

sdl2

Source

pixels.lisp (file)

Function: maximize-window WIN
Package

sdl2

Source

video.lisp (file)

Function: minimize-window WIN
Package

sdl2

Source

video.lisp (file)

Function: mod-keywords VALUE
Package

sdl2

Source

keyboard.lisp (file)

Function: mod-value KEYSYM
Package

sdl2

Source

keyboard.lisp (file)

Function: mod-value-p VALUE &rest KEYWORDS
Package

sdl2

Source

keyboard.lisp (file)

Function: mouse-is-haptic-p ()
Package

sdl2

Source

haptic.lisp (file)

Function: mouse-state ()

Returns (VALUES X Y BITMASK) where X, Y give the mouse cursor position relative to the focused window and BITMASK has bit i from the right set if and only if mouse button i is pressed.

Package

sdl2

Source

mouse.lisp (file)

Function: mouse-state-p BUTTON

Whether the mouse button numbered BUTTON is pressed. 1 indicates the left mouse button, 2 the middle mouse button and 3 the right mouse button.

Package

sdl2

Source

mouse.lisp (file)

Function: new-event &optional EVENT-TYPE
Package

sdl2

Source

events.lisp (file)

Function: next-event EVENT &optional METHOD TIMEOUT

Method can be either :poll, :wait. If :wait is used, ‘TIMEOUT‘ may be specified.

Package

sdl2

Source

events.lisp (file)

Function: platform ()

Returns the name of the platform.
If the correct platform name is not available, returns a string beginning with the text "Unknown"

Package

sdl2

Source

platform.lisp (file)

Function: point-x POINT
Function: (setf point-x) V POINT
Package

sdl2

Source

rect.lisp (file)

Function: point-y POINT
Function: (setf point-y) V POINT
Package

sdl2

Source

rect.lisp (file)

Function: points* &rest POINTS

Return a pointer to SDL_Point and the number of elements in it.

Package

sdl2

Source

rect.lisp (file)

Function: power-info ()

Use this function to get the current power supply details.

Returns the current power state, seconds remaining, and percent remaining.
- Power state will be one of: :unknown, :on-battery, :no-battery, :charging, :charged
- Seconds will be -1 if a value can’t be determined or you’re not running on battery.
- Percent remaining will be a value between 0 and 100, or -1 if a value can’t be determined or you’re not running on battery.

You should never take a battery status as absolute truth.
Batteries (especially failing batteries) are delicate hardware, and the
values reported here are best estimates based on what that hardware reports.
It’s not uncommon for older batteries to lose stored power much faster than it reports, or completely drain when reporting it has 20 percent left, etc.

Battery status can change at any time; if you are concerned with power state,
you should call this function frequently, and perhaps ignore changes until they
seem to be stable for a few seconds.

Package

sdl2

Source

platform.lisp (file)

Function: pump-events ()
Package

sdl2

Source

events.lisp (file)

Function: push-event EVENT

Allocates a new sdl event struct of the specified type and pushes it into the queue.

Package

sdl2

Source

events.lisp (file)

Function: push-quit-event ()
Package

sdl2

Source

events.lisp (file)

Function: push-user-event USER-EVENT &optional USER-DATA

Allocates a new user-defined sdl event struct of the specified type and pushes it into the queue. Stores the optional user-data in sdl2::*user-events*

Package

sdl2

Source

events.lisp (file)

Function: query-texture TEXTURE
Package

sdl2

Source

render.lisp (file)

Function: quit ()

Shuts down SDL2.

Package

sdl2

Source

sdl2.lisp (file)

Function: raise-window WIN
Package

sdl2

Source

video.lisp (file)

Function: rect-empty &rest RECTS

Return T if the rectangle has no width or height.

Package

sdl2

Source

rect.lisp (file)

Function: rect-equals FIRST-RECT &rest RECTS

Return T if the passed in SDL_Rect structures are valid and all slots are equal to each other.

Package

sdl2

Source

rect.lisp (file)

Function: rect-height RECT
Function: (setf rect-height) V RECT
Package

sdl2

Source

rect.lisp (file)

Function: rect-width RECT
Function: (setf rect-width) V RECT
Package

sdl2

Source

rect.lisp (file)

Function: rect-x RECT
Function: (setf rect-x) V RECT
Package

sdl2

Source

rect.lisp (file)

Function: rect-y RECT
Function: (setf rect-y) V RECT
Package

sdl2

Source

rect.lisp (file)

Function: rects* &rest RECTS

Return a pointer to SDL_Rect and the number of elements in it.

Package

sdl2

Source

rect.lisp (file)

Function: register-user-event-type USER-EVENT-TYPE

Register a new sdl event-type if it doesn’t already exist

Package

sdl2

Source

events.lisp (file)

Function: relative-mouse-mode-p ()
Package

sdl2

Source

mouse.lisp (file)

Function: remove-timer TIMER

Use this function to remove a timer created with ’add-timer’.

Package

sdl2

Source

timer.lisp (file)

Function: render-clear RENDERER

Use this function to clear the current rendering target with the drawing color.

Package

sdl2

Source

render.lisp (file)

Function: render-copy RENDERER TEXTURE &key SOURCE-RECT DEST-RECT

Use this function to copy a portion of the texture to the current rendering target.

Package

sdl2

Source

render.lisp (file)

Function: render-copy-ex RENDERER TEXTURE &key SOURCE-RECT DEST-RECT ANGLE CENTER FLIP

Use this function to copy a portion of the texture to the current rendering target, optionally rotating it by angle around the given center and also flipping it top-bottom and/or left-right.

Package

sdl2

Source

render.lisp (file)

Function: render-draw-line RENDERER X1 Y1 X2 Y2

Use this function to draw a line on the current rendering target.

Package

sdl2

Source

render.lisp (file)

Function: render-draw-lines RENDERER POINTS NUM-POINTS

Pass a pointer to SDL_Point to render connected lines on the current rendering target.

Package

sdl2

Source

render.lisp (file)

Function: render-draw-point RENDERER X Y

Use this function to draw a point on the current rendering target.

Package

sdl2

Source

render.lisp (file)

Function: render-draw-points RENDERER POINTS NUM-POINTS

Use this function to draw multiple points on the current rendering target.

Package

sdl2

Source

render.lisp (file)

Function: render-draw-rect RENDERER SDL-RECT

Use this function to draw a rectangle on the current rendering target.

Package

sdl2

Source

render.lisp (file)

Function: render-draw-rects RENDERER RECTS NUM-RECTS

Use this function to draw some number of rectangles on the current rendering target.

Package

sdl2

Source

render.lisp (file)

Function: render-fill-rect RENDERER SDL-RECT

Use this function to fill a rectangle on the current rendering target with the drawing color.

Package

sdl2

Source

render.lisp (file)

Function: render-fill-rects RENDERER RECTS NUM-RECTS

Use this function to fill some number of rectangles on the current rendering target with the drawing color.

Package

sdl2

Source

render.lisp (file)

Function: render-get-viewport RENDERER

Use this function to get the drawing area for the current target.

Package

sdl2

Source

render.lisp (file)

Function: render-present RENDERER

Use this function to update the screen with rendering performed.

Package

sdl2

Source

render.lisp (file)

Function: render-set-viewport RENDERER SDL-RECT

Use this function to set the drawing area for rendering on the current target.

Package

sdl2

Source

render.lisp (file)

Function: restore-window WIN
Package

sdl2

Source

video.lisp (file)

Function: rumble-init HAPTIC

Use this function to initialize a haptic device for simple rumble.

Package

sdl2

Source

haptic.lisp (file)

Function: rumble-play HAPTIC STRENGTH DURATION

Use this function to play a simple rumble effect on a haptic device.

Package

sdl2

Source

haptic.lisp (file)

Function: rumble-stop HAPTIC

Use this function to stop the rumble on a haptic device.

Package

sdl2

Source

haptic.lisp (file)

Function: rumble-supported-p HAPTIC

Use this function to test whether rumble is supported on a haptic device.

Package

sdl2

Source

haptic.lisp (file)

Function: rw-close SDL-RWOPS-STRUCT

Flush the file represented by the sdl-rwops object and free the memory associated with it. Returns 0 if the file is successfully flushed and -1 otherwise. Even if the file fails to flush the memory is freed and pointer is invalid

Package

sdl2

Source

rwops.lisp (file)

Function: rw-from-file FILE-NAME MODE

Create an RWops structure from a given file name in a given mode.

Package

sdl2

Source

rwops.lisp (file)

Function: scancode KEYSYM

Converts a keysym to a scancode keyword.

Package

sdl2

Source

keyboard.lisp (file)

Function: scancode-key-name SCANCODE
Package

sdl2

Source

keyboard.lisp (file)

Function: scancode-key-to-value SCANCODE-KEY

Converts a scancode keyword to its numerical value.

Package

sdl2

Source

keyboard.lisp (file)

Function: scancode-name SCANCODE
Package

sdl2

Source

keyboard.lisp (file)

Function: scancode-symbol SCANCODE

Converts a scancode number to a scancode keyword.

Package

sdl2

Source

keyboard.lisp (file)

Function: scancode-value KEYSYM

Converts a keysym to the numerical value of its scancode.

Package

sdl2

Source

keyboard.lisp (file)

Function: screensaver-enabled-p ()
Package

sdl2

Source

video.lisp (file)

Function: set-alpha-mod SURFACE ALPHA

Use this function to set an additional alpha value used in blit operations.

Package

sdl2

Source

surface.lisp (file)

Function: set-color-key SURFACE FLAG KEY

Use this function to set the color key (transparent pixel) in a surface.

Package

sdl2

Source

surface.lisp (file)

Function: set-color-mod SURFACE R G B

Use this function to set an additional color value multiplied into blit operations.

Package

sdl2

Source

surface.lisp (file)

Function: set-relative-mouse-mode ENABLED
Package

sdl2

Source

mouse.lisp (file)

Function: set-render-draw-blend-mode RENDERER BLEND-MODE

Use this function to set the blend mode used for drawing operations (Fill and Line).

Package

sdl2

Source

render.lisp (file)

Function: set-render-draw-color RENDERER R G B A

Use this function to set the color used for drawing operations (Rect, Line and Clear).

Package

sdl2

Source

render.lisp (file)

Function: set-render-target RENDERER TEXTURE

Use this function to set a texture as the current rendering target.

Package

sdl2

Source

render.lisp (file)

Function: set-texture-alpha-mod TEXTURE ALPHA

Use this function to set an additional alpha value multiplied into render copy operations.

Package

sdl2

Source

render.lisp (file)

Function: set-texture-blend-mode TEXTURE BLEND-MODE

Use this function to set the blend mode for a texture, used by SDL_RenderCopy().

Package

sdl2

Source

render.lisp (file)

Function: set-texture-color-mod TEXTURE R G B

Use this function to set an additional color value multiplied into render copy operations.

Package

sdl2

Source

render.lisp (file)

Function: set-window-fullscreen WIN FULLSCREEN-VALUE

‘FULLSCREEN-VALUE‘ of ‘t‘ or ‘:fullscreen‘ is "regular" fullscreen, ‘SDL_WINDOW_FULLSCREEN‘. Specifying ‘:windowed‘ or ‘:desktop‘ is "windowed" fullscreen, using ‘SDL_WINDOW_FULLSCREEN_DESKTOP‘.

Package

sdl2

Source

video.lisp (file)

Function: set-window-position WIN X Y
Package

sdl2

Source

video.lisp (file)

Function: set-window-size WIN W H
Package

sdl2

Source

video.lisp (file)

Function: set-window-title WIN TITLE
Package

sdl2

Source

video.lisp (file)

Function: show-cursor ()
Package

sdl2

Source

mouse.lisp (file)

Function: show-window WIN
Package

sdl2

Source

video.lisp (file)

Function: start-text-input ()
Package

sdl2

Source

keyboard.lisp (file)

Function: stop-text-input ()
Package

sdl2

Source

keyboard.lisp (file)

Function: surface-format SURFACE
Package

sdl2

Source

surface.lisp (file)

Function: surface-format-format SURFACE
Package

sdl2

Source

surface.lisp (file)

Function: surface-height SURFACE
Package

sdl2

Source

surface.lisp (file)

Function: surface-pitch SURFACE
Package

sdl2

Source

surface.lisp (file)

Function: surface-pixels SURFACE

Access raw pixel data from a surface object

Package

sdl2

Source

surface.lisp (file)

Function: surface-width SURFACE
Package

sdl2

Source

surface.lisp (file)

Function: sym-value KEYSYM
Package

sdl2

Source

keyboard.lisp (file)

Function: texture-height TEXTURE
Package

sdl2

Source

render.lisp (file)

Function: texture-width TEXTURE
Package

sdl2

Source

render.lisp (file)

Function: toggle-relative-mouse-mode ()
Package

sdl2

Source

mouse.lisp (file)

Function: union-rect FIRST-RECT &rest RECTS

Calculate and return the union of all rectangles passed in. The result will be one large rectangle as a newly allocated SDL_rect in which all others fit perfectly.

Package

sdl2

Source

rect.lisp (file)

Function: unlock-texture TEXTURE

Use this function to unlock a texture, uploading the changes to video memory, if needed. Warning: See Bug No. 1586 before using this function!

Package

sdl2

Source

render.lisp (file)

Function: update-texture TEXTURE PIXELS &key RECT WIDTH

Use this function to update the given texture rectangle with new pixel data.

Package

sdl2

Source

render.lisp (file)

Function: update-window WIN
Package

sdl2

Source

video.lisp (file)

Function: version ()
Package

sdl2

Source

sdl2.lisp (file)

Function: version-wrapped ()
Package

sdl2

Source

sdl2.lisp (file)

Function: was-init &rest FLAGS
Package

sdl2

Source

sdl2.lisp (file)

Function: windowpos-centered &optional DISPLAY
Package

sdl2

Source

video.lisp (file)

Function: windowpos-from-coord N
Package

sdl2

Source

video.lisp (file)

Function: windowpos-undefined &optional DISPLAY
Package

sdl2

Source

video.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Generic functions

Generic Function: scancode= VALUE SCANCODE-KEY
Package

sdl2

Source

keyboard.lisp (file)

Methods
Method: scancode= (KEYSYM sdl-keysym) SCANCODE-KEY
Method: scancode= (SCANCODE integer) SCANCODE-KEY

Previous: , Up: Exported definitions   [Contents][Index]

6.1.4 Conditions

Condition: sdl-continue ()
Package

sdl2

Source

sdl2.lisp (file)

Direct superclasses

condition (condition)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: *default-controller-maps*
Package

sdl2

Source

gamecontroller.lisp (file)

Special Variable: *event-loop*
Package

sdl2

Source

events.lisp (file)

Special Variable: *event-type-to-accessor*
Package

sdl2

Source

events.lisp (file)

Special Variable: *lisp-message-event*
Package

sdl2

Source

sdl2.lisp (file)

Special Variable: *main-thread*
Package

sdl2

Source

sdl2.lisp (file)

Special Variable: *main-thread-channel*
Package

sdl2

Source

sdl2.lisp (file)

Special Variable: *the-main-thread*
Package

sdl2

Source

sdl2.lisp (file)

Special Variable: *user-event-codes*
Package

sdl2

Source

events.lisp (file)

Special Variable: *user-event-id*
Package

sdl2

Source

events.lisp (file)

Special Variable: *user-event-types*
Package

sdl2

Source

events.lisp (file)

Special Variable: *user-events*
Package

sdl2

Source

events.lisp (file)

Special Variable: *wakeup-event*
Package

sdl2

Source

sdl2.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Macros

Macro: %haptic-open FN SOURCE

Unused

Package

sdl2

Source

haptic.lisp (file)

Macro: %with-point (BINDING) &body BODY
Package

sdl2

Source

rect.lisp (file)

Macro: %with-rect (BINDING) &body BODY
Package

sdl2

Source

rect.lisp (file)

Macro: add-to-default-controller-maps &rest MAPS
Package

sdl2

Source

gamecontroller.lisp (file)

Macro: c-keysym (KS) &body BODY
Package

sdl2

Source

keyboard.lisp (file)

Macro: c-point (WRAPPER-VAR) &body BODY
Package

sdl2

Source

rect.lisp (file)

Macro: c-points (&rest WRAPPERS) &body BODY
Package

sdl2

Source

rect.lisp (file)

Macro: c-rect (R) &body BODY
Package

sdl2

Source

rect.lisp (file)

Macro: c-rects (&rest WRAPPERS) &body BODY
Package

sdl2

Source

rect.lisp (file)

Macro: check-false FORM
Package

sdl2

Source

sdl2.lisp (file)

Macro: check-nil FORM
Package

sdl2

Source

sdl2.lisp (file)

Macro: check-nullptr FORM
Package

sdl2

Source

sdl2.lisp (file)

Macro: check-rc FORM
Package

sdl2

Source

sdl2.lisp (file)

Macro: check-zero FORM
Package

sdl2

Source

sdl2.lisp (file)

Macro: define-struct-accessors (PREFIX FOREIGN-STRUCT) &body FIELDS
Package

sdl2

Source

util.lisp (file)

Macro: joystick-caps-query FN JOYSTICK
Package

sdl2

Source

joystick.lisp (file)

Macro: let-rects BINDINGS &body BODY
Package

sdl2

Source

rect.lisp (file)

Macro: without-fp-traps &body BODY
Package

sdl2

Source

sdl2.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Functions

Function: %rect-equal A B

Return T if the two rectanges are valid and the slots are equal

Package

sdl2

Source

rect.lisp (file)

Function: %sdl-rw-close SDL-RWOPS-PTR
Package

sdl2

Source

rwops.lisp (file)

Function: add-user-data USER-DATA
Package

sdl2

Source

events.lisp (file)

Function: audio-big-endian-p X
Package

sdl2

Source

audio.lisp (file)

Function: audio-bitsize X
Package

sdl2

Source

audio.lisp (file)

Function: audio-float-p X
Package

sdl2

Source

audio.lisp (file)

Function: audio-int-p X
Package

sdl2

Source

audio.lisp (file)

Function: audio-little-endian-p X
Package

sdl2

Source

audio.lisp (file)

Function: audio-signed-p X
Package

sdl2

Source

audio.lisp (file)

Function: audio-unsigned-p X
Package

sdl2

Source

audio.lisp (file)

Function: ensure-main-channel ()
Package

sdl2

Source

sdl2.lisp (file)

Function: expand-handler SDL-EVENT EVENT-TYPE PARAMS FORMS
Package

sdl2

Source

events.lisp (file)

Function: expand-idle-handler EVENT-HANDLERS
Package

sdl2

Source

events.lisp (file)

Function: expand-quit-handler SDL-EVENT FORMS QUIT
Package

sdl2

Source

events.lisp (file)

Function: free-render-info RINFO

Specifically free the SDL_RendererInfo structure which will do the right thing with respect to the garbage collector. This is not required, but may make garbage collection performance better if used in tight SDL_RendererInfo allocating loops.

Package

sdl2

Source

render.lisp (file)

Function: free-user-data EVENT-ID
Package

sdl2

Source

events.lisp (file)

Function: get-and-handle-messages ()
Package

sdl2

Source

sdl2.lisp (file)

Function: get-event-code EVENT-TYPE
Package

sdl2

Source

events.lisp (file)

Function: get-user-data EVENT-ID

Returns the user-data attached to an event-id and if the event-id was found

Package

sdl2

Source

events.lisp (file)

Function: handle-message MSG
Package

sdl2

Source

sdl2.lisp (file)

Function: make-renderer-info ()

Return an uninitialized SDL_RendererInfo structure.

Package

sdl2

Source

render.lisp (file)

Function: niy MESSAGE
Package

sdl2

Source

sdl2.lisp (file)

Function: recv-and-handle-message ()
Package

sdl2

Source

sdl2.lisp (file)

Function: sdl-cancel-collect WRAPPED-PTR
Package

sdl2

Source

sdl2.lisp (file)

Function: sdl-collect WRAPPED-PTR &optional FREE-FUN
Package

sdl2

Source

sdl2.lisp (file)

Function: sdl-main-thread ()
Package

sdl2

Source

sdl2.lisp (file)

Function: sdl-true-p INTEGER-BOOL

Use this function to convert truth from a low level wrapped SDL function returning an SDL_true into CL’s boolean type system.

Package

sdl2

Source

sdl2.lisp (file)

Function: unique-pairs LIST

Return all unique pair combinations of the list.

Package

sdl2

Source

util.lisp (file)

Function: unpack-event-params EVENT-VAR EVENT-TYPE PARAMS
Package

sdl2

Source

events.lisp (file)

Function: user-event-type-p EVENT-TYPE
Package

sdl2

Source

events.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.4 Generic functions

Generic Function: sdl-error-code CONDITION
Generic Function: (setf sdl-error-code) NEW-VALUE CONDITION
Package

sdl2

Methods
Method: sdl-error-code (CONDITION sdl-rc-error)
Method: (setf sdl-error-code) NEW-VALUE (CONDITION sdl-rc-error)
Source

sdl2.lisp (file)

Generic Function: sdl-error-string CONDITION
Generic Function: (setf sdl-error-string) NEW-VALUE CONDITION
Package

sdl2

Methods
Method: sdl-error-string (CONDITION sdl-error)
Method: (setf sdl-error-string) NEW-VALUE (CONDITION sdl-error)
Source

sdl2.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.5 Conditions

Condition: sdl-error ()
Package

sdl2

Source

sdl2.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

sdl-rc-error (condition)

Direct methods
Direct slots
Slot: string
Initargs

:string

Initform

(quote nil)

Readers

sdl-error-string (generic function)

Writers

(setf sdl-error-string) (generic function)

Condition: sdl-rc-error ()
Package

sdl2

Source

sdl2.lisp (file)

Direct superclasses

sdl-error (condition)

Direct methods
Direct slots
Slot: code
Initargs

:rc

Initform

(quote nil)

Readers

sdl-error-code (generic function)

Writers

(setf sdl-error-code) (generic function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   M   O   S  
Index Entry  Section

F
File, Lisp, sdl2.asd: The sdl2<dot>asd file
File, Lisp, sdl2/audio.lisp: The sdl2/audio<dot>lisp file
File, Lisp, sdl2/autowrap.lisp: The sdl2/autowrap<dot>lisp file
File, Lisp, sdl2/events.lisp: The sdl2/events<dot>lisp file
File, Lisp, sdl2/gamecontroller.lisp: The sdl2/gamecontroller<dot>lisp file
File, Lisp, sdl2/haptic.lisp: The sdl2/haptic<dot>lisp file
File, Lisp, sdl2/joystick.lisp: The sdl2/joystick<dot>lisp file
File, Lisp, sdl2/keyboard.lisp: The sdl2/keyboard<dot>lisp file
File, Lisp, sdl2/library.lisp: The sdl2/library<dot>lisp file
File, Lisp, sdl2/mouse.lisp: The sdl2/mouse<dot>lisp file
File, Lisp, sdl2/optional-deps.lisp: The sdl2/optional-deps<dot>lisp file
File, Lisp, sdl2/package.lisp: The sdl2/package<dot>lisp file
File, Lisp, sdl2/pixels.lisp: The sdl2/pixels<dot>lisp file
File, Lisp, sdl2/platform.lisp: The sdl2/platform<dot>lisp file
File, Lisp, sdl2/rect.lisp: The sdl2/rect<dot>lisp file
File, Lisp, sdl2/render.lisp: The sdl2/render<dot>lisp file
File, Lisp, sdl2/rwops.lisp: The sdl2/rwops<dot>lisp file
File, Lisp, sdl2/sdl2.lisp: The sdl2/sdl2<dot>lisp file
File, Lisp, sdl2/surface.lisp: The sdl2/surface<dot>lisp file
File, Lisp, sdl2/syswm.lisp: The sdl2/syswm<dot>lisp file
File, Lisp, sdl2/timer.lisp: The sdl2/timer<dot>lisp file
File, Lisp, sdl2/util.lisp: The sdl2/util<dot>lisp file
File, Lisp, sdl2/video.lisp: The sdl2/video<dot>lisp file
File, other, sdl2/autowrap-spec/SDL2.arm-pc-linux-gnu.spec: The sdl2/autowrap-spec/sdl2<dot>arm-pc-linux-gnu<dot>spec file
File, other, sdl2/autowrap-spec/SDL2.h: The sdl2/autowrap-spec/sdl2<dot>h file
File, other, sdl2/autowrap-spec/SDL2.i386-unknown-freebsd.spec: The sdl2/autowrap-spec/sdl2<dot>i386-unknown-freebsd<dot>spec file
File, other, sdl2/autowrap-spec/SDL2.i386-unknown-openbsd.spec: The sdl2/autowrap-spec/sdl2<dot>i386-unknown-openbsd<dot>spec file
File, other, sdl2/autowrap-spec/SDL2.i686-apple-darwin9.spec: The sdl2/autowrap-spec/sdl2<dot>i686-apple-darwin9<dot>spec file
File, other, sdl2/autowrap-spec/SDL2.i686-pc-linux-gnu.spec: The sdl2/autowrap-spec/sdl2<dot>i686-pc-linux-gnu<dot>spec file
File, other, sdl2/autowrap-spec/SDL2.i686-pc-windows-msvc.spec: The sdl2/autowrap-spec/sdl2<dot>i686-pc-windows-msvc<dot>spec file
File, other, sdl2/autowrap-spec/SDL2.x86_64-apple-darwin9.spec: The sdl2/autowrap-spec/sdl2<dot>x86_64-apple-darwin9<dot>spec file
File, other, sdl2/autowrap-spec/SDL2.x86_64-pc-linux-gnu.spec: The sdl2/autowrap-spec/sdl2<dot>x86_64-pc-linux-gnu<dot>spec file
File, other, sdl2/autowrap-spec/SDL2.x86_64-pc-windows-msvc.spec: The sdl2/autowrap-spec/sdl2<dot>x86_64-pc-windows-msvc<dot>spec file
File, other, sdl2/autowrap-spec/SDL2.x86_64-unknown-freebsd.spec: The sdl2/autowrap-spec/sdl2<dot>x86_64-unknown-freebsd<dot>spec file
File, other, sdl2/autowrap-spec/SDL2.x86_64-unknown-openbsd.spec: The sdl2/autowrap-spec/sdl2<dot>x86_64-unknown-openbsd<dot>spec file

L
Lisp File, sdl2.asd: The sdl2<dot>asd file
Lisp File, sdl2/audio.lisp: The sdl2/audio<dot>lisp file
Lisp File, sdl2/autowrap.lisp: The sdl2/autowrap<dot>lisp file
Lisp File, sdl2/events.lisp: The sdl2/events<dot>lisp file
Lisp File, sdl2/gamecontroller.lisp: The sdl2/gamecontroller<dot>lisp file
Lisp File, sdl2/haptic.lisp: The sdl2/haptic<dot>lisp file
Lisp File, sdl2/joystick.lisp: The sdl2/joystick<dot>lisp file
Lisp File, sdl2/keyboard.lisp: The sdl2/keyboard<dot>lisp file
Lisp File, sdl2/library.lisp: The sdl2/library<dot>lisp file
Lisp File, sdl2/mouse.lisp: The sdl2/mouse<dot>lisp file
Lisp File, sdl2/optional-deps.lisp: The sdl2/optional-deps<dot>lisp file
Lisp File, sdl2/package.lisp: The sdl2/package<dot>lisp file
Lisp File, sdl2/pixels.lisp: The sdl2/pixels<dot>lisp file
Lisp File, sdl2/platform.lisp: The sdl2/platform<dot>lisp file
Lisp File, sdl2/rect.lisp: The sdl2/rect<dot>lisp file
Lisp File, sdl2/render.lisp: The sdl2/render<dot>lisp file
Lisp File, sdl2/rwops.lisp: The sdl2/rwops<dot>lisp file
Lisp File, sdl2/sdl2.lisp: The sdl2/sdl2<dot>lisp file
Lisp File, sdl2/surface.lisp: The sdl2/surface<dot>lisp file
Lisp File, sdl2/syswm.lisp: The sdl2/syswm<dot>lisp file
Lisp File, sdl2/timer.lisp: The sdl2/timer<dot>lisp file
Lisp File, sdl2/util.lisp: The sdl2/util<dot>lisp file
Lisp File, sdl2/video.lisp: The sdl2/video<dot>lisp file

M
Module, sdl2/autowrap-spec: The sdl2/autowrap-spec module

O
Other File, sdl2/autowrap-spec/SDL2.arm-pc-linux-gnu.spec: The sdl2/autowrap-spec/sdl2<dot>arm-pc-linux-gnu<dot>spec file
Other File, sdl2/autowrap-spec/SDL2.h: The sdl2/autowrap-spec/sdl2<dot>h file
Other File, sdl2/autowrap-spec/SDL2.i386-unknown-freebsd.spec: The sdl2/autowrap-spec/sdl2<dot>i386-unknown-freebsd<dot>spec file
Other File, sdl2/autowrap-spec/SDL2.i386-unknown-openbsd.spec: The sdl2/autowrap-spec/sdl2<dot>i386-unknown-openbsd<dot>spec file
Other File, sdl2/autowrap-spec/SDL2.i686-apple-darwin9.spec: The sdl2/autowrap-spec/sdl2<dot>i686-apple-darwin9<dot>spec file
Other File, sdl2/autowrap-spec/SDL2.i686-pc-linux-gnu.spec: The sdl2/autowrap-spec/sdl2<dot>i686-pc-linux-gnu<dot>spec file
Other File, sdl2/autowrap-spec/SDL2.i686-pc-windows-msvc.spec: The sdl2/autowrap-spec/sdl2<dot>i686-pc-windows-msvc<dot>spec file
Other File, sdl2/autowrap-spec/SDL2.x86_64-apple-darwin9.spec: The sdl2/autowrap-spec/sdl2<dot>x86_64-apple-darwin9<dot>spec file
Other File, sdl2/autowrap-spec/SDL2.x86_64-pc-linux-gnu.spec: The sdl2/autowrap-spec/sdl2<dot>x86_64-pc-linux-gnu<dot>spec file
Other File, sdl2/autowrap-spec/SDL2.x86_64-pc-windows-msvc.spec: The sdl2/autowrap-spec/sdl2<dot>x86_64-pc-windows-msvc<dot>spec file
Other File, sdl2/autowrap-spec/SDL2.x86_64-unknown-freebsd.spec: The sdl2/autowrap-spec/sdl2<dot>x86_64-unknown-freebsd<dot>spec file
Other File, sdl2/autowrap-spec/SDL2.x86_64-unknown-openbsd.spec: The sdl2/autowrap-spec/sdl2<dot>x86_64-unknown-openbsd<dot>spec file

S
sdl2.asd: The sdl2<dot>asd file
sdl2/audio.lisp: The sdl2/audio<dot>lisp file
sdl2/autowrap-spec: The sdl2/autowrap-spec module
sdl2/autowrap-spec/SDL2.arm-pc-linux-gnu.spec: The sdl2/autowrap-spec/sdl2<dot>arm-pc-linux-gnu<dot>spec file
sdl2/autowrap-spec/SDL2.h: The sdl2/autowrap-spec/sdl2<dot>h file
sdl2/autowrap-spec/SDL2.i386-unknown-freebsd.spec: The sdl2/autowrap-spec/sdl2<dot>i386-unknown-freebsd<dot>spec file
sdl2/autowrap-spec/SDL2.i386-unknown-openbsd.spec: The sdl2/autowrap-spec/sdl2<dot>i386-unknown-openbsd<dot>spec file
sdl2/autowrap-spec/SDL2.i686-apple-darwin9.spec: The sdl2/autowrap-spec/sdl2<dot>i686-apple-darwin9<dot>spec file
sdl2/autowrap-spec/SDL2.i686-pc-linux-gnu.spec: The sdl2/autowrap-spec/sdl2<dot>i686-pc-linux-gnu<dot>spec file
sdl2/autowrap-spec/SDL2.i686-pc-windows-msvc.spec: The sdl2/autowrap-spec/sdl2<dot>i686-pc-windows-msvc<dot>spec file
sdl2/autowrap-spec/SDL2.x86_64-apple-darwin9.spec: The sdl2/autowrap-spec/sdl2<dot>x86_64-apple-darwin9<dot>spec file
sdl2/autowrap-spec/SDL2.x86_64-pc-linux-gnu.spec: The sdl2/autowrap-spec/sdl2<dot>x86_64-pc-linux-gnu<dot>spec file
sdl2/autowrap-spec/SDL2.x86_64-pc-windows-msvc.spec: The sdl2/autowrap-spec/sdl2<dot>x86_64-pc-windows-msvc<dot>spec file
sdl2/autowrap-spec/SDL2.x86_64-unknown-freebsd.spec: The sdl2/autowrap-spec/sdl2<dot>x86_64-unknown-freebsd<dot>spec file
sdl2/autowrap-spec/SDL2.x86_64-unknown-openbsd.spec: The sdl2/autowrap-spec/sdl2<dot>x86_64-unknown-openbsd<dot>spec file
sdl2/autowrap.lisp: The sdl2/autowrap<dot>lisp file
sdl2/events.lisp: The sdl2/events<dot>lisp file
sdl2/gamecontroller.lisp: The sdl2/gamecontroller<dot>lisp file
sdl2/haptic.lisp: The sdl2/haptic<dot>lisp file
sdl2/joystick.lisp: The sdl2/joystick<dot>lisp file
sdl2/keyboard.lisp: The sdl2/keyboard<dot>lisp file
sdl2/library.lisp: The sdl2/library<dot>lisp file
sdl2/mouse.lisp: The sdl2/mouse<dot>lisp file
sdl2/optional-deps.lisp: The sdl2/optional-deps<dot>lisp file
sdl2/package.lisp: The sdl2/package<dot>lisp file
sdl2/pixels.lisp: The sdl2/pixels<dot>lisp file
sdl2/platform.lisp: The sdl2/platform<dot>lisp file
sdl2/rect.lisp: The sdl2/rect<dot>lisp file
sdl2/render.lisp: The sdl2/render<dot>lisp file
sdl2/rwops.lisp: The sdl2/rwops<dot>lisp file
sdl2/sdl2.lisp: The sdl2/sdl2<dot>lisp file
sdl2/surface.lisp: The sdl2/surface<dot>lisp file
sdl2/syswm.lisp: The sdl2/syswm<dot>lisp file
sdl2/timer.lisp: The sdl2/timer<dot>lisp file
sdl2/util.lisp: The sdl2/util<dot>lisp file
sdl2/video.lisp: The sdl2/video<dot>lisp file

Jump to:   F   L   M   O   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   J   K   L   M   N   P   Q   R   S   T   U   V   W  
Index Entry  Section

%
%haptic-open: Internal macros
%rect-equal: Internal functions
%sdl-rw-close: Internal functions
%with-point: Internal macros
%with-rect: Internal macros

(
(setf point-x): Exported functions
(setf point-y): Exported functions
(setf rect-height): Exported functions
(setf rect-width): Exported functions
(setf rect-x): Exported functions
(setf rect-y): Exported functions
(setf sdl-error-code): Internal generic functions
(setf sdl-error-code): Internal generic functions
(setf sdl-error-string): Internal generic functions
(setf sdl-error-string): Internal generic functions

A
add-timer: Exported functions
add-to-default-controller-maps: Internal macros
add-user-data: Internal functions
alti-vec-p: Exported macros
audio-big-endian-p: Internal functions
audio-bitsize: Internal functions
audio-float-p: Internal functions
audio-int-p: Internal functions
audio-little-endian-p: Internal functions
audio-signed-p: Internal functions
audio-unsigned-p: Internal functions

B
blit-scaled: Exported functions
blit-surface: Exported functions

C
c-keysym: Internal macros
c-point: Internal macros
c-points: Internal macros
c-rect: Internal macros
c-rects: Internal macros
check-false: Internal macros
check-nil: Internal macros
check-nullptr: Internal macros
check-rc: Internal macros
check-zero: Internal macros
convert-surface: Exported functions
convert-surface-format: Exported functions
copy-into-point: Exported functions
copy-into-rect: Exported functions
copy-point: Exported functions
copy-rect: Exported functions
cpu-cache-line-size: Exported macros
cpu-count: Exported macros
create-renderer: Exported functions
create-rgb-surface: Exported functions
create-rgb-surface-from: Exported functions
create-software-renderer: Exported functions
create-texture: Exported functions
create-texture-from-surface: Exported functions
create-window: Exported functions
create-window-and-renderer: Exported functions

D
define-struct-accessors: Internal macros
delay: Exported macros
destroy-renderer: Exported functions
destroy-texture: Exported functions
destroy-window: Exported functions
disable-screensaver: Exported functions

E
enable-screensaver: Exported functions
ensure-main-channel: Internal functions
expand-handler: Internal functions
expand-idle-handler: Internal functions
expand-quit-handler: Internal functions

F
fill-rect: Exported functions
free-event: Exported functions
free-point: Exported functions
free-rect: Exported functions
free-render-info: Internal functions
free-surface: Exported functions
free-user-data: Internal functions
Function, %rect-equal: Internal functions
Function, %sdl-rw-close: Internal functions
Function, (setf point-x): Exported functions
Function, (setf point-y): Exported functions
Function, (setf rect-height): Exported functions
Function, (setf rect-width): Exported functions
Function, (setf rect-x): Exported functions
Function, (setf rect-y): Exported functions
Function, add-timer: Exported functions
Function, add-user-data: Internal functions
Function, audio-big-endian-p: Internal functions
Function, audio-bitsize: Internal functions
Function, audio-float-p: Internal functions
Function, audio-int-p: Internal functions
Function, audio-little-endian-p: Internal functions
Function, audio-signed-p: Internal functions
Function, audio-unsigned-p: Internal functions
Function, blit-scaled: Exported functions
Function, blit-surface: Exported functions
Function, convert-surface: Exported functions
Function, convert-surface-format: Exported functions
Function, copy-into-point: Exported functions
Function, copy-into-rect: Exported functions
Function, copy-point: Exported functions
Function, copy-rect: Exported functions
Function, create-renderer: Exported functions
Function, create-rgb-surface: Exported functions
Function, create-rgb-surface-from: Exported functions
Function, create-software-renderer: Exported functions
Function, create-texture: Exported functions
Function, create-texture-from-surface: Exported functions
Function, create-window: Exported functions
Function, create-window-and-renderer: Exported functions
Function, destroy-renderer: Exported functions
Function, destroy-texture: Exported functions
Function, destroy-window: Exported functions
Function, disable-screensaver: Exported functions
Function, enable-screensaver: Exported functions
Function, ensure-main-channel: Internal functions
Function, expand-handler: Internal functions
Function, expand-idle-handler: Internal functions
Function, expand-quit-handler: Internal functions
Function, fill-rect: Exported functions
Function, free-event: Exported functions
Function, free-point: Exported functions
Function, free-rect: Exported functions
Function, free-render-info: Internal functions
Function, free-surface: Exported functions
Function, free-user-data: Internal functions
Function, game-controller-add-mapping: Exported functions
Function, game-controller-attached-p: Exported functions
Function, game-controller-close: Exported functions
Function, game-controller-get-joystick: Exported functions
Function, game-controller-instance-id: Exported functions
Function, game-controller-name-for-index: Exported functions
Function, game-controller-open: Exported functions
Function, game-controller-p: Exported functions
Function, get-alpha-mod: Exported functions
Function, get-and-handle-messages: Internal functions
Function, get-color-key: Exported functions
Function, get-color-mod: Exported functions
Function, get-current-display-mode: Exported functions
Function, get-current-video-driver: Exported functions
Function, get-display-bounds: Exported functions
Function, get-display-mode: Exported functions
Function, get-display-name: Exported functions
Function, get-event-code: Internal functions
Function, get-event-type: Exported functions
Function, get-key-from-scancode: Exported functions
Function, get-key-name: Exported functions
Function, get-num-display-modes: Exported functions
Function, get-num-render-drivers: Exported functions
Function, get-num-video-displays: Exported functions
Function, get-num-video-drivers: Exported functions
Function, get-pixel-format-name: Exported functions
Function, get-render-driver-info: Exported functions
Function, get-renderer: Exported functions
Function, get-renderer-info: Exported functions
Function, get-renderer-output-size: Exported functions
Function, get-texture-alpha-mod: Exported functions
Function, get-texture-color-mod: Exported functions
Function, get-user-data: Internal functions
Function, get-video-driver: Exported functions
Function, get-window-aspect-ratio: Exported functions
Function, get-window-flags: Exported functions
Function, get-window-id: Exported functions
Function, get-window-pixel-format: Exported functions
Function, get-window-position: Exported functions
Function, get-window-size: Exported functions
Function, get-window-surface: Exported functions
Function, get-window-title: Exported functions
Function, get-window-wm-info: Exported functions
Function, gl-bind-texture: Exported functions
Function, gl-create-context: Exported functions
Function, gl-delete-context: Exported functions
Function, gl-extension-supported-p: Exported functions
Function, gl-get-attr: Exported functions
Function, gl-get-attrs: Exported functions
Function, gl-get-proc-address: Exported functions
Function, gl-get-swap-interval: Exported functions
Function, gl-make-current: Exported functions
Function, gl-set-attr: Exported functions
Function, gl-set-attrs: Exported functions
Function, gl-set-swap-interval: Exported functions
Function, gl-swap-window: Exported functions
Function, gl-unbind-texture: Exported functions
Function, handle-message: Internal functions
Function, haptic-close: Exported functions
Function, haptic-index: Exported functions
Function, haptic-open: Exported functions
Function, haptic-open-from-joystick: Exported functions
Function, haptic-open-from-mouse: Exported functions
Function, haptic-opened-p: Exported functions
Function, has-intersect: Exported functions
Function, hide-cursor: Exported functions
Function, hide-window: Exported functions
Function, init: Exported functions
Function, intersect-rect: Exported functions
Function, joystick-axis-count: Exported functions
Function, joystick-ball-count: Exported functions
Function, joystick-button-count: Exported functions
Function, joystick-close: Exported functions
Function, joystick-count: Exported functions
Function, joystick-hat-count: Exported functions
Function, joystick-instance-id: Exported functions
Function, joystick-is-haptic-p: Exported functions
Function, joystick-name: Exported functions
Function, joystick-name-for-index: Exported functions
Function, joystick-open: Exported functions
Function, key-down-p: Exported functions
Function, key-up-p: Exported functions
Function, keyboard-state-p: Exported functions
Function, load-bmp: Exported functions
Function, lock-texture: Exported functions
Function, make-point: Exported functions
Function, make-rect: Exported functions
Function, make-renderer-info: Internal functions
Function, make-this-thread-main: Exported functions
Function, map-rgb: Exported functions
Function, maximize-window: Exported functions
Function, minimize-window: Exported functions
Function, mod-keywords: Exported functions
Function, mod-value: Exported functions
Function, mod-value-p: Exported functions
Function, mouse-is-haptic-p: Exported functions
Function, mouse-state: Exported functions
Function, mouse-state-p: Exported functions
Function, new-event: Exported functions
Function, next-event: Exported functions
Function, niy: Internal functions
Function, platform: Exported functions
Function, point-x: Exported functions
Function, point-y: Exported functions
Function, points*: Exported functions
Function, power-info: Exported functions
Function, pump-events: Exported functions
Function, push-event: Exported functions
Function, push-quit-event: Exported functions
Function, push-user-event: Exported functions
Function, query-texture: Exported functions
Function, quit: Exported functions
Function, raise-window: Exported functions
Function, rect-empty: Exported functions
Function, rect-equals: Exported functions
Function, rect-height: Exported functions
Function, rect-width: Exported functions
Function, rect-x: Exported functions
Function, rect-y: Exported functions
Function, rects*: Exported functions
Function, recv-and-handle-message: Internal functions
Function, register-user-event-type: Exported functions
Function, relative-mouse-mode-p: Exported functions
Function, remove-timer: Exported functions
Function, render-clear: Exported functions
Function, render-copy: Exported functions
Function, render-copy-ex: Exported functions
Function, render-draw-line: Exported functions
Function, render-draw-lines: Exported functions
Function, render-draw-point: Exported functions
Function, render-draw-points: Exported functions
Function, render-draw-rect: Exported functions
Function, render-draw-rects: Exported functions
Function, render-fill-rect: Exported functions
Function, render-fill-rects: Exported functions
Function, render-get-viewport: Exported functions
Function, render-present: Exported functions
Function, render-set-viewport: Exported functions
Function, restore-window: Exported functions
Function, rumble-init: Exported functions
Function, rumble-play: Exported functions
Function, rumble-stop: Exported functions
Function, rumble-supported-p: Exported functions
Function, rw-close: Exported functions
Function, rw-from-file: Exported functions
Function, scancode: Exported functions
Function, scancode-key-name: Exported functions
Function, scancode-key-to-value: Exported functions
Function, scancode-name: Exported functions
Function, scancode-symbol: Exported functions
Function, scancode-value: Exported functions
Function, screensaver-enabled-p: Exported functions
Function, sdl-cancel-collect: Internal functions
Function, sdl-collect: Internal functions
Function, sdl-main-thread: Internal functions
Function, sdl-true-p: Internal functions
Function, set-alpha-mod: Exported functions
Function, set-color-key: Exported functions
Function, set-color-mod: Exported functions
Function, set-relative-mouse-mode: Exported functions
Function, set-render-draw-blend-mode: Exported functions
Function, set-render-draw-color: Exported functions
Function, set-render-target: Exported functions
Function, set-texture-alpha-mod: Exported functions
Function, set-texture-blend-mode: Exported functions
Function, set-texture-color-mod: Exported functions
Function, set-window-fullscreen: Exported functions
Function, set-window-position: Exported functions
Function, set-window-size: Exported functions
Function, set-window-title: Exported functions
Function, show-cursor: Exported functions
Function, show-window: Exported functions
Function, start-text-input: Exported functions
Function, stop-text-input: Exported functions
Function, surface-format: Exported functions
Function, surface-format-format: Exported functions
Function, surface-height: Exported functions
Function, surface-pitch: Exported functions
Function, surface-pixels: Exported functions
Function, surface-width: Exported functions
Function, sym-value: Exported functions
Function, texture-height: Exported functions
Function, texture-width: Exported functions
Function, toggle-relative-mouse-mode: Exported functions
Function, union-rect: Exported functions
Function, unique-pairs: Internal functions
Function, unlock-texture: Exported functions
Function, unpack-event-params: Internal functions
Function, update-texture: Exported functions
Function, update-window: Exported functions
Function, user-event-type-p: Internal functions
Function, version: Exported functions
Function, version-wrapped: Exported functions
Function, was-init: Exported functions
Function, windowpos-centered: Exported functions
Function, windowpos-from-coord: Exported functions
Function, windowpos-undefined: Exported functions

G
game-controller-add-mapping: Exported functions
game-controller-attached-p: Exported functions
game-controller-close: Exported functions
game-controller-get-joystick: Exported functions
game-controller-instance-id: Exported functions
game-controller-name-for-index: Exported functions
game-controller-open: Exported functions
game-controller-p: Exported functions
Generic Function, (setf sdl-error-code): Internal generic functions
Generic Function, (setf sdl-error-string): Internal generic functions
Generic Function, scancode=: Exported generic functions
Generic Function, sdl-error-code: Internal generic functions
Generic Function, sdl-error-string: Internal generic functions
get-alpha-mod: Exported functions
get-and-handle-messages: Internal functions
get-color-key: Exported functions
get-color-mod: Exported functions
get-current-display-mode: Exported functions
get-current-video-driver: Exported functions
get-display-bounds: Exported functions
get-display-mode: Exported functions
get-display-name: Exported functions
get-event-code: Internal functions
get-event-type: Exported functions
get-key-from-scancode: Exported functions
get-key-name: Exported functions
get-num-display-modes: Exported functions
get-num-render-drivers: Exported functions
get-num-video-displays: Exported functions
get-num-video-drivers: Exported functions
get-performance-counter: Exported macros
get-performance-frequency: Exported macros
get-pixel-format-name: Exported functions
get-render-driver-info: Exported functions
get-renderer: Exported functions
get-renderer-info: Exported functions
get-renderer-output-size: Exported functions
get-texture-alpha-mod: Exported functions
get-texture-color-mod: Exported functions
get-ticks: Exported macros
get-user-data: Internal functions
get-video-driver: Exported functions
get-window-aspect-ratio: Exported functions
get-window-flags: Exported functions
get-window-id: Exported functions
get-window-pixel-format: Exported functions
get-window-position: Exported functions
get-window-size: Exported functions
get-window-surface: Exported functions
get-window-title: Exported functions
get-window-wm-info: Exported functions
gl-bind-texture: Exported functions
gl-create-context: Exported functions
gl-delete-context: Exported functions
gl-extension-supported-p: Exported functions
gl-get-attr: Exported functions
gl-get-attrs: Exported functions
gl-get-proc-address: Exported functions
gl-get-swap-interval: Exported functions
gl-make-current: Exported functions
gl-set-attr: Exported functions
gl-set-attrs: Exported functions
gl-set-swap-interval: Exported functions
gl-swap-window: Exported functions
gl-unbind-texture: Exported functions

H
handle-message: Internal functions
haptic-close: Exported functions
haptic-index: Exported functions
haptic-open: Exported functions
haptic-open-from-joystick: Exported functions
haptic-open-from-mouse: Exported functions
haptic-opened-p: Exported functions
has-intersect: Exported functions
hide-cursor: Exported functions
hide-window: Exported functions

I
in-main-thread: Exported macros
init: Exported functions
intersect-rect: Exported functions

J
joystick-axis-count: Exported functions
joystick-ball-count: Exported functions
joystick-button-count: Exported functions
joystick-caps-query: Internal macros
joystick-close: Exported functions
joystick-count: Exported functions
joystick-hat-count: Exported functions
joystick-instance-id: Exported functions
joystick-is-haptic-p: Exported functions
joystick-name: Exported functions
joystick-name-for-index: Exported functions
joystick-open: Exported functions
joystick-update: Exported macros

K
key-down-p: Exported functions
key-up-p: Exported functions
keyboard-state-p: Exported functions

L
let-rects: Internal macros
load-bmp: Exported functions
lock-texture: Exported functions

M
Macro, %haptic-open: Internal macros
Macro, %with-point: Internal macros
Macro, %with-rect: Internal macros
Macro, add-to-default-controller-maps: Internal macros
Macro, alti-vec-p: Exported macros
Macro, c-keysym: Internal macros
Macro, c-point: Internal macros
Macro, c-points: Internal macros
Macro, c-rect: Internal macros
Macro, c-rects: Internal macros
Macro, check-false: Internal macros
Macro, check-nil: Internal macros
Macro, check-nullptr: Internal macros
Macro, check-rc: Internal macros
Macro, check-zero: Internal macros
Macro, cpu-cache-line-size: Exported macros
Macro, cpu-count: Exported macros
Macro, define-struct-accessors: Internal macros
Macro, delay: Exported macros
Macro, get-performance-counter: Exported macros
Macro, get-performance-frequency: Exported macros
Macro, get-ticks: Exported macros
Macro, in-main-thread: Exported macros
Macro, joystick-caps-query: Internal macros
Macro, joystick-update: Exported macros
Macro, let-rects: Internal macros
Macro, mmx-p: Exported macros
Macro, rdtsc-p: Exported macros
Macro, sse-p: Exported macros
Macro, sse2-p: Exported macros
Macro, sse3-p: Exported macros
Macro, sse41-p: Exported macros
Macro, sse42-p: Exported macros
Macro, warp-mouse-in-window: Exported macros
Macro, with-event-loop: Exported macros
Macro, with-everything: Exported macros
Macro, with-gl-context: Exported macros
Macro, with-init: Exported macros
Macro, with-points: Exported macros
Macro, with-rects: Exported macros
Macro, with-renderer: Exported macros
Macro, with-sdl-event: Exported macros
Macro, with-window: Exported macros
Macro, without-fp-traps: Internal macros
make-point: Exported functions
make-rect: Exported functions
make-renderer-info: Internal functions
make-this-thread-main: Exported functions
map-rgb: Exported functions
maximize-window: Exported functions
Method, (setf sdl-error-code): Internal generic functions
Method, (setf sdl-error-string): Internal generic functions
Method, scancode=: Exported generic functions
Method, scancode=: Exported generic functions
Method, sdl-error-code: Internal generic functions
Method, sdl-error-string: Internal generic functions
minimize-window: Exported functions
mmx-p: Exported macros
mod-keywords: Exported functions
mod-value: Exported functions
mod-value-p: Exported functions
mouse-is-haptic-p: Exported functions
mouse-state: Exported functions
mouse-state-p: Exported functions

N
new-event: Exported functions
next-event: Exported functions
niy: Internal functions

P
platform: Exported functions
point-x: Exported functions
point-y: Exported functions
points*: Exported functions
power-info: Exported functions
pump-events: Exported functions
push-event: Exported functions
push-quit-event: Exported functions
push-user-event: Exported functions

Q
query-texture: Exported functions
quit: Exported functions

R
raise-window: Exported functions
rdtsc-p: Exported macros
rect-empty: Exported functions
rect-equals: Exported functions
rect-height: Exported functions
rect-width: Exported functions
rect-x: Exported functions
rect-y: Exported functions
rects*: Exported functions
recv-and-handle-message: Internal functions
register-user-event-type: Exported functions
relative-mouse-mode-p: Exported functions
remove-timer: Exported functions
render-clear: Exported functions
render-copy: Exported functions
render-copy-ex: Exported functions
render-draw-line: Exported functions
render-draw-lines: Exported functions
render-draw-point: Exported functions
render-draw-points: Exported functions
render-draw-rect: Exported functions
render-draw-rects: Exported functions
render-fill-rect: Exported functions
render-fill-rects: Exported functions
render-get-viewport: Exported functions
render-present: Exported functions
render-set-viewport: Exported functions
restore-window: Exported functions
rumble-init: Exported functions
rumble-play: Exported functions
rumble-stop: Exported functions
rumble-supported-p: Exported functions
rw-close: Exported functions
rw-from-file: Exported functions

S
scancode: Exported functions
scancode-key-name: Exported functions
scancode-key-to-value: Exported functions
scancode-name: Exported functions
scancode-symbol: Exported functions
scancode-value: Exported functions
scancode=: Exported generic functions
scancode=: Exported generic functions
scancode=: Exported generic functions
screensaver-enabled-p: Exported functions
sdl-cancel-collect: Internal functions
sdl-collect: Internal functions
sdl-error-code: Internal generic functions
sdl-error-code: Internal generic functions
sdl-error-string: Internal generic functions
sdl-error-string: Internal generic functions
sdl-main-thread: Internal functions
sdl-true-p: Internal functions
set-alpha-mod: Exported functions
set-color-key: Exported functions
set-color-mod: Exported functions
set-relative-mouse-mode: Exported functions
set-render-draw-blend-mode: Exported functions
set-render-draw-color: Exported functions
set-render-target: Exported functions
set-texture-alpha-mod: Exported functions
set-texture-blend-mode: Exported functions
set-texture-color-mod: Exported functions
set-window-fullscreen: Exported functions
set-window-position: Exported functions
set-window-size: Exported functions
set-window-title: Exported functions
show-cursor: Exported functions
show-window: Exported functions
sse-p: Exported macros
sse2-p: Exported macros
sse3-p: Exported macros
sse41-p: Exported macros
sse42-p: Exported macros
start-text-input: Exported functions
stop-text-input: Exported functions
surface-format: Exported functions
surface-format-format: Exported functions
surface-height: Exported functions
surface-pitch: Exported functions
surface-pixels: Exported functions
surface-width: Exported functions
sym-value: Exported functions

T
texture-height: Exported functions
texture-width: Exported functions
toggle-relative-mouse-mode: Exported functions

U
union-rect: Exported functions
unique-pairs: Internal functions
unlock-texture: Exported functions
unpack-event-params: Internal functions
update-texture: Exported functions
update-window: Exported functions
user-event-type-p: Internal functions

V
version: Exported functions
version-wrapped: Exported functions

W
warp-mouse-in-window: Exported macros
was-init: Exported functions
windowpos-centered: Exported functions
windowpos-from-coord: Exported functions
windowpos-undefined: Exported functions
with-event-loop: Exported macros
with-everything: Exported macros
with-gl-context: Exported macros
with-init: Exported macros
with-points: Exported macros
with-rects: Exported macros
with-renderer: Exported macros
with-sdl-event: Exported macros
with-window: Exported macros
without-fp-traps: Internal macros

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   J   K   L   M   N   P   Q   R   S   T   U   V   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
C   S  
Index Entry  Section

*
*default-controller-maps*: Internal special variables
*event-loop*: Internal special variables
*event-type-to-accessor*: Internal special variables
*lisp-message-event*: Internal special variables
*main-thread*: Internal special variables
*main-thread-channel*: Internal special variables
*the-main-thread*: Internal special variables
*user-event-codes*: Internal special variables
*user-event-id*: Internal special variables
*user-event-types*: Internal special variables
*user-events*: Internal special variables
*wakeup-event*: Internal special variables

C
code: Internal conditions

S
Slot, code: Internal conditions
Slot, string: Internal conditions
Special Variable, *default-controller-maps*: Internal special variables
Special Variable, *event-loop*: Internal special variables
Special Variable, *event-type-to-accessor*: Internal special variables
Special Variable, *lisp-message-event*: Internal special variables
Special Variable, *main-thread*: Internal special variables
Special Variable, *main-thread-channel*: Internal special variables
Special Variable, *the-main-thread*: Internal special variables
Special Variable, *user-event-codes*: Internal special variables
Special Variable, *user-event-id*: Internal special variables
Special Variable, *user-event-types*: Internal special variables
Special Variable, *user-events*: Internal special variables
Special Variable, *wakeup-event*: Internal special variables
string: Internal conditions

Jump to:   *  
C   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
Condition, sdl-continue: Exported conditions
Condition, sdl-error: Internal conditions
Condition, sdl-rc-error: Internal conditions

P
Package, sdl2: The sdl2 package
Package, sdl2-examples: The sdl2-examples package

S
sdl-continue: Exported conditions
sdl-error: Internal conditions
sdl-rc-error: Internal conditions
sdl2: The sdl2 system
sdl2: The sdl2 package
sdl2-examples: The sdl2-examples package
System, sdl2: The sdl2 system

Jump to:   C   P   S