This is the opticl-core Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:29:20 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
opticl-coreA library for representing and processing images
Cyrus Harmon <ch-lisp@bobobeach.com>
BSD
alexandria (system).
package.lisp (file).
opticl-core.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
opticl-core/opticl-core.lisppackage.lisp (file).
opticl-core (system).
1-bit-gray-alpha-image (type).
1-bit-gray-image (type).
16-bit-gray-alpha-image (type).
16-bit-gray-image (type).
16-bit-rgb-image (type).
16-bit-rgba-image (type).
2-bit-gray-alpha-image (type).
2-bit-gray-image (type).
32-bit-gray-alpha-image (type).
32-bit-gray-image (type).
32-bit-rgb-image (type).
32-bit-rgba-image (type).
4-bit-gray-alpha-image (type).
4-bit-gray-image (type).
4-bit-rgb-image (type).
4-bit-rgba-image (type).
8-bit-gray-alpha-image (type).
8-bit-gray-image (type).
8-bit-rgb-image (type).
8-bit-rgba-image (type).
clear-image (function).
copy-array (function).
do-pixels (macro).
do-region-pixels (macro).
double-float-gray-image (type).
double-float-rgb-image (type).
double-float-rgba-image (type).
fixnum-gray-image (type).
fixnum-rgb-image (type).
fixnum-rgba-image (type).
gray-alpha-image (type).
gray-image (type).
image (type).
make-1-bit-gray-alpha-image (function).
make-1-bit-gray-image (function).
make-16-bit-gray-alpha-image (function).
make-16-bit-gray-image (function).
make-16-bit-rgb-image (function).
make-16-bit-rgba-image (function).
make-2-bit-gray-alpha-image (function).
make-2-bit-gray-image (function).
make-32-bit-gray-image (function).
make-32-bit-rgb-image (function).
make-32-bit-rgba-image (function).
make-4-bit-gray-alpha-image (function).
make-4-bit-gray-image (function).
make-4-bit-rgb-image (function).
make-4-bit-rgba-image (function).
make-8-bit-gray-alpha-image (function).
make-8-bit-gray-image (function).
make-8-bit-rgb-image (function).
make-8-bit-rgba-image (function).
make-double-float-gray-image (function).
make-double-float-rgb-image (function).
make-double-float-rgba-image (function).
make-fixnum-gray-image (function).
make-fixnum-rgb-image (function).
make-fixnum-rgba-image (function).
make-single-float-gray-image (function).
make-single-float-rgb-image (function).
make-single-float-rgba-image (function).
pixel (macro).
(setf pixel) (setf expander).
(setf pixel*) (setf expander).
pixel* (function).
rgb-image (type).
rgba-image (type).
set-pixels (macro).
set-region-pixels (macro).
single-float-gray-image (type).
single-float-rgb-image (type).
single-float-rgba-image (type).
with-image-bounds (macro).
%get-array-dimensions-from-type-decl (function).
%get-image-dimensions (function).
*image-types* (special variable).
+max-image-channels+ (constant).
define-image-type (macro).
double-float-image (type).
make-32-bit-gray-alpha-image (function).
make-double-float-image (function).
make-single-float-image (function).
set-pixel* (macro).
single-float-image (type).
Packages are listed by definition order.
opticl-corecommon-lisp.
1-bit-gray-alpha-image (type).
1-bit-gray-image (type).
16-bit-gray-alpha-image (type).
16-bit-gray-image (type).
16-bit-rgb-image (type).
16-bit-rgba-image (type).
2-bit-gray-alpha-image (type).
2-bit-gray-image (type).
32-bit-gray-alpha-image (type).
32-bit-gray-image (type).
32-bit-rgb-image (type).
32-bit-rgba-image (type).
4-bit-gray-alpha-image (type).
4-bit-gray-image (type).
4-bit-rgb-image (type).
4-bit-rgba-image (type).
8-bit-gray-alpha-image (type).
8-bit-gray-image (type).
8-bit-rgb-image (type).
8-bit-rgba-image (type).
clear-image (function).
copy-array (function).
do-pixels (macro).
do-region-pixels (macro).
double-float-gray-image (type).
double-float-rgb-image (type).
double-float-rgba-image (type).
fixnum-gray-image (type).
fixnum-rgb-image (type).
fixnum-rgba-image (type).
gray-alpha-image (type).
gray-image (type).
image (type).
make-1-bit-gray-alpha-image (function).
make-1-bit-gray-image (function).
make-16-bit-gray-alpha-image (function).
make-16-bit-gray-image (function).
make-16-bit-rgb-image (function).
make-16-bit-rgba-image (function).
make-2-bit-gray-alpha-image (function).
make-2-bit-gray-image (function).
make-32-bit-gray-image (function).
make-32-bit-rgb-image (function).
make-32-bit-rgba-image (function).
make-4-bit-gray-alpha-image (function).
make-4-bit-gray-image (function).
make-4-bit-rgb-image (function).
make-4-bit-rgba-image (function).
make-8-bit-gray-alpha-image (function).
make-8-bit-gray-image (function).
make-8-bit-rgb-image (function).
make-8-bit-rgba-image (function).
make-double-float-gray-image (function).
make-double-float-rgb-image (function).
make-double-float-rgba-image (function).
make-fixnum-gray-image (function).
make-fixnum-rgb-image (function).
make-fixnum-rgba-image (function).
make-single-float-gray-image (function).
make-single-float-rgb-image (function).
make-single-float-rgba-image (function).
pixel (macro).
(setf pixel) (setf expander).
(setf pixel*) (setf expander).
pixel* (function).
rgb-image (type).
rgba-image (type).
set-pixels (macro).
set-region-pixels (macro).
single-float-gray-image (type).
single-float-rgb-image (type).
single-float-rgba-image (type).
with-image-bounds (macro).
%get-array-dimensions-from-type-decl (function).
%get-image-dimensions (function).
*image-types* (special variable).
+max-image-channels+ (constant).
define-image-type (macro).
double-float-image (type).
make-32-bit-gray-alpha-image (function).
make-double-float-image (function).
make-single-float-image (function).
set-pixel* (macro).
single-float-image (type).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Returns the (possibly multiple) image intensity value(s) at position y, x. With proper type declarations for images, use of this macro should yield non-consing access to image intensity data.
Sets the (possibly multiple) image intensity value(s) at position y, x to the provided value(s). For example, to set pixel [0,0] in an rgb-image to R20, G40, B60, one would do (setf (pixel img 0 0) (values 20 40 60)). With proper type declarations for images, use of this macro should yield non-consing setting of image intensity data.
pixel (macro).
(setf (pixel* img y x) list) sets the values of pixel y, x in img to the values contained in list. (setf (pixel ...) ...) is the more efficient way to do this, but if one wants to pass a set of values as a list instead of as multiple-values (for named colors perhaps), this function does that.
pixel* (function).
set-pixel* (macro).
Returns an undisplaced copy of ARRAY, with same fill-pointer and adjustability (if any) as the original, unless overridden by the keyword arguments.
pixel* returns the value(s) at position y, x as a list. This
function conses, but occasionally one wants the image intensity values
as a list, rather than as multiple values. This is a convenience
function to provide this, largely to provide symmetry
with (setf (pixel* ...) ...)
Defines a new image type. Under the covers, this results in evaluation of the appropriate deftype and make-my-image-type constructor functions. Returns the name of the created type (i.e. name).
Extract the array dimension specifier from type declaration TYPE-DECL.
| Jump to: | %
(
C D F M P S W |
|---|
| Jump to: | %
(
C D F M P S W |
|---|
| Jump to: | *
+
C S |
|---|
| Jump to: | *
+
C S |
|---|
| Jump to: | 1
2
3
4
8
D F G I O P R S T |
|---|
| Jump to: | 1
2
3
4
8
D F G I O P R S T |
|---|