The cl-devil Reference Manual

This is the cl-devil Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 20:01:44 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-devil

Dependencies
  • cffi (system).
  • alexandria (system).
Source

cl-devil.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 cl-devil/cl-devil.asd

Source

cl-devil.asd.

Parent Component

cl-devil (system).

ASDF Systems

cl-devil.


3.1.2 cl-devil/package.lisp

Source

cl-devil.asd.

Parent Component

cl-devil (system).

Packages

3.1.3 cl-devil/internal.lisp

Dependency

package.lisp (file).

Source

cl-devil.asd.

Parent Component

cl-devil (system).

Public Interface

3.1.4 cl-devil/il.lisp

Dependencies
Source

cl-devil.asd.

Parent Component

cl-devil (system).

Public Interface
Internals

3.1.5 cl-devil/utilities.lisp

Dependencies
Source

cl-devil.asd.

Parent Component

cl-devil (system).

Public Interface
Internals

define-deprecated-image-fun (macro).


4 Packages

Packages are listed by definition order.


4.1 cl-devil

Source

package.lisp.

Nickname

il

Use List
Public Interface
Internals

4.2 %cl-devil-internal

Source

package.lisp.

Nickname

%il

Use List
  • alexandria.
  • common-lisp.
Used By List

cl-devil.

Public Interface

5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: deferrwrap (name &optional args)
Package

%cl-devil-internal.

Source

internal.lisp.

Macro: maybe-error (call)
Package

%cl-devil-internal.

Source

internal.lisp.

Macro: with-bound-image (id &body body)

Binds ID for the duration of BODY, returning to the previously bound image thereafter.

Package

cl-devil.

Source

utilities.lisp.

Macro: with-images ((&rest images) &body body)

Generates an IL image for each of IMAGES, binding and loading if a parameter is supplied. BODY is executed, and the images are freed thereafter.

Package

cl-devil.

Source

utilities.lisp.

Macro: with-init (&body body)
Package

cl-devil.

Source

utilities.lisp.


5.1.2 Compiler macros

Compiler Macro: bytes-per-pixel-of (id)
Package

cl-devil.

Source

utilities.lisp.

Compiler Macro: element-type-of (id)
Package

cl-devil.

Source

utilities.lisp.

Compiler Macro: height-of (id)
Package

cl-devil.

Source

utilities.lisp.

Compiler Macro: pixel-format-of (id)
Package

cl-devil.

Source

utilities.lisp.

Compiler Macro: width-of (id)
Package

cl-devil.

Source

utilities.lisp.


5.1.3 Ordinary functions

Function: bind-image (image)
Package

cl-devil.

Source

il.lisp.

Function: blit (source dest-x dest-y dest-z src-x src-y src-z width height depth)
Package

cl-devil.

Source

il.lisp.

Function: bytes-per-pixel-of (id)
Package

cl-devil.

Source

utilities.lisp.

Function: check-error ()
Package

cl-devil.

Source

il.lisp.

Function: clear-colour (red green blue alpha)
Package

cl-devil.

Source

il.lisp.

Function: clear-image ()
Package

cl-devil.

Source

il.lisp.

Function: convert-image (format type)
Package

cl-devil.

Source

il.lisp.

Function: copy-image (source)
Package

cl-devil.

Source

il.lisp.

Function: copy-palette (dest src)
Package

cl-devil.

Source

utilities.lisp.

Function: copy-pixels (x-offset y-offset z-offset width height depth format type data)
Package

cl-devil.

Source

il.lisp.

Function: delete-images (&rest images)
Package

cl-devil.

Source

il.lisp.

Function: determine-type (pathname)
Package

cl-devil.

Source

il.lisp.

Function: disable (mode)
Package

cl-devil.

Source

il.lisp.

Function: element-type-of (id)
Package

cl-devil.

Source

utilities.lisp.

Function: enable (mode)
Package

cl-devil.

Source

il.lisp.

Function: enabledp (mode)
Package

cl-devil.

Source

il.lisp.

Function: error-condition (keyword)
Package

%cl-devil-internal.

Source

internal.lisp.

Function: flip-image ()
Package

cl-devil.

Source

il.lisp.

Function: gen-image ()
Package

cl-devil.

Source

il.lisp.

Function: gen-images (count)
Package

cl-devil.

Source

il.lisp.

Function: get-data ()
Package

cl-devil.

Source

il.lisp.

Function: get-integer (mode)
Package

cl-devil.

Source

il.lisp.

Function: get-palette ()
Package

cl-devil.

Source

il.lisp.

Function: height-of (id)
Package

cl-devil.

Source

utilities.lisp.

Function: image-bits-per-pixel (&optional id)
Package

cl-devil.

Source

utilities.lisp.

Function: image-bytes-per-pixel (&optional id)
Package

cl-devil.

Source

utilities.lisp.

Function: image-format (&optional id)
Package

cl-devil.

Source

utilities.lisp.

Function: image-height (&optional id)
Package

cl-devil.

Source

utilities.lisp.

Function: image-origin (&optional id)
Package

cl-devil.

Source

utilities.lisp.

Function: image-type (&optional id)
Package

cl-devil.

Source

utilities.lisp.

Function: image-width (&optional id)
Package

cl-devil.

Source

utilities.lisp.

Function: init ()
Package

cl-devil.

Source

il.lisp.

Function: key-color (red green blue alpha)
Package

cl-devil.

Source

il.lisp.

Function: load (type file-name)
Package

cl-devil.

Source

il.lisp.

Function: load-f (type handle)
Package

cl-devil.

Source

il.lisp.

Function: load-image (file-name)
Package

cl-devil.

Source

il.lisp.

Function: load-l (type pointer size)
Package

cl-devil.

Source

il.lisp.

Function: origin-func (origin)
Package

cl-devil.

Source

il.lisp.

Function: overlay-image (source x y z)
Package

cl-devil.

Source

il.lisp.

Function: pixel-format-of (id)
Package

cl-devil.

Source

utilities.lisp.

Function: register-palette (palette size type)
Package

cl-devil.

Source

il.lisp.

Function: save (type file-name)
Package

cl-devil.

Source

il.lisp.

Function: save-f (type handle)
Package

cl-devil.

Source

il.lisp.

Function: save-image (file-name)
Package

cl-devil.

Source

il.lisp.

Function: save-l (type pointer size)
Package

cl-devil.

Source

il.lisp.

Function: set-data ()
Package

cl-devil.

Source

il.lisp.

Function: set-integer (mode param)
Package

cl-devil.

Source

il.lisp.

Function: set-pixels (x-offset y-offset z-offset width height depth format type data)
Package

cl-devil.

Source

il.lisp.

Function: shutdown ()
Package

cl-devil.

Source

il.lisp.

Function: tex-image (width height depth bpp format type data)
Package

cl-devil.

Source

il.lisp.

Function: width-of (id)
Package

cl-devil.

Source

utilities.lisp.


5.1.4 Standalone methods

Method: expand-to-foreign-dyn (value var body (type pathname-string-type))
Package

cffi.

Source

il.lisp.


5.1.5 Conditions

Condition: bad-dimensions
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valuebad-dimensions
Condition: could-not-open-file
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valuecould-not-open-file
Condition: error
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct subclasses
Direct methods

enum-value.

Direct slots
Slot: enum-value
Initargs

:enum-value

Readers

enum-value.

Writers

This slot is read-only.

Condition: file-already-exists
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valuefile-already-exists
Condition: file-read-error
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valuefile-read-error
Condition: file-write-error
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valuefile-write-error
Condition: format-not-supported
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valueformat-not-supported
Condition: illegal-file-value
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valueillegal-file-value
Condition: illegal-operation
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valueillegal-operation
Condition: internal-error
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valueinternal-error
Condition: invalid-conversion
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valueinvalid-conversion
Condition: invalid-enum
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valueinvalid-enum
Condition: invalid-extension
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valueinvalid-extension
Condition: invalid-file-header
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valueinvalid-file-header
Condition: invalid-param
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valueinvalid-param
Condition: invalid-value
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valueinvalid-value
Condition: lib-gif-error
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valuelib-gif-error
Condition: lib-jpeg-error
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valuelib-jpeg-error
Condition: lib-mng-error
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valuelib-mng-error
Condition: lib-png-error
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valuelib-png-error
Condition: lib-tiff-error
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valuelib-tiff-error
Condition: no-error
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valueno-error
Condition: out-format-same
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valueout-format-same
Condition: out-of-memory
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valueout-of-memory
Condition: stack-overflow
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valuestack-overflow
Condition: stack-underflow
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valuestack-underflow
Condition: unknown-error
Package

cl-devil.

Source

il.lisp.

Direct superclasses

error.

Direct Default Initargs
InitargValue
:enum-valueunknown-error

5.2 Internals


5.2.1 Macros

Macro: define-deprecated-image-fun (deprecated new)
Package

cl-devil.

Source

utilities.lisp.


5.2.2 Ordinary functions

Function: %blit (source dest-x dest-y dest-z src-x src-y src-z width height depth)
Package

cl-devil.

Source

il.lisp.

Function: %clear-image ()
Package

cl-devil.

Source

il.lisp.

Function: %convert-image (format type)
Package

cl-devil.

Source

il.lisp.

Function: %copy-image (source)
Package

cl-devil.

Source

il.lisp.

Function: %delete-images (num images)
Package

cl-devil.

Source

il.lisp.

Function: %disable (mode)
Package

cl-devil.

Source

il.lisp.

Function: %enable (mode)
Package

cl-devil.

Source

il.lisp.

Function: %flip-image ()
Package

cl-devil.

Source

il.lisp.

Function: %gen-images (num images)
Package

cl-devil.

Source

il.lisp.

Function: %is-enabled (mode)
Package

cl-devil.

Source

il.lisp.

Function: %load (type file-name)
Package

cl-devil.

Source

il.lisp.

Function: %load-f (type file)
Package

cl-devil.

Source

il.lisp.

Function: %load-image (file-name)
Package

cl-devil.

Source

il.lisp.

Function: %load-l (type lump size)
Package

cl-devil.

Source

il.lisp.

Function: %overlay-image (source x-coord y-coord z-coord)
Package

cl-devil.

Source

il.lisp.

Function: %save (type file-name)
Package

cl-devil.

Source

il.lisp.

Function: %save-f (type file)
Package

cl-devil.

Source

il.lisp.

Function: %save-image (file-name)
Package

cl-devil.

Source

il.lisp.

Function: %save-l (type lump size)
Package

cl-devil.

Source

il.lisp.

Function: %tex-image (width height depth bpp format type data)
Package

cl-devil.

Source

il.lisp.

Function: get-error ()
Package

cl-devil.

Source

il.lisp.


5.2.3 Generic functions

Generic Reader: enum-value (condition)
Package

cl-devil.

Methods
Reader Method: enum-value ((condition error))
Source

il.lisp.

Target Slot

enum-value.


5.2.4 Classes

Class: pathname-string-type
Package

cl-devil.

Source

il.lisp.

Direct superclasses

enhanced-foreign-type.

Direct methods

expand-to-foreign-dyn.

Direct Default Initargs
InitargValue
:actual-type(quote (string))

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %  
B   C   D   E   F   G   H   I   K   L   M   O   P   R   S   T   W  
Index Entry  Section

%
%blit: Private ordinary functions
%clear-image: Private ordinary functions
%convert-image: Private ordinary functions
%copy-image: Private ordinary functions
%delete-images: Private ordinary functions
%disable: Private ordinary functions
%enable: Private ordinary functions
%flip-image: Private ordinary functions
%gen-images: Private ordinary functions
%is-enabled: Private ordinary functions
%load: Private ordinary functions
%load-f: Private ordinary functions
%load-image: Private ordinary functions
%load-l: Private ordinary functions
%overlay-image: Private ordinary functions
%save: Private ordinary functions
%save-f: Private ordinary functions
%save-image: Private ordinary functions
%save-l: Private ordinary functions
%tex-image: Private ordinary functions

B
bind-image: Public ordinary functions
blit: Public ordinary functions
bytes-per-pixel-of: Public compiler macros
bytes-per-pixel-of: Public ordinary functions

C
check-error: Public ordinary functions
clear-colour: Public ordinary functions
clear-image: Public ordinary functions
Compiler Macro, bytes-per-pixel-of: Public compiler macros
Compiler Macro, element-type-of: Public compiler macros
Compiler Macro, height-of: Public compiler macros
Compiler Macro, pixel-format-of: Public compiler macros
Compiler Macro, width-of: Public compiler macros
convert-image: Public ordinary functions
copy-image: Public ordinary functions
copy-palette: Public ordinary functions
copy-pixels: Public ordinary functions

D
deferrwrap: Public macros
define-deprecated-image-fun: Private macros
delete-images: Public ordinary functions
determine-type: Public ordinary functions
disable: Public ordinary functions

E
element-type-of: Public compiler macros
element-type-of: Public ordinary functions
enable: Public ordinary functions
enabledp: Public ordinary functions
enum-value: Private generic functions
enum-value: Private generic functions
error-condition: Public ordinary functions
expand-to-foreign-dyn: Public standalone methods

F
flip-image: Public ordinary functions
Function, %blit: Private ordinary functions
Function, %clear-image: Private ordinary functions
Function, %convert-image: Private ordinary functions
Function, %copy-image: Private ordinary functions
Function, %delete-images: Private ordinary functions
Function, %disable: Private ordinary functions
Function, %enable: Private ordinary functions
Function, %flip-image: Private ordinary functions
Function, %gen-images: Private ordinary functions
Function, %is-enabled: Private ordinary functions
Function, %load: Private ordinary functions
Function, %load-f: Private ordinary functions
Function, %load-image: Private ordinary functions
Function, %load-l: Private ordinary functions
Function, %overlay-image: Private ordinary functions
Function, %save: Private ordinary functions
Function, %save-f: Private ordinary functions
Function, %save-image: Private ordinary functions
Function, %save-l: Private ordinary functions
Function, %tex-image: Private ordinary functions
Function, bind-image: Public ordinary functions
Function, blit: Public ordinary functions
Function, bytes-per-pixel-of: Public ordinary functions
Function, check-error: Public ordinary functions
Function, clear-colour: Public ordinary functions
Function, clear-image: Public ordinary functions
Function, convert-image: Public ordinary functions
Function, copy-image: Public ordinary functions
Function, copy-palette: Public ordinary functions
Function, copy-pixels: Public ordinary functions
Function, delete-images: Public ordinary functions
Function, determine-type: Public ordinary functions
Function, disable: Public ordinary functions
Function, element-type-of: Public ordinary functions
Function, enable: Public ordinary functions
Function, enabledp: Public ordinary functions
Function, error-condition: Public ordinary functions
Function, flip-image: Public ordinary functions
Function, gen-image: Public ordinary functions
Function, gen-images: Public ordinary functions
Function, get-data: Public ordinary functions
Function, get-error: Private ordinary functions
Function, get-integer: Public ordinary functions
Function, get-palette: Public ordinary functions
Function, height-of: Public ordinary functions
Function, image-bits-per-pixel: Public ordinary functions
Function, image-bytes-per-pixel: Public ordinary functions
Function, image-format: Public ordinary functions
Function, image-height: Public ordinary functions
Function, image-origin: Public ordinary functions
Function, image-type: Public ordinary functions
Function, image-width: Public ordinary functions
Function, init: Public ordinary functions
Function, key-color: Public ordinary functions
Function, load: Public ordinary functions
Function, load-f: Public ordinary functions
Function, load-image: Public ordinary functions
Function, load-l: Public ordinary functions
Function, origin-func: Public ordinary functions
Function, overlay-image: Public ordinary functions
Function, pixel-format-of: Public ordinary functions
Function, register-palette: Public ordinary functions
Function, save: Public ordinary functions
Function, save-f: Public ordinary functions
Function, save-image: Public ordinary functions
Function, save-l: Public ordinary functions
Function, set-data: Public ordinary functions
Function, set-integer: Public ordinary functions
Function, set-pixels: Public ordinary functions
Function, shutdown: Public ordinary functions
Function, tex-image: Public ordinary functions
Function, width-of: Public ordinary functions

G
gen-image: Public ordinary functions
gen-images: Public ordinary functions
Generic Function, enum-value: Private generic functions
get-data: Public ordinary functions
get-error: Private ordinary functions
get-integer: Public ordinary functions
get-palette: Public ordinary functions

H
height-of: Public compiler macros
height-of: Public ordinary functions

I
image-bits-per-pixel: Public ordinary functions
image-bytes-per-pixel: Public ordinary functions
image-format: Public ordinary functions
image-height: Public ordinary functions
image-origin: Public ordinary functions
image-type: Public ordinary functions
image-width: Public ordinary functions
init: Public ordinary functions

K
key-color: Public ordinary functions

L
load: Public ordinary functions
load-f: Public ordinary functions
load-image: Public ordinary functions
load-l: Public ordinary functions

M
Macro, deferrwrap: Public macros
Macro, define-deprecated-image-fun: Private macros
Macro, maybe-error: Public macros
Macro, with-bound-image: Public macros
Macro, with-images: Public macros
Macro, with-init: Public macros
maybe-error: Public macros
Method, enum-value: Private generic functions
Method, expand-to-foreign-dyn: Public standalone methods

O
origin-func: Public ordinary functions
overlay-image: Public ordinary functions

P
pixel-format-of: Public compiler macros
pixel-format-of: Public ordinary functions

R
register-palette: Public ordinary functions

S
save: Public ordinary functions
save-f: Public ordinary functions
save-image: Public ordinary functions
save-l: Public ordinary functions
set-data: Public ordinary functions
set-integer: Public ordinary functions
set-pixels: Public ordinary functions
shutdown: Public ordinary functions

T
tex-image: Public ordinary functions

W
width-of: Public compiler macros
width-of: Public ordinary functions
with-bound-image: Public macros
with-images: Public macros
with-init: Public macros


A.3 Variables

Jump to:   E   S  
Index Entry  Section

E
enum-value: Public conditions

S
Slot, enum-value: Public conditions


A.4 Data types

Jump to:   %  
B   C   E   F   I   L   N   O   P   S   U  
Index Entry  Section

%
%cl-devil-internal: The %cl-devil-internal package

B
bad-dimensions: Public conditions

C
cl-devil: The cl-devil system
cl-devil: The cl-devil package
cl-devil.asd: The cl-devil/cl-devil․asd file
Class, pathname-string-type: Private classes
Condition, bad-dimensions: Public conditions
Condition, could-not-open-file: Public conditions
Condition, error: Public conditions
Condition, file-already-exists: Public conditions
Condition, file-read-error: Public conditions
Condition, file-write-error: Public conditions
Condition, format-not-supported: Public conditions
Condition, illegal-file-value: Public conditions
Condition, illegal-operation: Public conditions
Condition, internal-error: Public conditions
Condition, invalid-conversion: Public conditions
Condition, invalid-enum: Public conditions
Condition, invalid-extension: Public conditions
Condition, invalid-file-header: Public conditions
Condition, invalid-param: Public conditions
Condition, invalid-value: Public conditions
Condition, lib-gif-error: Public conditions
Condition, lib-jpeg-error: Public conditions
Condition, lib-mng-error: Public conditions
Condition, lib-png-error: Public conditions
Condition, lib-tiff-error: Public conditions
Condition, no-error: Public conditions
Condition, out-format-same: Public conditions
Condition, out-of-memory: Public conditions
Condition, stack-overflow: Public conditions
Condition, stack-underflow: Public conditions
Condition, unknown-error: Public conditions
could-not-open-file: Public conditions

E
error: Public conditions

F
File, cl-devil.asd: The cl-devil/cl-devil․asd file
File, il.lisp: The cl-devil/il․lisp file
File, internal.lisp: The cl-devil/internal․lisp file
File, package.lisp: The cl-devil/package․lisp file
File, utilities.lisp: The cl-devil/utilities․lisp file
file-already-exists: Public conditions
file-read-error: Public conditions
file-write-error: Public conditions
format-not-supported: Public conditions

I
il.lisp: The cl-devil/il․lisp file
illegal-file-value: Public conditions
illegal-operation: Public conditions
internal-error: Public conditions
internal.lisp: The cl-devil/internal․lisp file
invalid-conversion: Public conditions
invalid-enum: Public conditions
invalid-extension: Public conditions
invalid-file-header: Public conditions
invalid-param: Public conditions
invalid-value: Public conditions

L
lib-gif-error: Public conditions
lib-jpeg-error: Public conditions
lib-mng-error: Public conditions
lib-png-error: Public conditions
lib-tiff-error: Public conditions

N
no-error: Public conditions

O
out-format-same: Public conditions
out-of-memory: Public conditions

P
Package, %cl-devil-internal: The %cl-devil-internal package
Package, cl-devil: The cl-devil package
package.lisp: The cl-devil/package․lisp file
pathname-string-type: Private classes

S
stack-overflow: Public conditions
stack-underflow: Public conditions
System, cl-devil: The cl-devil system

U
unknown-error: Public conditions
utilities.lisp: The cl-devil/utilities․lisp file