L_Jp2FreeComposite

#include "l_bitmap.h"

L_LTJP2_API L_INT EXT_FUNCTION L_Jp2FreeComposite(hJp2, pComposite)

L_HJP2 hJp2;	/* JPEG 2000 engine handle */
pL_JP2_JPXCOMPOSITE pComposite;	/* pointer to a composite structure */

Frees and invalidates composite pointers that have been allocated by engine functions such as L_Jp2ReadComposite, L_Jp2ReadFrames, L_Jp2ReadCompositeMemory, and L_Jp2ReadFramesMemory.

Parameter	Description
hJp2	JPEG 2000 engine handle that was created by the L_Jp2Create function.
pComposite	Pointer to a composite structure to be freed.

Returns

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

Comments

L_Jp2FreeComposite frees and invalidates composite pointers that have been allocated by engine functions such as L_Jp2ReadComposite, L_Jp2ReadFrames, L_Jp2ReadCompositeMemory, and L_Jp2ReadFramesMemory. This function does not free the bitmaps inside the structures; you must free the bitmaps by using L_FreeBitmap function.

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.

See Also

Functions:	L_Jp2ReadComposite, L_Jp2ReadFrames, L_Jp2ReadCompositeMemory, L_Jp2ReadFramesMemory
Topics:	Programming with JPEG 2000 Features
	Programming with JPX Features
	Raster Image Functions: Working with JPEG 2000
	Raster Image Functions: Working with JPX

Example

For an example, refer to L_Jp2ReadFrames.