Next: Image Files, Previous: Image Types, Up: Images [Contents][Index]
The following paragraphs describe the CLX functions used to:
For a returned image, true if the order of bits in each :data byte is least-significant bit first.
One of 1, 4, 8, 16, 24, or 32.
For :true-color or :direct-color images, a pixel mask.
For a returned image, true if the :data byte order is least-significant byte first.
For a returned image, the number of :data bytes per scanline.
Either a list of bitmaps, a pixarray, or an array of card8 bytes.
The number of bits per displayed pixel.
One of :bitmap, :xy-format, or :z-format.
For :true-color or :direct-color images, a pixel mask.
A card16 for the image height in pixels.
An optional stringable for the image name.
An optional image property list.
For :true-color or :direct-color images, a pixel mask.
A card16 for the image width in pixels.
For a cursor image, the x position of the hot spot.
For a cursor image, the y position of the hot spot.
Creates an image object from the given :data and returns either an image, image-xy, or an image-z, depending on the type of image :data. If the :data is a list, it is assumed to be a list of bitmaps and an image-xy is created. If the :data is a pixarray, an image-z is created. Otherwise, the :data must be an array of bytes (card8), in which case a basic image object is created.
If the :data is a list, each element must be a bitmap of equal size. :width and :height default to the bitmap width – (array-dimension bitmap 1) – and the bitmap height – (array-dimension bitmap 0) – respectively. :depth defaults to the number of bitmaps.
If the :data is a pixarray, :width and :height default to the pixarray width – (array-dimension pixarray 1), and the pixarray height – (array-dimension pixarray 0), respectively. :depth defaults to (pixarray-depth :data). The :bits-per-pixel is rounded to a valid size, if necessary. By default, the :bits-per-pixel is equal to the :depth.
If the :data is an array of card8, the :width and :height are required to interpret the image data correctly. The :bits-per-pixel defaults to the :depth, and the :depth defaults to 1. :bytes-per-line defaults to:
(floor (length :data) (* :bits-per-pixel :height))
The :format defines the storage format of image data bytes and can be one of the following values:
The :data is organized as a set of bitmaps representing image bit planes, appearing in most-significant to least-significant bit order.
The :data is organized as a set of pixel values in scanline order.
Similar to :xy-pixmap, except that the :depth must be 1, and 1 and 0 bits represent the foreground and background pixels, respectively.
By default, the :format is :bitmap if :depth is 1; otherwise, :z-pixmap.
A list or a pattern.
A pattern.
Creates an image object from the given patterns and returns an image-z of depth 1. Each pattern is a bit-vector. If the first argument is a list, then it is used to initialize the property list of the image being created.
The consequences are undefined if the patterns are not of the same length.
An image object.
card16 values defining the position of the upper-left corner of the subimage copied.
card16 values defining the size of subimage copied.
One of ’image-x, ’image-xy, or ’image-z.
Returns a new image, of the given :result-type, containing a copy of the portion of the image defined by :x, :y, :width, and :height. By default, :width is:
(- (image-width image) :x)
and :height is:
(- (image-height image) :y)
If necessary, the new image is converted to the :result-type, that can be one of the following values:
'image-xA basic image object is returned.
'image-xyAn image-xy is returned.
'image-zAn image-z is returned.
Type image.
A drawable.
card16 values defining the upper-left drawable pixel returned. These arguments are required.
card16 values defining the size of the image returned. These arguments are required.
A pixel mask.
Either :xy-pixmap or :z-pixmap.
One of ’image-x, ’image-xy, or ’image-z.
Returns an image containing pixel values from the region of the drawable given by :x, :y, :width, and :height. The bits for all planes selected by 1 bits in the :plane-mask are returned as zero; the default :plane-mask is all 1 bits. The :format of the returned pixel values may be either :xy-format or :z-format.
The :result-type defines the type of image object returned:
'image-xA basic image object is returned.
'image-xyAn image-xy is returned.
'image-zAn image-z is returned.
By default, :result-type is ’image-z if :format is :z-format and ’image-xy if :format is :xy-format.
The destination drawable.
The graphics context used to display the image.
An image object.
card16 values defining the upper-left position of the image region to display.
The position in the drawable where the image region is displayed. These arguments are required.
card16 values defining the size of the image region displayed.
If image is depth 1, then if true, foreground and background pixels are used to display 1 and 0 bits of the image.
Displays a region of the image defined by :src-x, :src-y, :width, and :height on the destination drawable, with the upper-left pixel of the image region displayed at the drawable position given by :x and :y. By default, :width is:
(- (image-width image) :src-x)
and :height is:
(- (image-height image) :src-y)
The following attributes of the gcontext are used to display the image: clip-mask, clip-x, clip-y, function, plane-mask, and subwindow-mode.
The :bitmap-p argument applies only to images of depth 1. In this case, if :bitmap-p is true or if the image is a basic image object created with :format :bitmap, the image is combined with the foreground and background pixels of the gcontext. 1 bits of the image are displayed in the foreground pixel and 0 bits are displayed in the background pixel.
Next: Image Files, Previous: Image Types, Up: Images [Contents][Index]