L_LoadBitmapResize

Show in webframe

#include "l_bitmap.h"

L_LTFIL_API L_INT L_LoadBitmapResize(pszFile, pSmallBitmap, uStructSize, nDestWidth, nDestHeight, nDestBits, uFlags, nOrder, pLoadOptions, pFileInfo)

L_TCHAR* pszFile;	/* name of the file to load */
pBITMAPHANDLE pSmallBitmap;	/* pointer to the target bitmap handle */
L_UINT uStructSize;	/* size in bytes, of the structure pointed to by pBitmap */
L_INT nDestWidth;	/* new width of the image */
L_INT nDestHeight;	/* new height of the image */
L_INT nDestBits;	/* resulting bitmap pixel depth */
L_UINT uFlags;	/* flags */
L_INT nOrder;	/* color order for 16-, 24-, 32-, 48, and 64-bit bitmaps */
pLOADFILEOPTION pLoadOptions;	/* pointer to optional extended load options */
pFILEINFO pFileInfo;	/* pointer to a structure */

Loads an image file into a bitmap, resizing the bitmap as it loads, to the desired width, height, and bits per pixel. The file can be in any supported image file format and bits per pixel, whether compressed or uncompressed.

Note: More options are available in the LOADFILEOPTION structure.

Parameter	Description
pszFile	Character string containing the name of the file to load.
pSmallBitmap	Pointer to the bitmap handle referencing the target bitmap.
uStructSize	Size in bytes, of the structure pointed to by pBitmap, for versioning. Use sizeof(BITMAPHANDLE).
nDestWidth	New width of the image.
nDestHeight	New height of the image.
nDestBits	Resulting bitmap pixel depth. The following are valid values:
	Value	Meaning
	0	Keep the original file's pixel depth (Do not convert). A special note about loading 12 and 16-bit grayscale images.
	1 to 8	The specified bits per pixel in the resultant bitmap
	12	12 bits per pixel in the resultant bitmap.
	16	16 bits per pixel in the resultant bitmap
	24	24 bits per pixel in the resultant bitmap
	32	32 bits per pixel in the resultant bitmap
	48	48 bits per pixel in the resultant bitmap
	64	64 bits per pixel in the resultant bitmap

uFlags	Flag that indicates the type of resizing to use. Possible values are:
	Value	Meaning
	SIZE_NORMAL	[0x0] Normal resizing.
	SIZE_RESAMPLE	[0x2] Linear interpolation resizing.
	SIZE_BICUBIC	[0x4] Bicubic interpolation resizing.
nOrder	Color order for 16-, 24-, 32-, 48-, and 64-bit bitmaps. If the resultant bitmap is less than 16 bits per pixel, this will have no effect since palletized images have no order. The following are valid values:
	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 Document and Medical Imaging 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 Document and Medical Imaging toolkits.
	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 Document and Medical Imaging toolkits.
	ORDER_ROMM	[5] ROMM order. ROMM only supports 24 and 48-bit images.
	ORDER_BGRORGRAYORROMM	[6] Load the image as red, green, blue OR as a 12 or 16-bit grayscale image OR as ROMM. 12 and 16-bit grayscale images are supported in Document and Medical Imaging toolkits. ROMM only supports 24 and 48-bit color images.
pLoadOptions	Pointer to a LOADFILEOPTION structure optional extended load options. Pass NULL to use the default load options.
pFileInfo	Pointer to a FILEINFO structure. This structure may contain file information used in loading an image, or it may be updated with information about the file being loaded.
	If nothing is known about the file, pass NULL for this parameter, or declare a variable of type FILEINFO and set the FILEINFO.Flags to 0, then pass the address of the FILEINFO structure in this parameter. In this case, if the address of a FILEINFO structure is passed, the FILEINFO structure will be updated with the results of L_FileInfo.
	If only the file type is known, set pFileInfo.Format to the file type and set pFileInfo.Flags to FILEINFO_FORMATVALID. This can also be done if L_FileInfo has been called previously, but values that affect the size of the image loaded have been changed (for example, by calling L_SetPCDResolution or L_SetWMFResolution). In this case the FILEINFO structure pointed to by pFileInfo will be updated with the results of L_FileInfo.
	If L_FileInfo has been called prior to calling this function, and no changes have been made to the contents of the structure filled by L_FileInfo, then the address of the filled FILEINFO structure can be passed for this parameter. In this case, the FILEINFO.Flags member should be set to FILEINFO_INFOVALID. The L_FileInfo function will set the FILEINFO.Flags to FILEINFO_INFOVALID. In this case the load will be faster since this function does not have to query the file filters for the file type.
	Note: Local variables are not initialized (since they are placed on the stack). So if you have a FILEINFO structure as a local variable, the value of its Flags parameter is undefined, possibly having FILEINFO_INFOVALID or FILEINFO_FORMATVALID set. That is why it is important to initialize FILEINFO.Flags before passing the address of the FILEINFO structure to the function.

Returns

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

Comments

This function resizes a file as it loads, to the desired width, height, and bits per pixel. Note that the original file is not completely loaded into memory. This function is ideal for sampling large images (i.e. generating a thumbnail) without the memory overhead of loading the large file itself.

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

Note: You should never pass an uninitialized FILEINFO structure to this function.

Required DLLs and Libraries

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, Linux.

See Also

Functions:	L_LoadFile, L_LoadFileOffset, L_ReadFileStamp, L_SetLoadResolution, L_SetPCDResolution, L_SetWMFResolution, L_SetLoadInfoCallback, L_DlgOpen, L_CreatePanWindow,
	For Vector files: L_2DGetViewMode, L2DGetViewPort, L_2DSetViewMode, L_2DSetViewPort
Topics:	Raster Image Functions: Loading Files
	Raster Image Functions: Redirecting Input and Output
	Raster Image Functions: Input and Output
	Loading and Saving Images
	Using a PanWindow

Example

This sample loads and resizes an image to 400 pixels high. The width of the bitmap is determined by the aspect ratio. Bicubic interpolation is used on the resize. The bitmap is loaded at the original bits per pixel.

 L_INT LoadBitmapResizeExample(pBITMAPHANDLE pSmallBitmap, L_TCHAR *pszFile)
{
   L_INT nRet;
   if(pSmallBitmap->Flags.Allocated)
      L_FreeBitmap(pSmallBitmap);
   nRet = L_LoadBitmapResize(
                              pszFile,       // name of the file to load 
                              pSmallBitmap,  // pointer to the target bitmap handle 
                              sizeof(BITMAPHANDLE),
                              0,             // new width of the image 
                              400,           // new height of the image 
                              0,             // new bits per pixel for the image 
                              SIZE_BICUBIC,
                              ORDER_BGR,     // color order
                              NULL,          // pointer to optional extended load options 
                              NULL           // pointer to a structure 
                              );
   return nRet;
}