Loads a JPEG 2000 file.
L_INT LJp2FileFormat::Read(pszFile, pBitmap, nBitsPerPixel, nOrder, pLoadOptions, pFileInfo, pReadCallBack, pUserData)
Character string that contains the name of the JPEG 2000 file.
Pointer to the bitmap handle referencing the bitmap to be filled with image data.
Resulting bitmap pixel depth. If zero , the bitmap will have the original files pixel depth (do not convert).
The desired color order. Possible values are:
|ORDER_RGB|| Read-green-blue order.|
|ORDER_BGR|| Blue green-red order.|
|ORDER_GRAY|| 12 or 16-bit grayscale image. 12 and 16-bit grayscale images are supported in Document/Medical imaging products only.|
|0||The data is 8 bits per pixel or less.|
|ORDER_RGBORGRAY|| 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|| 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|| ROMM order. ROMM only supports 24 and 48-bit images.|
|ORDER_BGRORGRAYORROMM|| 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/Medical imaging products only.|
Pointer to optional extended load options. Pass NULL to use the default load options.
Pointer to a FILEINFO structure. If nothing is known about the file, pass NULL.
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 LFile::LoadFileCallBack function.
Void pointer that you can use to pass one or more additional parameters used by the callback function.
|SUCCESS||The function was successful.|
|< 1||An error occurred. Refer to Return Codes.|
LJp2FileFormat::Read loads a JPEG 2000 file. If the file contains multiple images only the first image is returned. To load all images use either LJp2FileFormat::ReadListMemory or LJp2FileFormat::ReadCompositeMemory functions. To load a specific frame or frames, use the LJp2FileFormat::ReadFramesMemory function. pLoadOptions is used for loading code streams such as J2K code streams. If any of the layers has opacity channels, it will be applied on the list bitmap unless the ELO_COLOR_COMPONENT_ONLY flag is set in pLoadOptions. All engine boxes will be reset and updated with the new loaded boxes only.
For an example, refer to LJp2FileFormat::Save.
Medical Web Viewer .NET
.NET, Java, Android, and iOS/macOS Assemblies
C API/C++ Class Libraries