L_OffsetBitmap
#include "l_bitmap.h"
L_LTIMGEFX_API L_INT L_OffsetBitmap(pBitmap, nHorizontalShift, nVerticalShift, crBackColor, uFlag)
pBITMAPHANDLE pBitmap; |
/* pointer to bitmap handle */ |
L_INT nHorizontalShift; |
/* horizontal shift */ |
L_INT nVerticalShift; |
/* vertical shift */ |
COLORREF crBackColor; |
/* background color */ |
L_UINT uFlag; |
/* flag */ |
Shifts the bitmap pixels horizontally and vertically.
Parameter |
Description |
|
pBitmap |
Pointer to the bitmap handle that references the bitmap on which to apply the effect. |
|
nHorizontalShift |
Horizontal shift of the bitmap, in pixels. |
|
nVerticalShift |
Vertical shift of the bitmap, in pixels. |
|
crBackColor |
The COLORREF value that specifies the fill color for any exposed areas. You can specify a COLORREF value, such as the return value of the Windows RGB macro, or you can use the PALETTEINDEX macro to specify a palette color. This is only useful when uFlag parameter is set to FILL_CLR. |
|
uFlag |
Flag that indicates how to handle any exposed areas resulting from the bitmap shift. Possible values are: |
|
|
Value |
Meaning |
|
FILL_CLR |
[0x0000] Fill the exposed areas with crBackColor. |
|
FILL_NOCHG |
[0x0001] Leave the exposed area as is, without changing it. |
|
FILL_RPT |
[0x0002] Stretch the image edges to fill the exposed area. |
|
FILL_WRAP |
[0x0003] Fill any exposed areas with the opposite side of the image. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
This function does not support signed data images. It returns the error code ERROR_SIGNED_DATA_NOT_SUPPORTED if a signed data image is passed to this function.
This function shifts the bitmap pixels horizontally and vertically.
Use the L_OffsetBitmapRgn function to move a bitmap region by the specified number of rows and columns.
This function supports 12- and 16-bit grayscale and 48- and 64-bit color images. Support for 12- and 16-bit grayscale and 48- and 64-bit color images is available only in the Document/Medical toolkits.
To update a status bar or detect a user interrupt during execution of this function, refer to L_SetStatusCallback.
This function does not support 32-bit grayscale images. It returns the error code ERROR_GRAY32_UNSUPPORTED if a 32-bit grayscale image is passed to this function.
Required DLLs and Libraries
LTIMGEFX 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
Windows 2000 / XP/Vista.
See Also
Example
L_INT OffsetBitmapExample(L_VOID) { L_INT nRet; BITMAPHANDLE LeadBitmap; /* Bitmap handle for the image */ /* Load a bitmap at its own bits per pixel */ nRet = L_LoadBitmap (TEXT ("C:\\Program Files\\LEAD Technologies\\LEADTOOLS 15\\Images\\IMAGE3.CMP"), &LeadBitmap, sizeof (BITMAPHANDLE), 0, ORDER_BGR, NULL, NULL); if(nRet !=SUCCESS) return nRet; /* Apply the Offset Bitmap effect to the image*/ nRet = L_OffsetBitmap(&LeadBitmap, LeadBitmap.Width / 2, LeadBitmap.Height / 2, 0, FILL_WRAP); if(nRet !=SUCCESS) return nRet; nRet = L_SaveBitmap(TEXT("C:\\Program Files\\LEAD Technologies\\LEADTOOLS 15\\Images\\Result.BMP"), &LeadBitmap, FILE_BMP, 24, 0, NULL); if(nRet !=SUCCESS) return nRet; //free bitmap if(LeadBitmap.Flags.Allocated) L_FreeBitmap(&LeadBitmap); return SUCCESS; }