7.2.1 Basic Images

The following paragraphs describe the CLX functions that can be used to access all types of image objects.



image-blue-mask image Function
        
image
An image object.

Returns (and with setf) changes the mask that selects the pixel subfield for blue intensity values. The mask is non-nil only for images for :direct-color or :true-color visual types.

mask
Type pixel or null.


image-depth image Function
        
image
An image object.

Returns the depth (that is, the number of bits per pixel) for the image.

depth
Type card8.


image-green-mask image Function
        
image
An image object.

Returns (and with setf) changes the mask that selects the pixel subfield for green intensity values. The mask is non-nil only for images for :direct-color or :true-color visual types.

mask
Type pixel or null.


image-height image Function
        
image
An image object.

Returns the height of the image in pixels.

height
Type card16.


image-name image Function
        
image
An image object.

Returns and (with setf) changes the name string optionally associated with the image.

name
Type stringable or null.


image-plist image Function
        
image
An image object.

Returns and (with setf) changes the image property list. The property list is a hook for added application extensions.

plist
Type list.


image-red-mask image Function
        
image
An image object.

Returns (and with setf) changes the mask which selects the pixel subfield for red intensity values. The mask is non-nil only for images for :direct-color or :true-color visual types.

mask
Type pixel or null.


image-width image Function
        
image
An image object.

Returns the width of the image in pixels.

width
Type card16.


image-x-hot image Function
        
image
An image object.

Returns and (with setf) changes the x position of the hot spot for an image used as a cursor glyph. The hot spot position is specified relative to the upper-left origin of the image.

x-position
Type card16 or null.


image-y-hot image Function
        
image
An image object.

Returns and (with setf) changes the y position of the hot spot for an image used as a cursor glyph. The hot spot position is specified relative to the upper-left origin of the image.

y-position
Type card16 or null.