LBitmapBase::GetColors

#include "ltwrappr.h"

virtual L_INT LBitmapBase::GetColors(nIndex, nCount, pPalette)

L_INT nIndex;

/* the index of the first color to be retrieved */

L_INT nCount;

/* the number of colors to retrieve*/

LPRGBQUAD pPalette;

/* pointer to an array of RGBQUAD structures that make up your palette */

Loads your palette with selected colors of a class object's bitmap.

Parameter

Description

nIndex

The index of the first color to be retrieved.

nCount

The number of colors to retrieve.

pPalette

Pointer to an array of RGBQUAD structures that will receive the colors.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Your palette can be smaller than the bitmap's palette, as long as it is big enough to hold the selected colors. For the reverse action, refer to LBitmapBase::PutColors.

Required DLLs and Libraries

LTDIS
LTFIL

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:

Class Members

Topics:

Raster Image Functions: Displaying Images

 

Handling Palette Changes

 

Color Halftones and Halftone Images

 

Raster Image Functions: Working with Color Halftones, Halftones, and Grayscale Images

Example

#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName
L_INT LBitmapBase__GetColorsExample()
{
   L_INT nRet;
   LBitmapBase MyBitmap;
   RGBQUAD Colors[256];
   MyBitmap.SetFileName(MAKE_IMAGE_PATH(TEXT("image1.cmp")));
   nRet =MyBitmap.Load(8);//load at 8 bit per pixel
   if(nRet !=SUCCESS)
      return nRet;
   nRet =MyBitmap.GetColors(0, 255, Colors) ;
   if(nRet !=SUCCESS)
      return nRet;
   return SUCCESS;
}