LJp2FileFormat::Read

Show in webframe

#include "ltwrappr.h"

L_INT LJp2FileFormat::Read(pszFile, pBitmap, nBitsPerPixel, nOrder, pLoadOptions, pFileInfo, pReadCallBack, pUserData)

L_TCHAR * pszFile;	/* JPEG 2000 file name */
pBITMAPHANDLE pBitmap;	/* pointer to the target bitmap handle */
L_INT nBitsPerPixel;	/* resulting bitmap pixel depth */
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 */
LFile::LoadFileCallBack pReadCallBack;	/* optional callback function */
L_VOID * pUserData;	/* pointer to more parameters for the callback */

Loads a JPEG 2000 file.

Parameter	Description
pszFile	Character string that contains the name of the JPEG 2000 file.
pBitmap	Pointer to the bitmap handle referencing the bitmap 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/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/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 LFile::LoadFileCallBack 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

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.

Required DLLs and Libraries

LTJP2
LFJ2K
LTIMGEFX

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.

Functions:	LJp2FileFormat::ReadList, LJp2FileFormat::ReadComposite, LJp2FileFormat::ReadFrames, LJp2FileFormat::Save, LJp2FileFormat::SaveList, LJp2FileFormat::SaveComposite, LJp2FileFormat::AppendFrames
Topics:	Implementing JPEG 2000 Features
	Raster Image Functions: Working with JPEG 2000
	Programming with JPX Features
	JPX File Comments
	Raster Image Functions: Working with JPX