L_OffsetBitmap (original) (raw)

Summary

Shifts the bitmap pixels horizontally and vertically.

Syntax

#include "l_bitmap.h"

L_LTIMGEFX_API L_INT L_OffsetBitmap(pBitmap, nHorizontalShift, nVerticalShift, crBackColor, uFlags)

Parameters

pBITMAPHANDLE pBitmap

Pointer to the bitmap handle that references the bitmap on which to apply the effect.

L_INT nHorizontalShift

Horizontal shift of the bitmap, in pixels.

L_INT nVerticalShift

Vertical shift of the bitmap, in pixels.

COLORREF 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 uFlags parameter is set to FILL_CLR.

L_UINT uFlags

Flag that indicates how to handle any exposed areas resulting from the bitmap shift. Possible values are:

Returns

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 in the Document and Medical Imaging 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.

Offset Function - Before

Offset Function - After

View additional platform support for this Offset 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

Win32, x64, Linux.

See Also

Functions

• L_EmbossBitmap
• L_AddShadowBitmap
• L_AllocFTArray
• L_ChangeHueSatIntBitmap
• L_ColorReplaceBitmap
• L_ColorThresholdBitmap
• L_DFTBitmap
• L_DirectionEdgeStatisticalBitmap
• L_FFTBitmap
• L_FreeFTArray
• L_FrqFilterBitmap
• L_FrqFilterMaskBitmap
• L_FTDisplayBitmap
• L_GetBitmapStatisticsInfo
• L_GetFeretsDiameter
• L_GetObjectInfo
• L_GetRgnContourPoints
• L_GetRgnPerimeterLength
• L_MathFunctionBitmap
• L_SegmentBitmap
• L_SubtractBackgroundBitmap
• L_UserFilterBitmap
• L_OffsetBitmapRgn.

Topics

• Raster Image Functions: Doing Geometric Transformations
• Raster Image Functions: Artistic Effects
• Applying Artistic Effects

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(MAKE_IMAGE_PATH(TEXT("NaturalFruits.jpg")), &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, RGB(0, 0, 0), FILL_WRAP); if (nRet != SUCCESS) return nRet; nRet = L_SaveBitmap(MAKE_IMAGE_PATH(TEXT("Result.BMP")), &LeadBitmap, FILE_BMP, 24, 0, NULL); if (nRet != SUCCESS) return nRet; //free bitmap if (LeadBitmap.Flags.Allocated) L_FreeBitmap(&LeadBitmap); return SUCCESS; }