CL-TCOD

Table of Contents

1 Internal Package: tcod

1.1 Introduction

Welcome to CL-TCOD, an interface between Common Lisp and the Doryen Library, AKA `libtcod', a portable truecolour console library intended for use with roguelike games.

CL-TCOD consists of the following files:

  1. tcod.lisp, a lisp file which creates lisp bindings for C functions in the compiled libtcod library, using the CFFI lisp foreign function interface.
  2. tcod.asd, which allows TCOD to be easily loaded and used as a library by other common lisp programs, via the ASDF library-loading facility.
  3. tcod-colours.lisp, a lisp file containing definitions for all the colours named in /etc/X11/rgb.txt; autogenerated using 'parse-rgb' (see below)
  4. parse-rgb.lisp, a lisp file containing code for parsing /etc/X11/rgb.txt and generating tcod-colours.lisp
  5. parse-rgb.asd, ASDF system definition file for parse-rgb.lisp

CL-TCOD has been tested with SBCL 1.0.36 on Linux and Windows, Clozure 1.5 on Linux and Windows, and CLISP on Windows.

**Note** that it has not been used on a Mac; if you do this you may need to tell CFFI the name of the compiled libtcod library under MacOS. To do this, open tcod.lisp in an editor, find the ='(define-foreign-library…'= clause, uncomment the ='(:macintosh…)'= line and change the string on that line to the name of the libtcod library file.

1.2 License

The CL-TCOD package is placed in the Public Domain by its author.

1.3 Dependencies

1.4 Hints on installation

You need to know your way around your chosen common lisp and how to install and load lisp libraries before proceeding. You also need to have a version of libtcod newer than 1.4.1rc2, which is the first version that includes the ='wrappers.c'= and ='wrappers.h'= source files that allow CL-TCOD to interface with libtcod.

  1. Ensure you have a working common lisp installation.
  2. Ensure either Quicklisp or the ASDF lisp library is installed.
  3. If CFFI or DEFSTAR are not installed, download and install them somewhere ASDF can find them. CFFI requires several third-party lisp libraries – see the CFFI documentation for more details. Note that if you have Quicklisp installed, you can install CFFI and its dependencies easily using the command (ql:quickload "cffi") at the Lisp prompt.
  4. Put the CL-TCOD files in a directory where ASDF can find them.
  5. Make sure libtcod is installed and compiled. Make sure the libtcod dynamically linked library (.DLL or .SO file) is somewhere your lisp system can find it. It probably is, but if CFFI complains about being unable to find the library, you can either copy it to an appropriate directory or add its directory to the list variable cffi:*foreign-library-directories* e.g. by typing the following in the lisp interpreter:
(push #P"/my/libtcod/directory/" cffi:*foreign-library-directories*)

On windows, DLL files should be put in one of the directories listed in the PATH environment variable. You will need to put SDL.dll in the same place if you don't already have SDL installed.

On Linux, you can usually put .SO files in /usr/local/lib/. Use your package installer to install libSDL. Try running the libtcod demo programs to check everything works.

  1. Start lisp, then load CL-TCOD. Using Quicklisp:
(ql:quickload :tcod)

Using ASDF:

(load "/path/to/asdf/asdf.lisp")
(asdf:oos 'asdf:load-op :tcod)
  1. Type something like the following commands at the lisp prompt to start using TCOD from within Lisp. Alternatively you can type (tcod:hello-world), which is a function containing the code below.
(tcod:console-set-custom-font "terminal.png" '(:font-layout-ascii-in-row) 16 16)
(tcod:console-init-root 80 25 "Test" nil :renderer-sdl)
(tcod:console-clear tcod:*root*)
(tcod:console-print tcod:*root* 1 1 "Hello, world!~%")
(tcod:console-wait-for-keypress t)

1.5 Differences between CL-TCOD and libtcod

1.5.1 Naming conventions

The C function TCOD_foobar corresponds to the lisp function foobar, which is in the tcod package (and so requires a prefix of tcod: to access in most situations). Underscores become hyphens. So:

 TCOD_foobar_function(a, b)     <===>    (tcod:foobar-function a b)

`Predicate functions' are functions whose main job is to return a boolean value, true (non NIL) or false (NIL), that answers a question. These have a terminal '?' added to their name:

 TCOD_console_is_fullscreen()   <===>    (tcod:console-is-fullscreen?)

C enums have generally more succinct names. As they are lisp keywords, their names all begin with =':'=. THey are named according to the following pattern:

 TCODK_BACKSPACE (etc)         <===>  :backspace
 TCOD_CHAR_HLINE  (etc)        <===>  :char-hline
 TCOD_COLCTRL_1  (etc)         <===>  :colctrl-1
 TCOD_BKGND_SET (etc)          <===>  :set
 TCOD_FONT_LAYOUT_ASCII_INCOL  <===>  :font-layout-ascii-in-col
 FOV_SHADOW                    <===>  :fov-shadow
 TCOD_KEY_PRESSED              <===>  :key-pressed
 CENTER                        <===>  :center

In general, most functions exist in both U.S. and non-U.S. spellings, This is mainly relevant to those functions with colour/color or centre/center in their names.

1.5.2 Colournums

In libtcod, colours are represented as structures containing three integer values: red, green and blue (each 0-255). The name of the structure type is TCOD_color_t.

In CL-TCOD, these colour structs are converted into 3-byte integers using the C functions int_to_color(int) and color_to_int(TCOD_color_t), both defined in wrappers.c. The 3 bytes are red, green and blue in order (blue is 1's). ie:

   /* C */                              ;; lisp ;;
  struct TCOD_color_t {r, g, b}  <==>   #x00RRGGBB

So, for example, one way to use the function TCOD_color_multiply_scalar from lisp is:

(tcod:color-multiply-scalar (tcod:compose-colour 218 165 32) 0.5)

All C functions that take or return TCOD_color_t structs, are wrapped by lisp functions that take or return integers as described above.

1.5.3 Colours by keyword

A lisp keyword is any symbol beginning with ':'. In lisp, keywords (like all symbols) are first-class values and can be passed around just like any other value. CL-TCOD uses keywords to refer to particular colours, for example the keyword :cyan refers to the colour #x0056A3CD (or 5678029 in decimal notation).

You can use keywords instead of colournums as arguments to lisp functions, by using the function colour to return the colournum associated with a keyword:

(tcod:colour :cyan)    ; returns 5678029

You can also define your own colour names, like so:

(tcod:make-colour :my-goldenrod 218 165 32)
(tcod:color-multiply-scalar (tcod:colour :my-goldenrod) 0.5)

CL-TCOD knows all the colour names defined in the 'rgb.txt' file under Xwindows, eg :navajo-white, :honeydew, :mint-cream, and so on. There is nothing special about the fact that rgb.txt comes from Xwindows – the colours are just named R,G,B values and can be used anywhere that CL-TCOD can be used. Look in the source file ='tcod-colours.lisp'= to see the available colour names. If you are using GNU Emacs, the king of lisp IDEs, do M-x list-colors-display to see a list of all colours.

1.5.4 Lisp format versus C printf

The TCOD functions that accept printf-like string-formatting arguments, have been modified to instead accept arguments to Common Lisp's format function.' For example:

TCOD_console_print (con, x, y, "Printing at %d, %dn", x, y);

becomes:

(tcod:console-print con x y "Printing at ~D, ~D~%" x y)

1.5.5 Miscellaneous extra functions

(tcod:console-print-double-frame CONSOLE X Y W H EMPTY? STRING...)

1.5.6 Coverage

Does not provide wrappers for:

  • File parser. Using this from lisp would be a very cumbersome way to read values from a file, as the resulting values are not lisp objects. You would be better to either consider using the lisp `read' function, or looking into lisp libraries for parser generation.
  • namegen-get-sets – I haven't yet implemented this as it will have to involve converting from libtcod's bespoke 'linked list' to a lisp list. You may be better to write your random name generator in lisp (fairly trivial).
  • sys-get-directory-content, sys-file-exists, sys-is-directory, sys-delete-file: Common Lisp already has functions that do the same thing.

1.6 Resources

1.6.1 Specific to CL-TCOD and libtcod

The latest version of CL-TCOD is available at:

http://bitbucket.org/eeeickythump/cl-tcod/

Forum for discussion of CL-TCOD and use of lisp in roguelike games:

Roguecentral Lisp forum

The latest version of libtcod is available at:

http://doryen.eptalys.net/libtcod/

This Common Lisp package depends on CFFI, the Common Foreign Function Interface:

http://common-lisp.net/project/cffi/

1.6.2 Learning Common Lisp

Recently written book, 'Practical Common Lisp'. buy hard copy or download free. Recommended, especially if coming from non-lisp languages.

Quicklisp allows you to very easily install libraries – it automatically downloads and installs a library and its dependencies, from within Lisp. If you don't decide to go with Lisp in a Box (below), then Quicklisp should be the first thing you install once you have your lisp running.

*"Lisp in a Box"* – aims to make it easy to start using Common Lisp by providing a single download with everything set up in advance (Lisp, Emacs, SLIME, and Quicklisp).

Lisp editors and IDEs:

  • GNU Emacs (the best; see below)
    • SLIME is the Emacs interface to Common Lisp.
  • Cusp, a common lisp plugin for Eclipse.
  • The Allegro and LispWorks lisp implementations each have a builtin IDE.
  • If you are on a Mac, the free, high-quality Clozure CL has a builtin graphical IDE.
  • Some editors with good lisp syntax highlighting include jEdit and Notepad++.

1.6.3 A note on editors and IDEs

Emacs is a very powerful program. It is mainly used as a programmers' text and source code editor, but it can do – and plugins exist to make it do – just about anything you can imagine. It is mostly written in a dialect of lisp, and this is also its extension language. When combined with SLIME, a plugin that allows it to communicate directly with a running common lisp compiler/interpreter, Emacs is not only the best IDE for common lisp, but one of the best and most advanced IDEs available for any programming language.

The downside: because Emacs + SLIME is so good, common lisp programmers have put very little effort into getting other popular programming editors/IDEs to support common lisp, at least beyond simple syntax highlighting. Emacs is an idiosyncratic program (though development is active, it is about 34 years old) and despite good efforts to modernise/regularise its interface it still has a steeper learning curve than many other IDEs, especially when you are also struggling to set up SLIME and get it to communicate through a socket with your lisp process…

My advice is that while all roads lead to Emacs, you don't have to hurry to get there. Initially you should concentrate on getting common lisp set up and starting to learn the language. Think about using the trial version of one of the big commercial implementations (Allegro or LispWorks), as they have built-in IDEs. Once you are ready to move on from them, install Emacs and SLIME.

1.6.4 Commercial Common Lisp implementations

These are both high quality, but painfully expensive. Luckily they have 'trial' versions that can be downloaded for free, and which I recommend you use when beginning to learn Common Lisp as they come with integrated graphical editors/development environments (although if you have a Mac you may wish to investigate Clozure CL's IDE – see below).

  • Allegro – starts at $599 USD
  • LispWorks – starts at $900 USD for a noncommercial license. The trial version quits automatically after 5 hours.

1.6.5 Full-featured, free Common Lisp implementations

Move on to one of these if and when you outgrow Allegro or LispWorks.

For the title of the best, most robust free multiplatform Common Lisp compiler, it is currently a very close call between these two:

  • Steel Bank Common Lisp (SBCL) Compiles to machine code, great on Linux/Mac, still nominally 'experimental' on Windows but actually seems very stable on that platform.
  • Clozure CL Compiles to machine code; native to Mac but recently ported to Linux and Windows. Formerly known as OpenMCL. The Mac version has a graphical IDE. Not to be confused with Clojure, which is a different dialect of lisp from Common Lisp.

Other worthwhile free implementations:

  • GNU CLISP Bytecode compiler, so programs won't run as fast as in the compiled lisps discussed above. However it runs pretty much everywhere, and is easy to install on Windows.
  • Embeddable Common Lisp Promising, compiles to C and then passes code to your C compiler. Does this 'on the fly' when running as an interpreter. Also designed to be easily embeddable in non-Lisp applications as a scripting language.
  • Armed Bear Common Lisp Common Lisp compiler running inside the Java virtual machine, so your code will run on any platform and can use all the Java libraries. I doubt you'll be able to use libtcod with this though.

Help & advice with lisp:

http://www.lispforum.com

1.7 External Symbols

1.7.1 External Structures


1.7.1.1 Structure: key
1.7.1.1.1 Description

The structure used by CL-TCOD to represent key-press events. Corresponds to the structure used by libtcod.

1.7.1.1.2 Slots

1.7.1.1.2.1 Slot: vk
  • Value type: keyword
  • Initial value: :none
  • Initargs: none
  • Allocation: instance

1.7.1.1.2.2 Internal Slot: c
  • Value type: character
  • Initial value: #\Nul
  • Initargs: none
  • Allocation: instance

1.7.1.1.2.3 Slot: pressed
  • Value type: boolean
  • Initial value: nil
  • Initargs: none
  • Allocation: instance

1.7.1.1.2.4 Slot: lalt
  • Value type: boolean
  • Initial value: nil
  • Initargs: none
  • Allocation: instance

1.7.1.1.2.5 Slot: lctrl
  • Value type: boolean
  • Initial value: nil
  • Initargs: none
  • Allocation: instance

1.7.1.1.2.6 Slot: ralt
  • Value type: boolean
  • Initial value: nil
  • Initargs: none
  • Allocation: instance

1.7.1.1.2.7 Slot: rctrl
  • Value type: boolean
  • Initial value: nil
  • Initargs: none
  • Allocation: instance

1.7.1.1.2.8 Slot: shift
  • Value type: boolean
  • Initial value: nil
  • Initargs: none
  • Allocation: instance

1.7.1.2 Structure: mouse
1.7.1.2.1 Description

Structure used by CL-TCOD to represent mouse status.

1.7.1.2.2 Slots

1.7.1.2.2.1 Internal Slot: x
  • Value type: uint16
  • Initial value: 0
  • Initargs: none
  • Allocation: instance

1.7.1.2.2.2 Slot: y
  • Value type: uint16
  • Initial value: 0
  • Initargs: none
  • Allocation: instance

1.7.1.2.2.3 Slot: dx
  • Value type: sint16
  • Initial value: 0
  • Initargs: none
  • Allocation: instance

1.7.1.2.2.4 Slot: dy
  • Value type: sint16
  • Initial value: 0
  • Initargs: none
  • Allocation: instance

1.7.1.2.2.5 Slot: cx
  • Value type: uint16
  • Initial value: 0
  • Initargs: none
  • Allocation: instance

1.7.1.2.2.6 Slot: cy
  • Value type: uint16
  • Initial value: 0
  • Initargs: none
  • Allocation: instance

1.7.1.2.2.7 Slot: dcx
  • Value type: sint16
  • Initial value: 0
  • Initargs: none
  • Allocation: instance

1.7.1.2.2.8 Slot: dcy
  • Value type: sint16
  • Initial value: 0
  • Initargs: none
  • Allocation: instance

1.7.1.2.2.9 Slot: lbutton
  • Value type: boolean
  • Initial value: nil
  • Initargs: none
  • Allocation: instance

1.7.1.2.2.10 Slot: rbutton
  • Value type: boolean
  • Initial value: nil
  • Initargs: none
  • Allocation: instance

1.7.1.2.2.11 Slot: mbutton
  • Value type: boolean
  • Initial value: nil
  • Initargs: none
  • Allocation: instance

1.7.1.2.2.12 Slot: lbutton-pressed
  • Value type: boolean
  • Initial value: nil
  • Initargs: none
  • Allocation: instance

1.7.1.2.2.13 Slot: rbutton-pressed
  • Value type: boolean
  • Initial value: nil
  • Initargs: none
  • Allocation: instance

1.7.1.2.2.14 Slot: mbutton-pressed
  • Value type: boolean
  • Initial value: nil
  • Initargs: none
  • Allocation: instance

1.7.1.2.2.15 Slot: wheel-up
  • Value type: boolean
  • Initial value: nil
  • Initargs: none
  • Allocation: instance

1.7.1.2.2.16 Slot: wheel-down
  • Value type: boolean
  • Initial value: nil
  • Initargs: none
  • Allocation: instance

1.7.2 External Types


1.7.2.1 Type: a*-path

Not documented.


1.7.2.2 Type: background-flag

Not documented.


1.7.2.3 Type: colctrl

Not documented.


1.7.2.4 Type: console

Not documented.


1.7.2.5 Type: dijkstra-path

Not documented.


1.7.2.6 Type: drawing-character

Not documented.


1.7.2.7 Type: fov-algorithm

Not documented.


1.7.2.8 Type: key-state

Not documented.


1.7.2.9 Type: keycode

Not documented.


1.7.2.10 Type: mapptr

Not documented.


1.7.2.11 Type: zipptr

Not documented.

1.7.3 External Global Variables


1.7.3.1 Variable: *root*

1.7.3.1.1 Value

#.(sb-sys:int-sap #X00000000)

Type: system-area-pointer

1.7.3.1.2 Description

The root console.


1.7.3.2 Variable: +null+

1.7.3.2.1 Value

#.(sb-sys:int-sap #X00000000)

Type: system-area-pointer

1.7.3.2.2 Description

The null pointer.

1.7.4 External Macros


1.7.4.1 Macro: legal-console-coordinates?

1.7.4.1.1 Syntax

(legal-console-coordinates? con x y)

1.7.4.1.2 Description

Are the relative coordinates X,Y within the bounds of console CON?

1.7.5 External Functions


1.7.5.1 Function: background-add-alpha

1.7.5.1.1 Syntax

(background-add-alpha alpha)

1.7.5.1.2 Description

Not documented.


1.7.5.2 Function: background-alpha

1.7.5.2.1 Syntax

(background-alpha alpha)

1.7.5.2.2 Description

Not documented.


1.7.5.3 Function: bsp-contains?

1.7.5.3.1 Syntax

(bsp-contains? node cx cy)

1.7.5.3.2 Description

Not documented.


1.7.5.4 Function: bsp-delete

1.7.5.4.1 Syntax

(bsp-delete node)

1.7.5.4.2 Description

Not documented.


1.7.5.5 Function: bsp-father

1.7.5.5.1 Syntax

(bsp-father node)

1.7.5.5.2 Description

Not documented.


1.7.5.6 Function: bsp-find-node

1.7.5.6.1 Syntax

(bsp-find-node node cx cy)

1.7.5.6.2 Description

Not documented.


1.7.5.7 Function: bsp-is-leaf?

1.7.5.7.1 Syntax

(bsp-is-leaf? node)

1.7.5.7.2 Description

Not documented.


1.7.5.8 Function: bsp-left

1.7.5.8.1 Syntax

(bsp-left node)

1.7.5.8.2 Description

Not documented.


1.7.5.9 Function: bsp-new-with-size

1.7.5.9.1 Syntax

(bsp-new-with-size x y w h)

1.7.5.9.2 Description

Not documented.


1.7.5.10 Function: bsp-remove-sons

1.7.5.10.1 Syntax

(bsp-remove-sons node)

1.7.5.10.2 Description

Not documented.


1.7.5.11 Function: bsp-resize

1.7.5.11.1 Syntax

(bsp-resize node x y w h)

1.7.5.11.2 Description

Not documented.


1.7.5.12 Function: bsp-right

1.7.5.12.1 Syntax

(bsp-right node)

1.7.5.12.2 Description

Not documented.


1.7.5.13 Function: bsp-split-once

1.7.5.13.1 Syntax

(bsp-split-once node horizontal? pos)

1.7.5.13.2 Description

Not documented.


1.7.5.14 Function: bsp-split-recursive

1.7.5.14.1 Syntax

(bsp-split-recursive node randomiser nb min-h-size min-v-size max-h-ratio
                     max-v-ratio)

1.7.5.14.2 Description

Not documented.


1.7.5.15 Function: bsp-traverse-in-order

1.7.5.15.1 Syntax

(bsp-traverse-in-order node callback userdata)

1.7.5.15.2 Description

Not documented.


1.7.5.16 Function: bsp-traverse-inverted-level-order

1.7.5.16.1 Syntax

(bsp-traverse-inverted-level-order node callback userdata)

1.7.5.16.2 Description

Not documented.


1.7.5.17 Function: bsp-traverse-level-order

1.7.5.17.1 Syntax

(bsp-traverse-level-order node callback userdata)

1.7.5.17.2 Description

Not documented.


1.7.5.18 Function: bsp-traverse-post-order

1.7.5.18.1 Syntax

(bsp-traverse-post-order node callback userdata)

1.7.5.18.2 Description

Not documented.


1.7.5.19 Function: bsp-traverse-pre-order

1.7.5.19.1 Syntax

(bsp-traverse-pre-order node callback userdata)

1.7.5.19.2 Description

Not documented.


1.7.5.20 Function: colctrl->char

1.7.5.20.1 Syntax

(colctrl->char ctrl)

1.7.5.20.2 Description

Not documented.


1.7.5.21 Function: color

1.7.5.21.1 Syntax

(color keywd)

1.7.5.21.2 Description

Not documented.


1.7.5.22 Function: color->grayscale

1.7.5.22.1 Syntax

(color->grayscale col)

1.7.5.22.2 Description

Not documented.


1.7.5.23 Function: color-add

1.7.5.23.1 Syntax

(color-add c1 c2)

1.7.5.23.2 Description

Not documented.


1.7.5.24 Function: color-equals?

1.7.5.24.1 Syntax

(color-equals? c1 c2)

1.7.5.24.2 Description

Not documented.


1.7.5.25 Function: color-get-hsv

1.7.5.25.1 Syntax

(color-get-hsv colour)

1.7.5.25.2 Description

Not documented.


1.7.5.26 Function: color-get-hue

1.7.5.26.1 Syntax

(color-get-hue colour)

1.7.5.26.2 Description

Not documented.


1.7.5.27 Function: color-get-saturation

1.7.5.27.1 Syntax

(color-get-saturation colour)

1.7.5.27.2 Description

Not documented.


1.7.5.28 Function: color-get-value

1.7.5.28.1 Syntax

(color-get-value colour)

1.7.5.28.2 Description

Not documented.


1.7.5.29 Function: color-hsv

1.7.5.29.1 Syntax

(color-hsv hue sat val)

1.7.5.29.2 Description

Not documented.


1.7.5.30 Function: color-lerp

1.7.5.30.1 Syntax

(color-lerp c1 c2 coef)

1.7.5.30.2 Description

Not documented.


1.7.5.31 Function: color-multiply

1.7.5.31.1 Syntax

(color-multiply c1 c2)

1.7.5.31.2 Description

Not documented.


1.7.5.32 Function: color-multiply-scalar

1.7.5.32.1 Syntax

(color-multiply-scalar c1 value)

1.7.5.32.2 Description

Not documented.


1.7.5.33 Function: color-rgb

1.7.5.33.1 Syntax

(color-rgb r g b)

1.7.5.33.2 Description

Not documented.


1.7.5.34 Function: color-set-hsv

1.7.5.34.1 Syntax

(color-set-hsv con hue sat v)

1.7.5.34.2 Description

Not documented.


1.7.5.35 Function: color-set-hue

1.7.5.35.1 Syntax

(color-set-hue colour hue)

1.7.5.35.2 Description

Not documented.


1.7.5.36 Function: color-set-saturation

1.7.5.36.1 Syntax

(color-set-saturation colour sat)

1.7.5.36.2 Description

Not documented.


1.7.5.37 Function: color-set-value

1.7.5.37.1 Syntax

(color-set-value colour val)

1.7.5.37.2 Description

Not documented.


1.7.5.38 Function: color-shift-hue

1.7.5.38.1 Syntax

(color-shift-hue colour hshift)

1.7.5.38.2 Description

Not documented.


1.7.5.39 Function: color-subtract

1.7.5.39.1 Syntax

(color-subtract c1 c2)

1.7.5.39.2 Description

Not documented.


1.7.5.40 Function: colour

1.7.5.40.1 Syntax

(colour keywd)

1.7.5.40.2 Description

Given a colour keyword such as :GREY, return its corresponding RGB value (#xRRGGBB).


1.7.5.41 Function: colour->grayscale

1.7.5.41.1 Syntax

(colour->grayscale col)

1.7.5.41.2 Description

Not documented.


1.7.5.42 Function: colour-add

1.7.5.42.1 Syntax

(colour-add c1 c2)

1.7.5.42.2 Description

Not documented.


1.7.5.43 Function: colour-equals?

1.7.5.43.1 Syntax

(colour-equals? c1 c2)

1.7.5.43.2 Description

Not documented.


1.7.5.44 Function: colour-get-hsv

1.7.5.44.1 Syntax

(colour-get-hsv c)

1.7.5.44.2 Description

Not documented.


1.7.5.45 Function: colour-get-hue

1.7.5.45.1 Syntax

(colour-get-hue c)

1.7.5.45.2 Description

Not documented.


1.7.5.46 Function: colour-get-saturation

1.7.5.46.1 Syntax

(colour-get-saturation c)

1.7.5.46.2 Description

Not documented.


1.7.5.47 Function: colour-get-value

1.7.5.47.1 Syntax

(colour-get-value c)

1.7.5.47.2 Description

Not documented.


1.7.5.48 Function: colour-hsv

1.7.5.48.1 Syntax

(colour-hsv hue sat val)

1.7.5.48.2 Description

Return a new colour with the given HSV (hue, saturation and value) components.


1.7.5.49 Function: colour-lerp

1.7.5.49.1 Syntax

(colour-lerp c1 c2 coef)

1.7.5.49.2 Description

Not documented.


1.7.5.50 Function: colour-multiply

1.7.5.50.1 Syntax

(colour-multiply c1 c2)

1.7.5.50.2 Description

Not documented.


1.7.5.51 Function: colour-multiply-scalar

1.7.5.51.1 Syntax

(colour-multiply-scalar c1 value)

1.7.5.51.2 Description

Not documented.


1.7.5.52 Function: colour-rgb

1.7.5.52.1 Syntax

(colour-rgb r g b)

1.7.5.52.2 Description

Not documented.


1.7.5.53 Function: colour-set-hsv

1.7.5.53.1 Syntax

(colour-set-hsv con hue sat v)

1.7.5.53.2 Description

Not documented.


1.7.5.54 Function: colour-set-hue

1.7.5.54.1 Syntax

(colour-set-hue colour hue)

1.7.5.54.2 Description

Return COLOUR with its hue modified to HUE.


1.7.5.55 Function: colour-set-saturation

1.7.5.55.1 Syntax

(colour-set-saturation colour sat)

1.7.5.55.2 Description

Return COLOUR with its saturation modified to SAT.


1.7.5.56 Function: colour-set-value

1.7.5.56.1 Syntax

(colour-set-value colour val)

1.7.5.56.2 Description

Return COLOUR with its HSV value modified to VAL.


1.7.5.57 Function: colour-shift-hue

1.7.5.57.1 Syntax

(colour-shift-hue colour hshift)

1.7.5.57.2 Description

Not documented.


1.7.5.58 Function: colour-subtract

1.7.5.58.1 Syntax

(colour-subtract c1 c2)

1.7.5.58.2 Description

Not documented.


1.7.5.59 Function: compose-color

1.7.5.59.1 Syntax

(compose-color r g b)

1.7.5.59.2 Description

Not documented.


1.7.5.60 Function: compose-colour

1.7.5.60.1 Syntax

(compose-colour r g b)

1.7.5.60.2 Description

Given three integer values R, G and B, representing the red, green and blue components of a colour, return a 3 byte integer whose value is #xBBGGRR.


1.7.5.61 Function: console-blit

1.7.5.61.1 Syntax

(console-blit src xsrc ysrc wsrc hsrc dest xdest ydest foreground-alpha
              background-alpha)

1.7.5.61.2 Description

Not documented.


1.7.5.62 Function: console-check-for-keypress

1.7.5.62.1 Syntax

(console-check-for-keypress flags)

1.7.5.62.2 Description

Not documented.


1.7.5.63 Function: console-clear

1.7.5.63.1 Syntax

(console-clear con)

1.7.5.63.2 Description

Not documented.


1.7.5.64 Function: console-credits

1.7.5.64.1 Syntax

(console-credits)

1.7.5.64.2 Description

Not documented.


1.7.5.65 Function: console-credits-reset

1.7.5.65.1 Syntax

(console-credits-reset)

1.7.5.65.2 Description

Not documented.


1.7.5.66 Function: console-delete

1.7.5.66.1 Syntax

(console-delete con)

1.7.5.66.2 Description

Not documented.


1.7.5.67 Function: console-disable-keyboard-repeat

1.7.5.67.1 Syntax

(console-disable-keyboard-repeat)

1.7.5.67.2 Description

Not documented.


1.7.5.68 Function: console-fill-char

1.7.5.68.1 Syntax

(console-fill-char con ch fx fy fw fh)

1.7.5.68.2 Description

Fill a rectangular area with the character CH.


1.7.5.69 Function: console-flush

1.7.5.69.1 Syntax

(console-flush)

1.7.5.69.2 Description

Not documented.


1.7.5.70 Function: console-get-alignment

1.7.5.70.1 Syntax

(console-get-alignment con)

1.7.5.70.2 Description

Not documented.


1.7.5.71 Function: console-get-background-flag

1.7.5.71.1 Syntax

(console-get-background-flag con)

1.7.5.71.2 Description

Not documented.


1.7.5.72 Function: console-get-char

1.7.5.72.1 Syntax

(console-get-char con x y)

1.7.5.72.2 Description

Not documented.


1.7.5.73 Function: console-get-char-background

1.7.5.73.1 Syntax

(console-get-char-background con x y)

1.7.5.73.2 Description

Not documented.


1.7.5.74 Function: console-get-char-foreground

1.7.5.74.1 Syntax

(console-get-char-foreground con x y)

1.7.5.74.2 Description

Not documented.


1.7.5.75 Function: console-get-default-background

1.7.5.75.1 Syntax

(console-get-default-background con)

1.7.5.75.2 Description

Not documented.


1.7.5.76 Function: console-get-default-foreground

1.7.5.76.1 Syntax

(console-get-default-foreground con)

1.7.5.76.2 Description

Not documented.


1.7.5.77 Function: console-get-fade

1.7.5.77.1 Syntax

(console-get-fade)

1.7.5.77.2 Description

Not documented.


1.7.5.78 Function: console-get-fading-color

1.7.5.78.1 Syntax

(console-get-fading-color)

1.7.5.78.2 Description

Not documented.


1.7.5.79 Function: console-get-fading-colour

1.7.5.79.1 Syntax

(console-get-fading-colour)

1.7.5.79.2 Description

Not documented.


1.7.5.80 Function: console-get-height

1.7.5.80.1 Syntax

(console-get-height con)

1.7.5.80.2 Description

Not documented.


1.7.5.81 Function: console-get-height-rect

1.7.5.81.1 Syntax

(console-get-height-rect con x y w h fmt &rest args)

1.7.5.81.2 Description

Not documented.


1.7.5.82 Function: console-get-width

1.7.5.82.1 Syntax

(console-get-width con)

1.7.5.82.2 Description

Not documented.


1.7.5.83 Function: console-hline

1.7.5.83.1 Syntax

(console-hline con x y len flag)

1.7.5.83.2 Description

Not documented.


1.7.5.84 Function: console-init-root

1.7.5.84.1 Syntax

(console-init-root width height title fullscreen? renderer)

1.7.5.84.2 Description

Not documented.


1.7.5.85 Function: console-is-fullscreen?

1.7.5.85.1 Syntax

(console-is-fullscreen?)

1.7.5.85.2 Description

Not documented.


1.7.5.86 Function: console-is-window-closed?

1.7.5.86.1 Syntax

(console-is-window-closed?)

1.7.5.86.2 Description

Not documented.


1.7.5.87 Function: console-map-ascii-code-to-font

1.7.5.87.1 Syntax

(console-map-ascii-code-to-font asciicode fontchar-x fontchar-y)

1.7.5.87.2 Description

Not documented.


1.7.5.88 Function: console-map-ascii-codes-to-font

1.7.5.88.1 Syntax

(console-map-ascii-codes-to-font asciicode num-codes fontchar-x fontchar-y)

1.7.5.88.2 Description

Not documented.


1.7.5.89 Function: console-map-string-to-font

1.7.5.89.1 Syntax

(console-map-string-to-font str fontchar-x fontchar-y)

1.7.5.89.2 Description

Not documented.


1.7.5.90 Function: console-map-string-to-font-utf

1.7.5.90.1 Syntax

(console-map-string-to-font-utf str fontchar-x fontchar-y)

1.7.5.90.2 Description

Not documented.


1.7.5.91 Function: console-new

1.7.5.91.1 Syntax

(console-new width height)

1.7.5.91.2 Description

Not documented.


1.7.5.92 Function: console-print

1.7.5.92.1 Syntax

(console-print con x y fmt &rest args)

1.7.5.92.2 Description

Not documented.


1.7.5.93 Function: console-print-double-frame

1.7.5.93.1 Syntax

(console-print-double-frame con x y width height empty? flag fmt &rest args)

1.7.5.93.2 Description

Not documented.


1.7.5.94 Function: console-print-ex

1.7.5.94.1 Syntax

(console-print-ex con x y flag align fmt &rest args)

1.7.5.94.2 Description

Not documented.


1.7.5.95 Function: console-print-ex-utf

1.7.5.95.1 Syntax

(console-print-ex-utf con x y flag align fmt &rest args)

1.7.5.95.2 Description

Not documented.


1.7.5.96 Function: console-print-frame

1.7.5.96.1 Syntax

(console-print-frame con x y width height empty? flag fmt &rest args)

1.7.5.96.2 Description

Not documented.


1.7.5.97 Function: console-print-rect

1.7.5.97.1 Syntax

(console-print-rect con x y w h fmt &rest args)

1.7.5.97.2 Description

Not documented.


1.7.5.98 Function: console-print-rect-ex

1.7.5.98.1 Syntax

(console-print-rect-ex con x y w h flag align fmt &rest args)

1.7.5.98.2 Description

Not documented.


1.7.5.99 Function: console-print-rect-ex-utf

1.7.5.99.1 Syntax

(console-print-rect-ex-utf con x y w h flag align fmt &rest args)

1.7.5.99.2 Description

Not documented.


1.7.5.100 Function: console-print-rect-utf

1.7.5.100.1 Syntax

(console-print-rect-utf con x y w h fmt &rest args)

1.7.5.100.2 Description

Not documented.


1.7.5.101 Function: console-print-utf

1.7.5.101.1 Syntax

(console-print-utf con x y fmt &rest args)

1.7.5.101.2 Description

Not documented.


1.7.5.102 Function: console-put-char

1.7.5.102.1 Syntax

(console-put-char con x y ch flag)

1.7.5.102.2 Description

Not documented.


1.7.5.103 Function: console-put-char-ex

1.7.5.103.1 Syntax

(console-put-char-ex con x y ch fg bg)

1.7.5.103.2 Description

Not documented.


1.7.5.104 Function: console-rect

1.7.5.104.1 Syntax

(console-rect con x y width height clear? flag)

1.7.5.104.2 Description

Not documented.


1.7.5.105 Function: console-set-alignment

1.7.5.105.1 Syntax

(console-set-alignment con align)

1.7.5.105.2 Description

Not documented.


1.7.5.106 Function: console-set-background-flag

1.7.5.106.1 Syntax

(console-set-background-flag con flag)

1.7.5.106.2 Description

Not documented.


1.7.5.107 Function: console-set-char

1.7.5.107.1 Syntax

(console-set-char con x y ch)

1.7.5.107.2 Description

Not documented.


1.7.5.108 Function: console-set-char-background

1.7.5.108.1 Syntax

(console-set-char-background con x y col flag)

1.7.5.108.2 Description

Not documented.


1.7.5.109 Function: console-set-char-foreground

1.7.5.109.1 Syntax

(console-set-char-foreground con x y col)

1.7.5.109.2 Description

Not documented.


1.7.5.110 Function: console-set-color-control

1.7.5.110.1 Syntax

(console-set-color-control control-num fore back)

1.7.5.110.2 Description

Not documented.


1.7.5.111 Function: console-set-colour-control

1.7.5.111.1 Syntax

(console-set-colour-control control-num fore back)

1.7.5.111.2 Description

Not documented.


1.7.5.112 Function: console-set-custom-font

1.7.5.112.1 Syntax

(console-set-custom-font fontfile flags chars-horizontal chars-vertical)

1.7.5.112.2 Description

Not documented.


1.7.5.113 Function: console-set-default-background

1.7.5.113.1 Syntax

(console-set-default-background con col)

1.7.5.113.2 Description

Not documented.


1.7.5.114 Function: console-set-default-foreground

1.7.5.114.1 Syntax

(console-set-default-foreground con col)

1.7.5.114.2 Description

Not documented.


1.7.5.115 Function: console-set-dirty

1.7.5.115.1 Syntax

(console-set-dirty rootx rooty width height)

1.7.5.115.2 Description

Declares an area of the *root* console to be 'dirty'.


1.7.5.116 Function: console-set-fade

1.7.5.116.1 Syntax

(console-set-fade val fade)

1.7.5.116.2 Description

Not documented.


1.7.5.117 Function: console-set-fullscreen

1.7.5.117.1 Syntax

(console-set-fullscreen full?)

1.7.5.117.2 Description

Not documented.


1.7.5.118 Function: console-set-keyboard-repeat

1.7.5.118.1 Syntax

(console-set-keyboard-repeat initial-delay interval)

1.7.5.118.2 Description

Not documented.


1.7.5.119 Function: console-set-window-title

1.7.5.119.1 Syntax

(console-set-window-title title)

1.7.5.119.2 Description

Not documented.


1.7.5.120 Function: console-vline

1.7.5.120.1 Syntax

(console-vline con x y len flag)

1.7.5.120.2 Description

Not documented.


1.7.5.121 Function: console-wait-for-keypress

1.7.5.121.1 Syntax

(console-wait-for-keypress flush?)

1.7.5.121.2 Description

Not documented.


1.7.5.122 Function: decompose-color

1.7.5.122.1 Syntax

(decompose-color num)

1.7.5.122.2 Description

Not documented.


1.7.5.123 Function: decompose-colour

1.7.5.123.1 Syntax

(decompose-colour num)

1.7.5.123.2 Description

Given a colournum #xBBGGRR, return R, G and B integer values as 3 separate return values.


1.7.5.124 Function: dijkstra-compute

1.7.5.124.1 Syntax

(dijkstra-compute dijkstra-path rootx rooty)

1.7.5.124.2 Description

Compute paths leading to the point at (ROOTX, ROOTY), using the Dijkstra algorithm.


1.7.5.125 Function: dijkstra-delete

1.7.5.125.1 Syntax

(dijkstra-delete dijkstra-path)

1.7.5.125.2 Description

Delete a Dijkstra path object.


1.7.5.126 Function: dijkstra-get

1.7.5.126.1 Syntax

(dijkstra-get dijkstra-path index)

1.7.5.126.2 Description

Return the INDEXth step in the path from its current origin to its current destination.


1.7.5.127 Function: dijkstra-get-distance

1.7.5.127.1 Syntax

(dijkstra-get-distance dijkstra-path to-x to-y)

1.7.5.127.2 Description

Return the number of steps on the path leading from the root node to the point at (TO-X, TO-Y).


1.7.5.128 Function: dijkstra-is-empty?

1.7.5.128.1 Syntax

(dijkstra-is-empty? dijkstra-path)

1.7.5.128.2 Description

Return true if the path object is empty (has zero steps).


1.7.5.129 Function: dijkstra-new

1.7.5.129.1 Syntax

(dijkstra-new map diagonal-cost)

1.7.5.129.2 Description

Return a new Dijkstra path object which uses MAP.


1.7.5.130 Function: dijkstra-new-using-function

1.7.5.130.1 Syntax

(dijkstra-new-using-function xdim ydim callback user-data diagonal-cost)

1.7.5.130.2 Description

Return a new Dijkstra path object which calls the function CALLBACK to calculate movement costs.


1.7.5.131 Function: dijkstra-path-set

1.7.5.131.1 Syntax

(dijkstra-path-set dijkstra-path to-x to-y)

1.7.5.131.2 Description

Return true if a path can be found leading from the root node to the point at (TO-X, TO-Y).


1.7.5.132 Function: dijkstra-path-walk

1.7.5.132.1 Syntax

(dijkstra-path-walk dijkstra-path)

1.7.5.132.2 Description

Move one step along PATH. The path becomes one step shorter. Returns the coordinates of the new location.


1.7.5.133 Function: dijkstra-reverse

1.7.5.133.1 Syntax

(dijkstra-reverse dijkstra-path)

1.7.5.133.2 Description

Swap origin and destination for a Dijkstra path object.


1.7.5.134 Function: dijkstra-size

1.7.5.134.1 Syntax

(dijkstra-size dijkstra-path)

1.7.5.134.2 Description

Return the number of steps in the path.


1.7.5.135 Function: heightmap-add

1.7.5.135.1 Syntax

(heightmap-add heightmap value)

1.7.5.135.2 Description

Add VALUE to all heights in the heightmap.


1.7.5.136 Function: heightmap-add-fbm

1.7.5.136.1 Syntax

(heightmap-add-fbm heightmap noise mulx muly addx addy octaves delta scale)

1.7.5.136.2 Description

Add values from the random noise object NOISE to all heights in equivalent positions in HEIGHTMAP.


1.7.5.137 Function: heightmap-add-hill

1.7.5.137.1 Syntax

(heightmap-add-hill heightmap hx hy hradius hheight)

1.7.5.137.2 Description

Not documented.


1.7.5.138 Function: heightmap-add-hm

1.7.5.138.1 Syntax

(heightmap-add-hm hm1 hm2 result)

1.7.5.138.2 Description

Add the heights in HM1 to heights in equivalent positions in HM2, and store the results in the heightmap RESULT.


1.7.5.139 Function: heightmap-add-voronoi

1.7.5.139.1 Syntax

(heightmap-add-voronoi heightmap num-points coefs rng)

1.7.5.139.2 Arguments:

HEIGHTMAP
pointer to a heightmap object.
NUM-POINTS
number of Voronoi sites to create.
COEFS
list of floats to use to scale the distance to each site.
RNG
pointer to a random number generator object.


1.7.5.140 Function: heightmap-clamp

1.7.5.140.1 Syntax

(heightmap-clamp heightmap min max)

1.7.5.140.2 Description

If any height in HEIGHTMAP is below MIN or above MAX, set it equal to MIN or MAX respectively.


1.7.5.141 Function: heightmap-clear

1.7.5.141.1 Syntax

(heightmap-clear heightmap)

1.7.5.141.2 Description

Set all the heights in the heightmap to zero.


1.7.5.142 Function: heightmap-copy

1.7.5.142.1 Syntax

(heightmap-copy source dest)

1.7.5.142.2 Description

Copy the heightmap SOURCE into the heightmap object DEST.


1.7.5.143 Function: heightmap-count-cells

1.7.5.143.1 Syntax

(heightmap-count-cells heightmap min max)

1.7.5.143.2 Description

Return the number of cells in HEIGHTMAP which contain heights between MIN and MAX.


1.7.5.144 Function: heightmap-delete

1.7.5.144.1 Syntax

(heightmap-delete heightmap)

1.7.5.144.2 Description

Destroy the heightmap object HEIGHTMAP.


1.7.5.145 Function: heightmap-dig-bezier

1.7.5.145.1 Syntax

(heightmap-dig-bezier heightmap coords start-radius start-depth end-radius
                      end-depth)

1.7.5.145.2 Description

Carve a path through HEIGHTMAP using a cubic Bezier curve.


1.7.5.146 Function: heightmap-dig-hill

1.7.5.146.1 Syntax

(heightmap-dig-hill heightmap hx hy hradius hheight)

1.7.5.146.2 Description

Not documented.


1.7.5.147 Function: heightmap-dig-line

1.7.5.147.1 Syntax

(heightmap-dig-line heightmap x1 y1 x2 y2 radius depth)

1.7.5.147.2 Description

Not documented.


1.7.5.148 Function: heightmap-get-interpolated-value

1.7.5.148.1 Syntax

(heightmap-get-interpolated-value heightmap x y)

1.7.5.148.2 Description

Calculate the height at position (X, Y) in the heightmap, where the coordinates might not be integers.


1.7.5.149 Function: heightmap-get-max

1.7.5.149.1 Syntax

(heightmap-get-max heightmap)

1.7.5.149.2 Description

Return the highest height in HEIGHTMAP.


1.7.5.150 Function: heightmap-get-min

1.7.5.150.1 Syntax

(heightmap-get-min heightmap)

1.7.5.150.2 Description

Return the lowest height in HEIGHTMAP.


1.7.5.151 Function: heightmap-get-normal

1.7.5.151.1 Syntax

(heightmap-get-normal heightmap x y water-level)

1.7.5.151.2 Returns: a list of 3 floats, representing the normalised normal

vector of the point at X, Y.


1.7.5.152 Function: heightmap-get-slope

1.7.5.152.1 Syntax

(heightmap-get-slope heightmap x y)

1.7.5.152.2 Description

Return the slope at position (X, Y) in the heightmap. The value returned will be between 0 and pi/2.


1.7.5.153 Function: heightmap-get-value

1.7.5.153.1 Syntax

(heightmap-get-value heightmap x y)

1.7.5.153.2 Description

Return the height at position (X, Y) in the heightmap.


1.7.5.154 Function: heightmap-has-land-on-border?

1.7.5.154.1 Syntax

(heightmap-has-land-on-border? heightmap waterlevel)

1.7.5.154.2 Description

Return true if any of the border cells of HEIGHTMAP have heights greater than WATERLEVEL.


1.7.5.155 Function: heightmap-islandify

1.7.5.155.1 Syntax

(heightmap-islandify heightmap sea-level rng)

1.7.5.155.2 Description

Not documented.


1.7.5.156 Function: heightmap-kernel-transform

1.7.5.156.1 Syntax

(heightmap-kernel-transform heightmap coords weights min-level max-level)

1.7.5.156.2 Arguments:

HEIGHTMAP
pointer to a heightmap object.
COORDS
a list of (X . Y) cons cells specifying coordinates relative to the

cell being processed. For example (-1 . 0) is the cell to the west, (0 . 1) is the cell to the south, etc.

WEIGHTS
a list of factors by which to scale the values in processed cells.

The list must be the same length as COORDS.

MIN-LEVEL, MAX-LEVEL
Cells are only processed if their values lies within

these limits.


1.7.5.157 Function: heightmap-lerp-hm

1.7.5.157.1 Syntax

(heightmap-lerp-hm hm1 hm2 result coef)

1.7.5.157.2 Description

Fill the heightmap RESULT with the results of a lerp operation between the two heightmaps HM1 and HM2.


1.7.5.158 Function: heightmap-multiply-hm

1.7.5.158.1 Syntax

(heightmap-multiply-hm hm1 hm2 result)

1.7.5.158.2 Description

Multiply the heights in HM1 by the heights in equivalent positions in HM2, and store the results in the heightmap RESULT.


1.7.5.159 Function: heightmap-new

1.7.5.159.1 Syntax

(heightmap-new width height)

1.7.5.159.2 Description

Return a new heightmap with the given dimensions.


1.7.5.160 Function: heightmap-normalise

1.7.5.160.1 Syntax

(heightmap-normalise heightmap min max)

1.7.5.160.2 Description

Not documented.


1.7.5.161 Function: heightmap-normalize

1.7.5.161.1 Syntax

(heightmap-normalize heightmap min max)

1.7.5.161.2 Description

Scale all the heights in HEIGHTMAP so that the lowest is equal to MIN and the highest is equal to MAX.


1.7.5.162 Function: heightmap-rain-erosion

1.7.5.162.1 Syntax

(heightmap-rain-erosion heightmap num-drops erosion-coef sedimentation-coef
                        &optional (rng +null+))

1.7.5.162.2 Description

'Erode' the heightmap HEIGHTMAP by dropping NUM-DROPS 'raindrops' in random locations.


1.7.5.163 Function: heightmap-scale

1.7.5.163.1 Syntax

(heightmap-scale heightmap factor)

1.7.5.163.2 Description

Multiply all the heights in the heightmap by SCALE.


1.7.5.164 Function: heightmap-scale-fbm

1.7.5.164.1 Syntax

(heightmap-scale-fbm heightmap noise mulx muly addx addy octaves delta scale)

1.7.5.164.2 Description

Not documented.


1.7.5.165 Function: heightmap-set-value

1.7.5.165.1 Syntax

(heightmap-set-value heightmap x y value)

1.7.5.165.2 Description

Set the height at position (X, Y) in the heightmap to VALUE.


1.7.5.166 Function: image-blit

1.7.5.166.1 Syntax

(image-blit image con x y flag scalex scaley angle)

1.7.5.166.2 Description

Not documented.


1.7.5.167 Function: image-blit-2x

1.7.5.167.1 Syntax

(image-blit-2x image dest dx dy sx sy width height)

1.7.5.167.2 Description

Not documented.


1.7.5.168 Function: image-blit-rect

1.7.5.168.1 Syntax

(image-blit-rect image con x y width height flag)

1.7.5.168.2 Description

Not documented.


1.7.5.169 Function: image-clear

1.7.5.169.1 Syntax

(image-clear image colour)

1.7.5.169.2 Description

Fill the image IMAGE with the colour COLOUR.


1.7.5.170 Function: image-delete

1.7.5.170.1 Syntax

(image-delete image)

1.7.5.170.2 Description

Not documented.


1.7.5.171 Function: image-from-console

1.7.5.171.1 Syntax

(image-from-console con)

1.7.5.171.2 Description

Return a new image whose contents are a 'screenshot' of the console CON.


1.7.5.172 Function: image-get-alpha

1.7.5.172.1 Syntax

(image-get-alpha image x y)

1.7.5.172.2 Description

Not documented.


1.7.5.173 Function: image-get-height

1.7.5.173.1 Syntax

(image-get-height image)

1.7.5.173.2 Description

Not documented.


1.7.5.174 Function: image-get-mipmap-pixel

1.7.5.174.1 Syntax

(image-get-mipmap-pixel image x0 y0 x1 y1)

1.7.5.174.2 Description

Calculate the interpolated colour of the pixel at (PIXEL-X, PIXEL-Y) in IMAGE.


1.7.5.175 Function: image-get-pixel

1.7.5.175.1 Syntax

(image-get-pixel image pixel-x pixel-y)

1.7.5.175.2 Description

Return the colour of the pixel at (PIXEL-X, PIXEL-Y) in IMAGE.


1.7.5.176 Function: image-get-width

1.7.5.176.1 Syntax

(image-get-width image)

1.7.5.176.2 Description

Not documented.


1.7.5.177 Function: image-hflip

1.7.5.177.1 Syntax

(image-hflip image)

1.7.5.177.2 Description

Not documented.


1.7.5.178 Function: image-invert

1.7.5.178.1 Syntax

(image-invert image)

1.7.5.178.2 Description

Not documented.


1.7.5.179 Function: image-is-pixel-transparent?

1.7.5.179.1 Syntax

(image-is-pixel-transparent? image x y)

1.7.5.179.2 Description

Not documented.


1.7.5.180 Function: image-load

1.7.5.180.1 Syntax

(image-load filename)

1.7.5.180.2 Description

Read an image from a file and return it.


1.7.5.181 Function: image-new

1.7.5.181.1 Syntax

(image-new width height)

1.7.5.181.2 Description

Return a new image, filled with black.


1.7.5.182 Function: image-put-pixel

1.7.5.182.1 Syntax

(image-put-pixel image pixel-x pixel-y colour)

1.7.5.182.2 Description

Set the colour of the pixel at (PIXEL-X, PIXEL-Y) in IMAGE to COLOUR.


1.7.5.183 Function: image-refresh-console

1.7.5.183.1 Syntax

(image-refresh-console image con)

1.7.5.183.2 Description

Not documented.


1.7.5.184 Function: image-rotate90

1.7.5.184.1 Syntax

(image-rotate90 image num-rotations)

1.7.5.184.2 Description

Not documented.


1.7.5.185 Function: image-save

1.7.5.185.1 Syntax

(image-save image filename)

1.7.5.185.2 Description

Write the image IMAGE to a file. The filename must end in .BMP or .PNG.


1.7.5.186 Function: image-scale

1.7.5.186.1 Syntax

(image-scale image new-width new-height)

1.7.5.186.2 Description

Not documented.


1.7.5.187 Function: image-set-key-color

1.7.5.187.1 Syntax

(image-set-key-color image key-color)

1.7.5.187.2 Description

Not documented.


1.7.5.188 Function: image-set-key-colour

1.7.5.188.1 Syntax

(image-set-key-colour image key-colour)

1.7.5.188.2 Description

Not documented.


1.7.5.189 Function: image-vflip

1.7.5.189.1 Syntax

(image-vflip image)

1.7.5.189.2 Description

Not documented.


1.7.5.190 Function: invert-color

1.7.5.190.1 Syntax

(invert-color num)

1.7.5.190.2 Description

Not documented.


1.7.5.191 Function: invert-colour

1.7.5.191.1 Syntax

(invert-colour num)

1.7.5.191.2 Description

Not documented.


1.7.5.192 Function: is-key-pressed?

1.7.5.192.1 Syntax

(is-key-pressed? code)

1.7.5.192.2 Description

Not documented.


1.7.5.193 Function: key-c

1.7.5.193.1 Syntax

(key-c instance)

1.7.5.193.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.194 Function: key-lalt

1.7.5.194.1 Syntax

(key-lalt instance)

1.7.5.194.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.195 Function: key-lctrl

1.7.5.195.1 Syntax

(key-lctrl instance)

1.7.5.195.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.196 Function: key-p

1.7.5.196.1 Syntax

(key-p object)

1.7.5.196.2 Description

Not documented.


1.7.5.197 Function: key-pressed

1.7.5.197.1 Syntax

(key-pressed instance)

1.7.5.197.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.198 Function: key-ralt

1.7.5.198.1 Syntax

(key-ralt instance)

1.7.5.198.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.199 Function: key-rctrl

1.7.5.199.1 Syntax

(key-rctrl instance)

1.7.5.199.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.200 Function: key-shift

1.7.5.200.1 Syntax

(key-shift instance)

1.7.5.200.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.201 Function: key-vk

1.7.5.201.1 Syntax

(key-vk instance)

1.7.5.201.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.202 Function: line-init

1.7.5.202.1 Syntax

(line-init xfrom yfrom xto yto)

1.7.5.202.2 Description

Not documented.


1.7.5.203 Function: line-line

1.7.5.203.1 Syntax

(line-line xfrom yfrom xto yto callback)

1.7.5.203.2 Description

Not documented.


1.7.5.204 Function: line-step

1.7.5.204.1 Syntax

(line-step xcur ycur)

1.7.5.204.2 Description

Not documented.


1.7.5.205 Function: make-color

1.7.5.205.1 Syntax

(make-color kwd r g b)

1.7.5.205.2 Description

Not documented.


1.7.5.206 Function: make-colour

1.7.5.206.1 Syntax

(make-colour kwd r g b)

1.7.5.206.2 Description

Not documented.


1.7.5.207 Function: make-key

1.7.5.207.1 Syntax

(make-key &key ((vk dum253) none) ((c dum254) ) ((pressed dum255) nil) ((lalt dum256) nil) ((lctrl dum257) nil) ((ralt dum258) nil) ((rctrl dum259) nil) ((shift dum260) nil))

1.7.5.207.2 Description

Not documented.


1.7.5.208 Function: make-mouse

1.7.5.208.1 Syntax

(make-mouse &key ((x dum443) 0) ((y dum444) 0) ((dx dum445) 0) ((dy dum446) 0)
            ((cx dum447) 0) ((cy dum448) 0) ((dcx dum449) 0) ((dcy dum450) 0)
            ((lbutton dum451) nil) ((rbutton dum452) nil)
            ((mbutton dum453) nil) ((lbutton-pressed dum454) nil)
            ((rbutton-pressed dum455) nil) ((mbutton-pressed dum456) nil)
            ((wheel-up dum457) nil) ((wheel-down dum458) nil))

1.7.5.208.2 Description

Not documented.


1.7.5.209 Function: make-simple-key

1.7.5.209.1 Syntax

(make-simple-key ch)

1.7.5.209.2 Description

Not documented.


1.7.5.210 Function: map-clear

1.7.5.210.1 Syntax

(map-clear map transparent? walkable?)

1.7.5.210.2 Description

Set all cells in MAP to be neither walkable nor transparent.


1.7.5.211 Function: map-compute-fov

1.7.5.211.1 Syntax

(map-compute-fov map player-x player-y max-radius light-walls? algorithm)

1.7.5.211.2 Description

Compute field of view information for MAP, assuming the player is at (PLAYER-X, PLAYER-Y), and using the field of view algorithm ALGORITHM.


1.7.5.212 Function: map-copy

1.7.5.212.1 Syntax

(map-copy map-src map-dest)

1.7.5.212.2 Description

Copy the map object SRC into the new map object DEST.


1.7.5.213 Function: map-delete

1.7.5.213.1 Syntax

(map-delete map)

1.7.5.213.2 Description

Destroy the map object MAP.


1.7.5.214 Function: map-get-height

1.7.5.214.1 Syntax

(map-get-height map)

1.7.5.214.2 Description

Return the height of the map object MAP.


1.7.5.215 Function: map-get-nb-cells

1.7.5.215.1 Syntax

(map-get-nb-cells map)

1.7.5.215.2 Description

Return the number of cells in the map object MAP.


1.7.5.216 Function: map-get-width

1.7.5.216.1 Syntax

(map-get-width map)

1.7.5.216.2 Description

Return the width of the map object MAP.


1.7.5.217 Function: map-is-in-fov?

1.7.5.217.1 Syntax

(map-is-in-fov? map x y)

1.7.5.217.2 Description

Return true if position (X, Y) on the map is visible.


1.7.5.218 Function: map-is-transparent?

1.7.5.218.1 Syntax

(map-is-transparent? map x y)

1.7.5.218.2 Description

Return true if position (X, Y) on the map is set to be transparent.


1.7.5.219 Function: map-is-walkable?

1.7.5.219.1 Syntax

(map-is-walkable? map x y)

1.7.5.219.2 Description

Return true if position (X, Y) on the map is set to be walkable.


1.7.5.220 Function: map-new

1.7.5.220.1 Syntax

(map-new width height)

1.7.5.220.2 Description

Return a new map object of the given dimensions.


1.7.5.221 Function: map-set-in-fov

1.7.5.221.1 Syntax

(map-set-in-fov map x y fov?)

1.7.5.221.2 Description

Set whether the cell at X, Y in MAP is in field of view.


1.7.5.222 Function: map-set-properties

1.7.5.222.1 Syntax

(map-set-properties map x y transparent? walkable?)

1.7.5.222.2 Description

Set the properties of the map cell at (X, Y). It is walkable if walkable? is true, and transparent if transparent? is true.


1.7.5.223 Function: mouse-cx

1.7.5.223.1 Syntax

(mouse-cx instance)

1.7.5.223.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.224 Function: mouse-cy

1.7.5.224.1 Syntax

(mouse-cy instance)

1.7.5.224.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.225 Function: mouse-dx

1.7.5.225.1 Syntax

(mouse-dx instance)

1.7.5.225.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.226 Function: mouse-dy

1.7.5.226.1 Syntax

(mouse-dy instance)

1.7.5.226.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.227 Function: mouse-get-cx

1.7.5.227.1 Syntax

(mouse-get-cx)

1.7.5.227.2 Description

Not documented.


1.7.5.228 Function: mouse-get-cy

1.7.5.228.1 Syntax

(mouse-get-cy)

1.7.5.228.2 Description

Not documented.


1.7.5.229 Function: mouse-get-dcx

1.7.5.229.1 Syntax

(mouse-get-dcx)

1.7.5.229.2 Description

Not documented.


1.7.5.230 Function: mouse-get-dcy

1.7.5.230.1 Syntax

(mouse-get-dcy)

1.7.5.230.2 Description

Not documented.


1.7.5.231 Function: mouse-get-dx

1.7.5.231.1 Syntax

(mouse-get-dx)

1.7.5.231.2 Description

Not documented.


1.7.5.232 Function: mouse-get-dy

1.7.5.232.1 Syntax

(mouse-get-dy)

1.7.5.232.2 Description

Not documented.


1.7.5.233 Function: mouse-get-lbutton

1.7.5.233.1 Syntax

(mouse-get-lbutton)

1.7.5.233.2 Description

Not documented.


1.7.5.234 Function: mouse-get-lbutton-pressed

1.7.5.234.1 Syntax

(mouse-get-lbutton-pressed)

1.7.5.234.2 Description

Not documented.


1.7.5.235 Function: mouse-get-mbutton

1.7.5.235.1 Syntax

(mouse-get-mbutton)

1.7.5.235.2 Description

Not documented.


1.7.5.236 Function: mouse-get-mbutton-pressed

1.7.5.236.1 Syntax

(mouse-get-mbutton-pressed)

1.7.5.236.2 Description

Not documented.


1.7.5.237 Function: mouse-get-rbutton

1.7.5.237.1 Syntax

(mouse-get-rbutton)

1.7.5.237.2 Description

Not documented.


1.7.5.238 Function: mouse-get-rbutton-pressed

1.7.5.238.1 Syntax

(mouse-get-rbutton-pressed)

1.7.5.238.2 Description

Not documented.


1.7.5.239 Function: mouse-get-status

1.7.5.239.1 Syntax

(mouse-get-status &optional (update? nil))

1.7.5.239.2 Description

Note that as of libtcod 1.5.1rc1, `mouse-get-status' returns information about the status of the mouse as at the last time `sys-check-for-event' was called. If you want the current status of the mouse to be returned instead, UPDATE? should be non-nil.


1.7.5.240 Function: mouse-get-x

1.7.5.240.1 Syntax

(mouse-get-x)

1.7.5.240.2 Description

Not documented.


1.7.5.241 Function: mouse-get-y

1.7.5.241.1 Syntax

(mouse-get-y)

1.7.5.241.2 Description

Not documented.


1.7.5.242 Function: mouse-is-cursor-visible?

1.7.5.242.1 Syntax

(mouse-is-cursor-visible?)

1.7.5.242.2 Description

Not documented.


1.7.5.243 Function: mouse-lbutton

1.7.5.243.1 Syntax

(mouse-lbutton instance)

1.7.5.243.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.244 Function: mouse-lbutton-pressed

1.7.5.244.1 Syntax

(mouse-lbutton-pressed instance)

1.7.5.244.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.245 Function: mouse-mbutton

1.7.5.245.1 Syntax

(mouse-mbutton instance)

1.7.5.245.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.246 Function: mouse-mbutton-pressed

1.7.5.246.1 Syntax

(mouse-mbutton-pressed instance)

1.7.5.246.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.247 Function: mouse-move

1.7.5.247.1 Syntax

(mouse-move pixel-x pixel-y)

1.7.5.247.2 Description

Not documented.


1.7.5.248 Function: mouse-rbutton

1.7.5.248.1 Syntax

(mouse-rbutton instance)

1.7.5.248.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.249 Function: mouse-rbutton-pressed

1.7.5.249.1 Syntax

(mouse-rbutton-pressed instance)

1.7.5.249.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.250 Function: mouse-show-cursor

1.7.5.250.1 Syntax

(mouse-show-cursor visible?)

1.7.5.250.2 Description

Not documented.


1.7.5.251 Function: mouse-wheel-down

1.7.5.251.1 Syntax

(mouse-wheel-down instance)

1.7.5.251.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.252 Function: mouse-wheel-up

1.7.5.252.1 Syntax

(mouse-wheel-up instance)

1.7.5.252.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.253 Function: mouse-x

1.7.5.253.1 Syntax

(mouse-x instance)

1.7.5.253.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.254 Function: mouse-y

1.7.5.254.1 Syntax

(mouse-y instance)

1.7.5.254.2 Description

Return whether debug-block represents elsewhere code.


1.7.5.255 Function: namegen-destroy

1.7.5.255.1 Syntax

(namegen-destroy)

1.7.5.255.2 Description

Not documented.


1.7.5.256 Function: namegen-generate

1.7.5.256.1 Syntax

(namegen-generate name allocate?)

1.7.5.256.2 Description

Not documented.


1.7.5.257 Function: namegen-generate-custom

1.7.5.257.1 Syntax

(namegen-generate-custom name rule allocate?)

1.7.5.257.2 Description

Not documented.


1.7.5.258 Function: namegen-parse

1.7.5.258.1 Syntax

(namegen-parse filename rng)

1.7.5.258.2 Description

Not documented.


1.7.5.259 Function: noise-delete

1.7.5.259.1 Syntax

(noise-delete noise)

1.7.5.259.2 Description

Destroy a noise object.


1.7.5.260 Function: noise-get

1.7.5.260.1 Syntax

(noise-get noise &rest nums)

1.7.5.260.2 Description

Returns the flat noise function at the given coordinates.


1.7.5.261 Function: noise-get-ex

1.7.5.261.1 Syntax

(noise-get-ex noise noise-type &rest nums)

1.7.5.261.2 Description

Returns the flat noise function at the given coordinates, using noise type NOISE-TYPE.


1.7.5.262 Function: noise-get-fbm

1.7.5.262.1 Syntax

(noise-get-fbm noise octaves &rest nums)

1.7.5.262.2 Description

Returns the fractional Brownian motion function at the given coordinates.


1.7.5.263 Function: noise-get-fbm-ex

1.7.5.263.1 Syntax

(noise-get-fbm-ex noise noise-type octaves &rest nums)

1.7.5.263.2 Description

Returns the fractional Brownian motion function at the given coordinates, using noise type NOISE-TYPE.


1.7.5.264 Function: noise-get-turbulence

1.7.5.264.1 Syntax

(noise-get-turbulence noise octaves &rest nums)

1.7.5.264.2 Description

Returns the turbulence function at the given coordinates.


1.7.5.265 Function: noise-get-turbulence-ex

1.7.5.265.1 Syntax

(noise-get-turbulence-ex noise noise-type octaves &rest nums)

1.7.5.265.2 Description

Returns the turbulence function at the given coordinates, using noise type NOISE-TYPE.


1.7.5.266 Function: noise-new

1.7.5.266.1 Syntax

(noise-new dimensions &key (hurst +noise-default-hurst+)
           (lacunarity +noise-default-lacunarity+) (rng +null+))

1.7.5.266.2 Description

Return a new noise object with the given characteristics.


1.7.5.267 Function: noise-set-type

1.7.5.267.1 Syntax

(noise-set-type noise noise-type)

1.7.5.267.2 Description

Set the type of noise produced by a noise object.


1.7.5.268 Function: path-compute

1.7.5.268.1 Syntax

(path-compute a*-path ox oy dx dy)

1.7.5.268.2 Description

Compute the path between the two points (OX,OY) and (DX,DY), using the A* algorithm.


1.7.5.269 Function: path-delete

1.7.5.269.1 Syntax

(path-delete a*-path)

1.7.5.269.2 Description

Delete an A* path object.


1.7.5.270 Function: path-get

1.7.5.270.1 Syntax

(path-get a*-path index)

1.7.5.270.2 Description

Return the INDEXth step in the path from its current origin to its current destination.


1.7.5.271 Function: path-get-destination

1.7.5.271.1 Syntax

(path-get-destination a*-path)

1.7.5.271.2 Description

Return the coordinates of the current destination of the A* path PATH.


1.7.5.272 Function: path-get-origin

1.7.5.272.1 Syntax

(path-get-origin a*-path)

1.7.5.272.2 Description

Return the coordinates of the current origin of the A* path PATH.


1.7.5.273 Function: path-is-empty?

1.7.5.273.1 Syntax

(path-is-empty? a*-path)

1.7.5.273.2 Description

Return true if the path object is empty (has zero steps).


1.7.5.274 Function: path-new-using-function

1.7.5.274.1 Syntax

(path-new-using-function xdim ydim callback user-data diagonal-cost)

1.7.5.274.2 Description

Return a new A* path object, which will call the function CALLBACK to calculate movement costs.


1.7.5.275 Function: path-new-using-map

1.7.5.275.1 Syntax

(path-new-using-map map diagonal-cost)

1.7.5.275.2 Description

Return a new A* path object, using the map MAP.


1.7.5.276 Function: path-reverse

1.7.5.276.1 Syntax

(path-reverse a*-path)

1.7.5.276.2 Description

Swap origin and destination for an A* path object.


1.7.5.277 Function: path-size

1.7.5.277.1 Syntax

(path-size a*-path)

1.7.5.277.2 Description

Return the number of steps in the path.


1.7.5.278 Function: path-walk

1.7.5.278.1 Syntax

(path-walk a*-path recalc-when-needed?)

1.7.5.278.2 Description

Move one step along PATH. The path becomes one step shorter. Returns the coordinates of the new location.


1.7.5.279 Function: random-delete

1.7.5.279.1 Syntax

(random-delete rng)

1.7.5.279.2 Description

Not documented.


1.7.5.280 Function: random-get-double

1.7.5.280.1 Syntax

(random-get-double rng min max)

1.7.5.280.2 Description

Not documented.


1.7.5.281 Function: random-get-double-mean

1.7.5.281.1 Syntax

(random-get-double-mean rng min max mean)

1.7.5.281.2 Description

Not documented.


1.7.5.282 Function: random-get-float

1.7.5.282.1 Syntax

(random-get-float rng min max)

1.7.5.282.2 Description

Not documented.


1.7.5.283 Function: random-get-float-mean

1.7.5.283.1 Syntax

(random-get-float-mean rng min max mean)

1.7.5.283.2 Description

Not documented.


1.7.5.284 Function: random-get-instance

1.7.5.284.1 Syntax

(random-get-instance)

1.7.5.284.2 Description

Not documented.


1.7.5.285 Function: random-get-int

1.7.5.285.1 Syntax

(random-get-int rng min max)

1.7.5.285.2 Description

Not documented.


1.7.5.286 Function: random-get-int-mean

1.7.5.286.1 Syntax

(random-get-int-mean rng min max mean)

1.7.5.286.2 Description

Not documented.


1.7.5.287 Function: random-new

1.7.5.287.1 Syntax

(random-new algorithm)

1.7.5.287.2 Description

Not documented.


1.7.5.288 Function: random-new-from-seed

1.7.5.288.1 Syntax

(random-new-from-seed algorithm seed)

1.7.5.288.2 Description

Not documented.


1.7.5.289 Function: random-restore

1.7.5.289.1 Syntax

(random-restore rng backup)

1.7.5.289.2 Description

Not documented.


1.7.5.290 Function: random-save

1.7.5.290.1 Syntax

(random-save rng)

1.7.5.290.2 Description

Not documented.


1.7.5.291 Function: random-set-distribution

1.7.5.291.1 Syntax

(random-set-distribution rng dist)

1.7.5.291.2 Description

Not documented.


1.7.5.292 Function: same-keys?

1.7.5.292.1 Syntax

(same-keys? key1 key2)

1.7.5.292.2 Description

Not documented.


1.7.5.293 Function: start-colors

1.7.5.293.1 Syntax

(start-colors)

1.7.5.293.2 Description

Not documented.


1.7.5.294 Function: start-colours

1.7.5.294.1 Syntax

(start-colours)

1.7.5.294.2 Description

Not documented.


1.7.5.295 Function: sys-check-for-event

1.7.5.295.1 Syntax

(sys-check-for-event eventmask key mouseptr)

1.7.5.295.2 Description

Not documented.


1.7.5.296 Function: sys-clipboard-get

1.7.5.296.1 Syntax

(sys-clipboard-get)

1.7.5.296.2 Description

Not documented.


1.7.5.297 Function: sys-clipboard-set

1.7.5.297.1 Syntax

(sys-clipboard-set text)

1.7.5.297.2 Description

Not documented.


1.7.5.298 Function: sys-create-directory

1.7.5.298.1 Syntax

(sys-create-directory path)

1.7.5.298.2 Description

Not documented.


1.7.5.299 Function: sys-delete-directory

1.7.5.299.1 Syntax

(sys-delete-directory path)

1.7.5.299.2 Description

Not documented.


1.7.5.300 Function: sys-elapsed-milli

1.7.5.300.1 Syntax

(sys-elapsed-milli)

1.7.5.300.2 Description

Not documented.


1.7.5.301 Function: sys-elapsed-seconds

1.7.5.301.1 Syntax

(sys-elapsed-seconds)

1.7.5.301.2 Description

Not documented.


1.7.5.302 Function: sys-force-fullscreen-resolution

1.7.5.302.1 Syntax

(sys-force-fullscreen-resolution width height)

1.7.5.302.2 Description

Not documented.


1.7.5.303 Function: sys-get-char-size

1.7.5.303.1 Syntax

(sys-get-char-size)

1.7.5.303.2 Description

Return the dimensions of each character in the current font bitmap.


1.7.5.304 Function: sys-get-current-resolution

1.7.5.304.1 Syntax

(sys-get-current-resolution)

1.7.5.304.2 Description

Not documented.


1.7.5.305 Function: sys-get-events

1.7.5.305.1 Syntax

(sys-get-events)

1.7.5.305.2 Description

User-friendly wrapper for the new input event model in libtcod 1.5.1rc1. When called, returns a list of all queued events (calling the function also EMPTIES the queue). Each element in the list is a cons cell of the form (EVENT-TYPE . DATA) where EVENT-TYPE is a member of the `event' enum, and DATA is either a key struct or a mouse-state struct.


1.7.5.306 Function: sys-get-fps

1.7.5.306.1 Syntax

(sys-get-fps)

1.7.5.306.2 Description

Not documented.


1.7.5.307 Function: sys-get-fullscreen-offsets

1.7.5.307.1 Syntax

(sys-get-fullscreen-offsets)

1.7.5.307.2 Description

Not documented.


1.7.5.308 Function: sys-get-last-frame-length

1.7.5.308.1 Syntax

(sys-get-last-frame-length)

1.7.5.308.2 Description

Not documented.


1.7.5.309 Function: sys-get-renderer

1.7.5.309.1 Syntax

(sys-get-renderer)

1.7.5.309.2 Description

Return the currently active renderer.


1.7.5.310 Function: sys-register-sdl-renderer

1.7.5.310.1 Syntax

(sys-register-sdl-renderer callback)

1.7.5.310.2 Description

Not documented.


1.7.5.311 Function: sys-save-screenshot

1.7.5.311.1 Syntax

(sys-save-screenshot &optional (filename (null-pointer)))

1.7.5.311.2 Description

Not documented.


1.7.5.312 Function: sys-set-fps

1.7.5.312.1 Syntax

(sys-set-fps val)

1.7.5.312.2 Description

Not documented.


1.7.5.313 Function: sys-set-renderer

1.7.5.313.1 Syntax

(sys-set-renderer renderer)

1.7.5.313.2 Description

Change the currently active renderer.


1.7.5.314 Function: sys-sleep-milli

1.7.5.314.1 Syntax

(sys-sleep-milli val)

1.7.5.314.2 Description

Not documented.


1.7.5.315 Function: sys-update-char

1.7.5.315.1 Syntax

(sys-update-char ascii fontx fonty image x y)

1.7.5.315.2 Description

Not documented.


1.7.5.316 Function: sys-wait-for-event

1.7.5.316.1 Syntax

(sys-wait-for-event eventmask key mouseptr flush?)

1.7.5.316.2 Description

Not documented.


1.7.5.317 Function: zip-delete

1.7.5.317.1 Syntax

(zip-delete zip)

1.7.5.317.2 Description

Not documented.


1.7.5.318 Function: zip-get-char

1.7.5.318.1 Syntax

(zip-get-char zip)

1.7.5.318.2 Description

Not documented.


1.7.5.319 Function: zip-get-color

1.7.5.319.1 Syntax

(zip-get-color zip)

1.7.5.319.2 Description

Not documented.


1.7.5.320 Function: zip-get-colour

1.7.5.320.1 Syntax

(zip-get-colour zip)

1.7.5.320.2 Description

Not documented.


1.7.5.321 Function: zip-get-console

1.7.5.321.1 Syntax

(zip-get-console zip)

1.7.5.321.2 Description

Not documented.


1.7.5.322 Function: zip-get-current-bytes

1.7.5.322.1 Syntax

(zip-get-current-bytes zip)

1.7.5.322.2 Description

Not documented.


1.7.5.323 Function: zip-get-data

1.7.5.323.1 Syntax

(zip-get-data zip nbytes data)

1.7.5.323.2 Description

Not documented.


1.7.5.324 Function: zip-get-float

1.7.5.324.1 Syntax

(zip-get-float zip)

1.7.5.324.2 Description

Not documented.


1.7.5.325 Function: zip-get-image

1.7.5.325.1 Syntax

(zip-get-image zip)

1.7.5.325.2 Description

Not documented.


1.7.5.326 Function: zip-get-int

1.7.5.326.1 Syntax

(zip-get-int zip)

1.7.5.326.2 Description

Not documented.


1.7.5.327 Function: zip-get-remaining-bytes

1.7.5.327.1 Syntax

(zip-get-remaining-bytes zip)

1.7.5.327.2 Description

Not documented.


1.7.5.328 Function: zip-get-string

1.7.5.328.1 Syntax

(zip-get-string zip)

1.7.5.328.2 Description

Not documented.


1.7.5.329 Function: zip-load-from-file

1.7.5.329.1 Syntax

(zip-load-from-file zip filename)

1.7.5.329.2 Description

Not documented.


1.7.5.330 Function: zip-new

1.7.5.330.1 Syntax

(zip-new)

1.7.5.330.2 Description

Not documented.


1.7.5.331 Function: zip-put

1.7.5.331.1 Syntax

(zip-put zip val)

1.7.5.331.2 Description

Not documented.


1.7.5.332 Function: zip-put-char

1.7.5.332.1 Syntax

(zip-put-char zip ch)

1.7.5.332.2 Description

Not documented.


1.7.5.333 Function: zip-put-color

1.7.5.333.1 Syntax

(zip-put-color zip color)

1.7.5.333.2 Description

Not documented.


1.7.5.334 Function: zip-put-colour

1.7.5.334.1 Syntax

(zip-put-colour zip colour)

1.7.5.334.2 Description

Not documented.


1.7.5.335 Function: zip-put-console

1.7.5.335.1 Syntax

(zip-put-console zip con)

1.7.5.335.2 Description

Not documented.


1.7.5.336 Function: zip-put-data

1.7.5.336.1 Syntax

(zip-put-data zip nbytes data)

1.7.5.336.2 Description

Not documented.


1.7.5.337 Function: zip-put-float

1.7.5.337.1 Syntax

(zip-put-float zip val)

1.7.5.337.2 Description

Not documented.


1.7.5.338 Function: zip-put-image

1.7.5.338.1 Syntax

(zip-put-image zip image)

1.7.5.338.2 Description

Not documented.


1.7.5.339 Function: zip-put-int

1.7.5.339.1 Syntax

(zip-put-int zip val)

1.7.5.339.2 Description

Not documented.


1.7.5.340 Function: zip-put-string

1.7.5.340.1 Syntax

(zip-put-string zip val)

1.7.5.340.2 Description

Not documented.


1.7.5.341 Function: zip-save-to-file

1.7.5.341.1 Syntax

(zip-save-to-file zip filename)

1.7.5.341.2 Description

Not documented.


1.7.5.342 Function: zip-skip-bytes

1.7.5.342.1 Syntax

(zip-skip-bytes zip nbytes)

1.7.5.342.2 Description

Not documented.

1.8 Index

1.8.1 Nonalphabetic

1.8.2 A

1.8.4 C

1.8.6 F

1.8.9 K

1.8.10 L

1.8.11 M

2 Colophon

This documentation was generated from Common Lisp source code using CLOD, version 1.0. The latest version of CLOD is available here.

Date: 2012-03-14 12:04:19 New Zealand Daylight Time

Author: Paul Sexton

Org version 7.7 with Emacs version 24

Validate XHTML 1.0