The zpng Reference Manual

Child Components

package.lisp (file).
specials.lisp (file).
utils.lisp (file).
chunk.lisp (file).
conditions.lisp (file).
png.lisp (file).

3 Files

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

Lisp

3.1.1 `zpng/zpng.asd`

Source: zpng.asd.
Parent Component: zpng (system).
ASDF Systems: zpng.

3.1.2 `zpng/package.lisp`

Source: zpng.asd.
Parent Component: zpng (system).
Packages: zpng.

3.1.3 `zpng/specials.lisp`

Dependency

package.lisp (file).

Source

Parent Component

zpng (system).

Internals

*color-types* (special variable).
*png-signature* (special variable).
+png-compression-method+ (constant).
+png-filtering+ (constant).
+png-interlace+ (constant).

3.1.4 `zpng/utils.lisp`

Dependency

package.lisp (file).

Source

Parent Component

zpng (system).

Internals

checksum (function).
write-uint32 (function).

3.1.5 `zpng/chunk.lisp`

Dependency

utils.lisp (file).

Source

Parent Component

zpng (system).

Internals

buffer (reader method).
chunk (class).
chunk-write-byte (function).
chunk-write-uint32 (function).
make-chunk (function).
pos (reader method).
(setf pos) (writer method).
write-chunk (function).

3.1.6 `zpng/conditions.lisp`

Dependency

package.lisp (file).

Source

Parent Component

zpng (system).

Public Interface

color-type-mismatch (condition).
incomplete-row (condition).
insufficient-rows (condition).
invalid-row-length (condition).
invalid-size (condition).
invalid-size-height (reader method).
invalid-size-width (reader method).
too-many-rows (condition).
zpng-error (condition).

Internals

color-type-mismatch-expected (reader method).
(setf color-type-mismatch-expected) (writer method).
color-type-mismatch-given (reader method).
(setf color-type-mismatch-given) (writer method).
incomplete-row-needed (reader method).
(setf incomplete-row-needed) (writer method).
incomplete-row-written (reader method).
(setf incomplete-row-written) (writer method).
insufficient-rows-needed (reader method).
(setf insufficient-rows-needed) (writer method).
insufficient-rows-written (reader method).
(setf insufficient-rows-written) (writer method).
invalid-row-length-actual-length (reader method).
(setf invalid-row-length-actual-length) (writer method).
invalid-row-length-expected-length (reader method).
(setf invalid-row-length-expected-length) (writer method).
too-many-rows-count (reader method).
(setf too-many-rows-count) (writer method).

3.1.7 `zpng/png.lisp`

Dependencies

specials.lisp (file).
chunk.lisp (file).
conditions.lisp (file).
utils.lisp (file).

Source

Parent Component

zpng (system).

Public Interface

color-type (reader method).
copy-png (generic function).
data-array (reader method).
finish-png (generic function).
height (reader method).
image-data (reader method).
initialize-instance (method).
pixel-streamed-png (class).
pixels-left-in-row (generic function).
png (class).
png= (generic function).
row-data (reader method).
(setf row-data) (writer method).
rows-left (generic function).
rows-written (reader method).
(setf rows-written) (writer method).
rowstride (generic function).
samples-per-pixel (generic function).
slot-unbound (method).
slot-unbound (method).
start-png (generic function).
streamed-png (class).
width (reader method).
write-pixel (generic function).
write-png (generic function).
write-png-stream (generic function).
write-row (generic function).

Internals

(setf %data-array) (writer method).
(setf %image-data) (writer method).
base-png (class).
bpp (reader method).
check-size (function).
compressor (reader method).
(setf compressor) (writer method).
current-offset (reader method).
(setf current-offset) (writer method).
ihdr-color-type (generic function).
make-idat-callback (function).
output-stream (reader method).
(setf output-stream) (writer method).
reset-streamed-png (generic function).
scanline-offset (generic function).
write-idat (generic function).
write-iend (generic function).
write-ihdr (generic function).
write-png-header (generic function).

4 Packages

Packages are listed by definition order.

zpng

4.1 `zpng`

Source

package.lisp.

Use List

common-lisp.
salza2.

Public Interface

color-type (generic reader).
color-type-mismatch (condition).
copy-png (generic function).
data-array (generic reader).
finish-png (generic function).
height (generic reader).
image-data (generic reader).
incomplete-row (condition).
insufficient-rows (condition).
invalid-row-length (condition).
invalid-size (condition).
invalid-size-height (generic reader).
invalid-size-width (generic reader).
pixel-streamed-png (class).
pixels-left-in-row (generic function).
png (class).
png= (generic function).
row-data (generic reader).
(setf row-data) (generic writer).
rows-left (generic function).
rows-written (generic reader).
(setf rows-written) (generic writer).
rowstride (generic function).
samples-per-pixel (generic function).
start-png (generic function).
streamed-png (class).
too-many-rows (condition).
width (generic reader).
write-pixel (generic function).
write-png (generic function).
write-png-stream (generic function).
write-row (generic function).
zpng-error (condition).

Internals

(setf %data-array) (generic writer).
(setf %image-data) (generic writer).
*color-types* (special variable).
*png-signature* (special variable).
+png-compression-method+ (constant).
+png-filtering+ (constant).
+png-interlace+ (constant).
base-png (class).
bpp (generic reader).
buffer (generic reader).
check-size (function).
checksum (function).
chunk (class).
chunk-write-byte (function).
chunk-write-uint32 (function).
color-type-mismatch-expected (generic reader).
(setf color-type-mismatch-expected) (generic writer).
color-type-mismatch-given (generic reader).
(setf color-type-mismatch-given) (generic writer).
compressor (generic reader).
(setf compressor) (generic writer).
current-offset (generic reader).
(setf current-offset) (generic writer).
ihdr-color-type (generic function).
incomplete-row-needed (generic reader).
(setf incomplete-row-needed) (generic writer).
incomplete-row-written (generic reader).
(setf incomplete-row-written) (generic writer).
insufficient-rows-needed (generic reader).
(setf insufficient-rows-needed) (generic writer).
insufficient-rows-written (generic reader).
(setf insufficient-rows-written) (generic writer).
invalid-row-length-actual-length (generic reader).
(setf invalid-row-length-actual-length) (generic writer).
invalid-row-length-expected-length (generic reader).
(setf invalid-row-length-expected-length) (generic writer).
make-chunk (function).
make-idat-callback (function).
output-stream (generic reader).
(setf output-stream) (generic writer).
pos (generic reader).
(setf pos) (generic writer).
reset-streamed-png (generic function).
scanline-offset (generic function).
too-many-rows-count (generic reader).
(setf too-many-rows-count) (generic writer).
write-chunk (function).
write-idat (generic function).
write-iend (generic function).
write-ihdr (generic function).
write-png-header (generic function).
write-uint32 (function).

5 Definitions

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

Public Interface
Internals

5.1 Public Interface

Generic functions
Standalone methods
Conditions
Classes

5.1.1 Generic functions

Generic Reader: color-type (object) ¶

Package

Methods

Reader Method: color-type ((base-png base-png)) ¶

automatically generated reader method

Source: png.lisp.
Target Slot: color-type.

Generic Function: copy-png (png) ¶

Package

Source

Methods

Method: copy-png (orig) ¶

Generic Reader: data-array (object) ¶

Package

Methods

Reader Method: data-array ((png png)) ¶

automatically generated reader method

Source: png.lisp.
Target Slot: data-array.

Generic Function: finish-png (png) ¶

Package

Source

Methods

Method: finish-png ((png pixel-streamed-png)) ¶

Method: finish-png ((png streamed-png)) ¶

Generic Reader: height (object) ¶

Package

Methods

Reader Method: height ((base-png base-png)) ¶

automatically generated reader method

Source: png.lisp.
Target Slot: height.

Generic Reader: image-data (object) ¶

Package

Methods

Reader Method: image-data ((png png)) ¶

automatically generated reader method

Source: png.lisp.
Target Slot: image-data.

Generic Reader: invalid-size-height (condition) ¶

Package

Methods

Reader Method: invalid-size-height ((condition invalid-size)) ¶

Source: conditions.lisp.
Target Slot: height.

Generic Reader: invalid-size-width (condition) ¶

Package

Methods

Reader Method: invalid-size-width ((condition invalid-size)) ¶

Source: conditions.lisp.
Target Slot: width.

Generic Function: pixels-left-in-row (png) ¶

Package

Source

Methods

Method: pixels-left-in-row ((png pixel-streamed-png)) ¶

Generic Function: png= (png1 png2) ¶

Package

Source

Methods

Method: png= (png1 png2) ¶

Generic Reader: row-data (object) ¶

Package

Methods

Reader Method: row-data ((streamed-png streamed-png)) ¶

automatically generated reader method

Source: png.lisp.
Target Slot: row-data.

Generic Writer: (setf row-data) (object) ¶

Package

Methods

Writer Method: (setf row-data) ((streamed-png streamed-png)) ¶

automatically generated writer method

Source: png.lisp.
Target Slot: row-data.

Generic Function: rows-left (png) ¶

Package

Source

Methods

Method: rows-left ((png streamed-png)) ¶

Generic Reader: rows-written (object) ¶

Package

Methods

Reader Method: rows-written ((streamed-png streamed-png)) ¶

automatically generated reader method

Source: png.lisp.
Target Slot: rows-written.

Generic Writer: (setf rows-written) (object) ¶

Package

Methods

Writer Method: (setf rows-written) ((streamed-png streamed-png)) ¶

automatically generated writer method

Source: png.lisp.
Target Slot: rows-written.

Generic Function: rowstride (png) ¶

Package

Source

Methods

Method: rowstride (png) ¶

Generic Function: samples-per-pixel (png) ¶

Package

Source

Methods

Method: samples-per-pixel (png) ¶

Generic Function: start-png (png stream) ¶

Package

Source

Methods

Method: start-png ((png pixel-streamed-png) stream) ¶

Method: start-png ((png streamed-png) stream) ¶

Generic Reader: width (object) ¶

Package

Methods

Reader Method: width ((base-png base-png)) ¶

automatically generated reader method

Source: png.lisp.
Target Slot: width.

Generic Function: write-pixel (pixel png) ¶

Package

Source

Methods

Method: write-pixel (pixel (png pixel-streamed-png)) ¶

Generic Function: write-png (png pathname &key if-exists) ¶

Package

Source

Methods

Method: write-png (png file &key if-exists) ¶

Generic Function: write-png-stream (png stream) ¶

Package

Source

Methods

Method: write-png-stream (png stream) ¶

Generic Function: write-row (row png &key start end) ¶

Package

Source

Methods

Method: write-row (row (png streamed-png) &key start end) ¶

5.1.2 Standalone methods

Method: initialize-instance :after ((png png) &rest args &key image-data) ¶

Source: png.lisp.

Method: slot-unbound (class (png streamed-png) (slot (eql zpng:row-data))) ¶

Source: png.lisp.

Method: slot-unbound (class (png png) (slot (eql zpng:data-array))) ¶

Source: png.lisp.

5.1.3 Conditions

Condition: color-type-mismatch ¶

Package

Source

Direct superclasses

Direct methods

(setf color-type-mismatch-expected).
color-type-mismatch-expected.
(setf color-type-mismatch-given).
color-type-mismatch-given.

Direct slots

Slot: given ¶

Initargs: :given
Readers: color-type-mismatch-given.
Writers: (setf color-type-mismatch-given).

Slot: expected ¶

Initargs: :expected
Readers: color-type-mismatch-expected.
Writers: (setf color-type-mismatch-expected).

Condition: incomplete-row ¶

Package

Source

Direct superclasses

Direct methods

(setf incomplete-row-needed).
incomplete-row-needed.
(setf incomplete-row-written).
incomplete-row-written.

Direct slots

Slot: written ¶

Initargs: :written
Readers: incomplete-row-written.
Writers: (setf incomplete-row-written).

Slot: needed ¶

Initargs: :needed
Readers: incomplete-row-needed.
Writers: (setf incomplete-row-needed).

Condition: insufficient-rows ¶

Package

Source

Direct superclasses

Direct methods

(setf insufficient-rows-needed).
insufficient-rows-needed.
(setf insufficient-rows-written).
insufficient-rows-written.

Direct slots

Slot: written ¶

Initargs: :written
Readers: insufficient-rows-written.
Writers: (setf insufficient-rows-written).

Slot: needed ¶

Initargs: :needed
Readers: insufficient-rows-needed.
Writers: (setf insufficient-rows-needed).

Condition: invalid-row-length ¶

Package

Source

Direct superclasses

Direct methods

(setf invalid-row-length-actual-length).
invalid-row-length-actual-length.
(setf invalid-row-length-expected-length).
invalid-row-length-expected-length.

Direct slots

Slot: expected-length ¶

Initargs: :expected-length
Readers: invalid-row-length-expected-length.
Writers: (setf invalid-row-length-expected-length).

Slot: actual-length ¶

Initargs: :actual-length
Readers: invalid-row-length-actual-length.
Writers: (setf invalid-row-length-actual-length).

Condition: invalid-size ¶

Package

Source

Direct superclasses

Direct methods

invalid-size-height.
invalid-size-width.

Direct slots

Slot: width ¶

Initargs: :width
Readers: invalid-size-width.
Writers: This slot is read-only.

Slot: height ¶

Initargs: :height
Readers: invalid-size-height.
Writers: This slot is read-only.

Condition: too-many-rows ¶

Package

Source

Direct superclasses

Direct methods

(setf too-many-rows-count).
too-many-rows-count.

Direct slots

Slot: count ¶

Package: common-lisp.
Initargs: :count
Readers: too-many-rows-count.
Writers: (setf too-many-rows-count).

Condition: zpng-error ¶

Package

Source

Direct superclasses

error.

Direct subclasses

color-type-mismatch.
incomplete-row.
insufficient-rows.
invalid-row-length.
invalid-size.
too-many-rows.

5.1.4 Classes

Class: pixel-streamed-png ¶

Package

Source

Direct superclasses

streamed-png.

Direct methods

(setf current-offset).
current-offset.
finish-png.
pixels-left-in-row.
reset-streamed-png.
start-png.
write-pixel.

Direct slots

Slot: current-offset ¶

Initform: 0
Readers: current-offset.
Writers: (setf current-offset).

Class: png ¶

Package

Source

Direct superclasses

base-png.

Direct methods

(setf %data-array).
(setf %image-data).
data-array.
image-data.
initialize-instance.
slot-unbound.

Direct slots

Slot: image-data ¶

Initargs: :image-data
Readers: image-data.
Writers: (setf %image-data).

Slot: data-array ¶

Readers: data-array.
Writers: (setf %data-array).

Class: streamed-png ¶

Package

Source

Direct superclasses

base-png.

Direct subclasses

pixel-streamed-png.

Direct methods

(setf compressor).
compressor.
finish-png.
(setf output-stream).
output-stream.
reset-streamed-png.
(setf row-data).
row-data.
rows-left.
(setf rows-written).
rows-written.
slot-unbound.
start-png.
write-row.

Direct Default Initargs

Initarg	Value
`:rows-written`	`0`

Direct slots

Slot: rows-written ¶

Initargs: :rows-written
Readers: rows-written.
Writers: (setf rows-written).

Slot: row-data ¶

Initargs: :row-data
Readers: row-data.
Writers: (setf row-data).

Slot: compressor ¶

Initargs: :compressor
Readers: compressor.
Writers: (setf compressor).

Slot: output-stream ¶

Initargs: :output-stream
Readers: output-stream.
Writers: (setf output-stream).

5.2 Internals

Constants
Special variables
Ordinary functions
Generic functions
Classes

5.2.1 Constants

Constant: +png-compression-method+ ¶

Package: zpng.
Source: specials.lisp.

Constant: +png-filtering+ ¶

Package: zpng.
Source: specials.lisp.

Constant: +png-interlace+ ¶

Package: zpng.
Source: specials.lisp.

5.2.2 Special variables

Special Variable: *color-types* ¶

Package: zpng.
Source: specials.lisp.

Special Variable: *png-signature* ¶

Package: zpng.
Source: specials.lisp.

5.2.3 Ordinary functions

Function: check-size (png) ¶

Package: zpng.
Source: png.lisp.

Function: checksum (data count) ¶

Package: zpng.
Source: utils.lisp.

Function: chunk-write-byte (byte chunk) ¶

Save one byte to CHUNK.

Package: zpng.
Source: chunk.lisp.

Function: chunk-write-uint32 (integer chunk) ¶

Save INTEGER to CHUNK as four bytes.

Package: zpng.
Source: chunk.lisp.

Function: make-chunk (a b c d size) ¶

Make a chunk that uses A, B, C, and D as the signature bytes, with data size SIZE.

Package: zpng.
Source: chunk.lisp.

Function: make-idat-callback (stream) ¶

Package: zpng.
Source: png.lisp.

Function: write-chunk (chunk stream) ¶

Package: zpng.
Source: chunk.lisp.

Function: write-uint32 (integer stream) ¶

Package: zpng.
Source: utils.lisp.

5.2.4 Generic functions

Generic Writer: (setf %data-array) (object) ¶

Package

Methods

Writer Method: (setf %data-array) ((png png)) ¶

automatically generated writer method

Source: png.lisp.
Target Slot: data-array.

Generic Writer: (setf %image-data) (object) ¶

Package

Methods

Writer Method: (setf %image-data) ((png png)) ¶

automatically generated writer method

Source: png.lisp.
Target Slot: image-data.

Generic Reader: bpp (object) ¶

Package

Methods

Reader Method: bpp ((base-png base-png)) ¶

automatically generated reader method

Source: png.lisp.
Target Slot: bpp.

Generic Reader: buffer (object) ¶

Package

Methods

Reader Method: buffer ((chunk chunk)) ¶

automatically generated reader method

Source: chunk.lisp.
Target Slot: buffer.

Generic Reader: color-type-mismatch-expected (condition) ¶

Generic Writer: (setf color-type-mismatch-expected) (condition) ¶

Package

Methods

Reader Method: color-type-mismatch-expected ((condition color-type-mismatch)) ¶

Writer Method: (setf color-type-mismatch-expected) ((condition color-type-mismatch)) ¶

Source: conditions.lisp.
Target Slot: expected.

Generic Reader: color-type-mismatch-given (condition) ¶

Generic Writer: (setf color-type-mismatch-given) (condition) ¶

Package

Methods

Reader Method: color-type-mismatch-given ((condition color-type-mismatch)) ¶

Writer Method: (setf color-type-mismatch-given) ((condition color-type-mismatch)) ¶

Source: conditions.lisp.
Target Slot: given.

Generic Reader: compressor (object) ¶

Package

Methods

Reader Method: compressor ((streamed-png streamed-png)) ¶

automatically generated reader method

Source: png.lisp.
Target Slot: compressor.

Generic Writer: (setf compressor) (object) ¶

Package

Methods

Writer Method: (setf compressor) ((streamed-png streamed-png)) ¶

automatically generated writer method

Source: png.lisp.
Target Slot: compressor.

Generic Reader: current-offset (object) ¶

Package

Methods

Reader Method: current-offset ((pixel-streamed-png pixel-streamed-png)) ¶

automatically generated reader method

Source: png.lisp.
Target Slot: current-offset.

Generic Writer: (setf current-offset) (object) ¶

Package

Methods

Writer Method: (setf current-offset) ((pixel-streamed-png pixel-streamed-png)) ¶

automatically generated writer method

Source: png.lisp.
Target Slot: current-offset.

Generic Function: ihdr-color-type (png) ¶

Package

Source

Methods

Method: ihdr-color-type (png) ¶

Generic Reader: incomplete-row-needed (condition) ¶

Generic Writer: (setf incomplete-row-needed) (condition) ¶

Package

Methods

Reader Method: incomplete-row-needed ((condition incomplete-row)) ¶

Writer Method: (setf incomplete-row-needed) ((condition incomplete-row)) ¶

Source: conditions.lisp.
Target Slot: needed.

Generic Reader: incomplete-row-written (condition) ¶

Generic Writer: (setf incomplete-row-written) (condition) ¶

Package

Methods

Reader Method: incomplete-row-written ((condition incomplete-row)) ¶

Writer Method: (setf incomplete-row-written) ((condition incomplete-row)) ¶

Source: conditions.lisp.
Target Slot: written.

Generic Reader: insufficient-rows-needed (condition) ¶

Generic Writer: (setf insufficient-rows-needed) (condition) ¶

Package

Methods

Reader Method: insufficient-rows-needed ((condition insufficient-rows)) ¶

Writer Method: (setf insufficient-rows-needed) ((condition insufficient-rows)) ¶

Source: conditions.lisp.
Target Slot: needed.

Generic Reader: insufficient-rows-written (condition) ¶

Generic Writer: (setf insufficient-rows-written) (condition) ¶

Package

Methods

Reader Method: insufficient-rows-written ((condition insufficient-rows)) ¶

Writer Method: (setf insufficient-rows-written) ((condition insufficient-rows)) ¶

Source: conditions.lisp.
Target Slot: written.

Generic Reader: invalid-row-length-actual-length (condition) ¶

Generic Writer: (setf invalid-row-length-actual-length) (condition) ¶

Package

Methods

Reader Method: invalid-row-length-actual-length ((condition invalid-row-length)) ¶

Writer Method: (setf invalid-row-length-actual-length) ((condition invalid-row-length)) ¶

Source: conditions.lisp.
Target Slot: actual-length.

Generic Reader: invalid-row-length-expected-length (condition) ¶

Generic Writer: (setf invalid-row-length-expected-length) (condition) ¶

Package

Methods

Reader Method: invalid-row-length-expected-length ((condition invalid-row-length)) ¶

Writer Method: (setf invalid-row-length-expected-length) ((condition invalid-row-length)) ¶

Source: conditions.lisp.
Target Slot: expected-length.

Generic Reader: output-stream (object) ¶

Package

Methods

Reader Method: output-stream ((streamed-png streamed-png)) ¶

automatically generated reader method

Source: png.lisp.
Target Slot: output-stream.

Generic Writer: (setf output-stream) (object) ¶

Package

Methods

Writer Method: (setf output-stream) ((streamed-png streamed-png)) ¶

automatically generated writer method

Source: png.lisp.
Target Slot: output-stream.

Generic Reader: pos (object) ¶

Package

Methods

Reader Method: pos ((chunk chunk)) ¶

automatically generated reader method

Source: chunk.lisp.
Target Slot: pos.

Generic Writer: (setf pos) (object) ¶

Package

Methods

Writer Method: (setf pos) ((chunk chunk)) ¶

automatically generated writer method

Source: chunk.lisp.
Target Slot: pos.

Generic Function: reset-streamed-png (png) ¶

Package

Source

Methods

Method: reset-streamed-png ((png pixel-streamed-png)) ¶

Method: reset-streamed-png ((png streamed-png)) ¶

Generic Function: scanline-offset (png scanline) ¶

Package

Source

Methods

Method: scanline-offset (png scanline) ¶

Generic Reader: too-many-rows-count (condition) ¶

Generic Writer: (setf too-many-rows-count) (condition) ¶

Package

Methods

Reader Method: too-many-rows-count ((condition too-many-rows)) ¶

Writer Method: (setf too-many-rows-count) ((condition too-many-rows)) ¶

Source: conditions.lisp.
Target Slot: count.

Generic Function: write-idat (png stream) ¶

Package

Source

Methods

Method: write-idat (png stream) ¶

Generic Function: write-iend (png stream) ¶

Package

Source

Methods

Method: write-iend (png stream) ¶

Generic Function: write-ihdr (png stream) ¶

Package

Source

Methods

Method: write-ihdr (png stream) ¶

Generic Function: write-png-header (png stream) ¶

Package

Source

Methods

Method: write-png-header (png stream) ¶

5.2.5 Classes

Class: base-png ¶

Package

Source

Direct subclasses

png.
streamed-png.

Direct methods

bpp.
color-type.
height.
width.

Direct slots

Slot: width ¶

Initargs: :width
Readers: width.
Writers: This slot is read-only.

Slot: height ¶

Initargs: :height
Readers: height.
Writers: This slot is read-only.

Slot: color-type ¶

Initform: :truecolor
Initargs: :color-type
Readers: color-type.
Writers: This slot is read-only.

Slot: bpp ¶

Initform: 8
Initargs: :bpp
Readers: bpp.
Writers: This slot is read-only.

Class: chunk ¶

Package