Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the png-read Reference Manual, version 0.3.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 14:41:58 2020 GMT+0.
• Introduction | What png-read is all about | |
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
Portable Network Graphics (PNG) decoder (more or less) for Common Lisp. All critical chunks are implemented. Most ancillary chunks are. It should be able to read back any file produced by ZPNG. Interlaced files can be read, but without progressive loading. Usage: read-png-file (file) and read-png-datastream (stream), both return a png-state object and a boolean to indicate if CRC was successful, which most interesting property is image-data, a two (grayscale) or three dimensional array containing image data. Other properties are width, height, bit-depth and colour-type. If file was loaded by read-png-file slot png-file contains pathname used. Dynamic variable *crc-fail-behaviour* can be set to one of :error, :warn or :no-action (default is :error), and controls what happens on checksum failure. Error signalled is of type png-read:crc-failure, and restart png-read:ignore-crc-failure is established. For indexed images slot index-data contains an array with indices in palette (stored in palette slot), and image-data contains decoded colors. The library loads all files from http://www.schaik.com/pngsuite/ , but I did not check whether it does so correctly. Note that ancillary chunks are mostly untested. They never modify primary image data array directly, but provide additional information in slots of png-state object. Of the ancillary chunks specified in http://www.w3.org/TR/2003/REC-PNG-20031110/ missing are: cHRM, iCCP and sPLT. gAMA is present, but using it is responsibility of library user. Dynamic variable *warn-missing-ancillaries* controls whether library warns on encountering unknown ancillary chunk. Ancillary chunks: tRNS - if present, additional alpha map is stored in slot transparency gAMA - if present, image gamma is stored in slot gamma sBIT - if present, the original number of significant bits is stored in slot significant-bits as a property list sRGB - if present, rendering intent is storen in slot rendering-intent as a keyword symbol tEXt - if present, text strings are collected in slot textual-data as an association list of keyword and string zTXt - if present, text strings are collected in slot textual-data as an association list of keyword and string iTXt - if present, text strings are collected in slot texttual-data as an association list of keyword and a list of language tag, translated keyword and translated text bKGD - if present, preferred background is stored in slot preferred-background as an array of color components (RGB), greyscale datum or palette index hIST - if present, image histogram is stored in slot image-histogram as an array pHYS - if present, intended pixel size is stored in slot physical-dimensions as a property list tIME - if present, last modification time is stored in slot last-modification as an universal time
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The png-read system |
Jakub Higersberger <ramarren@gmail.com>
BSD-style
A library for reading PNG files.
0.3.1
png-read.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
Next: The png-read/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
png-read.asd
png-read (system)
Next: The png-read/png-state․lisp file, Previous: The png-read․asd file, Up: Lisp files [Contents][Index]
Next: The png-read/deinterlace․lisp file, Previous: The png-read/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
png-read (system)
png-state.lisp
Next: The png-read/util․lisp file, Previous: The png-read/png-state․lisp file, Up: Lisp files [Contents][Index]
png-read (system)
deinterlace.lisp
Next: The png-read/decode․lisp file, Previous: The png-read/deinterlace․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
png-read (system)
util.lisp
Next: The png-read/crc․lisp file, Previous: The png-read/util․lisp file, Up: Lisp files [Contents][Index]
png-read (system)
decode.lisp
Next: The png-read/critical-chunks․lisp file, Previous: The png-read/decode․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
png-read (system)
crc.lisp
Next: The png-read/ancillary-chunks․lisp file, Previous: The png-read/crc․lisp file, Up: Lisp files [Contents][Index]
png-read (system)
critical-chunks.lisp
Next: The png-read/basic-chunks․lisp file, Previous: The png-read/critical-chunks․lisp file, Up: Lisp files [Contents][Index]
png-read (system)
ancillary-chunks.lisp
Previous: The png-read/ancillary-chunks․lisp file, Up: Lisp files [Contents][Index]
png-read (system)
basic-chunks.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The png-read package |
package.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported special variables | ||
• Exported functions | ||
• Exported generic functions | ||
• Exported conditions | ||
• Exported classes |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
basic-chunks.lisp (file)
Next: Exported generic functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
basic-chunks.lisp (file)
basic-chunks.lisp (file)
Next: Exported conditions, Previous: Exported functions, Up: Exported definitions [Contents][Index]
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
Next: Exported classes, Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
basic-chunks.lisp (file)
warning (condition)
:file
file-of (generic function)
:crc-is
crc-is-of (generic function)
:crc-read
crc-read-of (generic function)
Previous: Exported conditions, Up: Exported definitions [Contents][Index]
png-state.lisp (file)
standard-object (class)
png-file (generic function)
(setf png-file) (generic function)
finished (generic function)
(setf finished) (generic function)
width (generic function)
(setf width) (generic function)
height (generic function)
(setf height) (generic function)
bit-depth (generic function)
(setf bit-depth) (generic function)
colour-type (generic function)
(setf colour-type) (generic function)
compression (generic function)
(setf compression) (generic function)
filter-method (generic function)
(setf filter-method) (generic function)
interlace-method (generic function)
(setf interlace-method) (generic function)
palette (generic function)
(setf palette) (generic function)
datastream (generic function)
(setf datastream) (generic function)
image-data (generic function)
(setf image-data) (generic function)
index-data (generic function)
(setf index-data) (generic function)
postprocess-ancillaries (generic function)
(setf postprocess-ancillaries) (generic function)
transparency (generic function)
(setf transparency) (generic function)
gamma (generic function)
(setf gamma) (generic function)
significant-bits (generic function)
(setf significant-bits) (generic function)
rendering-intent (generic function)
(setf rendering-intent) (generic function)
textual-data (generic function)
(setf textual-data) (generic function)
preferred-background (generic function)
(setf preferred-background) (generic function)
image-histogram (generic function)
(setf image-histogram) (generic function)
physical-dimensions (generic function)
(setf physical-dimensions) (generic function)
last-modification (generic function)
(setf last-modification) (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal special variables | ||
• Internal compiler macros | ||
• Internal functions | ||
• Internal generic functions |
Next: Internal compiler macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
deinterlace.lisp (file)
basic-chunks.lisp (file)
basic-chunks.lisp (file)
png-state.lisp (file)
ancillary-chunks.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
Next: Internal generic functions, Previous: Internal compiler macros, Up: Internal definitions [Contents][Index]
ancillary-chunks.lisp (file)
deinterlace.lisp (file)
deinterlace.lisp (file)
decode.lisp (file)
deinterlace.lisp (file)
deinterlace.lisp (file)
decode.lisp (file)
deinterlace.lisp (file)
decode.lisp (file)
basic-chunks.lisp (file)
basic-chunks.lisp (file)
decode.lisp (file)
deinterlace.lisp (file)
decode.lisp (file)
decode.lisp (file)
decode.lisp (file)
decode.lisp (file)
Previous: Internal functions, Up: Internal definitions [Contents][Index]
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
basic-chunks.lisp (file)
basic-chunks.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
decode.lisp (file)
basic-chunks.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
ancillary-chunks.lisp (file)
critical-chunks.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
automatically generated reader method
png-state.lisp (file)
automatically generated writer method
png-state.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | F L P |
---|
Jump to: | F L P |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | (
B C D F G H I L M P R S T U W |
---|
Jump to: | (
B C D F G H I L M P R S T U W |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
B C D F G H I L P R S T W |
---|
Jump to: | *
B C D F G H I L P R S T W |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C P S |
---|
Jump to: | C P S |
---|