Image.h

#pragma once
 
#include <Foundation/Containers/Blob.h>
#include <Foundation/Containers/DynamicArray.h>
#include <Foundation/Containers/HybridArray.h>
#include <Foundation/Logging/Log.h>
 
#include <Texture/Image/Formats/ImageFileFormat.h>
#include <Texture/Image/ImageHeader.h>
 
class PL_TEXTURE_DLL plImageView : protected plImageHeader
{
public:
  plImageView();
 
  plImageView(const plImageHeader& header, plConstByteBlobPtr imageData);
 
  void Clear();
 
  bool IsValid() const;
 
  void ResetAndViewExternalStorage(const plImageHeader& header, plConstByteBlobPtr imageData);
 
  plResult SaveTo(plStringView sFileName) const;
 
  const plImageHeader& GetHeader() const;
 
  template <typename T>
  plBlobPtr<const T> GetBlobPtr() const;
 
  plConstByteBlobPtr GetByteBlobPtr() const;
 
  plImageView GetSubImageView(plUInt32 uiMipLevel = 0, plUInt32 uiFace = 0, plUInt32 uiArrayIndex = 0) const;
 
  plImageView GetPlaneView(plUInt32 uiMipLevel = 0, plUInt32 uiFace = 0, plUInt32 uiArrayIndex = 0, plUInt32 uiPlaneIndex = 0) const;
 
  plImageView GetSliceView(plUInt32 uiMipLevel = 0, plUInt32 uiFace = 0, plUInt32 uiArrayIndex = 0, plUInt32 z = 0, plUInt32 uiPlaneIndex = 0) const;
 
  plImageView GetRowView(plUInt32 uiMipLevel = 0, plUInt32 uiFace = 0, plUInt32 uiArrayIndex = 0, plUInt32 y = 0, plUInt32 z = 0, plUInt32 uiPlaneIndex = 0) const;
 
  template <typename T>
  const T* GetPixelPointer(
    plUInt32 uiMipLevel = 0, plUInt32 uiFace = 0, plUInt32 uiArrayIndex = 0, plUInt32 x = 0, plUInt32 y = 0, plUInt32 z = 0, plUInt32 uiPlaneIndex = 0) const;
 
  void ReinterpretAs(plImageFormat::Enum format);
 
public:
  using plImageHeader::GetDepth;
  using plImageHeader::GetHeight;
  using plImageHeader::GetWidth;
 
  using plImageHeader::GetNumArrayIndices;
  using plImageHeader::GetNumFaces;
  using plImageHeader::GetNumMipLevels;
  using plImageHeader::GetPlaneCount;
 
  using plImageHeader::GetImageFormat;
 
  using plImageHeader::GetNumBlocksX;
  using plImageHeader::GetNumBlocksY;
  using plImageHeader::GetNumBlocksZ;
 
  using plImageHeader::GetDepthPitch;
  using plImageHeader::GetRowPitch;
 
protected:
  plUInt64 ComputeLayout();
 
  void ValidateSubImageIndices(plUInt32 uiMipLevel, plUInt32 uiFace, plUInt32 uiArrayIndex, plUInt32 uiPlaneIndex) const;
  template <typename T>
  void ValidateDataTypeAccessor(plUInt32 uiPlaneIndex) const;
 
  const plUInt64& GetSubImageOffset(plUInt32 uiMipLevel, plUInt32 uiFace, plUInt32 uiArrayIndex, plUInt32 uiPlaneIndex) const;
 
  plHybridArray<plUInt64, 16> m_SubImageOffsets;
  plBlobPtr<plUInt8> m_DataPtr;
};
 
class PL_TEXTURE_DLL plImage : public plImageView
{
  void operator=(const plImage& rhs) = delete;
 
  void operator=(const plImageView& rhs) = delete;
 
  explicit plImage(const plImageHeader& header);
 
  explicit plImage(const plImageHeader& header, plByteBlobPtr externalData);
 
  explicit plImage(const plImageView& other);
 
public:
  PL_DECLARE_MEM_RELOCATABLE_TYPE();
 
  plImage();
 
  plImage(plImage&& other);
 
  void operator=(plImage&& rhs);
 
  void Clear();
 
  void ResetAndAlloc(const plImageHeader& header);
 
  void ResetAndUseExternalStorage(const plImageHeader& header, plByteBlobPtr externalData);
 
  void ResetAndMove(plImage&& other);
 
  void ResetAndCopy(const plImageView& other);
 
  plResult LoadFrom(plStringView sFileName);
 
  plResult Convert(plImageFormat::Enum targetFormat);
 
  template <typename T>
  plBlobPtr<T> GetBlobPtr();
 
  plByteBlobPtr GetByteBlobPtr();
 
  using plImageView::GetBlobPtr;
  using plImageView::GetByteBlobPtr;
 
  plImage GetSubImageView(plUInt32 uiMipLevel = 0, plUInt32 uiFace = 0, plUInt32 uiArrayIndex = 0);
 
  using plImageView::GetSubImageView;
 
  plImage GetPlaneView(plUInt32 uiMipLevel = 0, plUInt32 uiFace = 0, plUInt32 uiArrayIndex = 0, plUInt32 uiPlaneIndex = 0);
 
  using plImageView::GetPlaneView;
 
  plImage GetSliceView(plUInt32 uiMipLevel = 0, plUInt32 uiFace = 0, plUInt32 uiArrayIndex = 0, plUInt32 z = 0, plUInt32 uiPlaneIndex = 0);
 
  using plImageView::GetSliceView;
 
  plImage GetRowView(plUInt32 uiMipLevel = 0, plUInt32 uiFace = 0, plUInt32 uiArrayIndex = 0, plUInt32 y = 0, plUInt32 z = 0, plUInt32 uiPlaneIndex = 0);
 
  using plImageView::GetRowView;
 
  template <typename T>
  T* GetPixelPointer(plUInt32 uiMipLevel = 0, plUInt32 uiFace = 0, plUInt32 uiArrayIndex = 0, plUInt32 x = 0, plUInt32 y = 0, plUInt32 z = 0, plUInt32 uiPlaneIndex = 0);
 
  using plImageView::GetPixelPointer;
 
private:
  bool UsesExternalStorage() const;
 
  plBlob m_InternalStorage;
};
 
#include <Texture/Image/Implementation/Image_inl.h>