Changes the hue, saturation and brightness of all or specified colors in the image.


#include "ltwrappr.h"

virtual L_INT LBitmap::ChangeHueSatInt (nHue, nSaturation, nIntensity, pHsiData, uHsiDataCount, uFlags = 0)


L_INT nHue

Angular amount to change the hue, in hundredths of degrees. Valid values range from -18000 through 18000. This value is divided internally by 100.

L_INT nSaturation

Percentage amount to change saturation, in tenths of percent. Valid values range from -1000 through 1000. This value is divided internally by 10. Negative values decrease the saturation of colors. Positive values increase the saturation. The saturation level is increased or decreased by a percentage of its present saturation level. For example, an increase of 20% of the current saturation level "L" will raise the new saturation level "L1" to a value L = 0.20 * L. Likewise, increasing the saturation level 100% doubles the saturation level (L1 = L + 1.0 * L). Decreasing the saturation level 100% will set the new saturation level to 0. This process is carried out for every pixel. The saturation is set to 1000 (maximum value) if the new value exceeds 1000).

L_INT nIntensity

Percentage amount to change the intensity, in tenths of percent. Valid values range from -1000 (black) through 1000 (white). This value is divided internally by 10. Positive values increase (or lighten) the brightness of the bitmap image. Negative values decrease (or darken) the brightness of the bitmap image.


Pointer to array of HSIDATA structures for each color range to be changed.

L_UINT uHsiDataCount

Count of structures in the pHsiData array.

L_UINT32 uFlags

Reserved for future use. Must be 0.


Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.


This function combines the basic functionality found in the LBitmap::ChangeHue, LBitmap::ChangeSaturation, and LBitmap::ChangeIntensity functions. In addition, special options can be specified in the LPHSIDATA structure.

The pHsiData->uStructSize must be set to sizeof(HSIDATA) before calling this function. For an array of structures, only the first structure in the array needs to have uStructSize member set.

To change the overall hue, saturation and intensity all at one time, pass NULL for the pHsiData and 0 for the uHsiDataCount in the main function. To adjust the parameters separately, or to make adjustments in successive passes, use the structures and pass 0 for the nHue, nSaturation, and nIntensity parameters in the main function.

For detailed information about using the ranges in the HSIDATA structure, refer to HSIDATA.

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


Win32, x64.

See Also




L_INT LBitmap__ChangeHueSatIntBitmapExample(LBitmap *pLeadBitmap)  
   HSIDATA         HsiData;          /*Color Range Information structure*/ 
   /*Change bitmap hue, saturation, and brightness */ 
   HsiData.uStructSize = sizeof(HSIDATA);  
   HsiData.nHue            =18000;  
   HsiData.nSaturation   = 0;  
   HsiData. nIntensity     = 0;  
   HsiData.nOuterLow   =315;  
   HsiData.nOuterHigh  = 45;  
   HsiData.nInnerLow    = 345;  
   HsiData.nInnerHigh   = 15;  
   /* change the red color to green */ 
   return pLeadBitmap->ChangeHueSatInt( 0, 0, 0, &HsiData, 1);  
Help Version 22.0.2022.6.26
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help