LBitmap::Ocean

#include "ltwrappr.h"

virtual L_INT LBitmap::Ocean (uAmplitude, uFrequency, bLowerTrnsp, uFlags = 0)

Reflects the bitmap on an ocean surface.

Parameters

L_UINT uAmplitude

Wave magnitude, in pixels.

L_UINT uFrequency

Number of repeated waves.

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

L_UINT32 uFlags

Reserved for future use. Must be 0.

Returns

Value Meaning
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, click here

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.

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

Platforms

Win32, x64.

See Also

Functions

Topics

Example

Help Version 21.0.2020.8.25
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help