oemGetImage
This function retrieves an image from the engine and stores it in memory pointed to by pImageBuffer.
Result_t oemGetImage (
BYTE *pImageBuffer, DWORD *pdwSize, WORD nTop, WORD nLeft, WORD nRight, WORD nBottom, WORD nSkip, WORD nBits, FileFormat_t nFormat, WORD nWhiteValue, WORD nExposeAttempts, WORD nGap,
BOOL Invert
void ( *fpProgress ) (WORD)
)
Return Values
RESULT_SUCCESS
RESULT_ERR_UNSUPPORTED
RESULT_ERR_DRIVER
RESULT_ERR_PARAMETER
RESULT_ERR_NORESPONSE
RESULT_ERR_BADREGION
RESULT_ERR_MEMORY
RESULT_ERR_FILE
Parameters
pImageBuffer
Memory pointer to where the image should be stored. The caller must allocate this buffer before calling oemGetImage.
pdwSize
Upon successful return, the number of bytes of image data stored in pImageBuffer.
nTop, nLeft
Coordinates relative to the image engine's pixel grid for first pixel of the transferred image. The upper left pixel has both an nLeft and an nTop value of 0.
nRight, nBottom
Coordinates relative to the image engine's pixel grid for last pixel of the transferred image.
nSkip:
When transferring an image, transfer every nSkip pixel.
nBits
The color depth for the transferred image. Valid values are typically only 8 or 1, but this depends on the engine hardware. Independent of the bits used, a lower value is darker than a higher value. For example, if 8 bits are chosen, then a pixel value of 255 indicates pure white, and a pixel value of 0 indicates pure black. Values in between are to be interpreted as incremental levels of gray.
nFormat: FF_RAW_BINARY
The black and white data stored in the pImageBuffer is stored 1 bit per pixel starting with the upper left pixel and proceeding sequentially left to right and top to bottom.
FF_RAW_GRAY
The grayscale data stored in the pImageBuffer is stored 8 bit per pixel starting with the upper left pixel and proceeding sequentially left to right and top to bottom.
nWhiteValue
The target white value when performing auto exposure control.
IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide | 2 - 7 |
