LEADTOOLS Raster Imaging C++ Class Library Help > Classes and Member Functions > LBitmap > LBitmap Member Functions > LBitmap::Clouds |
#include "ltwrappr.h"
L_INT LBitmap::Clouds(uSeed, uFrequency, uDensity, uOpacity, cBackColor, crCloudsColor, uFlags)
L_UINT uSeed; |
/* randomization factor */ |
L_UINT uFrequency; |
/* number of clouds */ |
L_UINT uDensity; |
/* cloud density */ |
L_UINT uOpacity; |
/* transparency percentage */ |
COLORREF cBackColor; |
/* background color */ |
COLORREF crCloudsColor; |
/* cloud's color */ |
L_UINT uFlags; |
/* flags */ |
Applies cloud effects to a bitmap.
Parameter |
Description |
|
uSeed |
Seed value that controls the cloud creation process. Possible values are those values that are 0 or greater. |
|
uFrequency |
Number of clouds inside the image. Valid values range from 0 to 16.The value of 0 means no clouds texture will be created, while the value of 16 means the maximum concentration of the clouds. |
|
uDensity |
Value that indicates the detail in the cloud. Possible values are range from 0 to 16. The value of 0 means no clouds texture will be created., while the value of 16 means the maximum detailed texture in the clouds. Use larger values to increase the detail in the clouds, smaller values for blurring. |
|
uOpacity |
Value that indicates the transparency, in percent, between the cloud's image and the original image. Possible values range from 0 to 100. This parameter is used if the CLD_OPACITY or CLD_DIFFERENCE flag is set. A value of 0 indicates that no clouds are being used and a value of 100 represents a mix of clouds and image. |
|
cBackColor |
The COLORREF value that specifies the fill color for the areas outside the cloud. 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. |
|
crCloudsColor |
The COLORREF value that specifies the fill color for the cloud. 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 |
Flag that specifies how to apply the effect. Possible values are: |
|
|
Value |
Meaning |
|
CLD_PURE |
[0x0000] Create a pure cloud texture. |
|
CLD_DIFFERENCE |
[0x0001] Apply the difference between the created cloud texture and the original image. |
|
CLD_OPACITY |
[0x0002] Combine the cloud colors with the colors of the original image by using the uOpacity value. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
The uSeed parameter allows you to change the shape of the cloud effect. The clouds are created using a pseudo-random process based on the value of the uSeed parameter. Each uSeed parameter value produces a different cloud effect from the other uSeed parameter values.
Use the CLD_PURE flag to create a bitmap of the cloud effect by itself.
When using the CLD_OPACITY flag, if the opacity is 0, the resulting pixel value relies entirely on the value of the original pixel. As the opacity increases to 100, the value of the cloud pixel has an increasing effect on the resulting pixel value.
When using the CLD_DIFFERENCE flag, if the opacity is 0, the resulting pixel value is just the absolute difference between the original pixel value and the cloud pixel value. As the opacity increases, the resulting pixel value is increasingly affected by an additional factor related to the absolute difference.
This function can process the whole image or a region of the image. If a bitmap has a region, the effect is applied only to the region.
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. |
Win32, x64.
See Also
Example
#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName L_INT LBitmap__CloudsExample() { L_INT nRet; LBitmap LeadBitmap; nRet =LeadBitmap.Load(MAKE_IMAGE_PATH(TEXT("IMAGE1.CMP")), 0,ORDER_BGR); if(nRet !=SUCCESS) return nRet; nRet =LeadBitmap.Clouds( 1000, 4, 10, 10, RGB(255,255,255), RGB(0,0,0), CLD_DIFFERENCE); if(nRet !=SUCCESS) return nRet; return SUCCESS; }