background_buffer.h

Go to the documentation of this file.

#ifndef YAZE_APP_GFX_BACKGROUND_BUFFER_H
#define YAZE_APP_GFX_BACKGROUND_BUFFER_H
 
#include <array>
#include <cstdint>
#include <optional>
#include <vector>
 
#include "app/gfx/core/bitmap.h"
#include "app/gfx/types/snes_tile.h"
 
namespace yaze {
namespace gfx {
 
enum class BG1RevealMaskSource : uint8_t {
  kBG2Layout = 1 << 0,
  kBG2Objects = 1 << 1,
};
 
// Decode the eight 8x8 tiles selected by a dungeon room's floor-graphics
// nibble. The first four words live in the main table and the second four in
// the adjacent floor table, matching RoomDraw_DrawFloors in the game.
std::optional<std::array<TileInfo, 8>> DecodeDungeonFloorTilePattern(
    const std::vector<uint8_t>& rom_data, int tile_address,
    int tile_address_floor, uint8_t floor_graphics);
 
class BackgroundBuffer {
 public:
  BackgroundBuffer(int width = 512, int height = 512);
 
  // Buffer manipulation methods
  void SetTileAt(int x, int y, uint16_t value);
  uint16_t GetTileAt(int x, int y) const;
  void ClearTileBuffer();
  void ClearBuffer();
 
  // Drawing methods
  void DrawTile(const TileInfo& tile_info, uint8_t* canvas,
                const uint8_t* tiledata, int indexoffset);
  void DrawBackground(std::span<uint8_t> gfx16_data);
 
  // Floor drawing methods
  void DrawFloor(const std::vector<uint8_t>& rom_data, int tile_address,
                 int tile_address_floor, uint8_t floor_graphics);
 
  // Ensure bitmap is initialized before accessing
  // Call this before using bitmap() if the buffer was created standalone
  void EnsureBitmapInitialized();
 
  // Priority buffer methods for per-tile priority support
  // SNES Mode 1 uses priority bits to control Z-ordering between layers
  void ClearPriorityBuffer();
  uint8_t GetPriorityAt(int x, int y) const;
  void SetPriorityAt(int x, int y, uint8_t priority);
  const std::vector<uint8_t>& priority_data() const { return priority_buffer_; }
  std::vector<uint8_t>& mutable_priority_data();
 
  // Coverage buffer methods for per-pixel "this layer wrote here" tracking.
  //
  // This is critical for accurate dungeon compositing: a tilemap entry can
  // legally be fully transparent (all pixels == 0), and it still overwrites
  // whatever was previously on that BG. With separate Layout/Object buffers,
  // we need an explicit coverage mask to distinguish:
  // - "object layer didn't write here" (fall back to layout), vs
  // - "object layer wrote transparent here" (clear layout; reveal BG2/backdrop).
  void ClearCoverageBuffer();
  const std::vector<uint8_t>& coverage_data() const { return coverage_buffer_; }
  std::vector<uint8_t>& mutable_coverage_data();
 
  // Per-pixel cross-layer reveal bits carried by raw BG1 target buffers.
  // Each bit identifies the BG2 source layer that requested the reveal, so
  // compositing can ignore that request when its owner is hidden while later
  // BG1 writes can clear only the source bit they supersede.
  void ClearBG1RevealMask();
  void ClearBG1RevealMask(BG1RevealMaskSource source);
  void ClearBG1RevealMaskRect(BG1RevealMaskSource source, int start_x,
                              int start_y, int width, int height);
  void SetBG1RevealMaskRect(BG1RevealMaskSource source, int start_x,
                            int start_y, int width, int height);
  const std::vector<uint8_t>& bg1_reveal_mask_data() const {
    return bg1_reveal_mask_buffer_;
  }
  std::vector<uint8_t>& mutable_bg1_reveal_mask_data();
 
  // Accessors
  std::vector<uint16_t>& buffer() { return buffer_; }
  const std::vector<uint16_t>& buffer() const { return buffer_; }
  auto& bitmap() { return bitmap_; }
  const gfx::Bitmap& bitmap() const { return bitmap_; }
 
 private:
  void EnsureTileBufferAllocated();
  void EnsurePriorityBufferAllocated();
  void EnsureCoverageBufferAllocated();
  void EnsureBG1RevealMaskAllocated();
 
  std::vector<uint16_t> buffer_;
  std::vector<uint8_t> priority_buffer_;  // Per-pixel priority (0 or 1)
  std::vector<uint8_t> coverage_buffer_;  // Per-pixel coverage (0=unset,1=set)
  std::vector<uint8_t> bg1_reveal_mask_buffer_;  // Per-pixel BG1 reveal mask
  gfx::Bitmap bitmap_;
  int width_;
  int height_;
};
 
}  // namespace gfx
}  // namespace yaze
 
#endif  // YAZE_APP_GFX_BACKGROUND_BUFFER_H