Class Image

Class Documentation

class Image

The image class encapsulates image information. It can be created from a buffer or a buffer part in case of a mult part buffer and provides a part of its information. It can be used to temporarily store the image so that the buffer can be freed.

NOTE: A GenTLException is thrown in case of a severe error.

Public Functions

Image(const Buffer *buffer, uint32_t part)

Copies the image information of the buffer.

Parameters:
  • bufferBuffer object to copy the data from.

  • part – Part number from which the image should be created.

inline const uint8_t *getPixels() const

Pointer to pixel information of the image.

Returns:

Pointer to pixels.

inline uint64_t getTimestampNS() const
inline size_t getWidth() const
inline size_t getHeight() const
inline size_t getXOffset() const
inline size_t getYOffset() const
inline size_t getXPadding() const
inline size_t getYPadding() const
inline uint64_t getFrameID() const
inline uint64_t getPixelFormat() const
inline bool isBigEndian() const