LBitmap::Ocean

#include "ltwrappr.h"

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

L_UINT uAmplitude;	/* waves magnitude */
L_UINT uFrequency;	/* number of repeated waves */
L_BOOL bLowerTrnsp;	/* flag */
L_UINT32 uFlags;	/* flags */

Reflects the bitmap on an ocean surface.

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.
uFlags	Reserved for future use. Must be 0.

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, 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

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::AdjustTint. LBitmap::ColorHalfTone, LBitmap::BricksTexture, LBitmap::Canvas, LBitmap::Clouds, LBitmap::ColoredBalls, LBitmap::DiffuseGlow, LBitmap::DisplaceMap, LBitmap::Fragment, LBitmap::HalfTonePattern, LBitmap::MaskConvolution, LBitmap::MosaicTiles, LBitmap::Offset, LBitmap::Perspective, LBitmap::PlasmaFilter, LBitmap::Pointillist, LBitmap::RomanMosaic, LBitmap::Vignette, LBitmap::ZigZag, LBitmap::AddNoise, LBitmap::Emboss, LBitmap::Mosaic, LBitmap::MotionBlur, LBitmap::Oilify, LBitmap::Posterize, LBitmap::RemoveRedeye, LBitmap::Solarize, LBitmapBase::Underlay, LBitmap::BumpMap, LBitmap::Cubism, LBitmap::DrawStar, LBitmap::Dry, LBitmap::FreePlaneBend, LBitmap::FreeRadBend, LBitmap::GlassEffect, LBitmap::GlowFilter, LBitmap::LensFlare, LBitmap::Light, LBitmap::PlaneBend, LBitmap::Plane, LBitmap::SampleTarget, LBitmap::Tunnel, LBitmap::Bending, LBitmap::Cylindrical, LBitmap::FreeHandShear, LBitmap::FreeHandWave, LBitmap::Impressionist, LBitmap::Pixelate, LBitmap::Polar, LBitmap::Punch, LBitmap::RadialBlur, LBitmap::RadWave, LBitmap::Ripple, LBitmap::Spherize, LBitmap::Swirl, LBitmap::Wave, LBitmap::Wind, LBitmap::ZoomBlur, LBitmap::ZoomWave
Topics:	Raster Image Functions: Artistic Effects
	Applying Artistic Effects
	Raster Image Functions: Correcting Colors

Example

L_INT LBitmap__OceanExample(LAnimationWindow *BitmapWindow) 
{
   return BitmapWindow->Ocean(20,6,true); 
}