Pylon Logo Basler Logo
Public Member Functions | Public Attributes | List of all members
Pylon::CompressionInfo_t Struct Reference

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

#include <pylon/ImageDecompressor.h>

Public Member Functions

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

Public Attributes

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

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.

Constructor & Destructor Documentation

Pylon::CompressionInfo_t::CompressionInfo_t ( )

Creates and initializes a compression info struct.

Error Safety:
Does not throw C++ exceptions.

The documentation for this struct was generated from the following file:

pylon 6.1.0
Copyright (c) 2006-2020 Basler AG (Mon Mar 16 2020 10:57:00)