class P1::CameraSdk::LiveViewImpl

Overview

#include <C_P1CameraPrivStructs.hpp>

class LiveViewImpl: public P1::CameraSdk::ILiveView
{
public:
    // typedefs

    typedef P1::IQP::LiveView::LiveViewImage const PrivStructType;

    // construction

    LiveViewImpl(PrivStructType*const dataStruct);

    // methods

    virtual std::shared_ptr<uint8_t const> Data() const;
    virtual size_t DataSizeBytes() const;
    virtual ImageFormat Format() const;
    virtual Type BufferType() const;
    virtual char const* BufferTypeStr() const;
    virtual char const* FormatStr() const;
    virtual uint32_t DestinationWidth() const;
    virtual uint32_t DestinationHeight() const;
    virtual uint32_t CompressionQuality() const;
    virtual bool IsCompressed() const;
    virtual ValueRect SourceCrop() const;
    virtual ValueRect RequestedCrop() const;
    virtual ValueArea SourceFullImageSize() const;
};

Inherited Members

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;
    virtual uint32_t DestinationWidth() const = 0;
    virtual uint32_t DestinationHeight() const = 0;
    virtual uint32_t CompressionQuality() const = 0;
    virtual bool IsCompressed() const = 0;
    virtual ValueRect SourceCrop() const = 0;
    virtual ValueRect RequestedCrop() const = 0;
    virtual ValueArea SourceFullImageSize() const = 0;

Detailed Documentation

Methods

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

Returns a pointer to the pixel buffer data.

virtual size_t DataSizeBytes() const

Returns the size of the pixel buffer in bytes.

virtual ImageFormat Format() const

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

virtual Type BufferType() const

Returns the type of this buffer.

virtual char const* BufferTypeStr() const

Returns a string of the type this buffer.

virtual char const* FormatStr() const

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

virtual uint32_t DestinationWidth() const

Return the buffers width in pixels.

virtual uint32_t DestinationHeight() const

Returns the buffers height in pixels.

virtual uint32_t CompressionQuality() const

The compression quality as a percentage.

virtual bool IsCompressed() const

Returns whether the image has been compressed (e.g., by JPEG).

virtual ValueRect SourceCrop() const

The actual crop that was cropped in the sensor.

virtual ValueRect RequestedCrop() const

The user requested crop.

virtual ValueArea SourceFullImageSize() const

The full source (sensor) size.