ImageInfo.h

Go to the documentation of this file.

// Copyright (c) 2025 Optris GmbH Co. KG

 
#pragma once
 
#include "otcsdk/Api.h"
 
 
namespace optris
{

enum class ColorFormat
{
  RGB,  
  BGR,  
};

enum class WidthAlignment
{
  OneByte    = 1,  
  TwoBytes   = 2,  
  FourBytes  = 4,  
  EightBytes = 8,  
};
 

class ImageInfo
{
public:
  OTC_SDK_API ImageInfo(ColorFormat colorFormat, WidthAlignment widthAlignment) noexcept;
 

  ColorFormat getColorFormat() const noexcept;

  int getChannels() const noexcept;

  int getOffsetRed() const noexcept;

  int getOffsetGreen() const noexcept;

  int getOffsetBlue() const noexcept;
 

  OTC_SDK_API int resize(int width, int height);

  int getWidth() const noexcept;

  int getStride() const noexcept;

  int getHeight() const noexcept;

  int getSize() const noexcept;
 

  WidthAlignment getWidthAlignment() const noexcept;

  int getWidthPaddingInBytes() const noexcept;
 
 
private:
  ColorFormat _colorFormat;
 
  int _channels;
 
  int _offsetRed;
  int _offsetBlue;
 
  int _width;
  int _stride;
  int _height;
  int _size;
 
  int _widthAlignment;
  int _widthPaddingInBytes;
};
 
 
// Inline implementations
inline ColorFormat ImageInfo::getColorFormat() const noexcept
{
  return _colorFormat;
}
 
inline int ImageInfo::getChannels() const noexcept
{
  return _channels;
}
 
inline int ImageInfo::getOffsetRed() const noexcept
{
  return _offsetRed;
}
 
inline int ImageInfo::getOffsetGreen() const noexcept
{
  return 1;
}
 
inline int ImageInfo::getOffsetBlue() const noexcept
{
  return _offsetBlue;
}
 
inline int ImageInfo::getWidth() const noexcept
{
  return _width;
}
 
inline int ImageInfo::getStride() const noexcept
{
  return _stride;
}
 
inline int ImageInfo::getHeight() const noexcept
{
  return _height;
}
 
inline int ImageInfo::getSize() const noexcept
{
    return _size;
}
 
inline WidthAlignment ImageInfo::getWidthAlignment() const noexcept
{
  return static_cast<WidthAlignment>(_widthAlignment);
}
 
inline int ImageInfo::getWidthPaddingInBytes() const noexcept
{
  return _widthPaddingInBytes;
}
 
} // namespace optris