LBitmapWindow::Load

#include "ltwrappr.h"

virtual L_INT LBitmapWindow::Load(nBitsPerPixel=0, nOrder=ORDER_BGRORGRAY, pLoadFileOption=NULL, pFileInfo=NULL)

virtual L_INT LBitmapWindow::Load(nBitsPerPixel, nOrder, nPage, pFileInfo=NULL)

virtual L_INT LBitmapWindow::Load(pszFileName, nBitsPerPixel=0, nOrder=ORDER_BGRORGRAY, pLoadFileOption=NULL, pFileInfo=NULL)

virtual L_INT LBitmapWindow::Load(pszFileName, nBitsPerPixel, nOrder, nPage, pFileInfo=NULL)

Loads a bitmap image from disk into the class object. The image file can be in any supported image file format and bits per pixel, whether compressed or uncompressed.

Returns

Comments

Call this function to load a bitmap image from disk into the class object.

If PaintWhileLoad is enabled for the bitmap window the loaded image will be painted as it is loaded. In this case, the mapped file object will not be used for the load operation. If PaintWhileLoad is disabled the mapped file object will be used for the load operation.

Support for 12 and 16-bit grayscale images is only available in the Document/Medical toolkits.

For supported formats, refer to Files To Be Included With Your Application.

Before calling this function, you may need to get or set file information, such as the page number of a multipage file or the resolution of a PCD file. Refer to Getting and Setting File Information.

The function will initialize the bitmap handle and allocate the storage necessary to hold the image. If the bits per pixel of the file is larger than 8 bits, the image data will be loaded in the same color order as the one passed to the function in nOrder.

The class object will free the bitmap when it is destroyed. If you wish to free the bitmap, use LBitmapBase::Free.

If the paint while load is enabled for the bitmap window, then the loaded image will be painted as it is loaded.

Warning: The function will return ERROR_INV_PARAMETER if nOrder was set to ORDER_GRAY and the image file was not 12 or 16 bits per pixel.

Note: If Document/Medical support is unlocked, and the format being loaded is FILE_LEAD1BIT, FILE_CCITT_GROUP3_1DIM, FILE_CCITT_GROUP3_2DIM, FILE_CCITT_GROUP4, FILE_ICA_G3_1D, FILE_ICA_G3_2D, FILE_ICA_G4, FILE_RAWICA_G3_1D, FILE_RAWICA_G3_2D, FILE_RAWICA_G4, FILE_FAX_G3_1D, FILE_FAX_G3_2D, FILE_FAX_G4, FILE_WFX_G3_1D, or FILE_WFX_G4, the image data will be loaded compressed. For more information, refer to Speeding Up 1-Bit Documents.

Note: For information on loading and saving large TIFF files faster, refer to Loading and Saving Large TIFF Files.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Example

#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName
/*This is an example for LAnimationWindow::Load(nBitsPerPixel, nColorOrder, nPage, pFileInfo=NULL):*/
L_INT LBitmapWindow__LoadFirstExample(HWND hWnd) 
{
   L_INT nRet;
   LAnimationWindow AnimationWindow; 
   AnimationWindow.SetFileName(MAKE_IMAGE_PATH(TEXT("eye.gif")));
   nRet = AnimationWindow.Load(8, ORDER_BGR, 1);
   if (nRet ==SUCCESS)
   {
      AnimationWindow.CreateWnd(hWnd,0, WS_VISIBLE|WS_CHILD|WS_BORDER,0,0,300,300);
      nRet =AnimationWindow.PlayAnimation();
      if(nRet !=SUCCESS)
         return nRet;
      while (AnimationWindow.IsPlaying())
      {
         if (AnimationWindow.DoEvents())
            break; 
      }
   }
   else
      return nRet;
   return SUCCESS;
} 
/*This is an example for LAnimationWindow::Load(nBitsPerPixel=0, nColorOrder=ORDER_BGR, pLoadFileOption=NULL, pFileInfo=NULL):*/
L_INT LBitmapWindow__LoadSecondExample(HWND hWnd) 
{
   L_INT nRet;
   LAnimationWindow AnimationWindow;
   AnimationWindow.SetFileName(MAKE_IMAGE_PATH(TEXT("eye.gif")));
   
   nRet = AnimationWindow.Load(8, ORDER_BGR, NULL); 
   if (nRet==SUCCESS)
   {
      AnimationWindow.CreateWnd(hWnd,0, WS_VISIBLE|WS_CHILD|WS_BORDER,0,0,300,300);
      nRet =AnimationWindow.PlayAnimation();
      if(nRet !=SUCCESS)
         return nRet;
      while (AnimationWindow.IsPlaying())
      {
         if (AnimationWindow.DoEvents())
            break; 
      }
   }
   else
      return nRet;
   return SUCCESS;
} 
/*This is an example for LAnimationWindow::Load(pszFileName, nBitsPerPixel, nColorOrder, nPage, pFileInfo=NULL):*/
L_INT LBitmapWindow__LoadThirdExample(HWND hWnd) 
{
   L_INT nRet;
   LAnimationWindow AnimationWindow;
   
   nRet = AnimationWindow.Load(MAKE_IMAGE_PATH(TEXT("eye.gif")), 8, ORDER_BGR, 5);
   if (nRet ==SUCCESS)
   {
      AnimationWindow.CreateWnd(hWnd,0, WS_VISIBLE|WS_CHILD|WS_BORDER,0,0,300,300);
      nRet =AnimationWindow.PlayAnimation();
      if(nRet !=SUCCESS)
         return nRet;
      while (AnimationWindow.IsPlaying())
      {
         if (AnimationWindow.DoEvents())
            break; 
      }
   }
   else 
      return nRet;
   return SUCCESS;
} 
/*This is an example for LAnimationWindow::Load(pszFileName, nBitsPerPixel=0, nColorOrder=ORDER_BGR, pLoadFileOption=NULL, pFileInfo=NULL):*/
L_INT LBitmapWindow__LoadForthExample(HWND hWnd) 
{
   L_INT nRet;  
   LAnimationWindow AnimationWindow;
   nRet = AnimationWindow.Load(MAKE_IMAGE_PATH(TEXT("eye.gif")), 8, ORDER_BGR, NULL); 
   if (nRet ==SUCCESS)
   {
      AnimationWindow.CreateWnd(hWnd,0, WS_VISIBLE|WS_CHILD|WS_BORDER,0,0,300,300);
      nRet =AnimationWindow.PlayAnimation();
      if(nRet !=SUCCESS)
         return nRet;
      while (AnimationWindow.IsPlaying())
      {
         if (AnimationWindow.DoEvents())
            break; 
      }
   }
   else
      return nRet;
   return SUCCESS;
}