boundaries.hpp

Go to the documentation of this file.

#pragma once

 
#include <array>
#include <cstdint>
 
#include <welder/vocabulary.hpp>
 
#include <wowlib/core/client_builds.hpp>
#include <wowlib/core/client_version.hpp>
#include <wowlib/formats/common/version_range.hpp>
 
namespace wowlib::formats::adt {
  inline constexpr std::uint32_t AdtVersion18 = 18;

  inline constexpr std::size_t ChunksPerTile = 16 * 16;
 
  // --- layout pivots (documented boundaries that change ADT<V> content) -------

  inline constexpr ClientVersion AdtTexFdids = builds::BfA_TidesOfVengeance_28294;

  inline constexpr ClientVersion AdtSplit = builds::Cata;
 
  // --- version grids ----------------------------------------------------------

  inline constexpr std::array AdtVersions{
    versions::Vanilla,
    versions::Tbc,
    versions::Wotlk,
    versions::Cata,
    versions::Mop,
    versions::Wod,
    versions::Legion,
    versions::Bfa,
    versions::Shadowlands,
    versions::Dragonflight,
    versions::Tww
  };
 
  // --- per-family canonicalization pivots -------------------------------------
  // Listed generously; a pivot that does not separate two grid versions is a
  // no-op (version_range.hpp). Each names a build where an ADT<V> or MapChunk<V>
  // member first appears or vanishes.

  inline constexpr std::array MapChunkPivots{builds::WotLK, builds::Cata};

  inline constexpr std::array AdtPivots{builds::TBC, builds::WotLK, builds::Cata, AdtTexFdids};
 
  // --- alpha-format context ---------------------------------------------------
 
  enum class [[
      =welder::weld,
      =welder::doc(R"(
        The on-disk MCAL alpha-map bit depth for a tile, decided by the map's
        WDT MPHD flags (adt_has_big_alpha 0x4 / adt_has_height_texturing 0x80),
        not the client era. wowlib always decodes alpha maps to a 64x64 8-bit
        edit surface; this records how they were laid out on disk so a write can
        reproduce the same encoding. RLE compression is an independent per-layer
        choice (the MCLY alpha_map_compressed flag), orthogonal to the depth.)")
    ]] AlphaFormat : std::uint8_t {
    Lowres4Bit [[=welder::doc(
      "2048-byte 4-bit alpha maps (the default when the WDT "
      "sets neither big-alpha flag).")]] = 0,
    Highres8Bit [[=welder::doc(
      "4096-byte 8-bit alpha maps (the WDT has adt_has_big_alpha "
      "or adt_has_height_texturing).")]] = 1
  };
}