Combines the source object's bitmap with the calling objects bitmap so that one appears to be an underlying texture for the other. This is most effective when the underlying image is a filtered one, such as an embossed image.
#include "ltwrappr.h"
virtual L_INT LBitmapBase::Underlay(LUnderlayBmp, uFlags=UB_TILE)
The LBitmapBase object. This objects bitmap will be used as an underlay for the calling object's bitmap.
Flag that indicates how the underlying image is to be positioned. Possible values are:
Value | Meaning |
---|---|
UB_TILE | [0x00] Tile the underlay. This repeats the underlying image, so that it fills the target image. This function does not do any resizing; you are responsible for the size of the tiles. |
UB_STRETCH | [0x01] Stretch the underlay to fit the dimensions of the target image. |
Value | Meaning |
---|---|
SUCCESS | The function was successful. |
< 1 | An error occurred. Refer to Return Codes. |
This function changes the colors of the underlay to grayscale as it combines the images. It updates the target bitmap (pBitmapDst), leaving the second bitmap (pUnderlay) unchanged. The underlying image can either be stretched or tiled to fill the target image, as shown in the following illustration:
To update a status bar or detect a user interrupt during execution of this function, refer to LBase::EnableStatusCallBack.
If a region is defined for the target bitmap, the underlay is applied to the region, not to the whole bitmap. (Any region defined for the underlay bitmap is ignored.)
Note: The LUnderlayBmp parameter is passed by reference, and is a required parameter.
Win32, x64.
L_INT LBitmapBase__UnderlayExample()
{
L_INT nRet;
LBitmapBase MyBitmap,Bitmap2;
MyBitmap.SetFileName(MAKE_IMAGE_PATH(TEXT("image1.cmp")));
nRet =MyBitmap.Load();
if(nRet !=SUCCESS)
return nRet;
Bitmap2.SetFileName(MAKE_IMAGE_PATH(TEXT("IMAGE2.CMP")));
nRet =Bitmap2.Load();
if(nRet !=SUCCESS)
return nRet;
nRet =MyBitmap.Underlay(Bitmap2, UB_TILE);
if(nRet !=SUCCESS)
return nRet;
return SUCCESS;
}
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document
Your email has been sent to support! Someone should be in touch! If your matter is urgent please come back into chat.
Chat Hours:
Monday - Friday, 8:30am to 6pm ET
Thank you for your feedback!
Please fill out the form again to start a new chat.
All agents are currently offline.
Chat Hours:
Monday - Friday
8:30AM - 6PM EST
To contact us please fill out this form and we will contact you via email.