CompressionInfo Structure#

The struct containing information about a grab buffer/result.

Syntax#

C#

public struct CompressionInfo

VB

Public Structure CompressionInfo

The CompressionInfo type exposes the following members.

Fields#

	Name	Description
	CompressionStatus	Status of compression (see CompressionStatus).
	DecompressedImageSize	Size (in bytes) required for decompressed image (only valid if HasCompressedImage is true).
	DecompressedPayloadSize	Size (in bytes; including chunk data) required for decompressed payload (only valid if HasCompressedImage is true).
	HasCompressedImage	True if grab buffer/result provided contains a compressed image (otherwise false if buffer/result is already decompressed).
	Height	Height (in pixels) of compressed image.
	Lossy	True if image was compressed lossily (otherwise false if it was compressed losslessly).
	OffsetX	X offset (in pixels) of compressed image.
	OffsetY	Y offset (in pixels) of compressed image.
	PaddingX	X padding (line padding; in bytes) of compressed image.
	PaddingY	Y padding (image padding; in bytes) of compressed image.
	PixelType	Pixel type of compressed image.
	Width	Width (in pixels) of compressed image.

Remarks#

You can find more information about the usage of this struct in the description of the ImageDecompressor class.

CompressionInfo.CompressionStatus Field#

Status of compression (see CompressionStatus).

Syntax#

C#

public CompressionStatus CompressionStatus

VB

Public CompressionStatus As CompressionStatus

Field Value#

Type: CompressionStatus

CompressionInfo.DecompressedImageSize Field#

Size (in bytes) required for decompressed image (only valid if HasCompressedImage is true).

Syntax#

C#

public int DecompressedImageSize

VB

Public DecompressedImageSize As Integer

Field Value#

Type: Int32

CompressionInfo.DecompressedPayloadSize Field#

Size (in bytes; including chunk data) required for decompressed payload (only valid if HasCompressedImage is true).

Syntax#

C#

public int DecompressedPayloadSize

VB

Public DecompressedPayloadSize As Integer

Field Value#

Type: Int32

CompressionInfo.HasCompressedImage Field#

True if grab buffer/result provided contains a compressed image (otherwise false if buffer/result is already decompressed).

Syntax#

C#

public bool HasCompressedImage

VB

Public HasCompressedImage As Boolean

Field Value#

Type: Boolean

CompressionInfo.Height Field#

Height (in pixels) of compressed image.

Syntax#

C#

public int Height

VB

Public Height As Integer

Field Value#

Type: Int32

CompressionInfo.Lossy Field#

True if image was compressed lossily (otherwise false if it was compressed losslessly).

Syntax#

C#

public bool Lossy

VB

Public Lossy As Boolean

Field Value#

Type: Boolean

CompressionInfo.OffsetX Field#

X offset (in pixels) of compressed image.

Syntax#

C#

public int OffsetX

VB

Public OffsetX As Integer

Field Value#

Type: Int32

CompressionInfo.OffsetY Field#

Y offset (in pixels) of compressed image.

Syntax#

C#

public int OffsetY

VB

Public OffsetY As Integer

Field Value#

Type: Int32

CompressionInfo.PaddingX Field#

X padding (line padding; in bytes) of compressed image.

Syntax#

C#

public int PaddingX

VB

Public PaddingX As Integer

Field Value#

Type: Int32

CompressionInfo.PaddingY Field#

Y padding (image padding; in bytes) of compressed image.

Syntax#

C#

public int PaddingY

VB

Public PaddingY As Integer

Field Value#

Type: Int32

CompressionInfo.PixelType Field#

Pixel type of compressed image.

Syntax#

C#

public PixelType PixelType

VB

Public PixelType As PixelType

Field Value#

Type: PixelType

CompressionInfo.Width Field#

Width (in pixels) of compressed image.

Syntax#

C#

public int Width

VB

Public Width As Integer

Field Value#

Type: Int32

CompressionInfo Fields#

The CompressionInfo type exposes the following members.

Fields#

	Name	Description
	CompressionStatus	Status of compression (see CompressionStatus).
	DecompressedImageSize	Size (in bytes) required for decompressed image (only valid if HasCompressedImage is true).
	DecompressedPayloadSize	Size (in bytes; including chunk data) required for decompressed payload (only valid if HasCompressedImage is true).
	HasCompressedImage	True if grab buffer/result provided contains a compressed image (otherwise false if buffer/result is already decompressed).
	Height	Height (in pixels) of compressed image.
	Lossy	True if image was compressed lossily (otherwise false if it was compressed losslessly).
	OffsetX	X offset (in pixels) of compressed image.
	OffsetY	Y offset (in pixels) of compressed image.
	PaddingX	X padding (line padding; in bytes) of compressed image.
	PaddingY	Y padding (image padding; in bytes) of compressed image.
	PixelType	Pixel type of compressed image.
	Width	Width (in pixels) of compressed image.