L_CompressRow

#include "l_bitmap.h"

L_LTKRN_API L_INT L_CompressRow(pRunBuffer, pBuffer, nCol, nWidth)

Does buffer-to-buffer RLE compression of 1-bit image data. Use this function to process all or part of a single line of image data.

Parameters

L_UINT16* pRunBuffer

Pointer to the output buffer, which will be filled with 1-bit compressed image data. Calculate the required size of this buffer as follows: bytes required = (nWidth + 3) * 2.

L_UCHAR* pBuffer

Pointer to the input buffer, which contains the 1-bit image data to be compressed. Use integer math to calculate the required size of this buffer as follows: bytes required = (nCol + nWidth + 7) / 8.

L_INT nCol

Column offset within the row to be processed. The function skips this many pixels before it begins processing.

L_INT nWidth

The number of pixels to process.

Returns

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

Comments

The output buffer must be larger than the input buffer to accommodate the worst possible case with run-length encoding, where there are alternating black and white pixels. In most cases, however, the actual compressed data will be much smaller than the input data.

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.

Required DLLs and Libraries

Platforms

Win32, x64, Linux.

Help Version 21.0.2021.3.4
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help