Skip to content

PylonCompressionInfo_t

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

#include <pylonc/PylonC.h>

Public Attributes#

Name
EPylonCompressionStatus CompressionStatus
size_t DecompressedImageSize
size_t DecompressedPayloadSize
_Bool HasCompressedImage
_Bool Lossy
int OffsetX
int OffsetY
int PaddingX
int PaddingY
EPylonPixelType PixelType
int SizeX
int SizeY

Detailed Description#

struct PylonCompressionInfo_t;

The struct containing information about a grab buffer/result.

If the hasCompressedImage field in the struct is true, the grab buffer/result contains a compressed image. In this case, you should check the compressionStatus field in the struct to check whether the camera was able to compress the image properly. The camera can't compress an image if the amount of data required for compressing the image exceeds the desired compression ratio. The image can be decompressed if compressionStatus is CompressionStatus_Ok. If the hasCompressedImage field in the struct is false, the grab buffer/result already contains a decompressed image. In this case, the decompressedImageSize and decompressedPayloadSize fields will not be used. All other fields contain information about the decompressed data.

Public Attributes Documentation#

variable CompressionStatus#

EPylonCompressionStatus CompressionStatus;

Status of compression (see EPylonCompressionStatus).

variable DecompressedImageSize#

size_t DecompressedImageSize;

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

variable DecompressedPayloadSize#

size_t DecompressedPayloadSize;

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

variable HasCompressedImage#

_Bool HasCompressedImage;

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

variable Lossy#

_Bool Lossy;

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

variable OffsetX#

int OffsetX;

X offset (in pixels) of compressed image.

variable OffsetY#

int OffsetY;

Y offset (in pixels) of compressed image.

variable PaddingX#

int PaddingX;

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

variable PaddingY#

int PaddingY;

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

variable PixelType#

EPylonPixelType PixelType;

Pixel type of compressed image.

variable SizeX#

int SizeX;

Width (in pixels) of compressed image.

variable SizeY#

int SizeY;

Height (in pixels) of compressed image.


Updated on 5 July 2022 at 12:01:38