LBitmap::Canvas

#include "ltwrappr.h"

L_INT LBitmap::Canvas(phCanvasBitmap, uTransparency, uEmboss, nXOffset, nYOffset, uTilesOffset, uFlags)

L_INT LBitmap::Canvas(plCanvasBitmap, uTransparency, uEmboss, nXOffset, nYOffset, uTilesOffset, uFlags)

pBITMAPHANDLE phCanvasBitmap;	/* pointer to the bitmap handle */
LBitmapBase * plCanvasBitmap;	/* pointer to LBitmapBase class object */
L_UINT uTransparency;	/* the transparency amount */
L_UINT uEmboss;	/* image intensity */
L_INT nXOffset;	/* the x distance */
L_INT nYOffset;	/* the y distance */
L_UINT uTilesOffset;	/* the amount of shifting */
L_UINT uFlags;	/* flags */

Combines two bitmaps, superimposing one bitmap on another bitmap that is used like a canvas.

Parameter	Description
phCanvasBitmap	Pointer to the bitmap handle that references the canvas bitmap.
plCanvasBitmap	Pointer to LBitmapBase class object that references the canvas bitmap.
uTransparency	The transparency amount between the image and the canvas. Valid range is from 0 to 100. When set to 0, only the canvas image displays, and when set to 100, the canvas image is barely visible.
uEmboss	Apparent depth of the canvas image. Valid range is from 0 to 200. When uTransparency is at 100, and uEmboss is 0 only the image displays. Increasing uEmboss increases the apparent depth of the canvas image.
nXOffset	The X distance between the canvas origin point and the image origin point (in pixels). Valid range is from Canvas bitmap width to +Canvas bitmap width.
nYOffset	The Y distance between the canvas origin point and the image origin point (in pixels). Valid range is from Canvas bitmap height to +Canvas bitmap height.
uTilesOffset	The amount to shift every row of canvas image from the origin. This parameter is not used when uFlags is set to CANVAS_FIT.
uFlags	Flags that identify how to distribute the canvas image with respect to the image and how to handle resizing. The following flags identify how the distribute the canvas image with respect to the image:
	Value	Meaning
	CANVAS_FIT	[0x0000] Fit the canvas image so it has the same dimensions as the bitmap that is being applied to the canvas, without tiling.
	CANVAS_SHIFT	[0x0010] Shift the canvas image by the amount specified in uTilesOffset.
	The following flags identify which resizing method to use to resize the canvas image in order to fit the original image:
	Value	Meaning
	SIZE_NORMAL	[0x0000] Resize normally.
	SIZE_RESAMPLE	[0x0002] Use linear interpolation and averaging to produce a higher quality image.
	SIZE_BICUBIC	[0x0004] Use bicubic interpolation and averaging to produce a higher quality image. This is slower than SIZE_RESAMPLE.

Returns

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

Comments

The Canvas function combines two bitmaps, superimposing one bitmap on another bitmap that is used like a canvas.

For an example, click here

Other functions that allow you to combine images include:

LBitmap::BumpMap

LBitmapBase::Combine

LBitmapBase::CombineBitmapWarp

LBitmap::TextureAlphaBlend

LBitmapBase::Underlay

For more information on this and other functions that can be used to combine bitmaps, refer to Processing an Image.

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

LTIMGSFX

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::Emboss, LBitmap::AddShadow, LBitmap::BumpMap, LBitmap::ChangeHueSatInt, LBitmap::ColorReplace, LBitmap::ColorThreshold, LBitmapBase::Combine, LBitmapBase::CombineBitmapWarp, LBitmap::SubtractBackground, LBitmap::TextureAlphaBlend, LBitmapBase::Underlay, LBitmap::UserFilter, LBitmapBase::SizeInterpolate
Topics:	Raster Image Functions: Combining Images
	Raster Image Functions: Artistic Effects
	Applying Artistic Effects
	Processing an Image
	Raster Image Functions: Processing an Image

Example

This example is for LBitmap::Canvas(plCanvasBitmap, uTransparency, uEmboss, nXOffset, nYOffset, uTilesOffset, uFlags)

L_INT LBitmap__CanvasExample()
{
   L_INT nRet;
   LBitmap LeadBitmap, CanvasBitmap;
   
   nRet =LeadBitmap.Load(TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\IMAGE4.CMP"), 0,ORDER_BGR);
   if(nRet !=SUCCESS)
      return nRet;
   nRet =CanvasBitmap.Load(TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\IMAGE4.BMP"), 0,ORDER_BGR);
   if(nRet !=SUCCESS)
      return nRet;
   nRet =LeadBitmap.Canvas(&CanvasBitmap, 100, 100, 0, 0, 10, CANVAS_SHIFT);
   if(nRet !=SUCCESS)
      return nRet;
   return SUCCESS;
}