In This Topic ▼

LBitmap::ColoredPencil

#include "ltwrappr.h"

L_INT LBitmap::ColoredPencil (uRatio, uDim, uFlags = 0)

Applies an effect to the bitmap that makes it look like it has been drawn with colored pencils.

Parameters

L_UINT uRatio

Value that represents how much the bitmap colors should be adjusted so they appear to be colored pencil colors. Possible values range from 0 to 100. A value of 0 means that the bitmap will not have any change in pixel values; whereas a value of 100 means that the maximum possible amount will be added to the pixel values.

L_UINT uDim

Value that represents the size of the pencil coloring neighborhood. It is the length, in pixels, of one side of a square. Valid values range from 0 to 100. Increasing this value increases the thickness of the edges that are detected.

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 applies an effect to a bitmap that makes it look like it has been drawn with colored pencils.

For an example, click here

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.

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.

Platforms

Win32, x64.

Example

The following example loads a bitmap and applies the colored pencil effect:
Load the bitmap, keeping the bits per pixel of the file

L_INT LBitmap__ColoredPencilExample() 
{ 
   L_INT nRet; 
   LBitmap LeadBitmap;  
    
   nRet =LeadBitmap.Load(MAKE_IMAGE_PATH(TEXT("cannon.jpg")), 0,ORDER_BGR); 
   if(nRet !=SUCCESS) 
      return nRet; 
   /* pencil color the bitmap with Ratio value of 50 and with a neighborhood of 3x3 pixels*/ 
   nRet =LeadBitmap.ColoredPencil(50, 3); 
   if(nRet !=SUCCESS) 
      return nRet; 
 
   return SUCCESS; 
}