L_OceanBitmap (original) (raw)
Summary
Reflects the bitmap on an ocean surface.
Syntax
#include "l_bitmap.h"
L_LTIMGSFX_API L_INT L_OceanBitmap(pBitmap, uAmplitude, uFrequency, bLowerTrnsp, uFlags)
Parameters
pBITMAPHANDLE pBitmap
Pointer to the bitmap handle that references the bitmap to reflect.
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
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.
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 in the Document and Medical Imaging toolkits.
To update a status bar or detect a user interrupt during execution of this function, refer to L_SetStatusCallback.
To obtain this effect, the following settings were used with the function:
uAmplitude = 15
uFrequency = 20
bLowerTrnsp = TRUE
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.
Ocean Function - Before
Ocean Function - After
View additional platform support for this Ocean 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.
Platforms
Win32, x64.
See Also
Functions
- L_AddBitmapNoise
- L_EmbossBitmap
- L_MosaicBitmap
- L_MotionBlurBitmap
- L_OilifyBitmap
- L_PosterizeBitmap
- L_RemoveRedeyeBitmap
- L_SolarizeBitmap
- L_UnderlayBitmap
- L_BumpMapBitmap
- L_CubismBitmap
- L_DrawStarBitmap
- L_FreePlaneBendBitmap
- L_FreeRadBendBitmap
- L_DryBitmap
- L_GlowFilterBitmap
- L_GlassEffectBitmap
- L_LensFlareBitmap
- L_LightBitmap
- L_PlaneBendBitmap
- L_PlaneBitmap
- L_SampleTargetBitmap
- L_TunnelBitmap
- L_BendingBitmap
- L_CylindricalBitmap
- L_FreeHandShearBitmap
- L_FreeHandWaveBitmap
- L_ImpressionistBitmap
- L_PixelateBitmap
- L_PolarBitmap
- L_PunchBitmap
- L_RadialBlurBitmap
- L_RadWaveBitmap
- L_RippleBitmap
- L_SpherizeBitmap
- L_SwirlBitmap
- L_WaveBitmap
- L_WindBitmap
- L_ZoomBlurBitmap
- L_ZoomWaveBitmap
- L_BricksTextureBitmap
- L_CanvasBitmap
- L_CloudsBitmap
- L_ColoredBallsBitmap
- L_DiffuseGlowBitmap
- L_DisplaceMapBitmap
- L_FragmentBitmap
- L_HalfTonePatternBitmap
- L_MaskConvolutionBitmap
- L_MosaicTilesBitmap
- L_OffsetBitmap
- L_PerspectiveBitmap
- L_PlasmaFilterBitmap
- L_PointillistBitmap
- L_RomanMosaicBitmap
- L_VignetteBitmap
- L_ZigZagBitmap
- L_AdjustBitmapTint
- L_ColorHalfToneBitmap
Topics
- Raster Image Functions: Artistic Effects
- Applying Artistic Effects
- Raster Image Functions: Correcting Colors
Example
L_INT OceanBitmapExample(L_VOID)
{
L_INT nRet;
BITMAPHANDLE LeadBitmap; /* Bitmap handle for the image */
/* Load a bitmap at its own bits per pixel */
nRet = L_LoadBitmap(MAKE_IMAGE_PATH(TEXT("sample5.cmp")), &LeadBitmap, sizeof(BITMAPHANDLE), 0, ORDER_BGR, NULL, NULL);
if (nRet != SUCCESS)
return nRet;
nRet = L_OceanBitmap(&LeadBitmap, 20, 6, TRUE, 0);
if (nRet != SUCCESS)
return nRet;
nRet = L_SaveBitmap(MAKE_IMAGE_PATH(TEXT("Result.BMP")), &LeadBitmap, FILE_BMP, 24, 0, NULL);
if (nRet != SUCCESS)
return nRet;
//free bitmap
if (LeadBitmap.Flags.Allocated)
L_FreeBitmap(&LeadBitmap);
return SUCCESS;
}
LEADTOOLS Raster Imaging C API Help