GetClipboardImage()

Syntax

Result = GetClipboardImage(#Image [, Depth])

Creates a new #Image from the clipboard image data (if any). If #PB_Any is used as the '#Image' parameter, the new image number will be returned to Result. If something is wrong a 0 value is returned.

If 'Depth' is omitted or set to #PB_Image_DisplayFormat, the image format is taken from the desktop format. Valid 'Depth' values are: 1, 2, 4, 8, 16, 24 and 32 bits. When manipulating true-color formats, it is advised to use the 24 or 32 bit depth values, in order to avoid color information loss. If the images are to be used only for screen display, #PB_Image_DisplayFormat will provide the fastest performance.

The image may be freed by using the FreeImage() function. For further use of the image, there are functions available such as DrawImage() or ImageGadget().

Supported OS

All