LEADTOOLS Image File Support (Leadtools.Codecs assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
Decompress(Object,IntPtr,Int32,Int32,Int32,Int32,Int32,Int32,CodecsDecompressDataFlags) Method
See Also 
Leadtools.Codecs Namespace > RasterCodecs Class > Decompress Method : Decompress(Object,IntPtr,Int32,Int32,Int32,Int32,Int32,Int32,CodecsDecompressDataFlags) Method



decompressContext
The decompressing context object obtained through StartDecompress.
data
A pointer to an unmanaged memory buffer that contains the raw compressed data.
dataOffset
Offset of the strip referenced by data, This is usually zero.
dataLength
Number of bytes in data.
width
Width of the uncompressed strip or tile, in bytes
height
Height of the uncompressed strip or tile, in bytes. If the image consists of a single compressed strip, as with TWAIN, this is the height of the image.
row
Row offset of the tile or strip.
column
Column offset of the tile or strip.
flags

Flags that indicate whether which part of a strip or tile is being processed. Possible values are:

Value Meaning
CodecsDecompressDataFlags.Start Processing the beginning of a tile or strip
CodecsDecompressDataFlags.End Processing the end of a tile or strip
CodecsDecompressDataFlags.Complete Process a complete tile or strip. This is the same as CodecsDecompressDataFlags.Start | CodecsDecompressDataFlags.End

decompressContext
The decompressing context object obtained through StartDecompress.
data
A pointer to an unmanaged memory buffer that contains the raw compressed data.
dataOffset
Offset of the strip referenced by data, This is usually zero.
dataLength
Number of bytes in data.
width
Width of the uncompressed strip or tile, in bytes
height
Height of the uncompressed strip or tile, in bytes. If the image consists of a single compressed strip, as with TWAIN, this is the height of the image.
row
Row offset of the tile or strip.
column
Column offset of the tile or strip.
flags

Flags that indicate whether which part of a strip or tile is being processed. Possible values are:

Value Meaning
CodecsDecompressDataFlags.Start Processing the beginning of a tile or strip
CodecsDecompressDataFlags.End Processing the end of a tile or strip
CodecsDecompressDataFlags.Complete Process a complete tile or strip. This is the same as CodecsDecompressDataFlags.Start | CodecsDecompressDataFlags.End

Called for each unmanaged memory buffer, strip or tile of decompressed data.

Syntax

Visual Basic (Declaration) 
Overloads Public Sub Decompress( _
   ByVal decompressContext As Object, _
   ByVal data As IntPtr, _
   ByVal dataOffset As Integer, _
   ByVal dataLength As Integer, _
   ByVal width As Integer, _
   ByVal height As Integer, _
   ByVal row As Integer, _
   ByVal column As Integer, _
   ByVal flags As CodecsDecompressDataFlags _
) 
Visual Basic (Usage)Copy Code
Dim instance As RasterCodecs
Dim decompressContext As Object
Dim data As IntPtr
Dim dataOffset As Integer
Dim dataLength As Integer
Dim width As Integer
Dim height As Integer
Dim row As Integer
Dim column As Integer
Dim flags As CodecsDecompressDataFlags
 
instance.Decompress(decompressContext, data, dataOffset, dataLength, width, height, row, column, flags)
C# 
public void Decompress( 
   object decompressContext,
   IntPtr data,
   int dataOffset,
   int dataLength,
   int width,
   int height,
   int row,
   int column,
   CodecsDecompressDataFlags flags
)
C++/CLI 
public:
void Decompress( 
   Object^ decompressContext,
   IntPtr data,
   int dataOffset,
   int dataLength,
   int width,
   int height,
   int row,
   int column,
   CodecsDecompressDataFlags flags
) 

Parameters

decompressContext
The decompressing context object obtained through StartDecompress.
data
A pointer to an unmanaged memory buffer that contains the raw compressed data.
dataOffset
Offset of the strip referenced by data, This is usually zero.
dataLength
Number of bytes in data.
width
Width of the uncompressed strip or tile, in bytes
height
Height of the uncompressed strip or tile, in bytes. If the image consists of a single compressed strip, as with TWAIN, this is the height of the image.
row
Row offset of the tile or strip.
column
Column offset of the tile or strip.
flags

Flags that indicate whether which part of a strip or tile is being processed. Possible values are:

Value Meaning
CodecsDecompressDataFlags.Start Processing the beginning of a tile or strip
CodecsDecompressDataFlags.End Processing the end of a tile or strip
CodecsDecompressDataFlags.Complete Process a complete tile or strip. This is the same as CodecsDecompressDataFlags.Start | CodecsDecompressDataFlags.End

Example

For an example, refer to StartDecompress.

Remarks

Note that you must call the StartDecompress method before using this method, and you must call the StopDecompress method to end the decompression process.

If data does not point to a full tile or strip, set flags to CodecsDecompressDataFlags.Start when the tile/strip begins and set it to CodecsDecompressDataFlags.End when the tile/strip ends.

Requirements

Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also