peak_common_iimageview.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <peak_common/types/geometry/peak_common_size.hpp>
#include <peak_common/types/peak_common_pixel_format.hpp>
#include <peak_common_c/detail/peak_common_defines.h>
 
#include <cstddef>
#include <cstdint>
#include <memory>
 
namespace peak
{
namespace common
{
 
class Metadata;

class IImageView
{
public:
    virtual ~IImageView() = default;

    PEAK_COMMON_NO_DISCARD virtual const uint8_t* GetData() const = 0;

    PEAK_COMMON_NO_DISCARD virtual uint8_t* GetData() = 0;

    PEAK_COMMON_NO_DISCARD virtual std::size_t GetLineStartOffset() const = 0;

    PEAK_COMMON_NO_DISCARD virtual std::size_t GetSizeInBytes() const = 0;

    PEAK_COMMON_NO_DISCARD virtual peak::common::PixelFormat GetPixelFormat() const = 0;

    PEAK_COMMON_NO_DISCARD virtual peak::common::PixelFormatInfo GetPixelFormatInfo() const = 0;

    PEAK_COMMON_NO_DISCARD virtual Size GetSize() const = 0;

    PEAK_COMMON_NO_DISCARD virtual uint32_t GetWidth() const = 0;

    PEAK_COMMON_NO_DISCARD virtual uint32_t GetHeight() const = 0;

    PEAK_COMMON_NO_DISCARD virtual size_t GetBitsPerPixel() const = 0;

    PEAK_COMMON_NO_DISCARD virtual size_t GetBytesPerLine() const = 0;

    PEAK_COMMON_NO_DISCARD virtual std::shared_ptr<peak::common::Metadata> GetMetadata() = 0;

    PEAK_COMMON_NO_DISCARD virtual std::shared_ptr<const peak::common::Metadata> GetMetadata() const = 0;
};
 
} // namespace common 
} // namespace peak