Guile-SDL

Table of Contents

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

The (sdl *) Modules

This manual documents Guile-SDL 0.5.1, a package which provides the modules (sdl sdl), (sdl gfx), (sdl ttf) and (sdl mixer) for use in Guile Scheme programs. These modules wrap the Simple Direct Media Layer1 libraries on your system. Additionally, experimental abstractions and convenience procedures are provided in the modules (sdl misc-utils) and (sdl simple).

This manual is

Copyright © 2003–2013 Thien-Thi Nguyen

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the appendix entitled “GNU Free Documentation License”.


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

1 Introduction

The (sdl *) modules are an interface to the SDL (Simple Direct Media Layer) library. The goal is to provide both a clean and direct interface to the lowest level SDL, while extending with higher level concepts where useful, such as default arguments and functional-style application of graphics routines. Several SDL add-on libraries have been wrapped and included with Guile-SDL, including SDL_image (for loading multiple image formats), SDL_ttf (for rendering true type fonts), SDL_mixer (for playing/mixing different audio formats), and SDL_rotozoom (for rotating and scaling images). In addition, some low-level 2D graphics primitives have been provided.


Next: , Up: Introduction   [Contents][Index]

1.1 Quick Start

To whet your appetite, and hopefully get you excited about the ease and flexibility of programming with Guile-SDL, we begin with a simple example. The following program is a simple image browser. You can cycle through images by using space, n or right to go forward, backspace, p or left to go backwards, and escape or q to quit.

;; load the SDL module and some useful srfi's
(use-modules ((sdl sdl) #:prefix SDL:)
             (srfi srfi-1)
             (srfi srfi-2))

;; initialize the video subsystem
(SDL:init 'video)

;; directory to search for images in
(define image-dir "/usr/share/pixmaps/")

;; utility to test if a path is a directory
(define (file? f)
  (let* ((stats (stat f))
         (type (stat:type stats)))
    (eq? type 'regular)))

;; build a ring of image file names
(define image-ring
  (let ((dir (opendir image-dir)))
    (letrec ((D (lambda (ls)
                  (let ((file (readdir dir)))
                    (if (eof-object? file)
                        (begin (closedir dir) ls)
                        (D (cons (string-append image-dir file)
                                 ls)))))))
      (apply circular-list (reverse (filter file? (D '())))))))

;; functions to cycle through the ring
(define (next-image)
  (let ((next (car image-ring)))
    (set! image-ring (cdr image-ring))
    next))

(define (prev-image)
  (let ((orig image-ring))
    (while (not (eq? (cddr image-ring) orig))
      (set! image-ring (cdr image-ring)))
    (let ((image (car image-ring)))
      (set! image-ring (cdr image-ring))
      image)))

;; display an image given a filename
(define (show file)
  (and-let* ((image (SDL:load-image file)))
    (SDL:set-video-mode (SDL:surface:w image) (SDL:surface:h image) 24)
    (SDL:blit-surface image)
    (SDL:flip)))

;; show the first image
(show (next-image))

;; event handler
(let handle ((e (SDL:make-event)))
  (if (SDL:wait-event e)
    (case (SDL:event:type e)
      ((SDL_KEYDOWN)
       (case (SDL:event:key:keysym:sym e)
         ((left backspace)
          (show (prev-image)))
         ((right space)
          (show (next-image)))
         ((escape q)
          (SDL:quit)
          (quit))))))
  (handle e))

Next: , Previous: Quick Start, Up: Introduction   [Contents][Index]

1.2 Naming Conventions

The most important thing to learning a wrapped library for a programming language, assuming you know the language and the library, is to know the naming conventions. Then you can begin programming without having to look up the exact function reference (available in the rest of this document).


Next: , Up: Naming Conventions   [Contents][Index]

1.2.1 Renaming C Functions

As with standard guile naming conventions, all names are converted to lower-case, and underscores are replaced with hyphens. Functions that modify one or more arguments have an exclamation point (!) appended, and functions which ask a question and return a boolean value have a question mark (?) appended.


Next: , Previous: Renaming C Functions, Up: Naming Conventions   [Contents][Index]

1.2.2 Enums and Constants

SDL enumerated types and constants are passed and returned as symbols, thus enforcing their "constant" nature and for ease of use in case statements. Flags, such as the SDL initialization flags and video surface flags, are treated as lists of symbols, each constant in the flag group that you would or together in C code becoming a symbol in the list.

Some of these symbols retain their exact C names, while others are adapted to better fit Scheme (mostly by removing the ‘SDL_’ prefix, changing underscores to hyphens, downcasing, and inserting a hyphen between “words”).

A particular set of enums is called an enumstash. Likewise flagstash for flags.

You can use kotk to examine the enums and flags encapsulated by these respectively typed objects. You can also use integers where enums/flags are expected, and can convert between the symbol and numeric value with enum->number, number->enum, flags->number and number->flags.

The conversion procs all take stash as the first argument, a symbol that identifies the particular set of enums/flags. For backward compatability, stash may also be such an object, but this support will be removed after 2013-12-31, when those objects are to be fully internalized.

Procedure: kotk [name]

Return the contents of stash name (a symbol), as an alist with symbolic keys, integer values. If name is omitted, the keys are the names of the all the enum- and flagstashes, and the values have the form:

(N TYPE)

where n is the count of symbols in that stash, and type is a symbol: enums or flags.

Procedure: enum->number stash symbol

Return the number in stash associated with symbol.

Procedure: number->enum stash number

Return the symbol associated with number, or #f if it does not belong to stash.

Procedure: flags->number stash flags

Use stash to convert flags to a number. flags is a list of symbols; or #f, which is taken as the empty list; or #t, which is taken as the list of all possible symbols in stash.

Procedure: number->flags stash number

Use stash to convert number to a list of symbols. If the flags in stash are not sufficient to decode number, the first element of the list is the numeric remainder.

Conversion from symbols to numbers (including enum->number and flags->number) throws an error with key non-member-symbol if the specified symbol is not a member of the respective enumstash or flagstash.


Previous: Enums and Constants, Up: Naming Conventions   [Contents][Index]

1.2.3 Create and Make

The standard SDL prefix for creating a new instance of a type is create. The standard Guile prefix is make. Wherever an SDL function uses the create prefix we will keep it. Object creation functions unique to Guile, such as make-rect, will use make as a prefix. In addition, we will sometimes introduce higher-level creation functions, such as make-surface, which is a wrapper to create-rgb-surface which provides useful default values from the current screen information.


Next: , Previous: Naming Conventions, Up: Introduction   [Contents][Index]

1.3 Uniform Vectors

Some procedures take one or more uniform vector arguments, as specified in SRFI 4 (see Video, see SDL_gfx). The specific type of vector is one of u8, u16, s16, where u or s stands for “unsigned” or “signed”, respectively, and the rest the number of bits.


Previous: Uniform Vectors, Up: Introduction   [Contents][Index]

1.4 Limitations

There are some known problems with Guile-SDL modules. This section attempts to make them well-known, if not well-liked...


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

2 General SDL

Procedure: init sel

Initialize SDL and the subsystems/configuration represented by sel (see init flags).

Procedure: init-subsystem sel

Initialize the SDL subsystems represented by sel. sel is a list of flags (symbols) from the same set useful for init.

Procedure: quit

Shut down all SDL subsystems. Return #t.

Procedure: quit-subsystem sel

Shut down the SDL subsystems represented by sel. sel is a list of flags (symbols) from the same set useful for init. Return #t.

Procedure: was-init sel

Check if the SDL subsystems represented by sel have been initialized. sel is a list of flags (symbols) from the same set useful for init. Return a list likewise composed.

Procedure: get-ticks

Return the number of milliseconds since the SDL library initialization.

Procedure: delay ms

Wait ms milliseconds.

Procedure: get-error

Return the current SDL error string.


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

3 Video

Procedure: create-cursor data mask w h x y

Return a new cursor from data and mask (both u8 uniform vectors), sized w by h and with hot pixel located at x,y.

Procedure: create-yuv-overlay width height format [display]

Create a new YUV overlay, sized width by height with overlay format (a symbol or an exact number). Optional arg display specifies a surface to use instead of creating a new one.

Procedure: get-video-surface

Return the current display surface.

Procedure: video-cmf

Return information about the video hardware as three values: capabilities (list of symbols), memory (integer), and format (pixel format object). The capabilities are:

hw-available
wm-available
blit-hw   blit-hw-CC   blit-hw-A
blit-sw   blit-sw-CC   blit-sw-A
blit-fill
Procedure: get-video-info

NB: This procedure is obsoleted by video-cmf and will be removed after 2013-12-31.

Return information about the video hardware as an alist. Keys are: hw-available, wm-available, bit-hw, blit-hw-CC, blit-hw-A, blit-sw, blit-sw-CC, blit-sw-A, blit-fill, video-mem and vfmt.

Procedure: video-driver-name

Return the name of the video driver.

Procedure: list-modes [format [flags]]

Return a list of available screen dimensions for pixel format and flags (see video flags). Format defaults to that for the current screen. Flags default to none. Return #f if no modes are available, #t if all are available.

Procedure: video-mode-ok width height bpp [flags]

Check to see if a particular video mode is supported. Args are width, height, bpp (numbers), and flags (see video flags). Return #f if the mode is not supported, or a number indicating the bits-per-pixel of the closest available mode supporting width and height.

Procedure: set-video-mode width height bpp [flags]

Set the SDL video mode with width, height and bits-per-pixel bpp. Optional arg flags (see video flags) is supported. Return a new surface.

3.1 Rectangles

Procedure: rect? obj

Return #t iff obj is an SDL-rectangle object.

Procedure: make-rect x y width height

Return a rectangle object with location x,y and dimensions width by height.

Procedure: rect:x rect

Get x from rect.

Procedure: rect:y rect

Get y from rect.

Procedure: rect:w rect

Get w from rect.

Procedure: rect:h rect

Get h from rect.

Procedure: rect:set-x! rect value

Set x in rect to value.

Procedure: rect:set-y! rect value

Set y in rect to value.

Procedure: rect:set-w! rect value

Set w in rect to value.

Procedure: rect:set-h! rect value

Set h in rect to value.

Procedure: update-rect surface x [y [w [h]]]

Update surface within a specified rectangle. The second arg can either be an SDL-Rect object, or the second through fifth args are numbers specifying the x, y, width and height of a rectangular area.

Procedure: update-rects surface ls

On surface, update the rectangles in ls, a list of rectangles.

Procedure: flip [surface]

Swap double buffers of the default surface, or of surface if specified.

3.2 Colors

Procedure: color? obj

Return #t iff obj is an SDL-Color object.

Procedure: make-color r g b

Return a color object with r, g, and b components.

Procedure: color:r color

Get r from color.

Procedure: color:g color

Get g from color.

Procedure: color:b color

Get b from color.

Procedure: color:set-r! color value

Set r in color to value.

Procedure: color:set-g! color value

Set g in color to value.

Procedure: color:set-b! color value

Set b in color to value.

Procedure: set-colors! surface colors [start]

Set a portion of the colormap for the 8-bit surface using colors, a vector of SDL-Colors. Optional arg start (an integer in the range [0,255]) specifies the portion to be modified. It defaults to 0.

Procedure: set-palette surface flags colors [start]

Set the palette of an 8-bit surface using flags (see palette flags) and colors, a vector of SDL-Colors. Optional arg start (an integer in the range [0,255]) specifies the portion to be modified. It defaults to 0.

Procedure: set-gamma redgamma greengamma bluegamma

Set the color gamma function for the display using real numbers redgamma, greengamma and bluegamma.

Procedure: get-gamma-ramp

Return the gamma translation lookup tables currently used by the display as a list of three tables, for red, green and blue. Each table is a u16 uniform vector of length 256. Return #f if unsuccessful.

Procedure: set-gamma-ramp r g b

Set the gamma translation lookup tables currently used by the display to tables r, g and b, each a u16 uniform vector of length 256, or #f, in which case that particular component is unchanged. Return #t if successful.

Procedure: map-rgb format r [g [b]]

Map a RGB color value to the pixel format. The second arg can be an SDL-Color, otherwise the second through fourth args are red, green and blue values (numbers). Return the mapped components as an unsigned integer.

Procedure: map-rgba format r g [b [a]]

Map a RGB color value to the pixel format. If the second arg is an SDL-Color, the third is an alpha value (number). Otherwise, the second through fifth args are red, green, blue and alpha values (numbers). Return the mapped components as an unsigned integer.

Procedure: pixel-rgb pixel format

Return RGB info from pixel in the specified pixel format as three values: r, g and b (all integers).

Procedure: get-rgb pixel format

NB: This procedure is obsoleted by pixel-rgb and will be removed after 2013-12-31.

Get RGB values from pixel in the specified pixel format. Return an alist with keys r, g and b, with red, green and blue values (numbers), respectively.

Procedure: pixel-rgba pixel format

Return RGBA info from pixel in the specified pixel format as four values: r, g, b and a (all integers).

Procedure: get-rgba pixel format

NB: This procedure is obsoleted by pixel-rgba and will be removed after 2013-12-31.

Get RGBA values from pixel in the specified pixel format. Return an alist with keys r, g, b and a, with red, green, blue and alpha values (numbers), respectively.

Procedure: fill-rect surface rect color

Fill surface rect with color (a number). If rect is #f, fill the entire surface. Return #t if successful.

Procedure: display-format surface

Return a new surface made by converting surface to the display format. Return #f if not successful.

Procedure: display-format-alpha surface

Return a new surface made by converting surface to the display format, with an alpha channel. Return #f if not successful.

Procedure: warp-mouse x y

Set the position of the mouse cursor to x,y.

Procedure: set-cursor cursor

Set the current mouse cursor to cursor.

Procedure: get-cursor

Get the current mouse cursor.

Procedure: show-cursor [setting]

Return the current visibility of the pointer (aka “mouse cursor”) as a boolean. If arg setting (a boolean) is specified, set the visibility to setting (the returned visibility corresponds to that before the call, regardless).

Procedure: gl-get-attribute attribute

Return the value of a special SDL/OpenGL attribute.

Procedure: gl-set-attribute attribute value

Set the special SDL/OpenGL attribute to value. Both args are numbers.

Procedure: gl-swap-buffers

Swap OpenGL framebuffers/Update Display.

Procedure: lock-yuv-overlay overlay

Lock the given YUV overlay. Return #f if successful.

Procedure: unlock-yuv-overlay overlay

Unlock the previously locked YUV overlay.

Procedure: display-yuv-overlay overlay dstrect

Blit the YUV overlay to the display dstrect over which it was created. Return #t if successful.

3.3 Windowing System Interaction

Procedure: get-wm-info

Return information on the window manager, as a list of the form: (VERSION SUBSYSTEM DISPLAY WINDOW FSWINDOW WMWINDOW). VERSION is a sub-list of form: (MAJOR MINOR PATCH), where element is an integer. SUBSYSTEM is either the symbol x11, or #f. DISPLAY is a pointer (machine address) of the X11 Display structure, converted to an integer. WINDOW, FSWINDOW and WMWINDOW are Window identifiers (also integers).

Procedure: set-caption title [icon]

Set the title-bar and icon name of the display window to title and icon (both strings), respectively. If icon is not specified, use title by default.

Procedure: caption-ti

Return display-window caption as two values: title and icon (both strings, or #f if not set).

Procedure: get-caption

NB: This procedure is obsoleted by caption-ti and will be removed after 2013-12-31.

Return an alist with keys title and icon and values the title-bar and icon name (or #f) of the display window, respectively.

Procedure: set-icon icon

Set icon for the display window.

Procedure: iconify-window

Iconify/Minimize the window. Return #t if successful.

Procedure: toggle-full-screen [surface]

Toggle the default video surface between windowed and fullscreen mode, if supported. Optional arg surface specifies another surface to toggle. Return #t if successful.

Procedure: grab-input [mode]

Grab mouse and keyboard input. Return new grab state. Optional arg mode (a symbol) specifies the kind of grab, one of query (the default), off or on.

Procedure: get-app-state

Return the current state of the application, a list of symbols. The list may include: ‘mousefocus’, ‘inputfocus’, ‘active’.

3.4 Surface

Procedure: make-surface width height [flags]

Return a new surface of dimensions width by height. Optional third arg flags (see video flags) further specifies the surface. Color depth and masks are those for the current video surface.

Procedure: create-rgb-surface flags width height depth rmask gmask bmask amask

Return an empty surface. The eight arguments, directly analagous to those for SDL_CreateRGBSurface, are: flags (list of symbols, see video flags), width, height, depth, rmask, gmask, bmask, amask (all numbers).

Procedure: surface:w surface

Get w from surface.

Procedure: surface:h surface

Get h from surface.

Procedure: surface:depth surface

Get format->BitsPerPixel from surface.

Procedure: surface:flags surface

Return flags from surface as a (possibly empty) list of symbols.

Procedure: surface-get-format surface

Return a new pixel format, the same used by surface.

Procedure: surface? obj

Return true iff obj is a surface.

Procedure: lock-surface surface

Lock surface for direct access. Return #t if successful.

Procedure: unlock-surface surface

Unlock previously locked surface.

Procedure: load-bmp filename

Load bitmap data from filename. Return a new surface if successful, otherwise #f.

Procedure: load-image filename

Load image data from filename. Return a new surface if successful, otherwise #f.

Procedure: save-bmp surface filename

Save surface to filename in Windows BMP format. Return #t if successful.

Procedure: surface-color-key! surface pixel [rle]

Set the color key for surface to pixel. If pixel is #f, clear the current color key. Otherwise, it should be an integer of the appropriate depth for surface (e.g., in the range [0,65535] for 16 bpp). If color key processing is enabled, optional arg rle is a boolean that enables (true) or disables (false, the default) RLE acceleration. Return #t if successful.

Procedure: set-color-key! surface flag key

NB: This procedure is obsoleted by surface-color-key! and will be removed after 2013-12-31.

Set surface color key as specified by flag (see video flags) and key.

Procedure: surface-alpha! surface alpha [rle]

Set alpha blending for the entire surface to alpha. If alpha is #f, disable alpha blending. Otherwise it should be an integer in the range [0,255] or one of the symbols transparent or opaque. If alpha blending is enabled, optional arg rle is a boolean that enables (true) or disables (false, the default) RLE acceleration. Return #t if successful.

Procedure: set-alpha! surface flag [alpha]

NB: This procedure is obsoleted by surface-alpha! and will be removed after 2013-12-31.

Adjust whole-surface alpha as specified by flag (see video flags) and alpha (see alpha-enum enums, or a number 0-255). If flag is #f, ignore alpha completely.

Procedure: set-clip-rect! surface [rect]

Set surface clipping rectangle to the whole surface. Optional arg rect, if non-#f, specifies a particular rectangle instead of using the whole surface.

Procedure: get-clip-rect surface

Return the clipping rectangle for surface.

Procedure: convert-surface surface format [flags]

Convert surface to the same format as another surface. Optional third arg flags is a list of flags (see video flags).

Procedure: blit-surface src [srcrect [dst [dstrect]]]

Perform a fast blit from the src surface srcrect to the dst surface dstrect. srcrect defaults to x=0, y=0, src surface dimensions. If unspecified dst is taken as the default video surface. dstrect likewise defaults to x=0, y=0, dst surface dimensions.

3.5 Misc Surface Operations

Procedure: vertical-flip-surface surface

Return a new surface created by flipping surface vertically.

Procedure: horizontal-flip-surface surface

Return a new surface created by flipping surface horizontally.

Procedure: vh-flip-surface surface

Return a new surface created by flipping surface both vertically and horizontally.

Procedure: surface-pixels surface [squash]

Return pixel data of surface as a new uniform vector. The uvec has type u8, u16 or u32, corresponding to the surface depth, with height x width elements. A 24bpp surface — depth-in-bytes of 3 — is expanded (per pixel) to u32, leaving the high nybble clear.

Optional arg squash non-#f means to return a u8vector regardless of surface depth, with height x width x depth-in-bytes elements.


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

4 Events

Procedure: make-event [type]

Return a new SDL event. Optional arg type is a symbol (see event-type enums). If omitted, the default is SDL_NOEVENT.

Procedure: event:type event

Return the symbolic type from event.

Procedure: event:set-type! event value

Set type in event to value, a symbol or integer.

4.1 Activity

The value for event:active:gain and event:active:set-gain! is a symbol, one of: gained or lost.

The value for event:active:state and event:active:set-state! is a (possibly empty) list of symbols from the same set used by get-app-state.

Procedure: event:active:gain event

Return the symbolic active.gain from event.

Procedure: event:active:state event

Return active.state from event as a (possibly empty) list of symbols.

Procedure: event:active:set-gain! event value

Set active.gain in event to value, a symbol or integer.

Procedure: event:active:set-state! event value

Set active.state in event to value, a (possibly empty) list of symbols.

4.2 Keys

The value for event:key:state and event:key:set-state! is a symbol, one of: released or pressed.

Procedure: event:key:keysym:sym event

Return the symbolic key.keysym.sym from event.

Procedure: event:key:keysym:set-sym! event value

Set key.keysym.sym in event to value, a symbol or integer.

Procedure: event:key:keysym:mod event

Return key.keysym.mod from event as a (possibly empty) list of symbols.

Procedure: event:key:keysym:set-mod! event value

Set key.keysym.mod in event to value, a (possibly empty) list of symbols.

Procedure: event:key:state event

Return the symbolic key.state from event.

Procedure: event:key:keysym:scancode event

Get key.keysym.scancode from event.

Procedure: event:key:keysym:unicode event

Get key.keysym.unicode from event.

Procedure: event:key:set-state! event value

Set key.state in event to value, a symbol or integer.

Procedure: event:key:keysym:set-scancode! event value

Set key.keysym.scancode in event to value.

Procedure: event:key:keysym:set-unicode! event value

Set key.keysym.unicode in event to value.

4.3 Motions

Procedure: event:motion:state event

Return motion.state from event as a (possibly empty) list of symbols.

Procedure: event:motion:x event

Get motion.x from event.

Procedure: event:motion:y event

Get motion.y from event.

Procedure: event:motion:xrel event

Get motion.xrel from event.

Procedure: event:motion:yrel event

Get motion.yrel from event.

Procedure: event:motion:set-state! event value

Set motion.state in event to value, a (possibly empty) list of symbols.

Procedure: event:motion:set-x! event value

Set motion.x in event to value.

Procedure: event:motion:set-y! event value

Set motion.y in event to value.

Procedure: event:motion:set-xrel! event value

Set motion.xrel in event to value.

Procedure: event:motion:set-yrel! event value

Set motion.yrel in event to value.

4.4 Buttons

The value for event:button:button and event:button:set-button! is a (possibly empty) list of symbols from the set:

left middle right
wheel-up wheel-down
x1 x2

The value for event:button:state and event:button:set-state! is a symbol, one of: released or pressed.

Procedure: event:button:button event

Return the symbolic button.button from event.

Procedure: event:button:state event

Return the symbolic button.state from event.

Procedure: event:button:x event

Get button.x from event.

Procedure: event:button:y event

Get button.y from event.

Procedure: event:button:set-button! event value

Set button.button in event to value, a symbol or integer.

Procedure: event:button:set-state! event value

Set button.state in event to value, a symbol or integer.

Procedure: event:button:set-x! event value

Set button.x in event to value.

Procedure: event:button:set-y! event value

Set button.y in event to value.

4.5 Joysticks

The value for event:jbutton:state and event:jbutton:set-state! is a symbol, one of: released or pressed.

The value for event:jhat:value and event:jhat:set-value! is a list of or more symbols from the set:

centered
up    down
left  right

Specifying the empty list for event:jhat:set-value! is effectively the same as specifying centered.

Procedure: event:jaxis:which event

Get jaxis.which from event.

Procedure: event:jaxis:axis event

Get jaxis.axis from event.

Procedure: event:jaxis:value event

Get jaxis.value from event.

Procedure: event:jaxis:set-which! event value

Set jaxis.which in event to value.

Procedure: event:jaxis:set-axis! event value

Set jaxis.axis in event to value.

Procedure: event:jaxis:set-value! event value

Set jaxis.value in event to value.

Procedure: event:jbutton:which event

Get jbutton.which from event.

Procedure: event:jbutton:button event

Get jbutton.button from event.

Procedure: event:jbutton:state event

Return the symbolic jbutton.state from event.

Procedure: event:jbutton:set-which! event value

Set jbutton.which in event to value.

Procedure: event:jbutton:set-button! event value

Set jbutton.button in event to value.

Procedure: event:jbutton:set-state! event value

Set jbutton.state in event to value, a symbol or integer.

Procedure: event:jball:which event

Get jball.which from event.

Procedure: event:jball:ball event

Get jball.ball from event.

Procedure: event:jball:xrel event

Get jball.xrel from event.

Procedure: event:jball:yrel event

Get jball.yrel from event.

Procedure: event:jball:set-which! event value

Set jball.which in event to value.

Procedure: event:jball:set-ball! event value

Set jball.ball in event to value.

Procedure: event:jball:set-xrel! event value

Set jball.xrel in event to value.

Procedure: event:jball:set-yrel! event value

Set jball.yrel in event to value.

Procedure: event:jhat:which event

Get jhat.which from event.

Procedure: event:jhat:hat event

Get jhat.hat from event.

Procedure: event:jhat:value event

Return jhat.value from event as a (possibly empty) list of symbols.

Procedure: event:jhat:set-which! event value

Set jhat.which in event to value.

Procedure: event:jhat:set-hat! event value

Set jhat.hat in event to value.

Procedure: event:jhat:set-value! event value

Set jhat.value in event to value, a (possibly empty) list of symbols.

4.6 Resizes

Procedure: event:resize:w event

Get resize.w from event.

Procedure: event:resize:h event

Get resize.h from event.

Procedure: event:resize:set-w! event value

Set resize.w in event to value.

Procedure: event:resize:set-h! event value

Set resize.h in event to value.

4.7 Misc

Procedure: pump-events

Gather events from input devices and update the event queue.

Procedure: evqueue-add [events…]

Add events to the back of the event queue. Return the count of succesfully added events.

Procedure: evqueue-peek n mask [accumulate]

Return a count (less than or equal to n) of events at the front of the event queue that match mask, without changing the queue. Optional arg accumulate if non-#f means to return the list of matched events, instead. If there are errors, return #f.

See event-mask flags.

Procedure: evqueue-get n mask

Return a list (of length at most n) of events at the front of the event queue that match mask, removing them from the queue. If there are errors, return #f.

See event-mask flags.

Procedure: peep-events events numevents action mask

NB: This procedure is obsoleted by evqueue-add, evqueue-peek and evqueue-get; it will be removed after 2013-12-31.

Manage the event queue, depending on action (see event-action enums):

SDL_ADDEVENT

Add up to numevents (an integer) events from events (a list) to the back of the event queue.

SDL_PEEKEVENT

Return a count (number less than or equal to numevents) of events at the front of the event queue that match mask (see event-mask flags), without changing the queue.

SDL_GETEVENT

Act like for SDL_PEEKEVENT except return a list of matching events instead of a count, removing them from the queue.

Procedure: poll-event [event]

Poll for events and return #t if there are any pending. Optional arg event specifies an event object (from make-event) to be filled in with the next event from the queue (if available).

Procedure: wait-event [event]

Wait indefinitely for and return #f only if there were errors. Optional arg event specifies an event object (from make-event) to be filled in with the next event from the queue.

Procedure: push-event event

Push event onto the queue. Return #t on success.

Procedure: set-event-filter filter full?

Set the event filter to filter, or clear it if filter is #f. This is a procedure called with one arg, and whose return value, if non-#f, means to keep the event, otherwise discard it. If full? is #f, the arg the event type (a symbol), otherwise it is an event object.

Procedure: get-event-filter

Return information on the current event filter, or #f if none is set. If there is a filter, the value is a pair with car the filter proc, and cdr #f if the proc takes an event type, or #t if the proc takes an event object.

Procedure: event-type-handling type [setting]

Return #t if event type (see event-type enums) is recognized and queued, or #f if it is ignored. If setting is specified, set the handling of type to the truth value of setting first.

Procedure: event-state type state

NB: This procedure is obsoleted by event-type-handling and will be removed after 2013-12-31.

Set or query the state of event type (see event-type enums) processing, based on state (see event-state enums). If state is SDL_QUERY, return the current state. If it is SDL_IGNORE or SDL_ENABLE, disable or enable, respectively, internal event type processing and return state.

Procedure: enable-unicode [enable-p]

Return #t iff UNICODE keyboard translation is enabled. Optional arg enable? if non-#f, enables UNICODE keyboard translation, or disables it if #f.

Procedure: enable-key-repeat delay interval

Enable or disable keyboard repeat. delay is the initial delay in ms between the time when a key is pressed, and keyboard repeat begins. interval is the time in ms between keyboard repeat events. If delay is 0, keyboard repeat is disabled. Return #t on success.

Procedure: get-key-state

Return a list of pressed keys (see keysym enums).

Procedure: get-mod-state

Return the current key modifier state as a list of symbols.

Procedure: set-mod-state modstate

Set the current key modifier state to modstate, a list of symbols. This does not change the keyboard state, only the key modifier flags.

Procedure: get-mouse-state [symbolic]

NB: This procedure is obsoleted by mouse-bxy and will be removed after 2013-12-31.

Return the current state of the mouse as an alist with symbolic keys: state, x and y. Normally, all values are integers. However, if optional arg symbolic is non-#f, the state value is instead a (possibly empty) list of symbols of the set:

left middle right
wheel-up wheel-down
x1 x2
Procedure: get-mouse-relative-state [symbolic]

NB: This procedure is obsoleted by mouse-bxy and will be removed after 2013-12-31.

Return the current relative state of the mouse as an alist with symbolic keys: state, x and y. Optional arg symbolic has the same effect as for get-mouse-state.

Procedure: button? mask

Return #t if buttons specified in mask are pressed, otherwise #f. mask is a symbol or a list of symbols from the set returned by get-mouse-state.

For backward compatability, mask can also be the (integer) logior of the buttons, using mapping:

 1  left
 2  middle
 4  right
 8  wheel-up
16  wheel-down
32  x1
64  x2

For example, a value of 5 specifies both left and right buttons, equivalent to (left right).

Procedure: mouse-bxy [relative]

Return three values: a (possibly empty) list of symbols representing pressed mouse buttons (like event:button:button), and two integer coordinates x and y.

Optional arg relative non-#f means the coordinates are relative to the last time the underlying SDL_GetRelativeMouseState was called.


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

5 Joystick

Procedure: num-joysticks

Return the number of joysticks.

Procedure: joystick? obj

Return #t iff obj is a joystick object.

Procedure: joystick-name [n]

Return the (string) name of the default joystick, or #f. Optional arg n specifies which joystick to check.

Procedure: joystick-open [n]

Return a handle to the default joystick opened for use. Optional arg n specifies which joystick to open.

Procedure: joystick-opened? [n]

Return #t iff the default joystick is opened. Optional arg n specifies which joystick to check.

Procedure: joystick-index joystick

Return the index of joystick.

Procedure: joystick-num-axes joystick

Return the number of axes for joystick.

Procedure: joystick-num-balls joystick

Return the number trackballs for joystick.

Procedure: joystick-num-hats joystick

Return the number of hats for joystick.

Procedure: joystick-num-buttons joystick

Return number of buttons for joystick.

Procedure: joystick-update

Update the state of all Joysticks.

Procedure: joystick-polling [setting]

Return #t if joystick events are polled and queued (such that it is unnecessary to “manually” call joystick-update), otherwise #f. If setting is specified, set joystick events polling to the truth value of setting first.

Procedure: joystick-event-state state

NB: This procedure is obsoleted by joystick-polling and will be removed after 2013-12-31.

Set or query the state of internal joystick event processing, based on state (a symbol). If state is SDL_QUERY, return the current state. If it is SDL_IGNORE or SDL_ENABLE, disable or enable, respectively, internal joystick event processing and return state. When enabled, it is not necessary to call joystick-update.

Procedure: joystick-get-axis joystick axis

For joystick, return state of axis.

Procedure: joystick-ball-xy joystick n

Return relative motion of joystick trackball n as two values: dx and dy (both integers).

Procedure: joystick-get-ball joystick n

NB: This procedure is obsoleted by joystick-ball-xy and will be removed after 2013-12-31.

For joystick, return relative motion of trackball n, as an alist with keys dx and dy. If n is invalid, return #f.

Procedure: joystick-get-hat joystick n

For joystick, return state of hat n.

Procedure: joystick-get-button joystick n

For joystick, return state of button n, a symbol, one of: released or pressed.

Procedure: joystick-close joystick

Close a previously opened joystick.


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

6 CDROM

Procedure: cd? obj

Return #t iff obj is a CDROM drive object.

Procedure: cd-num-drives

Return the number of CDROM drives.

Procedure: cd-name [drive]

Return a human-readable, system-dependent identifier (a string) for the CDROM, or #f. Optional arg drive is a number specifying which drive.

Procedure: cd-open [drive]

Open the CDROM drive for access and return its handle. If the drive is unavailable, return #f. Optional arg drive is a number specifying which drive.

Procedure: cd-status cdrom

Return the current status of the drive cdrom as a symbol (see cdrom-state enums).

Procedure: cd-in-drive? cdrom

Return #t iff there is a CD in drive cdrom.

Procedure: cd-get-num-tracks cdrom

Return the number of tracks on the CD in drive cdrom.

Procedure: cd-get-cur-track cdrom

Return the current track on the CD in drive cdrom.

Procedure: cd-get-cur-frame cdrom

Return the current frame of the CD in drive cdrom.

Procedure: cd-nth-track-itlo cdrom [n]

For CD in drive cdrom, return four values describing track n (zero if unspecified): id, type, length and offset, all integers except for type, which is a symbol, either audio or data.

Procedure: cd-get-nth-track cdrom [n]

NB: This procedure is obsoleted by cd-nth-track-itlo and will be removed after 2013-12-31.

For CD in drive cdrom, return info on track n as an alist or #f if there were problems.

Procedure: cd-play-tracks cdrom [start-track [start-frame [n-tracks [n-frames]]]]

Play the given CD tracks in drive cdrom. Play the CD starting at start-track and start-frame for ntracks tracks and nframes frames. If both ntrack and nframe are 0, play until the end of the CD. This procedure will skip data tracks, and should only be called after calling cd-status to get track information about the CD. Return #t if successful.

Procedure: cd-play cdrom start length

Play CD in drive cdrom from start frame for length frames. Return #t if successful.

Procedure: cd-pause cdrom

Pause the CD in drive cdrom. Return #t if successful.

Procedure: cd-resume cdrom

Resume (unpause) the CD in drive cdrom. Return #t if successful.

Procedure: cd-stop cdrom

Stop the CD in drive cdrom. Return #t if successful.

Procedure: cd-eject cdrom

Eject the CD from drive cdrom. Return #t if successful.

Procedure: cd-close cdrom

Close the drive cdrom.

Procedure: cd-msf->frames m [s [f]]

Return frames (an integer) computed fr m, second s and frame f. s and f are optional.

Procedure: frames-msf frames

Break down frames (an integer) and return three values: minute, second and frames (all integers).

Procedure: cd-frames->msf frames

NB: This procedure is obsoleted by frames-msf and will be removed after 2013-12-31.

Return a minute/second/frames alist made from converting frames (a number).


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

7 OpenGL

[todo]


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

8 TrueType

Procedure: ttf-init

Initialize the SDL_ttf subsystem.

Procedure: load-font file ptsize

Load a font from file with point size ptsize. Return a handle.

Procedure: font:style font

Return the style of font (see font-style flags). This font style is implemented by modifying the font glyphs, and doesn’t reflect any inherent properties of the truetype font file.

Procedure: font:set-style! font style

Set font style to style (see font-style flags). This font style is implemented by modifying the font glyphs, and doesn’t reflect any inherent properties of the truetype font file.

Procedure: font:height font

Return the total height of font, usually equal to point size.

Procedure: font:ascent font

Return the offset from the baseline to the top of font. This is a positive number.

Procedure: font:descent font

Return the offset from the baseline to the bottom of font. This is a negative number.

Procedure: font:line-skip font

Return the recommended spacing between lines of text for font.

Procedure: font:glyph-xXyYa font ch

Return the metrics (dimensions) of a glyph as five values. The glyph is a font-specific rendering of char ch. Values are: minx, maxx, miny, maxy and advance (all integers).

Procedure: font:glyph-metrics font ch

NB: This procedure is obsoleted by font:glyph-xXyYa and will be removed after 2013-12-31.

Return the metrics (dimensions) of a glyph as an alist. The glyph is a font-specific rendering of char ch. Alist keys are: minx, maxx, miny, maxy and advance. Values are numbers.

Procedure: text-wh font text

Return two values: width and height (both integers) representing the dimensions of the font-specific rendering of the string text.

Procedure: font:size-text font text

NB: This procedure is obsoleted by text-wh and will be removed after 2013-12-31.

Return an alist with keys w and h and corresponding values (numbers) representing the width and height of the font-specific rendering of the string text.

Procedure: utf8-wh font text

Return two values: width and height (both integers) representing the dimensions of the font-specific rendering of the UTF-8 string text.

Procedure: font:size-utf8 font text

NB: This procedure is obsoleted by utf8-wh and will be removed after 2013-12-31.

Return an alist with keys w and h and corresponding values (numbers) representing the width and height of the font-specific rendering of the utf8 string text.

Procedure: render-text font text fg [bg]

Return a new surface containing the font-specific rendering of the text string. Third argument is the foreground color; optional fourth argument is the background color, or #t if the text is to be blended.

Procedure: render-utf8 font text fg [bg]

Return a new surface containing a font-specific rendering of the utf8 string text. Third argument is the foreground color; optional fourth argument is the background color, or #t if the text is to be blended.

Procedure: render-glyph font ch fg [bg]

Return a new surface containing a font-specific rendering of the character ch. Third argument is the foreground color; optional fourth argument is the background color, or #t if the text is to be blended.

Procedure: ttf-quit

Quit the SDL_ttf subsystem.


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

9 Audio

Procedure: open-audio [freq [format [stereo [chunksize]]]]

Open the mixer with a certain audio format. Optional args freq (number), format (number), stereo (boolean) and chunksize (number) specify those aspects of the device. Return #t if successful.

Procedure: allocated-channels numchans

Dynamically change the number of channels managed by the mixer to numchans. If decreasing the number of channels, the upper channels are stopped. Return the new number of allocated channels.

Procedure: device-ffc

Return audio device parameters as three values: frequency (Hz), format (number of bits) and channels (number of allocated channels).

Procedure: query-spec

NB: This procedure is obsoleted by device-ffc and will be removed after 2013-12-31.

Return audio device parameters as an alist, or #f if the audio has not yet been opened. Keys are freq (frequency), format, and channels (the number of allocated channels).

Procedure: load-music filename

Load music data (.mod .s3m .it .xm) from filename. Return a new music object if successful, otherwise #f.

Procedure: load-wave filename

Load wave data from filename. Return a new audio object if succesful, otherwise #f.

Procedure: reserve-channels num

Reserve the first num channels (0 through num-1) for the application. In other words don’t allocate them dynamically to the next sample if requested with a -1 value below. Return the number of reserved channels.

Procedure: group-channel channel [tag]

Attach to channel a tag. A tag can be assigned to several mixer channels, to form groups of channels. If tag is not specified, or is -1, the tag is removed (actually -1 is the tag used to represent the group of all the channels). Return #t if successful.

Procedure: group-channels from to [tag]

Assign channels in the range from through to to the default group. Optional arg tag specifies the group to use. Return #t if successful.

Procedure: group-available [tag]

Return the first available channel in the default group of channels. Optional arg tag specifies the group to check.

Procedure: group-count [tag]

Return the number of channels in the default group. Optional arg tag specifies the group to check.

Procedure: group-oldest [tag]

Return the "oldest" sample playing in the default group of channels. Optional arg tag specifies the group to check.

Procedure: group-newer [tag]

Return the "most recent" (i.e. last) sample playing in the default group of channels. Optional arg tag specifies the group to check.

Procedure: play-channel chunk [channel [loops [ticks [fade]]]]

Play an audio chunk on a specific channel. If the channel is unspecified or is -1, play on the first free channel. If loops is specified and greater than zero, loop the sound that many times. If loops is -1, loop infinitely (~65000 times). If ticks is specified, stop after that number of ticks. If fade is specified, fade in over that number of milliseconds. Return which channel was used to play the sound.

Procedure: play-music music [loops [fade]]

Play a music track. Optional args loops and fade are as in play-channel.

Procedure: volume [volume [which]]

Return the current volume on the default channel. Optional arg volume (a number in the range 0-128) means set the volume to volume and return the original volume. Optional second arg which specifies a chunk or channel to check (or modify) instead of the default. If volume is non-#f and which is #f, modify all channels.

[Here is the original (perhaps clearer) docstring. —ttn]

Set the volume in the range of 0-128 of a specific channel or chunk. If the channel is unspecified or is -1, set volume for all channels. Return the original volume. If the volume is unspecified or is -1, just return the current volume.

Procedure: music-volume [volume]

Return the current volume. Optional arg volume (a number in the range 0-128) means set the volume to volume.

Procedure: halt-channel [channel]

Halt playing of the default channel. Optional arg channel specifies a channel to halt.

Procedure: halt-group [tag]

Halt playing of the default group. Optional arg tag specifies the group to halt.

Procedure: halt-music

Halt playing of the music.

Procedure: expire-channel [channel [ticks]]

Turn off expiration for the default channel. Optional arg channel specifies a channel to change. Optional arg ticks (a number) means set the expiration delay to that many milliseconds, rather than turning it off.

Procedure: fade-out-channel [which [ms]]

Halt a channel, fading it out progressively until silent. Optional arg which specifies a channel to halt. Second optional arg ms specifies the number of milliseconds the fading will take (default 0).

Procedure: fade-out-group [tag [ms]]

Halt a group, fading it out progressively until silent. Optional arg tag specifies a group to halt. Second optional arg ms specifies the number of milliseconds the fading will take (default 0).

Procedure: fade-out-music [ms]

Halt the music, fading it out progressively until silent. Optional arg ms specifies the number of milliseconds the fading will take (default 0).

Procedure: fading-music

Return the fading status of the music, one of the symbols: no, out, in.

Procedure: fading-channel [which]

Return the fading status (a symbol, see fading-music) of the default channel. Optional arg which selects which channel to check.

Procedure: pause [channel]

Pause the default channel. Optional arg channel selects which channel to pause.

Procedure: resume [channel]

Resume (unpause) the default channel. Optional arg channel selects which channel to resume.

Procedure: paused? [channel]

Return #t if the default channel is paused. Optional arg channel selects a which channel to check.

Procedure: pause-music

Pause the music.

Procedure: resume-music

Resume (unpause) the music.

Procedure: rewind-music

Rewind the music.

Procedure: paused-music?

Return #t if the music is currently paused.

Procedure: playing? [channel]

Return #t iff the default channel is playing. Optional arg channel selects which channel to check.

Procedure: playing-music?

Return #t iff the music is currently playing.

Procedure: set-music-command command

Stop music and set external music playback command to command, a string. As a special case, if command is #f, arrange to use internal playback, instead.

FWIW, the C header file for the following panning, distance and position procs says:

Setting (channel) to MIX_CHANNEL_POST registers this as a posteffect, and the panning will be done to the final mixed stream before passing it on to the audio device.

Procedure: set-panning channel l r

Set panning for (stereo) channel with l and r. Both l and r are integers 0–255, inclusive, where 0 is quietest and 255 is loudest.

To get “true” panning, use (set-panning CH N (- 255 N)).

Procedure: set-distance channel distance

Set the “distance” of channel to distance (integer, 0–255). This controls the location of the sound with respect to the listener.

Distance 0 is overlapping the listener, and 255 is as far away as possible. A distance of 255 does not guarantee silence; in such a case, you might want to try changing the chunk’s volume, or just cull the sample from the mixing process with halt-channel.

For efficiency, the precision of this effect may be limited (distances 1 through 7 might all produce the same effect, 8 through 15 are equal, etc).

Setting (distance) to 0 unregisters this effect, since the data would be unchanged.

Procedure: set-position channel angle distance

Set the “position” of channel to angle, distance. In this polar coordinate, angle is in degrees (integer modulo 360), and distance is an integer 0–255 (and is treated as in proc set-distance – see notes there).

Angle 0 is due north, and rotates clockwise as the value increases. For efficiency, the precision of this effect may be limited (angles 1 through 7 might all produce the same effect, 8 through 15 are equal, etc).

Setting angle and distance to 0 unregisters this effect, since the data would be unchanged.

Additionally, the C header says:

If the audio device is configured for mono output, then you won’t get any effectiveness from the angle; however, distance attenuation on the channel will still occur. While this effect will function with stereo voices, it makes more sense to use voices with only one channel of sound, so when they are mixed through this effect, the positioning will sound correct. You can convert them to mono through SDL before giving them to the mixer in the first place if you like.

Procedure: close-audio

Close the mixer, halting all playing audio.


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

10 SDL_gfx by Andreas Schiffler

10.1 Graphics Primitives

Procedure: draw-point surface x y color

On surface, draw a point at location x,y with color color.

Procedure: draw-hline surface x1 x2 y color

On surface, draw a horizontal line segment from x1,y to x2,y, with color color.

Procedure: draw-vline surface x y1 y2 color

On surface, draw a vertical line segment from x,y1 to x,y2, with color color.

Procedure: draw-rectangle surface x1 y1 x2 y2 color [fill]

On surface, draw a rectangle with opposite points x1,y1 and x2,y2, with color color. Optional arg fill means to fill the rectangle as well.

Procedure: draw-rounded-rectangle surface x1 y1 x2 y2 rad color [fill]

On surface, draw a rectangle with opposite points x1,y1 and x2,y2, with rounded corners radius rad in color color. Optional arg fill means to fill the rectangle as well.

Procedure: draw-line surface x1 y1 x2 y2 color

On surface, draw a line segment from x1,y1 to x2,y2, with color color.

Procedure: draw-aa-line surface x1 y1 x2 y2 color

On surface, draw an anti-aliased line segment from x1,y1 to x2,y2, with color color.

Procedure: draw-thick-line surface x1 y1 x2 y2 width color

On surface, draw a line segment from x1,y1 to x2,y2, with thickness width in color color.

Procedure: draw-arc surface x y r start end color

On surface, draw arc with center x,y and radius r, going from start to end (degrees), with color color.

If start is greater than end, the effective range of the arc is taken to be end to start (that is, these arguments are internally reversed).

Procedure: draw-circle surface x y r color [fill]

On surface, draw a circle with center x,y and radius r, with color color. Optional arg fill means to fill the circle as well.

Procedure: draw-aa-circle surface x y r color

On surface, draw an anti-aliased circle with center x,y and radius r, with color color.

Procedure: draw-ellipse surface x y rx ry color [fill]

On surface, draw an ellipse with center x,y x-radius rx, y-radius ry, with color color. Optional arg fill means to fill the ellipse as well.

Procedure: draw-aa-ellipse surface x y rx ry color

On surface, draw an anti-aliased ellipse with center x,y, x-radius rx, y-radius ry, with color color.

Procedure: draw-pie-slice surface x y rad start end color [fill]

On surface, draw a pie slice with center x,y and radius rad, going from start to end (degrees), with color color. Optional arg fill means to fill the slice as well.

Procedure: draw-trigon surface x1 y1 x2 y2 x3 y3 color [fill]

On surface, draw a triangle with vertices at x1,y1, x2,y2 and x3,y3, with color color. Optional arg fill means to fill the triangle as well.

Procedure: draw-aa-trigon surface x1 y1 x2 y2 x3 y3 color

On surface, draw an anti-aliased triangle with vertices at x1,y1, x2,y2 and x3,y3, with color color.

Procedure: draw-polygon surface vx vy color [fill]

On surface, draw a polygon whose points are specified by corresponding pairs from the s16 uniform vectors vx and vy, in color color. Optional arg fill means to fill the polygon as well.

Procedure: draw-aa-polygon surface vx vy color

On surface, draw an anti-aliased polygon whose points are specified by corresponding pairs from the s16 uniform vectors vx and vy, in color color.

Procedure: draw-textured-polygon surface vx vy texture tdx tdy

On surface, draw a polygon whose points are specified by corresponding pairs from the s16 uniform vectors vx and vy, filling from texture (a surface) with offset tdx, tdy.

Procedure: draw-bezier surface vx vy s color

On surface, draw a bezier curve whose points are specified by corresponding pairs from the s16 uniform vectors vx and vy, with s steps in color color.

Procedure: draw-character surface x y c color

On surface at position x,y, draw char c with color (a number).

Procedure: draw-string surface x y text color

On surface at position x,y, draw string text with color (a number).

Procedure: font-rotation! rotation

Set the rotation for glyphs drawn by draw-character and draw-string to rotation (an integer or symbol), one of:

0  none
1  clockwise
2  upside-down
3  counter-clockwise

10.2 Rotation / Zooming

Procedure: roto-zoom-surface surface angle [zoom [smooth]]

Return a new surface made from rotating surface by angle degrees. Optional third arg zoom (default value 1.0) changes the size as well. Optional fourth arg smooth turns on anti-aliasing.

Procedure: roto-zoom-surface-xy surface angle [zoomx [zoomy [smooth]]]

Return a new surface made from rotating surface by angle degrees. Optional third and fourth args zoomx and zoomy (default value 1.0 for both) changes the size as well. Optional fifth arg smooth turns on anti-aliasing.

Procedure: zoom-surface surface zoomx [zoomy [smooth]]

Return a new scaled copy of surface. zoomx and zoomy specify the scaling factor. If omitted, zoomy defaults to zoomx. Optional fourth arg smooth turns on anti-aliasing.

Procedure: shrink-surface surface factorx factory

Return a new shrunken copy of surface. factorx and factory are positive integers specifying the inverse scaling factor. For example, 2 means half size, 3 means one-third size, etc.

The returned surface is antialiased by “averaging the source box RGBA or Y information” and is in 32-bit RGBA format.

10.3 Managing Frame Rate

Procedure: make-fps-manager [n]

Return a FPS manager object to be passed as the first arg to fps-manager-set!, fps-manager-get and fps-manager-delay!. Optional arg n specifies the value in Hz to initialize the object (default 30 if not specified).

Procedure: fps-manager-set! mgr n

Arrange for FPS manager mgr to try to maintain a frame rate of n Hz. Return #f if not successful.

Procedure: fps-manager-get mgr

Return the frame rate of FPS manager mgr in Hz, or #f if unsuccessful.

Procedure: fps-manager-delay! mgr

Request an appropriate delay from FPS manager mgr.

10.4 RGBA Extras

Procedure: set-pixel-alpha! surface alpha

If surface is 32-bit, set each pixel’s alpha value to alpha, an integer 0-255, inclusive, and return #t. Otherwise, do nothing and return #f.

Procedure: blit-rgba src srect dst drect

Blit from 32-bit surface src rectangle srect to 32-bit surface dst rectangle drect. Return #t if there are no problems.

Note that unlike blit-surface (see Video), all arguments must be fully specified. This restriction may be relaxed in the future.

10.5 Image Filtering

Procedure: imfi-mmx? [setting]

If setting is #t, enable MMX instructions for the image filter procs (if possible); if #f, disable; otherwise do nothing. Return the (boolean) value of the setting afterwards.

Procedure: imfi-add src1 src2 dst

D = saturation255 (S1 + S2).

Procedure: imfi-mean src1 src2 dst

D = S1/2 + S2/2.

Procedure: imfi-sub src1 src2 dst

D = saturation0 (S1 - S2).

Procedure: imfi-abs-diff src1 src2 dst

D = | S1 - S2 |.

Procedure: imfi-mult src1 src2 dst

D = saturation (S1 * S2).

Procedure: imfi-mulnor src1 src2 dst

D = S1 * S2 (non-MMX).

Procedure: imfi-muldiv2 src1 src2 dst

D = saturation255 (S1/2 * S2).

Procedure: imfi-muldiv4 src1 src2 dst

D = saturation255 (S1/2 * S2/2).

Procedure: imfi-logand src1 src2 dst

D = S1 & S2.

Procedure: imfi-logior src1 src2 dst

D = S1 | S2.

Procedure: imfi-div src1 src2 dst

D = S1 / S2 (non-MMX).

Procedure: imfi-not src dst

D = !S.

Procedure: imfi-add-c src dst c

D = saturation255 (S + C).

Procedure: imfi-add-c-to-half src dst c

D = saturation255 (S/2 + C).

Procedure: imfi-sub-c src dst c

D = saturation0 (S - C).

Procedure: imfi-ashr src dst n

D = saturation0 (S >> N).

Procedure: imfi-lshr src dst n

D = saturation0 ((uint) S >> N).

Procedure: imfi-mul-c src dst c

D = saturation255 (S * C).

Procedure: imfi-ashr-mul-c src dst n c

D = saturation255 ((S >> N) * C).

Procedure: imfi-bshl src dst n

D = (S << N).

Procedure: imfi-lshl src dst n

D = ((uint) S << N).

Procedure: imfi-ashl src dst n

D = saturation255 (S << N).

Procedure: imfi-binarize src dst t

D = (S < T ? 0 : 255).

Procedure: imfi-clip src dst tmin tmax

D = (Tmin <= S <= Tmax) ? 255 : 0.

Procedure: imfi-normalize-linear src dst cmin cmax nmin nmax

D = saturation255 ((Nmax - Nmin) / (Cmax - Cmin) * (S - Cmin) + Nmin).


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

11 Miscellaneous Utilities

These are available in module (sdl misc-utils).

Procedure: exact-truncate number

Return the exact truncation (rounding to zero) of number. This is “safer” than simply inexact->exact for some Guile versions.

(define scale 0.180281690140845)
(inexact->exact scale)
  ⇒ 3247666210160131/18014398509481984 ; Guile 1.8.7
  ⇒ 0                                  ; Guile 1.4.x
(exact-truncate scale)
  ⇒ 0
Procedure: call-with-clip-rect rect thunk

Set default clip rect to rect, call thunk, and restore it. thunk is a procedure that takes no arguments.

Procedure: rotate-square square angle

Return a new surface made by rotating square by angle degrees. The square retains its original size.

Procedure: rectangle-closure [rect]

Return a closure that manages a single rectangle object. Calling the closure with no args returns the rectangle object. Otherwise, the messages #:w, #:h, #:x and #:y return the rectangle’s width, height, horizontal offset and vertical offset, respectively; and the messages #:w!, #:h!, #:x! and #:y!, followed by an integer, update the rectangle’s width, height, horizontal offset and vertical offset, respectively.

Optional arg rect specifies a rectangle object to manage instead of allocating a new one.

Procedure: rectangle<-geometry-string spec

Return a rectangle made from parsing the geometry string spec, which typically has the form WxH+X+Y, where +X+Y is optional (defaults to “+0+0”), and W, H, X and Y are integers. Actually, the + can also be a -. If spec cannot be parsed, return #f. Examples:

(rectangle<-geometry-string "42x43+44+45")
⇒ #<SDL-Rect 42x43+44+45>

(rectangle<-geometry-string "42x43-10-20")
⇒ #<SDL-Rect 42x43+-10+-20>

(rectangle<-geometry-string "42x43")
⇒ #<SDL-Rect 42x43+0+0>

(rectangle<-geometry-string "42")
⇒ #f

Note that the print representation of a rectangle always has “+”. The term “geometry string” derives from the X Window System, where many programs take a --geometry (or -g for short) command-line option.

Procedure: poll-with-push-on-timeout-proc timeout slice [get-timeout-events]

Return a procedure P that checks the event queue for timeout ms, polling every slice ms. If an event arrives during that time, return #t. Otherwise return #f. Optional arg get-timeout-events is either a list of events to be pushed on the queue in the case of timeout, or a thunk to be called that produces such a list. If get-timeout-events is specified, return the result of another event queue polling. (This may still be #f if the pushed events are masked in some way.)

P is called with a single arg, a pre-constructed event object. This interface is congruent with that of wait-event and poll-event. See Events.

Procedure: rect<-surface surface [x y]

Return a new rectangle with the same width and height as surface. Optional second and third arg (which must appear together or not at all) specifies the x and y components, respectively, to use instead of the default of 0 (zero).

Procedure: copy-rectangle rect [modify args...]

Return a new rectangle copied from rect.

Optional second arg modify specifies which portions, if any, to modify using the values in the rest args. If modify is #:xy, the two args specify new x and y values. If modify is #:wh, the two args specify new w and h values.

rect
⇒ #<SDL-Rect 3x4+1+2>

(copy-rectangle rect)
⇒ #<SDL-Rect 3x4+1+2>

(copy-rectangle rect #:xy 11 22)
⇒ #<SDL-Rect 3x4+11+22>

(copy-rectangle rect #:wh 33 44)
⇒ #<SDL-Rect 33x44+1+2>
Procedure: copy-surface surface [clip]

Create a new surface and blit surface onto it. The new surface has the same pixel format as surface. Return the new surface.

Optional second arg clip is a rectangle describing the portion of surface to copy (default is the entire surface).

Procedure: ignore-all-event-types-except [types…]

Arrange to ignore all event types except those in types (see event-type enums). As a special case, if types is #f, arrange to not ignore any event types (all are enabled).

In the following procs, those named ending with /3p return three values, each a thunk (unless specified otherwise) handling the three-phase calling convention, namely init, next, and done.

(call-with-values (lambda () (foo/3p ...))
  (lambda (init! foo! done!)
    (init!)
    (let loop ((continue? (foo!)))
      (and continue? (loop (foo!))))
    (done!)))

Note that foo! returns non-#f to indicate that the looping is not yet complete.

Procedure: fader/3p sec realized location image replacement

Return three values, each a thunk, that can be used to loop for sec seconds, blitting onto realized at location (a rectangle or #f to indicate the origin) the alpha-composition of image and its replacement (both surfaces), to effect a fade-in of replacement over image. The alpha value is directly proportional to the time between the “next!” phase call and the “init!” phase call.

realized may be either a surface, in which case at the end of each loop it is shown via update-rect; or a pair whose CAR is a surface and whose CDR is a thunk that should do the showing.

Note that location is used for blitting, so its width and height should match those of image and replacement.

Procedure: toroidal-panner/3p surface dx dy [sub [batch?]]

Return three values, the first a procedure of one arg, the other two thunks, that can be used to toroidally pan surface by dx and dy pixels. This means that data disappearing from one side of the surface (left, right, top, bottom) is rotated to appear at the other side (right, left, bottom, top). The init! procedure takes one arg count, the number of pans to do.

Positive dx moves surface data to the left (panning right), and likewise, positive dy, up (panning down).

Optional third arg sub is a rectangle object specifying a subset of the surface. The default is to pan the entire surface.

Optional fourth arg batch? non-#f means to call update-rect on the (sub)surface after all the panning is done. The default is to update the surface after each pan. Batch mode is useful for implementing variable-speed panning, for example:

(define (pan dir)
  (call-with-values (lambda ()
                      (toroidal-panner/3p screen
                                          (* dir 21)
                                          (* dir 12)
                                          #f #t))
    (lambda (init! next! done!)
      (lambda (count)
        (init! count)
        (let loop ((continue? (next!)))
          (and continue? (loop (next!))))
        (done!)))))

(define pan-away (pan  1))
(define pan-back (pan -1))
(define ramp (map 1+ (append (make-list 21 0)
                             (identity (iota 12))
                             (reverse! (iota 12))
                             (make-list 21 0))))
(for-each pan-away ramp)
(for-each pan-back ramp)

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

12 Simple Closures

This chapter documents module (sdl simple).

This module provides some simple abstractions to introduce common Guile-SDL programming idioms. Although the interfaces are documented, they are permanently alpha, that is, subject to change w/o notice. Instead of relying on the stability of the interface, you are encouraged to look at the implementation as a model for creating customized abstractions.

Procedure: simple-canvas init? w h bpp [flags…]

Return a canvas closure that accepts a few simple messages. If init? is non-#f, initalize the SDL video subsystem first. w, h, and bpp specify the width, height, and bits-per-pixel, respectively. flags are symbols to set the video mode. If omitted, the default is hw-surface and doublebuf.

The closure, if called without arguments, returns the video surface. Otherwise, the following messages are recognized:

#:rect

Return a rectangle the width and height of the canvas.

#:set-bg! r g b

Set the background color (used for clearing) to the color specified by r, g and b (integers 0-255), respectively. By default it is black (all values zero).

#:clear!

Fill the canvas with the background color.

#:w
#:h
#:w/h

Return width, height, or a cons of width and height, respectively.

#:resize! new-width new-height

Request that the canvas dimension be changed to new-width by new-height. Return a rect that reflects the actual dimension.

Procedure: simple-stylus init? filename size r g b

Return a stylus closure that accepts a few simple messages. If init? is non-#f, initialize the SDL TTF support first. filename specifes the .ttf file to load and size the size. r, g and b are integers (0-255) specifying the color. The closure recognizes the following messages:

#:set-font! filename size
#:set-color! r g b

Change the font or color, respectively.

#:set-canvas! surface

Set the surface on which the #:write! command renders.

#:render text [color [bg]]

Return a surface of text rendered using the default font, size, color and size. Optional second arg color specifies another color to use. Optional third arg bg specifies a background mode: #f (default) for “solid”; #t for “blended”; a color to use that color.

#:write! where text [color [bg]]

Similar to #:render, but also blit the surface onto the canvas at the rectangle position specified by where. The width and height components of where are updated by side effect.

Procedure: simple-vpacked-image filename [canvas]

Return a vpacked image closure that accepts a few simple messages. "Vpacked" means multiple vertically-abutted images of dimensions NxN (at the top) through Nx1 (at the bottom), stored in a single image file. filename specifies the file and optional arg canvas specifies a surface for blitting. The closure recognizes the following messages:

#:set-canvas! surface

Change the canvas.

#:rects

Return the vector of rectangles of length N+1 (the element at index zero is #f) corresponding to areas on the image representing the smaller sub-images. The element at index I is a rectangle of dimension IxI.

#:blit! i rect

Blit the sub-image i (an integer 1 <= I <= N), onto the canvas. rect specifies a rectangle to blit to.


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

13 Excuses

Here are some notes on interface elements from /usr/include/SDL/*.h that are not yet wrapped by Guile-SDL. As things progress elements will be removed until an irreducible set remains.

Interface elements have zero or more attributes, some of which indicate irreducibility (such as probably-never). Following the attribute groupings are specific notes on those elements that are particular in some way. The presentation order is not significant.

13.1 Categories

For brevity, we omit the SDL_ prefix in the groupings. There are two speical cases: (N) stands for SDLNet_, and (M) stands for Mix_.

internal

These interface elements are exposed in the C header but should not be exposed to Scheme, for reasons of either safety or inutility.

  SoftStretch  LowerBlit  UpperBlit
  VideoInit  VideoQuit  AudioQuit  AudioInit
  (M)GetChunk
probably-never

Don’t expect to see these exposed to Scheme, ever!

  SoftStretch  SaveBMP_RW  LoadBMP_RW
  VideoInit  VideoQuit  InitQuickDraw  RegisterApp
  SetModuleHandle  getenv  putenv
  ClearError  SetError  WriteBE64  WriteLE64
  WriteBE32  WriteLE32  WriteBE16  WriteLE16
  ReadBE64  ReadLE64  ReadBE32  ReadLE32
  ReadBE16  ReadLE16  CloseAudio  UnlockAudio
  LockAudio  MixAudio  ConvertAudio  BuildAudioCVT
  FreeWAV  LoadWAV_RW  PauseAudio  GetAudioStatus
  OpenAudio  AudioDriverName  AudioQuit
  AudioInit  (M)GetMusicHookData  (M)GetChunk
doze

Windoze support, blech.

  SaveBMP_RW  LoadBMP_RW  RegisterApp
  SetModuleHandle
threading-implications

Will (any :–) ttn ever be ready for parallelism?

  RemoveTimer  AddTimer  SetTimer  KillThread
  WaitThread  GetThreadID  ThreadID
  CreateThread  CondWaitTimeout  CondWait
  CondBroadcast  CondSignal  DestroyCond
  CreateCond  SemValue  SemPost  SemWaitTimeout
  SemTryWait  SemWait  DestroySemaphore  CreateSemaphore
  DestroyMutex  mutexV  mutexP  CreateMutex
todo

To be completed by Guile-SDL 1.0 (that is, if All Goes Well).

  KillThread  WaitThread  GetThreadID
  ThreadID  CreateThread  CondWaitTimeout
  CondWait  CondBroadcast  CondSignal
  DestroyCond  CreateCond  SemValue
  SemPost  SemWaitTimeout  SemTryWait
  SemWait  DestroySemaphore  CreateSemaphore
  DestroyMutex  mutexV  mutexP  CreateMutex
  (N)Init  (N)Quit  (N)ResolveHost  (N)ResolveIP
  (N)TCP_Open  (N)TCP_Accept  (N)TCP_GetPeerAddress
  (N)TCP_Send  (N)TCP_Recv  (N)TCP_Close
  (N)AllocPacket  (N)ResizePacket  (N)FreePacket
  (N)AllocPacketV  (N)FreePacketV  (N)UDP_Open
  (N)UDP_Bind  (N)UDP_Unbind  (N)UDP_GetPeerAddress
  (N)UDP_SendV  (N)UDP_Send  (N)UDP_RecvV
  (N)UDP_Recv  (N)UDP_Close  (N)AllocSocketSet
  (N)AddSocket  (N)DelSocket  (N)CheckSockets
  (N)SocketReady  (N)FreeSocketSet  (N)Write16
  (N)Write32  (N)Read16  (N)Read32  (M)SetPostMix
  (M)HookMusic  (M)HookMusicFinished  (M)ChannelFinished
  (M)RegisterEffect  (M)UnregisterEffect  (M)UnregisterAllEffects
  (M)SetReverb  (M)SetReverseStereo  (M)SetMusicPosition
  (M)SetSynchroValue  (M)GetSynchroValue
rwops

Read-write operations.

  FreeRW  AllocRW  RWFromMem  RWFromConstMem
  RWFromFile
macos

Macintosh support, meh.

  InitQuickDraw
endian

These concern little- vs. big-endian i/o. Perhaps Guile already provides decent alternatives.

  WriteBE64  WriteLE64  WriteBE32  WriteLE32
  WriteBE16  WriteLE16  ReadBE64  ReadLE64
  ReadBE32  ReadLE32  ReadBE16  ReadLE16
use-mixer-instead

These elements are obsoleted by the module (sdl mixer).

  CloseAudio  UnlockAudio  LockAudio
  MixAudio  ConvertAudio  BuildAudioCVT
  FreeWAV  LoadWAV_RW  PauseAudio  GetAudioStatus
  OpenAudio  AudioDriverName  AudioQuit
  AudioInit
hook

Callback from SDL to Scheme code. Can be tricky to get right...

  (M)SetPostMix  (M)HookMusic  (M)HookMusicFinished  (M)ChannelFinished
  (M)RegisterEffect  (M)UnregisterEffect  (M)UnregisterAllEffects

13.2 Specific Notes

SDL_SoftStretch
SDL_video.h sez:
/* Not in public API at the moment - do not use! */
SDL_CreateRGBSurfaceFrom
not sure what this is useful for
SDL_GL_UpdateRects
arglist: (int numrects, SDL_Rect* rects)

we can either try to map uniform vectors (of smobs),
or introduce a `RectVector' smob.
SDL_VideoInit
actually, SDL_video.h sez:
/* These functions are used internally, and should not be used unless you
 * have a specific need to specify the video driver you want to use.
 * You should normally use SDL_Init() or SDL_InitSubSystem().
 * ...
 */
SDL_VideoQuit
see note for `SDL_VideoInit'
SDL_Linked_Version
SDL_version.h sez:
/* This function gets the version of the dynamically linked SDL library.
   it should NOT be used to fill a version structure, instead you should
   use the SDL_Version() macro.
 */
SDL_GetWMInfo
return value for proc `get-wm-info' does not presently
include the `lock_func' and `unlock_func' hooks.
support for those will be added after i figure out
how to "thunkify" them.
SDL_GetKeyName
why do we want to know the name of a key?
SDL_AudioQuit
SDL_audio.h sez:
/* These functions are used internally, and should not be used unless you
 * have a specific need to specify the audio driver you want to use.
 * You should normally use SDL_Init() or SDL_InitSubSystem().
 */
SDL_AudioInit
see note for `SDL_AudioQuit'
SDLNet_AddSocket
there are also:
#define SDLNet_TCP_AddSocket
#define SDLNet_UDP_AddSocket
SDLNet_DelSocket
there are also:
#define SDLNet_TCP_DelSocket
#define SDLNet_UDP_DelSocket
Mix_GetMusicHookData
If (when) `Mix_HookMusic' is added, it will not support "user data".
It's better to use object properties for that.

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

Appendix A Stashes

There are 24 stashes (14 enums, 10 flags).

Distribution of symbols count:

  2     6 ==============================       min: 2
  3     5 =========================            max: 231
  4     1 =====                               mean: 15.208
  5     4 ====================              median: 4.5
  7     2 ==========
  8     1 =====
 11     1 =====
 15     1 =====
 17     1 =====
 18     1 =====
231     1 =====

Distribution of symbol lengths:

  1    26 =============                        min: 1
  2    19 ==========                           max: 21
  3    23 ============                        mean: 6.6521
  4    38 ===================               median: 7.0
  5    28 ==============
  6    31 ================
  7    28 ==============
  8   103 ====================================================
  9    19 ==========
 10    15 ========
 11     4 ==
 12    12 ======
 13     4 ==
 14     2 =
 15     8 ====
 16     1 =
 17     3 ==
 21     1 =
2 enums: activity-change
lost             gained
2 enums: alpha-enum
SDL_ALPHA_TRANSPARENT  SDL_ALPHA_OPAQUE
2 enums: alpha-limit
transparent      opaque
3 flags: application-state
mousefocus       inputfocus       active
2 enums: cd-track-type
audio            data
5 enums: cdrom-state
error            stopped          paused
tray-empty       playing
3 enums: event-action
SDL_ADDEVENT     SDL_PEEKEVENT    SDL_GETEVENT
18 flags: event-mask

Note that these are a proper superset of those in the event-type enums, below.

active             mouse-button-up    joy-button-up
key-down           mouse              joy
key-up             joy-axis-motion    quit
key                joy-ball-motion    sys-wm
mouse-motion       joy-hat-motion     video-resize
mouse-button-down  joy-button-down    video-expose
3 enums: event-state
SDL_QUERY        SDL_IGNORE       SDL_ENABLE
15 enums: event-type

Note that these are a proper subset of those in the event-mask flags, above.

active             mouse-button-up    joy-button-up
key-down           joy-axis-motion    quit
key-up             joy-ball-motion    sys-wm
mouse-motion       joy-hat-motion     video-resize
mouse-button-down  joy-button-down    video-expose
3 enums: fading-status
no               out              in
4 enums: font-rotation
none               upside-down
clockwise          counter-clockwise
5 flags: font-style
normal           italic           strikethrough
bold             underline
3 enums: grab-mode
query            off              on
8 flags: init
timer            cdrom            no-parachute
audio            joystick         event-thread
video            everything
5 flags: joystick-hat-position
centered         right            left
up               down
11 flags: keyboard-modifier
L-shift          L-alt            num
R-shift          R-alt            caps
L-ctrl           L-meta           mode
R-ctrl           R-meta
2 enums: keyboard/button-state
released         pressed
231 enums: keysym

Note that digits begin with D- so that they are unambiguously (to read) symbols.

a b c d e f g h i j k l m n o p q r s t u v w x y z
D-0  D-9
ampersand   backquote   capslock   delete   end
asterisk    backslash   caret      dollar   equals
at          backspace   clear               escape
            break       colon               euro
                        comma               exclaim
                        compose
f1  f15

hash   insert
help
home
kp-0  kp-9

kp-plus         kp-equals
kp-minus        kp-period
kp-multiply     kp-enter
kp-divide
left  right  up  down

L-alt  L-ctrl  L-meta  L-shift  L-super
R-alt  R-ctrl  R-meta  R-shift  R-super
L-bracket  R-bracket
L-paren    R-paren
less  greater

menu      pagedown   question   scrollock   tab
minus     pageup     quote      semicolon
mode      pause      quotedbl   slash       underscore
numlock   period                space       undo
          plus       return     sysreq
          power
          print
world-0  world-95
7 flags: mouse-button
left             wheel-up         x1
middle           wheel-down       x2
right
7 enums: mouse-button
left             wheel-up         x1
middle           wheel-down       x2
right
5 flags: overlay

Although these should be enums, these are putative flags due to a limitation in the implementation2. Procs that use them enforce enums-ish usage, anyway; a list of symbols results in an error.

YV12             YVYU             UYVY
YUY2             IYUV
2 flags: palette
logical          physical
17 flags: video
sw-surface       no-frame         prealloc
hw-surface       hw-accel         any-format
opengl           src-colorkey     hw-palette
async-blit       rle-accel-ok     doublebuf
opengl-blit      rle-accel        fullscreen
resizable        src-alpha

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

Appendix B GNU Free Documentation License

Version 1.3, 3 November 2008
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
http://fsf.org/

Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
  1. PREAMBLE

    The purpose of this License is to make a manual, textbook, or other functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

    This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

    We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.

  2. APPLICABILITY AND DEFINITIONS

    This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.

    A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

    A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

    The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.

    The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.

    A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.

    Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

    The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.

    The “publisher” means any person or entity that distributes copies of the Document to the public.

    A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.

    The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.

  3. VERBATIM COPYING

    You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

    You may also lend copies, under the same conditions stated above, and you may publicly display copies.

  4. COPYING IN QUANTITY

    If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

    If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

    If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

    It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

  5. MODIFICATIONS

    You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

    1. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
    2. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
    3. State on the Title page the name of the publisher of the Modified Version, as the publisher.
    4. Preserve all the copyright notices of the Document.
    5. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
    6. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
    7. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document’s license notice.
    8. Include an unaltered copy of this License.
    9. Preserve the section Entitled “History”, Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled “History” in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
    10. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the “History” section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
    11. For any section Entitled “Acknowledgements” or “Dedications”, Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
    12. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
    13. Delete any section Entitled “Endorsements”. Such a section may not be included in the Modified Version.
    14. Do not retitle any existing section to be Entitled “Endorsements” or to conflict in title with any Invariant Section.
    15. Preserve any Warranty Disclaimers.

    If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.

    You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

    You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

    The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.

  6. COMBINING DOCUMENTS

    You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

    The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

    In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.”

  7. COLLECTIONS OF DOCUMENTS

    You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

    You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.

  8. AGGREGATION WITH INDEPENDENT WORKS

    A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

    If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.

  9. TRANSLATION

    Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

    If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.

  10. TERMINATION

    You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.

    However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

    Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

    Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.

  11. FUTURE REVISIONS OF THIS LICENSE

    The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.

    Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.

  12. RELICENSING

    “Massive Multiauthor Collaboration Site” (or “MMC Site”) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A “Massive Multiauthor Collaboration” (or “MMC”) contained in the site means any set of copyrightable works thus published on the MMC site.

    “CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.

    “Incorporate” means to publish or republish a Document, in whole or in part, as part of another Document.

    An MMC is “eligible for relicensing” if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.

    The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.

ADDENDUM: How to use this License for your documents

To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:

  Copyright (C)  year  your name.
  Permission is granted to copy, distribute and/or modify this document
  under the terms of the GNU Free Documentation License, Version 1.3
  or any later version published by the Free Software Foundation;
  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
  Texts.  A copy of the license is included in the section entitled ``GNU
  Free Documentation License''.

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with…Texts.” line with this:

    with the Invariant Sections being list their titles, with
    the Front-Cover Texts being list, and with the Back-Cover Texts
    being list.

If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.


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

Index

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

A
activity-change: Stashes
allocated-channels: Audio
alpha-enum: Stashes
alpha-limit: Stashes
application-state: Stashes

B
blit-rgba: SDL_gfx
blit-surface: Video
button?: Events

C
call-with-clip-rect: Miscellaneous Utilities
caption-ti: Video
cd-close: CDROM
cd-eject: CDROM
cd-frames->msf: CDROM
cd-get-cur-frame: CDROM
cd-get-cur-track: CDROM
cd-get-nth-track: CDROM
cd-get-num-tracks: CDROM
cd-in-drive?: CDROM
cd-msf->frames: CDROM
cd-name: CDROM
cd-nth-track-itlo: CDROM
cd-num-drives: CDROM
cd-open: CDROM
cd-pause: CDROM
cd-play: CDROM
cd-play-tracks: CDROM
cd-resume: CDROM
cd-status: CDROM
cd-stop: CDROM
cd-track-type: Stashes
cd?: CDROM
cdrom-state: Stashes
close-audio: Audio
color:b: Video
color:g: Video
color:r: Video
color:set-b!: Video
color:set-g!: Video
color:set-r!: Video
color?: Video
convert-surface: Video
copy-rectangle: Miscellaneous Utilities
copy-surface: Miscellaneous Utilities
create-cursor: Video
create-rgb-surface: Video
create-yuv-overlay: Video

D
delay: General SDL
device-ffc: Audio
display-format: Video
display-format-alpha: Video
display-yuv-overlay: Video
draw-aa-circle: SDL_gfx
draw-aa-ellipse: SDL_gfx
draw-aa-line: SDL_gfx
draw-aa-polygon: SDL_gfx
draw-aa-trigon: SDL_gfx
draw-arc: SDL_gfx
draw-bezier: SDL_gfx
draw-character: SDL_gfx
draw-circle: SDL_gfx
draw-ellipse: SDL_gfx
draw-hline: SDL_gfx
draw-line: SDL_gfx
draw-pie-slice: SDL_gfx
draw-point: SDL_gfx
draw-polygon: SDL_gfx
draw-rectangle: SDL_gfx
draw-rounded-rectangle: SDL_gfx
draw-string: SDL_gfx
draw-textured-polygon: SDL_gfx
draw-thick-line: SDL_gfx
draw-trigon: SDL_gfx
draw-vline: SDL_gfx

E
enable-key-repeat: Events
enable-unicode: Events
enum->number: Enums and Constants
error key non-member-symbol: Enums and Constants
event-action: Stashes
event-mask: Stashes
event-state: Stashes
event-state: Events
event-type: Stashes
event-type-handling: Events
event:active:gain: Events
event:active:set-gain!: Events
event:active:set-state!: Events
event:active:state: Events
event:button:button: Events
event:button:set-button!: Events
event:button:set-state!: Events
event:button:set-x!: Events
event:button:set-y!: Events
event:button:state: Events
event:button:x: Events
event:button:y: Events
event:jaxis:axis: Events
event:jaxis:set-axis!: Events
event:jaxis:set-value!: Events
event:jaxis:set-which!: Events
event:jaxis:value: Events
event:jaxis:which: Events
event:jball:ball: Events
event:jball:set-ball!: Events
event:jball:set-which!: Events
event:jball:set-xrel!: Events
event:jball:set-yrel!: Events
event:jball:which: Events
event:jball:xrel: Events
event:jball:yrel: Events
event:jbutton:button: Events
event:jbutton:set-button!: Events
event:jbutton:set-state!: Events
event:jbutton:set-which!: Events
event:jbutton:state: Events
event:jbutton:which: Events
event:jhat:hat: Events
event:jhat:set-hat!: Events
event:jhat:set-value!: Events
event:jhat:set-which!: Events
event:jhat:value: Events
event:jhat:which: Events
event:key:keysym:mod: Events
event:key:keysym:scancode: Events
event:key:keysym:set-mod!: Events
event:key:keysym:set-scancode!: Events
event:key:keysym:set-sym!: Events
event:key:keysym:set-unicode!: Events
event:key:keysym:sym: Events
event:key:keysym:unicode: Events
event:key:set-state!: Events
event:key:state: Events
event:motion:set-state!: Events
event:motion:set-x!: Events
event:motion:set-xrel!: Events
event:motion:set-y!: Events
event:motion:set-yrel!: Events
event:motion:state: Events
event:motion:x: Events
event:motion:xrel: Events
event:motion:y: Events
event:motion:yrel: Events
event:resize:h: Events
event:resize:set-h!: Events
event:resize:set-w!: Events
event:resize:w: Events
event:set-type!: Events
event:type: Events
evqueue-add: Events
evqueue-get: Events
evqueue-peek: Events
exact-truncate: Miscellaneous Utilities
expire-channel: Audio

F
fade-out-channel: Audio
fade-out-group: Audio
fade-out-music: Audio
fader/3p: Miscellaneous Utilities
fading-channel: Audio
fading-music: Audio
fading-status: Stashes
fill-rect: Video
flags->number: Enums and Constants
flip: Video
font-rotation: Stashes
font-rotation!: SDL_gfx
font-style: Stashes
font:ascent: TrueType
font:descent: TrueType
font:glyph-metrics: TrueType
font:glyph-xXyYa: TrueType
font:height: TrueType
font:line-skip: TrueType
font:set-style!: TrueType
font:size-text: TrueType
font:size-utf8: TrueType
font:style: TrueType
fps-manager-delay!: SDL_gfx
fps-manager-get: SDL_gfx
fps-manager-set!: SDL_gfx
frames-msf: CDROM

G
get-app-state: Video
get-caption: Video
get-clip-rect: Video
get-cursor: Video
get-error: General SDL
get-event-filter: Events
get-gamma-ramp: Video
get-key-state: Events
get-mod-state: Events
get-mouse-relative-state: Events
get-mouse-state: Events
get-rgb: Video
get-rgba: Video
get-ticks: General SDL
get-video-info: Video
get-video-surface: Video
get-wm-info: Video
gl-get-attribute: Video
gl-set-attribute: Video
gl-swap-buffers: Video
grab-input: Video
grab-mode: Stashes
group-available: Audio
group-channel: Audio
group-channels: Audio
group-count: Audio
group-newer: Audio
group-oldest: Audio

H
halt-channel: Audio
halt-group: Audio
halt-music: Audio
horizontal-flip-surface: Video

I
iconify-window: Video
ignore-all-event-types-except: Miscellaneous Utilities
imfi-abs-diff: SDL_gfx
imfi-add: SDL_gfx
imfi-add-c: SDL_gfx
imfi-add-c-to-half: SDL_gfx
imfi-ashl: SDL_gfx
imfi-ashr: SDL_gfx
imfi-ashr-mul-c: SDL_gfx
imfi-binarize: SDL_gfx
imfi-bshl: SDL_gfx
imfi-clip: SDL_gfx
imfi-div: SDL_gfx
imfi-logand: SDL_gfx
imfi-logior: SDL_gfx
imfi-lshl: SDL_gfx
imfi-lshr: SDL_gfx
imfi-mean: SDL_gfx
imfi-mmx?: SDL_gfx
imfi-mul-c: SDL_gfx
imfi-muldiv2: SDL_gfx
imfi-muldiv4: SDL_gfx
imfi-mulnor: SDL_gfx
imfi-mult: SDL_gfx
imfi-normalize-linear: SDL_gfx
imfi-not: SDL_gfx
imfi-sub: SDL_gfx
imfi-sub-c: SDL_gfx
init: General SDL
init: Stashes
init-subsystem: General SDL

J
joystick-ball-xy: Joystick
joystick-close: Joystick
joystick-event-state: Joystick
joystick-get-axis: Joystick
joystick-get-ball: Joystick
joystick-get-button: Joystick
joystick-get-hat: Joystick
joystick-hat-position: Stashes
joystick-index: Joystick
joystick-name: Joystick
joystick-num-axes: Joystick
joystick-num-balls: Joystick
joystick-num-buttons: Joystick
joystick-num-hats: Joystick
joystick-open: Joystick
joystick-opened?: Joystick
joystick-polling: Joystick
joystick-update: Joystick
joystick?: Joystick

K
keyboard-modifier: Stashes
keyboard/button-state: Stashes
keysym: Stashes
kotk: Enums and Constants

L
list-modes: Video
load-bmp: Video
load-font: TrueType
load-image: Video
load-music: Audio
load-wave: Audio
lock-surface: Video
lock-yuv-overlay: Video

M
make-color: Video
make-event: Events
make-fps-manager: SDL_gfx
make-rect: Video
make-surface: Video
map-rgb: Video
map-rgba: Video
mouse-button: Stashes
mouse-button: Stashes
mouse-bxy: Events
music-volume: Audio

N
non-member-symbol, error key: Enums and Constants
num-joysticks: Joystick
number->enum: Enums and Constants
number->flags: Enums and Constants

O
open-audio: Audio
overlay: Stashes

P
palette: Stashes
pause: Audio
pause-music: Audio
paused-music?: Audio
paused?: Audio
peep-events: Events
pixel-rgb: Video
pixel-rgba: Video
play-channel: Audio
play-music: Audio
playing-music?: Audio
playing?: Audio
poll-event: Events
poll-with-push-on-timeout-proc: Miscellaneous Utilities
pump-events: Events
push-event: Events

Q
query-spec: Audio
quit: General SDL
quit-subsystem: General SDL

R
rect:h: Video
rect:set-h!: Video
rect:set-w!: Video
rect:set-x!: Video
rect:set-y!: Video
rect:w: Video
rect:x: Video
rect:y: Video
rect<-surface: Miscellaneous Utilities
rect?: Video
rectangle-closure: Miscellaneous Utilities
rectangle<-geometry-string: Miscellaneous Utilities
render-glyph: TrueType
render-text: TrueType
render-utf8: TrueType
reserve-channels: Audio
resume: Audio
resume-music: Audio
rewind-music: Audio
rotate-square: Miscellaneous Utilities
roto-zoom-surface: SDL_gfx
roto-zoom-surface-xy: SDL_gfx

S
s16: Uniform Vectors
save-bmp: Video
set-alpha!: Video
set-caption: Video
set-clip-rect!: Video
set-color-key!: Video
set-colors!: Video
set-cursor: Video
set-distance: Audio
set-event-filter: Events
set-gamma: Video
set-gamma-ramp: Video
set-icon: Video
set-mod-state: Events
set-music-command: Audio
set-palette: Video
set-panning: Audio
set-pixel-alpha!: SDL_gfx
set-position: Audio
set-video-mode: Video
show-cursor: Video
shrink-surface: SDL_gfx
simple-canvas: Simple Closures
simple-stylus: Simple Closures
simple-vpacked-image: Simple Closures
surface-alpha!: Video
surface-color-key!: Video
surface-get-format: Video
surface-pixels: Video
surface:depth: Video
surface:flags: Video
surface:h: Video
surface:w: Video
surface?: Video

T
text-wh: TrueType
toggle-full-screen: Video
toroidal-panner/3p: Miscellaneous Utilities
ttf-init: TrueType
ttf-quit: TrueType

U
u16: Uniform Vectors
u8: Uniform Vectors
uniform vector argument(s): Uniform Vectors
unlock-surface: Video
unlock-yuv-overlay: Video
update-rect: Video
update-rects: Video
utf8-wh: TrueType

V
vertical-flip-surface: Video
vh-flip-surface: Video
video: Stashes
video-cmf: Video
video-driver-name: Video
video-mode-ok: Video
volume: Audio

W
wait-event: Events
warp-mouse: Video
was-init: General SDL

Z
zoom-surface: SDL_gfx

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

Footnotes

(1)

The SDL homepage is http://www.libsdl.org.

(2)

For speed, we use immediate integers (aka fixnums) for enums, but those are not wide enough on a 32-bit system to hold the overlay values. Probably this should be rectified prior to release as it represents a semi-regression. OTOH, it’s not like anyone is actually using create-yuv-overlay anyway…