class P1::CameraSdk::IImageBuffer

Overview

Contains an image buffer, encoded in either in bitmap or JPEG format. More…

#include <C_P1CameraCommonStructs.h>

class IImageBuffer
{
public:
    // enums

    enum Type;

    // methods

    virtual std::shared_ptr<uint8_t const> Data() const = 0;
    virtual size_t DataSizeBytes() const = 0;
    virtual ImageFormat Format() const = 0;
    virtual Type BufferType() const = 0;
    virtual char const* BufferTypeStr() const = 0;
    virtual char const* FormatStr() const = 0;
};

// direct descendants

class IFullImage;
class IImageBufferFrame;
class ImageEnumBuffer;

Detailed Documentation

Contains an image buffer, encoded in either in bitmap or JPEG format.

Version 3.0

Methods

virtual std::shared_ptr<uint8_t const> Data() const = 0

Returns a pointer to the pixel buffer data.

virtual size_t DataSizeBytes() const = 0

Returns the size of the pixel buffer in bytes.

virtual ImageFormat Format() const = 0

Returns the image encoding type of this buffer (bitmap, jpeg)

virtual Type BufferType() const = 0

Returns the type of this buffer.

virtual char const* BufferTypeStr() const = 0

Returns a string of the type this buffer.

virtual char const* FormatStr() const = 0

Returns a string of the type kind of this buffer, (RGB, JPEG, etc.)