Function

Summary

Loads an image from a Windows icon file, and returns the image object.

Signature

load-icon-image port filename &key width height => image

Arguments

port

A graphics port or CAPI object.

filename

The filename of an icon (.ico) file.

width

The desired width in pixels, or nil .

height

The desired height in pixels, or nil .

Values

image

An image object.

Description

The load-icon-image function loads an icon from filename which is expected to be a Windows format icon file. The first icon in the file is used.

load-icon-image returns an image object which can be drawn to port using draw-image and which must be freed using free-image when no longer needed.

If width and height are specified, then the image is scaled accordingly. If width and height are nil then the dimensions are taken from the icon file. width defaults to nil and height defaults to width .

Note: load-icon-image is defined only in LispWorks for Windows.

See also

draw-image
free-image
load-image