Syntax
INT is_SaveImage (HIDS hf, char* File)
Description
Saves an image from the computer’s memory to a file. The file is saved in BMP format. The images are read from the currently valid image memory (also see is_GetImageMem()). In DirectDraw modes the image data are read from the corresponding DirectDraw buffer. Consider in DirectDraw primary surface mode that the image is saved as displayed on the screen. The maximum image size is the size of the output window, independent of which image size is set with is_SetImageSize(). Overlapped parts of the output window will be saved with the content of the overlapping window.
The bitmap is saved with an 8, 15, 16, 24 or 32 bit color depth, as was allocated in the image memory and/or the color mode of the DirectDraw mode. Some image processing programs do not support all 15 bit, 16 bit and 32 bit bitmaps and therefore will be unable to load the images.
The file name can contain an absolute as well as a relative file path. With is_LoadImage() the BMP images can be loaded.
If the overlay is used in DirectDraw back buffer mode then the image and the overlay data will be saved if the overlay is visible.
In DirectDraw overlay surface mode the overlay data cannot be saved with the image data.
The read out of the Direct Draw Buffers is relatively slowly in comparison to the read out of the PC RAM. Thus is to be counted on a longer process time when storing Direct Draw buffers.
Parameters
hf |
Frame grabber handle |
File |
BMP file name NULL = "Save as" dialog box is displayed |
Return value
IS_SUCCESS, IS_NO_SUCCESS
