cl bmp

1.0.0

A library for dealing with Windows bitmaps (BMP, DIB, ICO, CUR)

About cl-bmp

This library implements encoding and decoding for Windows bitmap formats (BMP, DIB, ICO, CUR).

How To

Read a file with read-bmp or read-ico. From there you can decode the pixel data with decode-pixels. The other way around works with encode-pixels and write-bmp / write-ico.

See the ico and bmp descriptions for information on additional fields.

System Information

Version: 1.0.0

Dependencies:

Author: Nicolas Hafner

License: zlib

Homepage: https://shinmera.github.io/cl-bmp/

Bug Tracker: https://github.com/shinmera/cl-bmp/issues

Sources: https://github.com/shinmera/cl-bmp.git

Definition Index

ORG.SHIRAKUMO.TRIVIAL-EXTENSIBLE-SEQUENCES.DOC
No documentation provided.

ORG.SHIRAKUMO.BMP

No documentation provided.

EXTERNAL STRUCTURE

BMP

Source

Representation of a bitmap file.

See DECODE-PIXELS
See ENCODE-PIXELS
See READ-BMP
See WRITE-BMP
See WIDTH
See HEIGHT
See PLANES
See BITS/PIXEL
See COMPRESSION
See HORIZONTAL-RESOLUTION
See VERTICAL-RESOLUTION
See MASK
See RED-ENDPOINT
See GREEN-ENDPOINT
See BLUE-ENDPOINT
See GAMMA
See INTENT
See RESOLUTION-UNIT
See ORIGIN
See COLOR-ENCODING
See IDENTIFIER

EXTERNAL STRUCTURE

ICO

Source

Representation of an ICO or CUR file.

See READ-ICO
See WRITE-ICO
See TYPE
See ENTRIES
See IMAGES

EXTERNAL STRUCTURE

ICO-ENTRY

Source

Representation of the metadata about an ICO image.

See ICO (type)
See WIDTH
See HEIGHT
See PROPERTY-1
See PROPERTY-2

EXTERNAL FUNCTION

DECODE-PIXELS

BMP
&OPTIONAL
OUTPUT

Source

Decodes the pixel data from the bitmap.

Returns four values:
  OUTPUT      --- The packed pixel data as an octet vector.
  WIDTH       --- How many columns the image has.
  HEIGHT      --- How many rows the image has.
  BYTES/COLOR --- How many bytes (channels) per color are used.

This will resolve the colour palette and packed bit structure.
If OUTPUT is not passed, the PIXELS array may be returned verbatim
if it can be used directly. If OUTPUT is passed, it is filled with
the packed content and it is up to you to ensure that the array
has sufficient space to hold the data.

See BMP (type)
See BMPCONTENT (type)
See ENCODE-PIXELS
See READ-BMP

EXTERNAL FUNCTION

ENCODE-PIXELS

BMP
PIXELS
WIDTH
HEIGHT
CHANNELS

Source

Encode pixel data to the bitmap format.

Returns the altered bitmap.
This will alter the PIXELS slot on the bitmap with a new array that
holds the encoded and padded pixel data. If possible it will also
construct a colour palette and appropriately compress the pixel
data to fit.

See BMP (type)
See BMPCONTENT (type)
See DECODE-PIXELS
See WRITE-BMP

EXTERNAL FUNCTION

READ-BMP

STORAGE
&REST
ARGS

Source

Read a bitmap file.

Can decode from a stream, pathname, octet-vector, and pointer.

After decoding you will want to use DECODE-PIXELS to read out
the pixel data.

See BMP (type)
See DECODE-PIXELS

EXTERNAL FUNCTION

READ-ICO

STORAGE
&REST
ARGS

Source

Read an icon or cursor file.

Can decode from a stream, pathname, octet-vector, and pointer.

See ICO (type)

EXTERNAL FUNCTION

WRITE-BMP

VALUE
STORAGE
&REST
ARGS

Source

Write a bitmap file.

Can encode to a stream, pathname, octet-vector, and pointer.

To write the pixels into the bitmap structure, you should used
ENCODE-PIXELS.

See BMP (type)
See ENCODE-PIXELS

EXTERNAL FUNCTION

WRITE-ICO

VALUE
STORAGE
&REST
ARGS

Source

Write an icon or cursor file.

Can encode to a stream, pathname, octet-vector, and pointer.

See ICO (type)

EXTERNAL GENERIC-FUNCTION

A

ENTRY

Accesses the alpha mask.

See RGBA-MASK (type)

EXTERNAL GENERIC-FUNCTION
(SETF A)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

B

ENTRY

Accesses the blue mask.

See RGB-MASK (type)

EXTERNAL GENERIC-FUNCTION
(SETF B)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

BIT-MASKS

ENTRY

Accesses the bit masks of the image.

See RGB-MASK (type)
See RGBA-MASK (type)
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF BIT-MASKS)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

BITS/PIXEL

ENTRY

Accesses the bits per pixel count of the image.

See BITMAPCOREHEADER (type)
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF BITS/PIXEL)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

BLUE-ENDPOINT

ENTRY

Accesses the blue endpoint of the image.

See XYZ (type)
See BITMAPV2INFOHEADER (type)
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF BLUE-ENDPOINT)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

COLOR-ENCODING

ENTRY

Accesses the color encoding identifier of the image.

See OS22XBITMAPHEADER (type)
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF COLOR-ENCODING)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

COLORS

ENTRY

Accesses the (packed) color palette of the image.

See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF COLORS)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

COMPRESSION

ENTRY

Accesses the compression method of the image.

See OS22XBITMAPHEADER/SHORT (type)
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF COMPRESSION)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

ENTRIES

ENTRY

Accesses the vector of ICO-ENTRY instances.

See ICO (type)
See ICO-ENTRY (type)

EXTERNAL GENERIC-FUNCTION
(SETF ENTRIES)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

G

ENTRY

Accesses the green mask.

See RGB-MASK (type)

EXTERNAL GENERIC-FUNCTION
(SETF G)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

GAMMA

ENTRY

Accesses the gamma of the image.

See RGB-MASK (type)
See BITMAPV2INFOHEADER (type)
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF GAMMA)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

GREEN-ENDPOINT

ENTRY

Accesses the green endpoint of the image.

See XYZ (type)
See BITMAPV2INFOHEADER (type)
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF GREEN-ENDPOINT)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

HALFTONING

HEADER

Accesses the halftoning method of the image.

See OS22XBITMAPHEADER (type)
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF HEADER)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

HEIGHT

ENTRY

Accesses the height of the image.

See BITMAPCOREHEADER (type)
See ICO-ENTRY (type)
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF HEIGHT)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

HORIZONTAL-RESOLUTION

ENTRY

Accesses the horizontal physical resolution method ofhorizontal the image.

See BITMAPINFOHEADER (type)
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF HORIZONTAL-RESOLUTION)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

IDENTIFIER

ENTRY

Accesses the identifier of the image.

See OS22XBITMAPHEADER (type)
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF IDENTIFIER)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

IMAGES

ENTRY

Accesses the vector of BMPCONTENT instances.

See ICO (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF IMAGES)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

INTENT

ENTRY

Accesses the rendering intent of the image.

See BITMAPV5INFOHEADER (type)
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF INTENT)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

MASK

ENTRY

Accesses the mask of the image.

Returns either an RGB-MASK or an RGBA-MASK.

See RGB-MASK (type)
See RGBA-MASK (type)
See BITMAPV2INFOHEADER (type)
See BITMAPV3INFOHEADER (type)
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF MASK)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

ORIGIN

ENTRY

Accesses the image origin identifier of the image.

See OS22XBITMAPHEADER (type)
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF ORIGIN)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

PIXELS

ENTRY

Accesses the (packed) pixel data array of the image.

This array includes necessary padding and potentially colors in indexed format.

See DECODE-PIXELS
See ENCODE-PIXELS
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF PIXELS)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

PLANES

ENTRY

Accesses the plane count of the image.

See BITMAPCOREHEADER (type)
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF PLANES)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

PROPERTY-1

ENTRY

Returns the first property of the icon entry.

For a cursor that's the "hot zone" X coordinate.

See ICO-ENTRY (type)

EXTERNAL GENERIC-FUNCTION
(SETF PROPERTY-1)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

PROPERTY-2

ENTRY

Returns the second property of the icon entry.

For a cursor that's the "hot zone" Y coordinate.

See ICO-ENTRY (type)

EXTERNAL GENERIC-FUNCTION
(SETF PROPERTY-2)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

R

ENTRY

Accesses the red mask.

See RGB-MASK (type)

EXTERNAL GENERIC-FUNCTION
(SETF R)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

RED-ENDPOINT

ENTRY

Accesses the red endpoint of the image.

See XYZ (type)
See BITMAPV2INFOHEADER (type)
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF RED-ENDPOINT)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

RESOLUTION-UNIT

ENTRY

Accesses the resolution unit identifier of the image.

See OS22XBITMAPHEADER (type)
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF RESOLUTION-UNIT)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

TYPE

ENTRY

Accesses the contained image type.

Can be either :ICO for an icon, or :CUR for a cursor.

See ICO (type)

EXTERNAL GENERIC-FUNCTION
(SETF TYPE)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

VERTICAL-RESOLUTION

ENTRY

Accesses the vertical physical resolution method of the image.

See BITMAPINFOHEADER (type)
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF VERTICAL-RESOLUTION)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

WIDTH

ENTRY

Accesses the width of the image.

See BITMAPCOREHEADER (type)
See ICO-ENTRY (type)
See BMP (type)
See BMPCONTENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF WIDTH)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

X

ENTRY

Accesses the X component.

See XYZ (type)

EXTERNAL GENERIC-FUNCTION
(SETF X)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

Y

ENTRY

Accesses the Y component.

See XYZ (type)

EXTERNAL GENERIC-FUNCTION
(SETF Y)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

Z

ENTRY

Accesses the Z component.

See XYZ (type)

EXTERNAL GENERIC-FUNCTION
(SETF Z)
- VALUE
- ENTRY
No documentation provided.