The imago Reference Manual

Table of Contents

The imago Reference Manual

This is the imago Reference Manual, version 0.9.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 11:21:31 2020 GMT+0.

1 Systems

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

1.1 imago

Author

Matthieu Villeneuve <matthieu.villeneuve@free.fr>

License

LLGPL

Description

Image manipulation library

Version

0.9.0

Dependency

zlib

Source

imago.asd (file)

Components

• package.lisp (file)
• utilities.lisp (file)
• color.lisp (file)
• image.lisp (file)
• image-utilities.lisp (file)
• crc32.lisp (file)
• drawing.lisp (file)
• convert.lisp (file)
• convolve.lisp (file)
• compose.lisp (file)
• operations.lisp (file)
• file.lisp (file)
• file-png.lisp (file)
• file-pnm.lisp (file)
• file-tga.lisp (file)
• file-pcx.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 imago.asd

Location

imago.asd

Systems

imago (system)

2.1.2 imago/package.lisp

Parent

imago (system)

Location

package.lisp

Packages

imago

2.1.3 imago/utilities.lisp

Dependency

package.lisp (file)

Parent

imago (system)

Location

utilities.lisp

Internal Definitions

• best-in-array (function)
• limit-value (function)
• read-array-element (macro)
• read-byte-array (function)
• read-integer-as-text (function)
• read-lsb-integer (function)
• read-msb-integer (function)
• read-number (function)
• skip-bytes (function)
• skip-line (function)
• skip-whitespace-and-comments (function)
• square (function)
• with-gensyms (macro)
• write-integer-as-text (function)
• write-lsb-integer (function)
• write-msb-integer (function)

2.1.4 imago/color.lisp

Dependency

package.lisp (file)

Parent

imago (system)

Location

color.lisp

Exported Definitions

• +black+ (special variable)
• +blue+ (special variable)
• +cyan+ (special variable)
• +green+ (special variable)
• +magenta+ (special variable)
• +red+ (special variable)
• +white+ (special variable)
• +yellow+ (special variable)
• color-alpha (function)
• color-argb (function)
• color-blue (function)
• color-green (function)
• color-intensity (function)
• color-red (function)
• color-rgb (function)
• gray-alpha (function)
• gray-intensity (function)
• grayscale-pixel (type)
• indexed-pixel (type)
• invert-color (function)
• invert-gray (function)
• make-color (function)
• make-gray (function)
• planar-pixel (type)
• rgb-pixel (type)

Internal Definitions

• closest-colortable-entry (function)
• make-simple-gray-colormap (function)

2.1.5 imago/image.lisp

Dependency

package.lisp (file)

Parent

imago (system)

Location

image.lisp

Exported Definitions

• grayscale-image (class)
• image (class)
• image-colormap (method)
• image-colormap (method)
• image-height (generic function)
• image-height (method)
• image-pixel (generic function)
• image-pixel (method)
• (setf image-pixel) (method)
• (setf image-pixel) (generic function)
• image-pixels (generic function)
• image-pixels (method)
• image-pixels (method)
• image-pixels (method)
• image-pixels (method)
• image-plane-count (method)
• image-width (generic function)
• image-width (method)
• indexed-image (class)
• planar-image (class)
• rgb-image (class)

Internal Definitions

• pixel-size (generic function)
• pixel-size (method)
• pixel-size (method)
• pixel-size (method)
• pixel-size (method)

2.1.6 imago/image-utilities.lisp

Dependencies

• image.lisp (file)
• color.lisp (file)
• utilities.lisp (file)

Parent

imago (system)

Location

image-utilities.lisp

Exported Definitions

• do-image-pixels (macro)
• do-line-pixels (macro)
• do-region-pixels (macro)
• set-alpha (generic function)
• set-alpha (method)
• set-alpha (method)
• set-alpha (method)
• with-image-definition (macro)

Internal Definitions

• images-same-dimensions-p (function)
• images-same-type-p (function)
• in-image-p (function)
• in-region-p (function)
• make-similar-image (generic function)
• make-similar-image (method)

2.1.7 imago/crc32.lisp

Dependency

package.lisp (file)

Parent

imago (system)

Location

crc32.lisp

Internal Definitions

• +crc32-table+ (special variable)
• crc32 (function)
• update-crc32 (function)

2.1.8 imago/drawing.lisp

Dependencies

• image-utilities.lisp (file)
• color.lisp (file)

Parent

imago (system)

Location

drawing.lisp

Exported Definitions

• draw-bezier-curve (function)
• draw-circle (function)
• draw-line (function)
• draw-polygon (function)
• draw-rectangle (function)

Internal Definitions

draw-point (function)

2.1.9 imago/convert.lisp

Dependencies

• image.lisp (file)
• color.lisp (file)

Parent

imago (system)

Location

convert.lisp

Exported Definitions

• convert-to-grayscale (generic function)
• convert-to-grayscale (method)
• convert-to-grayscale (method)
• convert-to-indexed (generic function)
• convert-to-indexed (method)
• convert-to-indexed (method)
• convert-to-planar (generic function)
• convert-to-planar (method)
• convert-to-rgb (generic function)
• convert-to-rgb (method)
• convert-to-rgb (method)

2.1.10 imago/convolve.lisp

Dependencies

• image.lisp (file)
• color.lisp (file)

Parent

imago (system)

Location

convolve.lisp

Exported Definitions

• blur (function)
• convolve (generic function)
• convolve (method)
• convolve (method)
• edge-detect (function)
• emboss (function)
• sharpen (function)

Internal Definitions

+emboss-matrix-cell-angles+ (special variable)

2.1.11 imago/compose.lisp

Dependencies

• image.lisp (file)
• color.lisp (file)

Parent

imago (system)

Location

compose.lisp

Exported Definitions

• compose (generic function)
• compose (method)
• compose (method)

Internal Definitions

• default-compose-operator (generic function)
• default-compose-operator (method)

2.1.12 imago/operations.lisp

Dependencies

• image.lisp (file)
• color.lisp (file)

Parent

imago (system)

Location

operations.lisp

Exported Definitions

• copy (generic function)
• copy (method)
• copy (method)
• copy (method)
• copy (method)
• flip (generic function)
• flip (method)
• flip (method)
• flip (method)
• resize (generic function)
• resize (method)
• scale (generic function)
• scale (method)

2.1.13 imago/file.lisp

Dependency

package.lisp (file)

Parent

imago (system)

Location

file.lisp

Exported Definitions

• read-image (function)
• register-image-reader (function)

Internal Definitions

*image-file-readers* (special variable)

2.1.14 imago/file-png.lisp

Dependencies

• image.lisp (file)
• color.lisp (file)
• crc32.lisp (file)
• file.lisp (file)

Parent

imago (system)

Location

file-png.lisp

Exported Definitions

• read-png (function)
• write-png (function)

Internal Definitions

• +png-idat-chunk-type+ (special variable)
• +png-iend-chunk-type+ (special variable)
• +png-ihdr-chunk-type+ (special variable)
• +png-plte-chunk-type+ (special variable)
• +png-signature+ (special variable)
• copy-png-descriptor (function)
• decode-png-colormap (function)
• decode-png-descriptor (function)
• decode-png-image (function)
• image-png-color-type (generic function)
• image-png-color-type (method)
• image-png-color-type (method)
• image-png-color-type (method)
• make-png-descriptor (function)
• png-descriptor (structure)
• png-descriptor-color-type (function)
• (setf png-descriptor-color-type) (function)
• png-descriptor-compression-method (function)
• (setf png-descriptor-compression-method) (function)
• png-descriptor-depth (function)
• (setf png-descriptor-depth) (function)
• png-descriptor-filter-method (function)
• (setf png-descriptor-filter-method) (function)
• png-descriptor-height (function)
• (setf png-descriptor-height) (function)
• png-descriptor-interlace-method (function)
• (setf png-descriptor-interlace-method) (function)
• png-descriptor-p (function)
• png-descriptor-width (function)
• (setf png-descriptor-width) (function)
• png-paeth (function)
• png-samples-per-pixel (function)
• read-png-chunk (function)
• read-png-sample (function)
• read-png-signature (function)
• write-png-chunk (function)
• write-png-colormap-chunk (generic function)
• write-png-colormap-chunk (method)
• write-png-colormap-chunk (method)
• write-png-data-chunk (function)
• write-png-end-chunk (function)
• write-png-header-chunk (function)
• write-png-pixel-bytes (generic function)
• write-png-pixel-bytes (method)
• write-png-pixel-bytes (method)
• write-png-pixel-bytes (method)
• write-png-signature (function)

2.1.15 imago/file-pnm.lisp

Dependencies

• image.lisp (file)
• color.lisp (file)
• file.lisp (file)

Parent

imago (system)

Location

file-pnm.lisp

Exported Definitions

• read-pnm (function)
• write-pnm (function)

Internal Definitions

• +pnm-image-makers+ (special variable)
• +pnm-pixel-readers+ (special variable)
• read-ascii-rgb-pixel (function)
• read-bin-rgb-pixel (function)
• read-number2 (function)
• read-pnm-from-stream (function)
• read-pnm-info (function)
• with-write-pnm-loop (macro)
• write-pnm-to-stream (generic function)
• write-pnm-to-stream (method)
• write-pnm-to-stream (method)
• write-pnm-to-stream (method)
• write-pnm-to-stream (method)
• write-pnm-to-stream (method)
• write-pnm-to-stream (method)

2.1.16 imago/file-tga.lisp

Dependencies

• image.lisp (file)
• color.lisp (file)
• file.lisp (file)

Parent

imago (system)

Location

file-tga.lisp

Exported Definitions

• read-tga (function)
• write-tga (function)

Internal Definitions

• read-tga-color (function)
• read-tga-color-index (function)
• read-tga-colormap (function)
• read-tga-data (function)
• write-tga-data (function)
• write-tga-to-stream (generic function)
• write-tga-to-stream (method)
• write-tga-to-stream (method)

2.1.17 imago/file-pcx.lisp

Dependencies

• image.lisp (file)
• color.lisp (file)
• file.lisp (file)

Parent

imago (system)

Location

file-pcx.lisp

Exported Definitions

• read-pcx (function)
• write-pcx (function)

Internal Definitions

• colormap->pcx-ega-palette (function)
• fill-pcx-scanline-buffer (function)
• pcx-ega-palette->colormap (function)
• read-pcx-data (function)
• read-pcx-vga-palette (function)
• write-pcx-body (function)

3 Packages

Packages are listed by definition order.

3.1 imago

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• +black+ (special variable)
• +blue+ (special variable)
• +cyan+ (special variable)
• +green+ (special variable)
• +magenta+ (special variable)
• +red+ (special variable)
• +white+ (special variable)
• +yellow+ (special variable)
• blur (function)
• color-alpha (function)
• color-argb (function)
• color-blue (function)
• color-green (function)
• color-intensity (function)
• color-red (function)
• color-rgb (function)
• compose (generic function)
• compose (method)
• compose (method)
• convert-to-grayscale (generic function)
• convert-to-grayscale (method)
• convert-to-grayscale (method)
• convert-to-indexed (generic function)
• convert-to-indexed (method)
• convert-to-indexed (method)
• convert-to-planar (generic function)
• convert-to-planar (method)
• convert-to-rgb (generic function)
• convert-to-rgb (method)
• convert-to-rgb (method)
• convolve (generic function)
• convolve (method)
• convolve (method)
• copy (generic function)
• copy (method)
• copy (method)
• copy (method)
• copy (method)
• do-image-pixels (macro)
• do-line-pixels (macro)
• do-region-pixels (macro)
• draw-bezier-curve (function)
• draw-circle (function)
• draw-line (function)
• draw-polygon (function)
• draw-rectangle (function)
• edge-detect (function)
• emboss (function)
• flip (generic function)
• flip (method)
• flip (method)
• flip (method)
• gray-alpha (function)
• gray-intensity (function)
• grayscale-image (class)
• grayscale-pixel (type)
• image (class)
• image-colormap (generic function)
• image-colormap (method)
• image-colormap (method)
• image-height (generic function)
• image-height (method)
• image-pixel (generic function)
• image-pixel (method)
• (setf image-pixel) (method)
• (setf image-pixel) (generic function)
• image-pixels (generic function)
• image-pixels (method)
• image-pixels (method)
• image-pixels (method)
• image-pixels (method)
• image-plane-count (generic function)
• image-plane-count (method)
• image-width (generic function)
• image-width (method)
• indexed-image (class)
• indexed-pixel (type)
• invert-color (function)
• invert-gray (function)
• make-color (function)
• make-gray (function)
• planar-image (class)
• planar-pixel (type)
• read-image (function)
• read-pcx (function)
• read-png (function)
• read-pnm (function)
• read-tga (function)
• register-image-reader (function)
• resize (generic function)
• resize (method)
• rgb-image (class)
• rgb-pixel (type)
• scale (generic function)
• scale (method)
• set-alpha (generic function)
• set-alpha (method)
• set-alpha (method)
• set-alpha (method)
• sharpen (function)
• with-image-definition (macro)
• write-pcx (function)
• write-png (function)
• write-pnm (function)
• write-tga (function)

Internal Definitions

• *image-file-readers* (special variable)
• +crc32-table+ (special variable)
• +emboss-matrix-cell-angles+ (special variable)
• +png-idat-chunk-type+ (special variable)
• +png-iend-chunk-type+ (special variable)
• +png-ihdr-chunk-type+ (special variable)
• +png-plte-chunk-type+ (special variable)
• +png-signature+ (special variable)
• +pnm-image-makers+ (special variable)
• +pnm-pixel-readers+ (special variable)
• best-in-array (function)
• closest-colortable-entry (function)
• colormap->pcx-ega-palette (function)
• copy-png-descriptor (function)
• crc32 (function)
• decode-png-colormap (function)
• decode-png-descriptor (function)
• decode-png-image (function)
• default-compose-operator (generic function)
• default-compose-operator (method)
• draw-point (function)
• fill-pcx-scanline-buffer (function)
• image-png-color-type (generic function)
• image-png-color-type (method)
• image-png-color-type (method)
• image-png-color-type (method)
• images-same-dimensions-p (function)
• images-same-type-p (function)
• in-image-p (function)
• in-region-p (function)
• limit-value (function)
• make-png-descriptor (function)
• make-similar-image (generic function)
• make-similar-image (method)
• make-simple-gray-colormap (function)
• pcx-ega-palette->colormap (function)
• pixel-size (generic function)
• pixel-size (method)
• pixel-size (method)
• pixel-size (method)
• pixel-size (method)
• png-descriptor (structure)
• png-descriptor-color-type (function)
• (setf png-descriptor-color-type) (function)
• png-descriptor-compression-method (function)
• (setf png-descriptor-compression-method) (function)
• png-descriptor-depth (function)
• (setf png-descriptor-depth) (function)
• png-descriptor-filter-method (function)
• (setf png-descriptor-filter-method) (function)
• png-descriptor-height (function)
• (setf png-descriptor-height) (function)
• png-descriptor-interlace-method (function)
• (setf png-descriptor-interlace-method) (function)
• png-descriptor-p (function)
• png-descriptor-width (function)
• (setf png-descriptor-width) (function)
• png-paeth (function)
• png-samples-per-pixel (function)
• read-array-element (macro)
• read-ascii-rgb-pixel (function)
• read-bin-rgb-pixel (function)
• read-byte-array (function)
• read-integer-as-text (function)
• read-lsb-integer (function)
• read-msb-integer (function)
• read-number (function)
• read-number2 (function)
• read-pcx-data (function)
• read-pcx-vga-palette (function)
• read-png-chunk (function)
• read-png-sample (function)
• read-png-signature (function)
• read-pnm-from-stream (function)
• read-pnm-info (function)
• read-tga-color (function)
• read-tga-color-index (function)
• read-tga-colormap (function)
• read-tga-data (function)
• skip-bytes (function)
• skip-line (function)
• skip-whitespace-and-comments (function)
• square (function)
• update-crc32 (function)
• with-gensyms (macro)
• with-write-pnm-loop (macro)
• write-integer-as-text (function)
• write-lsb-integer (function)
• write-msb-integer (function)
• write-pcx-body (function)
• write-png-chunk (function)
• write-png-colormap-chunk (generic function)
• write-png-colormap-chunk (method)
• write-png-colormap-chunk (method)
• write-png-data-chunk (function)
• write-png-end-chunk (function)
• write-png-header-chunk (function)
• write-png-pixel-bytes (generic function)
• write-png-pixel-bytes (method)
• write-png-pixel-bytes (method)
• write-png-pixel-bytes (method)
• write-png-signature (function)
• write-pnm-to-stream (generic function)
• write-pnm-to-stream (method)
• write-pnm-to-stream (method)
• write-pnm-to-stream (method)
• write-pnm-to-stream (method)
• write-pnm-to-stream (method)
• write-pnm-to-stream (method)
• write-tga-data (function)
• write-tga-to-stream (generic function)
• write-tga-to-stream (method)
• write-tga-to-stream (method)

4 Definitions

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

4.1 Exported definitions

4.1.1 Special variables

Special Variable: +black+

Package

imago

Source

color.lisp (file)

Special Variable: +blue+

Package

imago

Source

color.lisp (file)

Special Variable: +cyan+

Package

imago

Source

color.lisp (file)

Special Variable: +green+

Package

imago

Source

color.lisp (file)

Special Variable: +magenta+

Package

imago

Source

color.lisp (file)

Special Variable: +red+

Package

imago

Source

color.lisp (file)

Special Variable: +white+

Package

imago

Source

color.lisp (file)

Special Variable: +yellow+

Package

imago

Source

color.lisp (file)

4.1.2 Macros

Macro: do-image-pixels (IMAGE COLOR X Y) &body BODY

Iterates through all pixels of an image. For each pixel, X and Y are bound to the pixel coordinates, and COLOR is a generalized variable corresponding to the pixel color.

Package

imago

Source

image-utilities.lisp (file)

Macro: do-line-pixels (IMAGE COLOR X Y X1 Y1 X2 Y2) &body BODY

Iterates through all pixels of a line segment in an image, corresponding to the X1, Y1, X2 and Y2 parameters. For each pixel, X and Y are bound to the pixel coordinates, and COLOR is a generalized variable corresponding to the pixel color.

Package

imago

Source

image-utilities.lisp (file)

Macro: do-region-pixels (IMAGE COLOR X Y REGION-X REGION-Y REGION-WIDTH REGION-HEIGHT) &body BODY

Iterates through all pixels of a rectangular region in an image.
For each pixel, X and Y are bound to the pixel coordinates, and COLOR is a generalized variable corresponding to the pixel color.

Package

imago

Source

image-utilities.lisp (file)

Macro: with-image-definition (IMAGE WIDTH HEIGHT PIXELS) &body BODY

Binds the WIDTH, HEIGHT and PIXELS variables to the values corresponding to IMAGE, then evaluates the body.

Package

imago

Source

image-utilities.lisp (file)

4.1.3 Functions

Function: blur IMAGE

Package

imago

Source

convolve.lisp (file)

Function: color-alpha COLOR

Package

imago

Source

color.lisp (file)

Function: color-argb COLOR

Package

imago

Source

color.lisp (file)

Function: color-blue COLOR

Package

imago

Source

color.lisp (file)

Function: color-green COLOR

Package

imago

Source

color.lisp (file)

Function: color-intensity COLOR

Package

imago

Source

color.lisp (file)

Function: color-red COLOR

Package

imago

Source

color.lisp (file)

Function: color-rgb COLOR

Package

imago

Source

color.lisp (file)

Function: draw-bezier-curve IMAGE X1 Y1 X2 Y2 X3 Y3 X4 Y4 COLOR

Draws a cublic Bezier curve defined by a starting point, two control points, and an end point, in an image.

Package

imago

Source

drawing.lisp (file)

Function: draw-circle IMAGE CENTER-X CENTER-Y RADIUS COLOR

Draws a circle in an image.

Package

imago

Source

drawing.lisp (file)

Function: draw-line IMAGE X1 Y1 X2 Y2 COLOR &key DASH-LENGTH DASH-INTERVAL

Draws a line between two points in an image.

Package

imago

Source

drawing.lisp (file)

Function: draw-polygon IMAGE COORD-LIST COLOR &key CLOSED DASH-LENGTH DASH-INTERVAL

Draws a polygon in an image.

Package

imago

Source

drawing.lisp (file)

Function: draw-rectangle IMAGE X1 Y1 WIDTH HEIGHT COLOR &key DASH-LENGTH DASH-INTERVAL

Draws a rectangle in an image.

Package

imago

Source

drawing.lisp (file)

Function: edge-detect IMAGE

Package

imago

Source

convolve.lisp (file)

Function: emboss IMAGE &key ANGLE DEPTH

Package

imago

Source

convolve.lisp (file)

Function: gray-alpha GRAY

Package

imago

Source

color.lisp (file)

Function: gray-intensity GRAY

Package

imago

Source

color.lisp (file)

Function: invert-color COLOR

Package

imago

Source

color.lisp (file)

Function: invert-gray GRAY

Package

imago

Source

color.lisp (file)

Function: make-color R G B &optional ALPHA

Package

imago

Source

color.lisp (file)

Function: make-gray INTENSITY &optional ALPHA

Package

imago

Source

color.lisp (file)

Function: read-image FILENAME &key ERRORP

Reads an image from a file. If the file format is not recognized, depending on the value of :ERRORP, either throws an error or returns NIL.

Package

imago

Source

file.lisp (file)

Function: read-pcx FILESPEC

Package

imago

Source

file-pcx.lisp (file)

Function: read-png FILESPEC

Package

imago

Source

file-png.lisp (file)

Function: read-pnm FILESPEC

Reads data for an image in PNM format from a file, and returns a newly created image correponding to those data.

Package

imago

Source

file-pnm.lisp (file)

Function: read-tga FILESPEC

Package

imago

Source

file-tga.lisp (file)

Function: register-image-reader EXTENSIONS FUNCTION

Register a reader function for some file extensions. The FUNCTION must take a FILESPEC as argument, and return an IMAGE.

Package

imago

Source

file.lisp (file)

Function: sharpen IMAGE

Package

imago

Source

convolve.lisp (file)

Function: write-pcx IMAGE FILESPEC &key MAX-RUN-LENGTH EVEN-SCANLINE-LENGTHS-P

Write the given IMAGE to a Z-Soft PCX 3.0 format file named by FILESPEC.

MAX-RUN-LENGTH => The longest run the PCX encoder will output. This can be as large as 63 (the default), but to support old and broken decoders, it should be set to 15. I’ve never seen a decoder so broken that it won’t read >15 byte runs, but they do exist, so the option is here.

EVEN-SCANLINE-LENGTHS-P => When set, will pad scanlines so that they are an even length. Supposedly there are decoders that want this behavior, but it’s not necessary for most decoders.

Package

imago

Source

file-pcx.lisp (file)

Function: write-png IMAGE FILESPEC

Package

imago

Source

file-png.lisp (file)

Function: write-pnm IMAGE FILESPEC OUTPUT-FORMAT

Writes the image data to a file in PNM format. OUTPUT-FORMAT can be either :ASCII or :BINARY.

Package

imago

Source

file-pnm.lisp (file)

Function: write-tga IMAGE FILESPEC &key TOP-DOWN-P

Package

imago

Source

file-tga.lisp (file)

4.1.4 Generic functions

Generic Function: compose DEST IMAGE1 IMAGE2 X Y OPERATOR

Composes IMAGE1 and IMAGE2 at offset (X, Y), using
OPERATOR to compose each pixel. OPERATOR must be a function of two colors, returning a color.

Package

imago

Source

compose.lisp (file)

Methods

Method: compose (DEST image) (IMAGE1 image) (IMAGE2 image) X Y OPERATOR

Method: compose (DEST (eql nil)) (IMAGE1 image) (IMAGE2 image) X Y OPERATOR

Generic Function: convert-to-grayscale IMAGE

Package

imago

Source

convert.lisp (file)

Methods

Method: convert-to-grayscale (IMAGE indexed-image)

Method: convert-to-grayscale (IMAGE rgb-image)

Generic Function: convert-to-indexed IMAGE

Package

imago

Source

convert.lisp (file)

Methods

Method: convert-to-indexed (IMAGE grayscale-image)

Method: convert-to-indexed (IMAGE rgb-image)

Generic Function: convert-to-planar IMAGE

Package

imago

Source

convert.lisp (file)

Methods

Method: convert-to-planar (IMAGE image)

Generic Function: convert-to-rgb IMAGE

Package

imago

Source

convert.lisp (file)

Methods

Method: convert-to-rgb (IMAGE grayscale-image)

Method: convert-to-rgb (IMAGE indexed-image)

Generic Function: convolve IMAGE MATRIX DIVISOR OFFSET

Applies a 5x5 convolution kernel (a 5x5 real number matrix) to an image. Returns the resulting image.

Package

imago

Source

convolve.lisp (file)

Methods

Method: convolve (IMAGE grayscale-image) MATRIX DIVISOR OFFSET

Method: convolve (IMAGE rgb-image) MATRIX DIVISOR OFFSET

Generic Function: copy DEST SRC &key DEST-X DEST-Y SRC-X SRC-Y WIDTH HEIGHT

Copies a rectangular region from image SRC to image DEST.
Both images must be large enough to contain the specified region at the given positions. Both images must be of same type.

Package

imago

Source

operations.lisp (file)

Methods

Method: copy (DEST image) (SRC image) &key DEST-X DEST-Y SRC-X SRC-Y WIDTH HEIGHT

Method: copy (DEST (eql nil)) (SRC planar-image) &key DEST-X DEST-Y SRC-X SRC-Y WIDTH HEIGHT

Method: copy (DEST (eql nil)) (SRC indexed-image) &key DEST-X DEST-Y SRC-X SRC-Y WIDTH HEIGHT around

Method: copy (DEST (eql nil)) (SRC image) &key DEST-X DEST-Y SRC-X SRC-Y WIDTH HEIGHT

Generic Function: flip DEST IMAGE AXIS

Flips an image. AXIS may be either :HORIZONTAL or
:VERTICAL. DEST must be either an image of same type and dimensions as IMAGE, or NIL. Returns the resulting image.

Package

imago

Source

operations.lisp (file)

Methods

Method: flip (DEST image) (IMAGE image) (AXIS (eql vertical))

Method: flip (DEST image) (IMAGE image) (AXIS (eql horizontal))

Method: flip (DEST (eql nil)) (IMAGE image) AXIS

Generic Function: image-colormap OBJECT

Package

imago

Methods

Method: image-colormap (PLANAR-IMAGE planar-image)

automatically generated reader method

Source

image.lisp (file)

Method: image-colormap (INDEXED-IMAGE indexed-image)

automatically generated reader method

Source

image.lisp (file)

Generic Function: image-height IMAGE

Returns the height of the image.

Package

imago

Source

image.lisp (file)

Methods

Method: image-height (IMAGE image)

Generic Function: image-pixel IMAGE X Y

Returns the color of the pixel at specified coordinates in the image.

Package

imago

Source

image.lisp (file)

Writer

(setf image-pixel) (generic function)

Methods

Method: image-pixel (IMAGE image) X Y

Generic Function: (setf image-pixel) PIXEL IMAGE X Y

Sets the color of the pixel at specified coordinates in the image.

Package

imago

Source

image.lisp (file)

Reader

image-pixel (generic function)

Methods

Method: (setf image-pixel) PIXEL (IMAGE image) X Y

Generic Function: image-pixels IMAGE

Returns a rectangular array of the image pixels.

Package

imago

Source

image.lisp (file)

Methods

Method: image-pixels (PLANAR-IMAGE planar-image)

automatically generated reader method

Method: image-pixels (INDEXED-IMAGE indexed-image)

automatically generated reader method

Method: image-pixels (GRAYSCALE-IMAGE grayscale-image)

automatically generated reader method

Method: image-pixels (RGB-IMAGE rgb-image)

automatically generated reader method

Generic Function: image-plane-count OBJECT

Package

imago

Methods

Method: image-plane-count (PLANAR-IMAGE planar-image)

automatically generated reader method

Source

image.lisp (file)

Generic Function: image-width IMAGE

Returns the width of the image.

Package

imago

Source

image.lisp (file)

Methods

Method: image-width (IMAGE image)

Generic Function: resize IMAGE NEW-WIDTH NEW-HEIGHT

Returns an newly created image corresponding to the IMAGE image, with given dimensions.

Package

imago

Source

operations.lisp (file)

Methods

Method: resize (IMAGE image) NEW-WIDTH NEW-HEIGHT

Generic Function: scale IMAGE WIDTH-FACTOR HEIGHT-FACTOR

Returns an newly created image corresponding to the
IMAGE image, with its dimensions multiplied by the given factors.

Package

imago

Source

operations.lisp (file)

Methods

Method: scale (IMAGE image) WIDTH-FACTOR HEIGHT-FACTOR

Generic Function: set-alpha IMAGE ALPHA

Sets the alpha channel value for all pixels/colors in an image.

Package

imago

Source

image-utilities.lisp (file)

Methods

Method: set-alpha (IMAGE indexed-image) ALPHA

Method: set-alpha (IMAGE grayscale-image) ALPHA

Method: set-alpha (IMAGE rgb-image) ALPHA

4.1.5 Classes

Class: grayscale-image ()

The class for grayscale images. Image dimensions must be provided to MAKE-INSTANCE, through the :WIDTH and :HEIGHT keyword parameters.

Package

imago

Source

image.lisp (file)

Direct superclasses

image (class)

Direct methods

• write-pnm-to-stream (method)
• write-pnm-to-stream (method)
• write-png-pixel-bytes (method)
• image-png-color-type (method)
• convolve (method)
• convert-to-indexed (method)
• convert-to-rgb (method)
• set-alpha (method)
• pixel-size (method)
• initialize-instance (method)
• image-pixels (method)

Direct slots

Slot: pixels

Type

(simple-array imago:grayscale-pixel (* *))

Readers

image-pixels (generic function)

Class: image ()

The protocol class for images.

Package

imago

Source

image.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• rgb-image (class)
• grayscale-image (class)
• indexed-image (class)
• planar-image (class)

Direct methods

• write-png-colormap-chunk (method)
• flip (method)
• flip (method)
• flip (method)
• resize (method)
• scale (method)
• copy (method)
• copy (method)
• compose (method)
• compose (method)
• convert-to-planar (method)
• make-similar-image (method)
• print-object (method)
• image-pixel (method)
• image-pixel (method)
• image-height (method)
• image-width (method)

Class: indexed-image ()

The class for indexed images. Image dimensions must be
provided to MAKE-INSTANCE, through the :WIDTH and :HEIGHT keyword parameters. Also accepts a :COLOR-COUNT keyword parameter, to specify the image color count (256 by default).

Package

imago

Source

image.lisp (file)

Direct superclasses

image (class)

Direct methods

• write-tga-to-stream (method)
• write-pnm-to-stream (method)
• write-pnm-to-stream (method)
• write-png-pixel-bytes (method)
• image-png-color-type (method)
• write-png-colormap-chunk (method)
• copy (method)
• convert-to-grayscale (method)
• convert-to-rgb (method)
• set-alpha (method)
• pixel-size (method)
• initialize-instance (method)
• image-colormap (method)
• image-pixels (method)

Direct slots

Slot: pixels

Type

(simple-array imago:indexed-pixel (* *))

Readers

image-pixels (generic function)

Slot: colormap

Initargs

:colormap

Readers

image-colormap (generic function)

Class: planar-image ()

The class for planar images. Image dimensions and
plane count must be provided to MAKE-INSTANCE, through the :WIDTH, :HEIGHT, and :PLANE-COUNT keyword parameters, respectively.

Package

imago

Source

image.lisp (file)

Direct superclasses

image (class)

Direct methods

• copy (method)
• pixel-size (method)
• initialize-instance (method)
• image-colormap (method)
• image-plane-count (method)
• image-pixels (method)

Direct slots

Slot: pixels

Type

simple-array

Readers

image-pixels (generic function)

Slot: plane-count

Type

integer

Readers

image-plane-count (generic function)

Slot: colormap

Initargs

:colormap

Readers

image-colormap (generic function)

Class: rgb-image ()

The class for RGB images. Image dimensions must be
provided to MAKE-INSTANCE, through the :WIDTH and :HEIGHT keyword parameters.

Package

imago

Source

image.lisp (file)

Direct superclasses

image (class)

Direct methods

• write-tga-to-stream (method)
• write-pnm-to-stream (method)
• write-pnm-to-stream (method)
• write-png-pixel-bytes (method)
• image-png-color-type (method)
• default-compose-operator (method)
• convolve (method)
• convert-to-indexed (method)
• convert-to-grayscale (method)
• set-alpha (method)
• pixel-size (method)
• initialize-instance (method)
• image-pixels (method)

Direct slots

Slot: pixels

Type

(simple-array imago:rgb-pixel (* *))

Readers

image-pixels (generic function)

4.1.6 Types

Type: grayscale-pixel ()

Package

imago

Source

color.lisp (file)

Type: indexed-pixel ()

Package

imago

Source

color.lisp (file)

Type: planar-pixel &optional PLANE-COUNT

Package

imago

Source

color.lisp (file)

Type: rgb-pixel ()

Package

imago

Source

color.lisp (file)

4.2 Internal definitions

4.2.1 Special variables

Special Variable: *image-file-readers*

Package

imago

Source

file.lisp (file)

Special Variable: +crc32-table+

Package

imago

Source

crc32.lisp (file)

Special Variable: +emboss-matrix-cell-angles+

Package

imago

Source

convolve.lisp (file)

Special Variable: +png-idat-chunk-type+

Package

imago

Source

file-png.lisp (file)

Special Variable: +png-iend-chunk-type+

Package

imago

Source

file-png.lisp (file)

Special Variable: +png-ihdr-chunk-type+

Package

imago

Source

file-png.lisp (file)

Special Variable: +png-plte-chunk-type+

Package

imago

Source

file-png.lisp (file)

Special Variable: +png-signature+

Package

imago

Source

file-png.lisp (file)

Special Variable: +pnm-image-makers+

Package

imago

Source

file-pnm.lisp (file)

Special Variable: +pnm-pixel-readers+

Package

imago

Source

file-pnm.lisp (file)

4.2.2 Macros

Macro: read-array-element ARRAY INDEX

Package

imago

Source

utilities.lisp (file)

Macro: with-gensyms VARS &body BODY

Bind variables to gensyms and execute the BODY forms in an implicit PROGN.

Package

imago

Source

utilities.lisp (file)

Macro: with-write-pnm-loop (STREAM X Y PIXELS MAGIC-NUMBER MAX-VALUE) &body BODY

Package

imago

Source

file-pnm.lisp (file)

4.2.3 Functions

Function: best-in-array F ARRAY &key TEST

Package

imago

Source

utilities.lisp (file)

Function: closest-colortable-entry COLOR TABLE

Package

imago

Source

color.lisp (file)

Function: colormap->pcx-ega-palette COLORMAP EGA-PALETTE

Package

imago

Source

file-pcx.lisp (file)

Function: copy-png-descriptor INSTANCE

Package

imago

Source

file-png.lisp (file)

Function: crc32 BUFFER

Package

imago

Source

crc32.lisp (file)

Function: decode-png-colormap DATA

Package

imago

Source

file-png.lisp (file)

Function: decode-png-descriptor DATA

Package

imago

Source

file-png.lisp (file)

Function: decode-png-image DESCRIPTOR DATA

Package

imago

Source

file-png.lisp (file)

Function: draw-point IMAGE X Y COLOR

Draws a point in an image.

Package

imago

Source

drawing.lisp (file)

Function: fill-pcx-scanline-buffer IMAGE SCANLINE PLANE BUFFER

Package

imago

Source

file-pcx.lisp (file)

Function: images-same-dimensions-p &rest IMAGES

Package

imago

Source

image-utilities.lisp (file)

Function: images-same-type-p &rest IMAGES

Package

imago

Source

image-utilities.lisp (file)

Function: in-image-p X Y IMAGE

Checks that the point with coordinates (X, Y) is inside IMAGE.

Package

imago

Source

image-utilities.lisp (file)

Function: in-region-p X Y REGION-X REGION-Y REGION-WIDTH REGION-HEIGHT

Checks that the point with coordinates (X, Y) is inside the given region.

Package

imago

Source

image-utilities.lisp (file)

Function: limit-value VALUE MIN MAX

Package

imago

Source

utilities.lisp (file)

Function: make-png-descriptor &key (WIDTH WIDTH) (HEIGHT HEIGHT) (DEPTH DEPTH) (COLOR-TYPE COLOR-TYPE) (COMPRESSION-METHOD COMPRESSION-METHOD) (FILTER-METHOD FILTER-METHOD) (INTERLACE-METHOD INTERLACE-METHOD)

Package

imago

Source

file-png.lisp (file)

Function: make-simple-gray-colormap ()

Package

imago

Source

color.lisp (file)

Function: pcx-ega-palette->colormap EGA-PALETTE COLORMAP

Package

imago

Source

file-pcx.lisp (file)

Function: png-descriptor-color-type INSTANCE

Function: (setf png-descriptor-color-type) VALUE INSTANCE

Package

imago

Source

file-png.lisp (file)

Function: png-descriptor-compression-method INSTANCE

Function: (setf png-descriptor-compression-method) VALUE INSTANCE

Package

imago

Source

file-png.lisp (file)

Function: png-descriptor-depth INSTANCE

Function: (setf png-descriptor-depth) VALUE INSTANCE

Package

imago

Source

file-png.lisp (file)

Function: png-descriptor-filter-method INSTANCE

Function: (setf png-descriptor-filter-method) VALUE INSTANCE

Package

imago

Source

file-png.lisp (file)

Function: png-descriptor-height INSTANCE

Function: (setf png-descriptor-height) VALUE INSTANCE

Package

imago

Source

file-png.lisp (file)

Function: png-descriptor-interlace-method INSTANCE

Function: (setf png-descriptor-interlace-method) VALUE INSTANCE

Package

imago

Source

file-png.lisp (file)

Function: png-descriptor-p OBJECT

Package

imago

Source

file-png.lisp (file)

Function: png-descriptor-width INSTANCE

Function: (setf png-descriptor-width) VALUE INSTANCE

Package

imago

Source

file-png.lisp (file)

Function: png-paeth A B C

Package

imago

Source

file-png.lisp (file)

Function: png-samples-per-pixel COLOR-TYPE

Package

imago

Source

file-png.lisp (file)

Function: read-ascii-rgb-pixel STREAM

Package

imago

Source

file-pnm.lisp (file)

Function: read-bin-rgb-pixel STREAM

Package

imago

Source

file-pnm.lisp (file)

Function: read-byte-array STREAM LENGTH

Package

imago

Source

utilities.lisp (file)

Function: read-integer-as-text STREAM &key BASE

Reads the text representation of a number from a binary output stream.

Package

imago

Source

utilities.lisp (file)

Function: read-lsb-integer STREAM SIZE

Package

imago

Source

utilities.lisp (file)

Function: read-msb-integer STREAM SIZE

Package

imago

Source

utilities.lisp (file)

Function: read-number STREAM

Package

imago

Source

utilities.lisp (file)

Function: read-number2 STREAM

Package

imago

Source

file-pnm.lisp (file)

Function: read-pcx-data STREAM IMAGE COLOR-PLANES BYTES-PER-LINE

Package

imago

Source

file-pcx.lisp (file)

Function: read-pcx-vga-palette STREAM IMAGE

Package

imago

Source

file-pcx.lisp (file)

Function: read-png-chunk STREAM

Package

imago

Source

file-png.lisp (file)

Function: read-png-sample DATA BIT-INDEX DEPTH

Package

imago

Source

file-png.lisp (file)

Function: read-png-signature STREAM

Package

imago

Source

file-png.lisp (file)

Function: read-pnm-from-stream STREAM

Package

imago

Source

file-pnm.lisp (file)

Function: read-pnm-info STREAM

Package

imago

Source

file-pnm.lisp (file)

Function: read-tga-color STREAM BPP

Package

imago

Source

file-tga.lisp (file)

Function: read-tga-color-index STREAM BPP

Package

imago

Source

file-tga.lisp (file)

Function: read-tga-colormap STREAM ORIGIN LENGTH BPP

Package

imago

Source

file-tga.lisp (file)

Function: read-tga-data STREAM IMAGE WIDTH HEIGHT TOP-DOWN-P READER BPP

Package

imago

Source

file-tga.lisp (file)

Function: skip-bytes STREAM COUNT

Package

imago

Source

utilities.lisp (file)

Function: skip-line STREAM

Package

imago

Source

utilities.lisp (file)

Function: skip-whitespace-and-comments STREAM &optional COMMENT-START

Package

imago

Source

utilities.lisp (file)

Function: square X

Package

imago

Source

utilities.lisp (file)

Function: update-crc32 CRC BUFFER

Package

imago

Source

crc32.lisp (file)

Function: write-integer-as-text STREAM NUMBER &key BASE

Writes the text representation of a number to a binary output stream.

Package

imago

Source

utilities.lisp (file)

Function: write-lsb-integer NUMBER STREAM SIZE

Writes SIZE bytes of the integer NUMBER to STREAM, in least-significant bit order.

Package

imago

Source

utilities.lisp (file)

Function: write-msb-integer NUMBER STREAM SIZE

Writes SIZE bytes of the integer NUMBER to STREAM, in most-significant bit order.

Package

imago

Source

utilities.lisp (file)

Function: write-pcx-body STREAM IMAGE COLOR-PLANES BYTES-PER-LINE MAX-RUN-LENGTH

Package

imago

Source

file-pcx.lisp (file)

Function: write-png-chunk DATA TYPE STREAM

Package

imago

Source

file-png.lisp (file)

Function: write-png-data-chunk STREAM IMAGE

Package

imago

Source

file-png.lisp (file)

Function: write-png-end-chunk STREAM

Package

imago

Source

file-png.lisp (file)

Function: write-png-header-chunk STREAM IMAGE

Package

imago

Source

file-png.lisp (file)

Function: write-png-signature STREAM

Package

imago

Source

file-png.lisp (file)

Function: write-tga-data IMAGE TOP-DOWN-P PIXEL-WRITER

Package

imago

Source

file-tga.lisp (file)

4.2.4 Generic functions

Generic Function: default-compose-operator IMAGE

Returns a compose operator that can be applied to
images of the same type as IMAGE. The default operator mixes colors according to their respective alpha component.

Package

imago

Source

compose.lisp (file)

Methods

Method: default-compose-operator (IMAGE rgb-image)

Generic Function: image-png-color-type IMAGE

Package

imago

Source

file-png.lisp (file)

Methods

Method: image-png-color-type (IMAGE indexed-image)

Method: image-png-color-type (IMAGE grayscale-image)

Method: image-png-color-type (IMAGE rgb-image)

Generic Function: make-similar-image IMAGE

Returns a new image, with same type and dimensions as IMAGE.

Package

imago

Source

image-utilities.lisp (file)

Methods

Method: make-similar-image (IMAGE image)

Generic Function: pixel-size IMAGE

Returns the number of bytes used to represent a pixel.

Package

imago

Source

image.lisp (file)

Methods

Method: pixel-size (IMAGE planar-image)

Method: pixel-size (IMAGE indexed-image)

Method: pixel-size (IMAGE grayscale-image)

Method: pixel-size (IMAGE rgb-image)

Generic Function: write-png-colormap-chunk STREAM IMAGE

Package

imago

Source

file-png.lisp (file)

Methods

Method: write-png-colormap-chunk STREAM (IMAGE indexed-image)

Method: write-png-colormap-chunk STREAM (IMAGE image)

Generic Function: write-png-pixel-bytes DEST IMAGE X Y INDEX

Package

imago

Source

file-png.lisp (file)

Methods

Method: write-png-pixel-bytes DEST (IMAGE indexed-image) X Y INDEX

Method: write-png-pixel-bytes DEST (IMAGE grayscale-image) X Y INDEX

Method: write-png-pixel-bytes DEST (IMAGE rgb-image) X Y INDEX

Generic Function: write-pnm-to-stream IMAGE STREAM OUTPUT-FORMAT

Package

imago

Source

file-pnm.lisp (file)

Methods

Method: write-pnm-to-stream (IMAGE indexed-image) STREAM (OUTPUT-FORMAT (eql binary))

Method: write-pnm-to-stream (IMAGE indexed-image) STREAM (OUTPUT-FORMAT (eql ascii))

Method: write-pnm-to-stream (IMAGE grayscale-image) STREAM (OUTPUT-FORMAT (eql binary))

Method: write-pnm-to-stream (IMAGE grayscale-image) STREAM (OUTPUT-FORMAT (eql ascii))

Method: write-pnm-to-stream (IMAGE rgb-image) STREAM (OUTPUT-FORMAT (eql binary))

Method: write-pnm-to-stream (IMAGE rgb-image) STREAM (OUTPUT-FORMAT (eql ascii))

Generic Function: write-tga-to-stream IMAGE STREAM TOP-DOWN-P

Package

imago

Source

file-tga.lisp (file)

Methods

Method: write-tga-to-stream (IMAGE indexed-image) STREAM TOP-DOWN-P

Method: write-tga-to-stream (IMAGE rgb-image) STREAM TOP-DOWN-P

4.2.5 Structures

Structure: png-descriptor ()

Package

imago

Source

file-png.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: width

Readers

png-descriptor-width (function)

Writers

(setf png-descriptor-width) (function)

Slot: height

Readers

png-descriptor-height (function)

Writers

(setf png-descriptor-height) (function)

Slot: depth

Readers

png-descriptor-depth (function)

Writers

(setf png-descriptor-depth) (function)

Slot: color-type

Readers

png-descriptor-color-type (function)

Writers

(setf png-descriptor-color-type) (function)

Slot: compression-method

Readers

png-descriptor-compression-method (function)

Writers

(setf png-descriptor-compression-method) (function)

Slot: filter-method

Readers

png-descriptor-filter-method (function)

Writers

(setf png-descriptor-filter-method) (function)

Slot: interlace-method

Readers

png-descriptor-interlace-method (function)

Writers

(setf png-descriptor-interlace-method) (function)

Appendix A Indexes

A.1 Concepts

A.2 Functions