L_ChangeBitmapIntensity

#include "l_bitmap.h"

L_LTIMGCLR_API L_INT L_ChangeBitmapIntensity(pBitmap, nChange, uFlags)

Changes the intensity (brightness) of the image in a bitmap.

Parameters

pBITMAPHANDLE pBitmap

Pointer to the bitmap handle referencing the bitmap to change.

L_INT nChange

Amount to change the intensity. The intensity ranges from -1000 to 1000. A positive value increases (or lightens) the brightness of the bitmap image. A negative values decreases (or darkens) the brightness of the bitmap image.

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

To update a status bar or detect a user interrupt during execution of this function, refer to L_SetStatusCallback.

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.

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.

This Function changes the intensity of the image data. If the image has a LUT, the function will work on the LUT, not the image data.

If the image has a LUT and you want to work on the image data, set the UseLUT Flag in the BITMAPHANDLE structure to FALSE. Then, after calling the function, reset the UseLUT flag to TRUE as follows:

pBitmap->Flags.UseLUT = FALSE; 
L_ChangeBitmapIntensity(pBitmap,250); 
pBitmap->Flags.UseLUT = TRUE; 

Required DLLs and Libraries

Platforms

Win32, x64, Linux.

See Also

Functions

Topics

Example

For complete sample code, refer to the FEATURE1 example. This example loads a bitmap and increases its intensity.

L_INT ChangeBitmapIntensityExample(L_VOID) 
{ 
   L_INT nRet; 
   BITMAPHANDLE LeadBitmap;   /* Bitmap handle to hold the loaded image. */ 
   /* Load the bitmap, keeping the bits per pixel of the file */ 
   nRet = L_LoadBitmap (MAKE_IMAGE_PATH(TEXT("IMAGE1.CMP")), &LeadBitmap, sizeof(BITMAPHANDLE), 0, ORDER_BGR, NULL, NULL); 
   if(nRet !=SUCCESS) 
      return nRet; 
   /* Increase the brightness by 25 percent  of the possible range */ 
   nRet = L_ChangeBitmapIntensity(&LeadBitmap, 250 , 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; 
} 

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

LEADTOOLS Raster Imaging C API Help