LEADTOOLS Raster Imaging C DLL Help
| LEADTOOLS Raster Imaging C DLL Help > Function References > L_Jp2ReadComposite |
#include "l_bitmap.h"
L_LTJP2_API L_INT EXT_FUNCTION L_Jp2ReadComposite(hJp2, pszFile, pComposite, nBitsPerPixel, nOrder, pLoadOptions, pFileInfo, pReadCallBack, pUserData)
|
L_HJP2 hJp2; |
/* JPEG 2000 engine handle */ |
|
L_TCHAR * pszFile; |
/* JPEG 2000 file name */ |
|
pL_JP2_JPXCOMPOSITE pComposite; |
/* pointer to a L_JP2_JPXCOMPOSITE structure */ |
|
L_INT nBitsPerPixel; |
/* resulting bitmaps pixel depth */ |
|
L_INT nOrder; |
/* desired color order */ |
|
pLOADFILEOPTION pLoadOptions; |
/* pointer to optional extended load options */ |
|
pFILEINFO pFileInfo; |
/* pointer to a structure */ |
|
FILEREADCALLBACK pReadCallBack; |
/* optional callback function */ |
|
L_VOID * pUserData; |
/* pointer to more parameters for the callback */ |
Loads all frames bitmaps stored in the specified JPEG 2000 file (Color, Opacity and Pre-multiplied opacity).
|
Parameter |
Description |
|
|
hJp2 |
JPEG 2000 engine handle that was created by the L_Jp2Create function. |
|
|
pszFile |
Character string that contains the name of the JPEG 2000 file. |
|
|
pComposite |
Pointer to the L_JP2_JPXCOMPOSITE structure that references L_JP2_JPXBITMAPS bitmaps to be filled with image data. |
|
|
nBitsPerPixel |
Resulting bitmap pixel depth. If zero [0], the bitmap will have the original files pixel depth (do not convert). |
|
|
nOrder |
The desired color order. Possible values are: |
|
|
Value |
Meaning |
|
|
ORDER_RGB |
[0] Read-green-blue order. |
|
|
ORDER_BGR |
[1] Blue green-red order. |
|
|
ORDER_GRAY |
[2] 12 or 16-bit grayscale image. 12 and 16-bit grayscale images are supported in Document and Medical imaging products only. |
|
|
0 |
The data is 8 bits per pixel or less. |
|
|
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/Medical imaging products 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 Document/Medical imaging products only. |
|
|
ORDER_ROMM |
[5] ROMM order. ROMM only supports 24 and 48-bit images. |
|
|
ORDER_BGRORGRAYORROMM |
[6] Load the image as blue, green, red, 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 products only. |
|
|
pLoadOptions |
Pointer to optional extended load options. Pass NULL to use the default load options. |
|
|
pFileInfo |
Pointer to a FILEINFO structure. If nothing is known about the file pass NULL. |
|
|
pReadCallBack |
Optional callback function for additional processing. |
|
|
|
If you do not provide a callback function, pass NULL. |
|
|
|
If you do provide a callback function, use the function pointer as the value of this parameter. |
|
|
|
The callback function must adhere to the function prototype described in the FILEREADCALLBACK function. |
|
|
pUserData |
Void pointer that you can use to pass one or more additional parameters used by the callback function. |
|
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
L_JP2ReadComposite loads all frames bitmaps stored in the specified JPEG 2000 file (Color, Opacity and Pre-multiplied opacity). You must free this structure by calling the L_Jp2FreeComposite function. Also you must free structure bitmaps by calling the L_FreeBitmap function. All of the engines boxes will be reset and updated with the new loaded boxes only.
Required DLLs and Libraries
|
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: |
L_Jp2Read, L_Jp2ReadList, L_Jp2ReadFrames, L_Jp2Save, L_Jp2SaveList, L_Jp2SaveComposite, L_Jp2AppendFrames |
|
Topics: |
|
|
` |
|
|
|
|
|
|
Example
For an example, refer to L_Jp2SaveComposite.
