Function

Summary

Displays an image on a graphics port at a given position.

Package

graphics-ports

Signature

draw-image port image to-x to-y &rest args &key from-x from-y to-width to-height from-width from-height global-alpha

Arguments

port

A graphics port.

image

An image.

to-x

A real number.

to-y

A real number.

args

graphics-state parameters passed as keyword arguments.

from-x

A real number.

from-y

A real number.

to-width

A real number.

to-height

A real number.

from-width

A real number.

from-height

A real number.

global-alpha

A real number in the inclusive range [0,1], or nil .

Description

The draw-image function displays image on the port at to-x to-y .

The default value of from-x and from-y is 0. The width and height arguments default to the size of the image.

When port 's drawing-mode is :compatible , graphics state translation is guaranteed to be supported but support for scaling and rotation are library dependent. Specifically, scaling is supported in the Windows, Cocoa and GTK+ implementations, but not on X11/Motif.

When port 's drawing-mode is :quality , the target coordinates are fully transformed according to the transformation in the graphics-state.

For more information about drawing-mode , see "Drawing mode and anti-aliasing" in the CAPI User Guide .

global-alpha , if non- nil , is a blending factor that applies to the whole image, in the Windows and Cocoa implementations, but not on X11/Motif or GTK+. The value 0 means use only the target (that is, do not draw anything) and the value 1 means use only the source (that is, normal drawing). Intermediate real values mean use proportions of both the target and source. The value nil also means normal drawing, and this is the default value.

Notes

On Microsoft Windows, if the image was loaded from a .ico file then draw-image ignores from-x , from-y , from-width , from-height and the graphics-state operation when drawing the image, and also global-alpha is ignored.