skin.hpp

Go to the documentation of this file.

#pragma once

 
#include <cstdint>
 
#include <welder/vocabulary.hpp>
 
#include <wowlib/core/client_version.hpp>
#include <wowlib/core/lang.hpp>
#include <wowlib/formats/m2/offset_block.hpp>
#include <wowlib/formats/m2/boundaries.hpp>
#include <wowlib/formats/m2/skin/records.hpp>
 
namespace wowlib::formats::m2::skin {
  inline constexpr std::uint32_t SkinMagic = 0x4E494B53; // "SKIN"

  struct [[
      =welder::weld,
      =welder::weld_as("Skin"),
  WOWLIB_CS_FAMILY_SURFACE
      =welder::doc(R"(
        An external model LOD view (.skin file), abstract over the client
        version. Construct a concrete version with Skin.for_version(expansion);
        the per-version Skin* classes are subclasses. See
        https://wowdev.wiki/M2/.skin.)")
    ]] SkinBase {
    bool operator==(const SkinBase&) const = default;
  };

      @tparam V the client version this skin targets.
      @see https://wowdev.wiki/M2/.skin */
  namespace detail {
    template <ClientVersion V> requires (V >= M2PerSequenceTimelines)
    struct [[
        =welder::weld,
        =welder::doc(R"(
        One external LOD view (.skin file, WotLK+): the 'SKIN' magic plus the
        profile tables (local lookups, submeshes, render batches). See
        https://wowdev.wiki/M2/.skin.)")
      ]] Skin : M2OffsetBlock<Skin<V>>, SkinBase {
      static constexpr ClientVersion Version = V;
 
      [[=welder::mark::exclude,
        =welder::doc("The leading magic, 'SKIN' — constant on every view file; "
          "hidden from the bindings.")]]
      std::uint32_t magic = SkinMagic;
 
      [[=welder::doc("The LOD view's tables (local lookups, submeshes, "
        "batches).")]]
      skin::M2SkinProfile<V> profile{};
 
      bool operator==(const Skin&) const = default;
    };
  }

  template <ClientVersion V> requires (V >= M2PerSequenceTimelines)
  using Skin = detail::Skin<canonicalVersion(V, M2SkinPivots, M2SkinVersions)>;
}