GetClipboardImage()

Syntax

Result = GetClipboardImage(#Image [, Depth])

Creates a new #Image from the clipboard image data (if any). If #PB_Any is used as '#Image' parameter, the new image number will be returned as 'Result'. If something is wrong the 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 can be: 1, 2, 4, 8, 16, 24 and 32 bits. When manipulating true colors formats, and want save back the modifications without color information loss, it's advised to use the 24 or 32 bits values. If the images are only used for displaying on the screen, #PB_Image_DisplayFormat will provide faster performances.

The image can be freed by using the FreeImage() command. For further use of the image there are available commands like DrawImage() or ImageGadget().

Supported OS

Windows