dolphin/Source/Core/VideoCommon/AbstractTexture.h

// Copyright 2017 Dolphin Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later

#pragma once

#include <cstddef>
#include <string>

#include "Common/CommonTypes.h"
#include "Common/MathUtil.h"
#include "VideoCommon/TextureConfig.h"

class AbstractTexture
{
public:
  explicit AbstractTexture(const TextureConfig& c);
  virtual ~AbstractTexture() = default;

  virtual void CopyRectangleFromTexture(const AbstractTexture* src,
                                        const MathUtil::Rectangle<int>& src_rect, u32 src_layer,
                                        u32 src_level, const MathUtil::Rectangle<int>& dst_rect,
                                        u32 dst_layer, u32 dst_level) = 0;
  virtual void ResolveFromTexture(const AbstractTexture* src, const MathUtil::Rectangle<int>& rect,
                                  u32 layer, u32 level) = 0;
  virtual void Load(u32 level, u32 width, u32 height, u32 row_length, const u8* buffer,
                    size_t buffer_size) = 0;

  // Hints to the backend that we have finished rendering to this texture, and it will be used
  // as a shader resource and sampled. For Vulkan, this transitions the image layout.
  virtual void FinishedRendering();

  u32 GetWidth() const { return m_config.width; }
  u32 GetHeight() const { return m_config.height; }
  u32 GetLevels() const { return m_config.levels; }
  u32 GetLayers() const { return m_config.layers; }
  u32 GetSamples() const { return m_config.samples; }
  AbstractTextureFormat GetFormat() const { return m_config.format; }
  MathUtil::Rectangle<int> GetRect() const { return m_config.GetRect(); }
  MathUtil::Rectangle<int> GetMipRect(u32 level) const { return m_config.GetMipRect(level); }
  bool IsMultisampled() const { return m_config.IsMultisampled(); }
  bool Save(const std::string& filename, unsigned int level);

  static bool IsCompressedFormat(AbstractTextureFormat format);
  static bool IsDepthFormat(AbstractTextureFormat format);
  static bool IsStencilFormat(AbstractTextureFormat format);
  static bool IsCompatibleDepthAndColorFormats(AbstractTextureFormat depth_format,
                                               AbstractTextureFormat color_format);
  static u32 CalculateStrideForFormat(AbstractTextureFormat format, u32 row_length);
  static u32 GetTexelSizeForFormat(AbstractTextureFormat format);
  static u32 GetBlockSizeForFormat(AbstractTextureFormat format);

  const TextureConfig& GetConfig() const;

protected:
  const TextureConfig m_config;
};