Pylon::CompressionInfo_t#

The struct containing information about a grab buffer/result. More…

#include <pylon/ImageDecompressor.h>

Public Functions#

Public Attributes#

Detailed Description#

struct Pylon::CompressionInfo_t;

The struct containing information about a grab buffer/result.

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

Public Functions Documentation#

function CompressionInfo_t#

CompressionInfo_t()

Creates and initializes a compression info struct.

Error Safety:

Does not throw C++ exceptions.

Public Attributes Documentation#

variable hasCompressedImage#

bool hasCompressedImage;

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

variable compressionStatus#

ECompressionStatus compressionStatus;

Status of compression (see ECompressionStatus).

variable lossy#

bool lossy;

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

variable pixelType#

EPixelType pixelType;

Pixel type of compressed image.

variable width#

size_t width;

Width (in pixels) of compressed image.

variable height#

size_t height;

Height (in pixels) of compressed image.

variable offsetX#

size_t offsetX;

X offset (in pixels) of compressed image.

variable offsetY#

size_t offsetY;

Y offset (in pixels) of compressed image.

variable paddingX#

size_t paddingX;

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

variable paddingY#

size_t paddingY;

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

variable decompressedImageSize#

size_t decompressedImageSize;

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

variable decompressedPayloadSize#

size_t decompressedPayloadSize;

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