Decompress(object,IntPtr,int,int,int,int,int,int,CodecsDecompressDataFlags) Method

Summary

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

Syntax

C++

public void Decompress( 
   object decompressContext, 
   IntPtr data, 
   int dataOffset, 
   int dataLength, 
   int width, 
   int height, 
   int row, 
   int column, 
   CodecsDecompressDataFlags flags 
)

Public Overloads 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 _ 
)

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

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.

Example

For an example, refer to StartDecompress.

Requirements

Target Platforms