In This Topic ▼

PAINTCALLBACK_GETDIBINFO Function

#include "l_bitmap.h"

L_INT pEXT_CALLBACK YourFunction(pDisplay, pBitmap, uWidth, pDibInfo, pUserData)

This callback is used to get information on the image date expected by your display adapter.

Parameters

L_VOID *pDisplay

Handle of the device context passed to the paint function.

pBITMAPHANDLE pBitmap

Pointer to the bitmap handle structure holding the input data.

L_UINT uWidth

The number of pixels that will be converted.

pPAINTDIBINFO pDibInfo

Pointer to a PAINTDIBINFO structure that will be filled by this function.

L_VOID *pUserData

Void pointer that you can use to access a variable or structure containing data that your callback function needs. This gives you a way to receive data indirectly from the function that uses this callback function. (This is the same pointer that you pass in the pUserData parameter of the PAINTCALLBACKDATA structure.)

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

pDisplay is the pDisplay member from the PAINTCALLBACKDATA structure that you passed to the paint function. The default callbacks expect it to be a HDC handle. But, if you override all the paint callbacks, it can be a pointer of any type you want.

This callback is expected to fill the pDibInfo structure with information describing the expected format of the data that should be used in painting to your display adapter. If you override the PAINTCALLBACK_STRETCHDIBITS callback, this structure will describe the format expected by that function.

uWidth should be used to calculate the uBytesPerLine member of the PAINTDIBINFO structure. This tells LEADTOOLS what sort of padding to add to each row. Usually, GDI functions expect the number of bytes per line to be a multiple of 4. You indicate if your device expects that or not by filling the uBytesPerLine field.

You have to provide this callback in order to be able to provide your own PAINTCALLBACK_CONVERTLINE callback.

Required DLLs and Libraries