LBitmap::Ocean
#include "ltwrappr.h"
virtual L_INT LBitmap::Ocean ( uAmplitude, uFrequency, bLowerTrnsp)
L_UINT uAmplitude; |
/* wave’s magnitude */ |
L_UINT uFrequency; |
/* number of repeated waves */ |
L_BOOL bLowerTrnsp; |
/* flag */ |
Reflects the bitmap on an ocean surface. This function is available in the Raster Pro and above toolkits.
Parameter |
Description |
|
uAmplitude |
Wave magnitude, in pixels. |
|
uFrequency |
Number of repeated waves. |
|
bLowerTrnsp |
Flag that indicates the transparency direction. Possible values are: |
|
|
Value |
Meaning |
|
TRUE |
Transparency increases as you move from the bottom of the bitmap to the top of the bitmap, line by line. |
|
FALSE |
Transparency increases as you move from the top of the bitmap to the bottom of the bitmap, line by line. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
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.
For an example, see the following figure:
The following figure shows the same bitmap, after the effect has been applied:
To obtain this effect, the following settings were used with the function:
uAmplitude=15
uFrequency=20
bLowerTrnsp=TRUE
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.
Required DLLs and Libraries
LTIMG 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
Example
void TestFunction(LAnimationWindow *BitmapWindow)
{
BitmapWindow->Ocean(20,6,true);
}