Classes and Member Functions > LBitmapBase > LBitmapBase Member Functions > LBitmapBase::GetColorOrder

LBitmapBase::GetColorOrder

#include "ltwrappr.h"

L_INT LBitmapBase::GetColorOrder()

Retrieves the color order of the class objects bitmap.

Returns

The color order of the bitmap data. Possible values are:

Value	Meaning
ORDER_RGB	[0] Red, green, and blue color order in memory.
ORDER_BGR	[1] Blue, green, and red color order in memory.
ORDER_GRAY	[2] 12 or 16-bit grayscale image. 12 and 16-bit grayscale images are only supported in the Document/Medical toolkits.
ORDER_RGBORGRAY	[3] Load the image as red, green, blue OR as a 12 or 16-bit grayscale image. 12 and 16-bit grayscale images are supported in the Document/Medical toolkits only.
ORDER_BGRORGRAY	[4] Load the image as blue, green, red OR as a 12 or 16-bit grayscale image. 12 and 16-bit grayscale images are supported in the Document/Medical toolkits only.

Comments

Use this function to retrieve the color order of the bitmap.

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.

Example

#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName 
L_INT LBitmapBase__GetColorOrderExample() 
{ 
   L_INT nRet; 
   LBitmapBase MyBitmap; 
   L_INT nOrder; 
   nRet =MyBitmap.Load(MAKE_IMAGE_PATH(TEXT("image1.cmp"))); 
   if(nRet !=SUCCESS) 
      return nRet; 
   nOrder=MyBitmap.GetColorOrder(); 
   return SUCCESS; 
}