L_PaintDCBuffer

#include "l_bitmap.h"

L_LTDIS_API L_INT L_PaintDCBuffer(hDC, pBitmap, pSrc, pClipSrc, pDst, pClipDst, uROP3, pBuffer, nRow, nCount)

Paints image data into a device context from a buffer.

Parameters

L_HDC hDC

Handle to a device context, such as a screen, to use as the display surface. The mapping mode of the device context must be MM_TEXT.

pBITMAPHANDLE pBitmap

Pointer to the bitmap handle that describes the image to paint.

L_RECT * pSrc

Pointer to the Windows RECT structure that specifies the part of the bitmap to use as the display source.

The coordinates in the RECT structure are relative to the bitmap. You can pass NULL to use the default, which matches the bitmap.

L_RECT * pClipSrc

Pointer to the Windows RECT structure that specifies the portion of the display source to paint. Generally, this is used for updating the display when part of the source bitmap has changed.

The coordinates in the RECT structure are relative to the bitmap. You can pass NULL to use the default, which matches the bitmap.

L_RECT * pDst

Pointer to the Windows RECT structure that determines how the source rectangle is scaled and how the image is positioned in the device context.

The coordinates in the RECT structure are relative to the device context. There is no default for this parameter. You must specify the RECT structure.

L_RECT * pClipDst

Pointer to the Windows RECT structure that specifies the portion of the display rectangle to paint. Generally, this is used for updating changes in the display surface, such as when a user moves another window, uncovering a part of the image that had been covered up.

The coordinates in the RECT structure are relative to the device context. You can pass NULL to use the default, which matches the device context. In most cases, however, you should use the rectangle returned by the Windows WM_PAINT message.

L_UINT32 uROP3

The Windows ROP code that determines how the destination rectangle is updated. This parameter takes the same codes as the Windows BitBlt function. For ordinary painting, use SRCCOPY.

L_UCHAR * pBuffer

Pointer to the buffer that contains the image data to paint.

L_INT nRow

The first row to paint. The painted portion of any row may be limited by the RECT parameters.

L_INT nCount

The number of rows to paint. The painted portion of any row may be limited by the RECT parameters. If the image data in pBuffer is compressed 1-bit data, you can specify the number of lines as a negative value (-nLines), as explained in Speeding Up 1-Bit Documents.

Returns

Comments

This function references a LEAD bitmap handle, which may or may not have a loaded bitmap. In either case, the following fields must be specified in the LEAD BITMAPHANDLE structure:

The Width, Height, BitsPerPixel, Order, and ViewPerspective fields must all be set to the correct values for the image. (You can use the L_InitBitmap function to set the values.)

The pPalette must be a valid palette (an array of RGBQUAD values). You can create or update the palette using the L_PutBitmapColors function.

Except for the buffer specifications, this function uses source and destination rectangles the same as L_PaintDC. For a complete explanation, refer to L_PaintDC.

You can call L_PaintDCBuffer from a callback function to paint an image while a bitmap is being loaded. This technique is used in the FILEREADCALLBACK procedures in the DEMO.C example program.

Required DLLs and Libraries

• LTDIS
• For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.