Skip to content

Pylon::CompressionInfo_t#

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

#include <pylon/ImageDecompressor.h>

Public Functions#

Name
CompressionInfo_t()
Creates and initializes a compression info struct.

Public Attributes#

Name
bool hasCompressedImage
True if grab buffer/result provided contains a compressed image (otherwise false if buffer/result is already decompressed).
ECompressionStatus compressionStatus
Status of compression (see ECompressionStatus).
bool lossy
True if image was compressed lossily (otherwise false if it was compressed losslessly).
EPixelType pixelType
Pixel type of compressed image.
size_t width
Width (in pixels) of compressed image.
size_t height
Height (in pixels) of compressed image.
size_t offsetX
X offset (in pixels) of compressed image.
size_t offsetY
Y offset (in pixels) of compressed image.
size_t paddingX
X padding (line padding; in bytes) of compressed image.
size_t paddingY
Y padding (image padding; in bytes) of compressed image.
size_t decompressedImageSize
Size (in bytes) required for decompressed image (only valid if hasCompressedImage is true).
size_t decompressedPayloadSize
Size (in bytes; including chunk data) required for decompressed payload (only valid if hasCompressedImage is true).

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#

CompressionInfo_t#

CompressionInfo_t()

Creates and initializes a compression info struct.

Error Safety:

Does not throw C++ exceptions.

Public Attributes Documentation#

hasCompressedImage#

bool hasCompressedImage;

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

compressionStatus#

ECompressionStatus compressionStatus;

Status of compression (see ECompressionStatus).

lossy#

bool lossy;

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

pixelType#

EPixelType pixelType;

Pixel type of compressed image.

width#

size_t width;

Width (in pixels) of compressed image.

height#

size_t height;

Height (in pixels) of compressed image.

offsetX#

size_t offsetX;

X offset (in pixels) of compressed image.

offsetY#

size_t offsetY;

Y offset (in pixels) of compressed image.

paddingX#

size_t paddingX;

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

paddingY#

size_t paddingY;

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

decompressedImageSize#

size_t decompressedImageSize;

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

decompressedPayloadSize#

size_t decompressedPayloadSize;

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


Updated on 5 July 2022 at 15:30:00