external-image

external-image Class

Summary

A class representing a color image.

Package

graphics-ports

Superclasses

t

Initargs

`:data`	A vector that is simple and with element type `(unsigned-byte 8)`.
`:transparent-color-index`
	An integer or `nil`.
`:type`	A keyword, or `nil`.

Description

The class external-image provides a representation of a color image that is subject to write-external-image, read-external-image and convert-external-image operations.

You can also make an instance of external-image using make-instance with the following initargs:

data must be supplied as a vector that is simple and with element type (unsigned-byte 8) containing the bytes representing the image. When the data comes from a file, you can use read-external-image, or use file-binary-bytes to get the data.

If type is nil (the default), then data must be in DIB format, otherwise type should be the type as specified for read-external-image and data must be in the corresponding format. If type is one of the list that is returned by list-known-image-formats then the image can be displayed on the screen that was passed to list-known-image-formats, but an external-image can be created with any type.

transparent-color-index is the same as specified for read-external-image.