In This Topic ▼

LBitmapBase::PutRowColCompressed

Summary

Puts a row (or part of a row) of 1-bit compressed data from a buffer into a class object's bitmap that is maintained in its compressed format.

Syntax

#include "ltwrappr.h"

virtual L_SSIZE_T LBitmapBase::PutRowColCompressed(LRunBuffer, nRow, nCol, uWidth, pWorkBuffer=NULL)

Parameters

LBuffer& LRunBuffer

An LBuffer object that contains the row data.

L_INT nRow

The number of the row in which to put the data. The first row is 0, and the last row is 1 less than the bitmap height.

L_INT nCol

The column offset within the row to update. The first column offset is 0, and the last column offset is 1 less than the bitmap width.

L_UINT32 uWidth

The number of pixels to be placed in the row.

LBuffer * pWorkBuffer

A pointer to an optional work buffer. You can also pass NULL. Allocating the work buffer speeds processing if you call this function more than once, because if you do not allocate a work buffer, the function allocates and frees a temporary buffer each time it is called. The size of this buffer should be the same as the value returned by LBitmapBase::GetBytesPerLine.

Returns

Value	Meaning
> 0	The number of pixels processed.
< 1	An error occurred. Refer to Return Codes.

Comments

This function is useful for working with 1-bit images that are loaded in their compressed formats for faster loading and display. For more information, refer to Speeding Up 1-Bit Documents.

Note: The LRunBuffer parameter is passed by reference, and is a required parameter.