LBitmap::DisplaceMap

#include "ltwrappr.h"

L_INT LBitmap::DisplaceMap(phDisplaceBitmap, uHorzFact, uVertFact, crFill, uFlags)

L_INT LBitmap::DisplaceMap(plDisplaceBitmap, uHorzFact, uVertFact, crFill, uFlags)

pBITMAPHANDLE phDisplaceBitmap;	/* pointer to the displacement bitmap handle */
LBitmapBase * plDisplaceBitmap;	/* pointer to LBitmapBase class object*/
L_UINT uHorzFact;	/* horizontal shift factor*/
L_UINT uVertFact;	/* vertical shift factor*/
COLORREF crFill;	/* fill color */
L_UINT uFlags;	/* flags */

Displaces bitmap pixels horizontally and vertically according to the values of the displacement map image.

Parameter	Description
phDisplaceBitmap	Pointer to the bitmap handle that references the displacement map bitmap.
plDisplaceBitmap	Pointer to LBitmapBase class object that references the displacement map bitmap.
uHorzFact	Horizontal displacement factor, in percent of the bitmap dimensions. The valid range is from 0 to 100.
uVertFact	Vertical displacement factor, in percent of the bitmap dimensions. The valid range is from 0 to 100.
crFill	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.
uFlags	Flags that indicate how to handle exposed areas, and the way to use the displacement map image. You can use a bitwise OR (\|) to specify one flag from each group. The following are the flags that indicate how to handle exposed areas:
	Value	Meaning
	FILL_CLR	[0x0000] Fill any exposed areas with crFill
	FILL_RPT	[0x0001] Stretch the image edges to fill the exposed area.
	FILL_NOCHG	[0x0002] Leave the exposed area as is, without changing it.
	FILL_WRAP	[0x0003] Fill any exposed area with the opposite side of the image.
	The following are the flags that indicate the way to use the displacement map image:
	Value	Meaning
	DSPL_STRETCH	[0x0000] Stretch the displacement map image over the entire image area.
	DSPL_TILE	[0x0010] Repeat the displacement map image to cover the image area.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This effect shifts image pixels according to the values of the displacement map. Red values in the displacement map shift the original pixels horizontally. Green values in the displacement map shift the original values vertically. Blue values are ignored. A displacement map value of 128 means not to shift anything. A displacement map value of 0 means to shift pixels the complete vertical or horizontal percentage, to the left or down. A displacement map value of 255 means to shift pixels the complete vertical or horizontal percentage, to the right or up.

Displacement maps modify the geometry of the object. As a result, pixel shifts and forms may be added to the image, and the image may be warped or distorted.

For an example, click here

If the bitmap has a region, the effect will be applied on the region only.

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 LBase::EnableStatusCallback.

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 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.

See Also

Functions:	LBitmap::AddNoise, LBitmap::Emboss, LBitmap::Mosaic, LBitmap::MotionBlur, LBitmap::Oilify, LBitmap::Posterize, LBitmap::RemoveRedeye, LBitmap::Solarize, LBitmapBase::Underlay, LBitmap::BumpMap, LBitmap::Cubism, LBitmap::DrawStar, LBitmap::FreePlaneBend, LBitmap::FreeRadBend, LBitmap::Dry, LBitmap::GlowFilter, LBitmap::Ocean, LBitmap::GlassEffect, LBitmap::LensFlare, LBitmap::Light, LBitmap::PlaneBend, LBitmap::Plane, LBitmap::SampleTarget, LBitmap::Tunnel, LBitmap::Bending, LBitmap::Cylindrical, LBitmap::FreeHandShear, LBitmap::FreeHandWave, LBitmap::Impressionist, LBitmap::Pixelate, LBitmap::Polar, LBitmap::Punch, LBitmap::RadialBlur, LBitmap::RadWave, LBitmap::Ripple, LBitmap::Spherize, LBitmap::Swirl, LBitmap::Wave, LBitmap::Wind, LBitmap::ZoomBlur, LBitmap::ZoomWave
Topics:	Raster Image Functions: Doing Geometric Transformations
	Applying Artistic Effects
	Processing an Image
	Raster Image Functions: Processing an Image
	Raster Image Functions: Combining Images
	Raster Image Functions: Functions Where the Region Preempts the Bitmap
	Raster Image Functions: Artistic Effects

Example

This example is for LBitmap::DisplaceMap(plDisplacementMap, uHorzFact, uVertFact, crFill, uFlags)

L_INT LBitmap__DisplaceMapExample()
{
   L_INT nRet;
   LBitmap btmp ;
   LBitmap LeadBitmap;
   
   nRet =LeadBitmap.Load(TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\IMAGE4.CMP"), 0,ORDER_BGR);
   if(nRet !=SUCCESS)
      return nRet;
   nRet =btmp.Load(TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\displacementmap.bmp"),0,ORDER_BGR) ;
   if(nRet !=SUCCESS)
      return nRet;
   /* Shift the image according to the displacement map*/
   nRet =LeadBitmap.DisplaceMap(&btmp, 5, 5, RGB(0,0,0), FILL_CLR|DSPL_TILE);
   if(nRet !=SUCCESS)
      return nRet;
   return SUCCESS;
}