draw_routine_symbology.h

Go to the documentation of this file.

#ifndef YAZE_ZELDA3_DUNGEON_DRAW_ROUTINES_DRAW_ROUTINE_SYMBOLOGY_H
#define YAZE_ZELDA3_DUNGEON_DRAW_ROUTINES_DRAW_ROUTINE_SYMBOLOGY_H
 
#include <cstdint>
#include <string>
 
namespace yaze {
namespace zelda3 {
 
struct DrawRoutineInfo;
 
struct DrawRoutineSymbology {
  std::string badge;        // One or two characters, for a grid cell.
  std::string family;       // Human-readable routine family.
  bool dual_layer = false;  // Routine writes to BG1 and BG2.
  int base_width = 0;       // Base pattern width in tiles (0 = unknown).
  int base_height = 0;      // Base pattern height in tiles (0 = unknown).
};
 
// Returns the symbology for `info`, or an "unknown" symbology when null.
DrawRoutineSymbology GetSymbologyForRoutine(const DrawRoutineInfo* info);
 
// Returns the symbology for whichever routine draws `object_id`, or an
// "unmapped" symbology when the registry has no routine for it.
DrawRoutineSymbology GetSymbologyForObject(int16_t object_id);
 
}  // namespace zelda3
}  // namespace yaze
 
#endif  // YAZE_ZELDA3_DUNGEON_DRAW_ROUTINES_DRAW_ROUTINE_SYMBOLOGY_H