ImageGear for C and C++ on Windows v20.5 - Updated
LPFNIG_RASTER_PLANE_SET
API Reference Guide > Core Component API Reference > Core Component Callback Functions Reference > LPFNIG_RASTER_PLANE_SET

This function is called by ImageGear to let your application store or process each color plane raster, as it is obtained from the file.

Declaration:

 
Copy Code
typedef AT_ERRCOUNT (LPACCUAPI LPFNIG_RASTER_PLANE_SET)(
        AT_VOID* lpPrivate, 
        const AT_VOID* lpRast, 
        AT_PIXPOS cyPos, 
        AT_INT cRasterSize, 
        AT_INT nBitPlane
);

Arguments:

Name Type Description
lpPrivate AT_VOID* A far pointer to a private data area.
lpRast const AT_VOID* Raster line to set.
cyPos AT_PIXPOS Y position in the image.
cRasterSize AT_INT Size of the raster line.
nBitPlane AT_INT Index of the color plane in which to merge.

Return Value:

Returns 0 if successful. Otherwise, returns the number of ImageGear errors that occurred during this function call.

Supported Raster Image Formats:

This function does not process image pixels.

Sample:

None

Remarks:

ImageGear calls this function to pass raster plane data that has been read from a file to the application. The callback is invoked when reading images where pixel data is stored in planar format. Currently, only TIFF and DICOM format filters support this callback.

Is this page helpful?
Yes No
Thanks for your feedback.