In This Topic ▼

LBitmapBase::PutRow

Summary

Copies a row of image data from an LBuffer object, to a bitmap. The data is copied exactly as it is stored in the buffer. The buffer contains uncompressed data.

Syntax

#include "ltwrappr.h"

virtual L_SSIZE_T LBitmapBase::PutRow(LBuff, nRow)

Parameters

LBuffer& LBuff

An LBuffer object that contains the row data.

L_INT nRow

The number of the row to update. The first row is 0, and the last row is 1 less than the bitmap height.

Returns

Value	Meaning
>=1	The number of bytes put.
< 1	An error occurred. Refer to Return Codes.

Comments

The bitmap memory must be locked when you use this function. Normally, you can call LBitmapBase::Access to lock the memory before starting an operation that uses this function, then call LBitmapBase::Release when the operation is finished.

You can use the bits per pixel of the image to determine the number of bytes to set the uBytes parameter. If the image is 8-bit then each byte is an index to the palette. If the image is a 24-bit image, then each three bytes represents one pixel element. Color order is determined by the LBitmapBase::GetColorOrder. This value can be either ORDER_RGB, ORDER_BGR, ORDER_GRAY, or ORDER_ROMM.

The LBuff parameter is passed by reference, and is a required parameter.

NOTE: To calculate the correct size for a single row of image data:

(((Width * BitsPerPixel) + 31) >> 3)) &~3