whiteoutlib 0.1.3

Read and write Blizzard game assets from Rust: models (MDX, M2, M3), textures (BLP, DDS, PNG, JPEG, BMP, TGA, TIFF, GIF) and archives (CASC, MPQ).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

// SPDX-License-Identifier: BSD-3-Clause
// Copyright (c) 2026 Fernando Sahmkow

namespace detail {

template <typename T, typename = void>
struct has_get_version : std::false_type {};

template <typename T>
struct has_get_version<T, std::void_t<decltype(std::declval<T&>().getVersion())>>
    : std::true_type {};

template <typename T>
u32 getStructureVersion(const T& value) {
    if constexpr (has_get_version<T>::value) {
        return value.getVersion();
    }
    return ChunkTagTraits<T>::max_version;
}

} // namespace detail

template <typename T>
void BinaryWriterVisitor::visit(const AnimBlock<T>& block, u32 version) {
    (void)version;
    visit(block.timestamps);
    writer.write(block.flags);
    writer.write(block.endFrame);
    visit(block.keys);
}

template <typename T>
void BinaryWriterVisitor::visit(const std::vector<T>& container) {
    Reference ref = {};
    if (container.empty()) {
        writer.write(ref);
        return;
    }

    auto ref_position = writer.getPosition();
    writer.write(ref);
    currentLevelWrites.push_back([this, ref_position, &container]() {
        auto new_entry_index = indexTable.size();
        auto version = detail::getStructureVersion(*container.begin());
        const auto currentOffset = writer.getPosition();
        indexTable.push_back({ChunkTagTraits<T>::value, currentOffset,
                              static_cast<u32>(container.size()), version});
        auto& entry = indexTable[new_entry_index];
        writer.setPosition(ref_position);
        Reference ref = {};
        ref.entries = static_cast<u32>(container.size());
        ref.index = static_cast<u32>(new_entry_index);
        writer.write(ref);
        writer.setPosition(entry.offset);
        if constexpr (ChunkTagTraits<T>::is_trivial) {
            writer.write(container);
        } else {
            for (auto& element : container) {
                visit(element, entry.version);
                transferDeferredWrites();
            }
        }
        writer.AlignTo(16, 0xAA);
    });
}

template <typename T>
void BinaryWriterVisitor::visit(const std::optional<T>& container) {
    Reference ref = {};
    if (!container.has_value()) {
        writer.write(ref);
        return;
    }

    auto ref_position = writer.getPosition();
    writer.write(ref);
    currentLevelWrites.push_back([this, ref_position, &container]() {
        auto new_entry_index = indexTable.size();
        auto version = detail::getStructureVersion(*container);
        const auto currentOffset = writer.getPosition();
        indexTable.push_back({ChunkTagTraits<T>::value, currentOffset, 1, version});
        auto& entry = indexTable[new_entry_index];
        writer.setPosition(ref_position);
        Reference ref = {};
        ref.entries = 1;
        ref.index = static_cast<u32>(new_entry_index);
        writer.write(ref);
        writer.setPosition(entry.offset);
        if constexpr (ChunkTagTraits<T>::is_trivial) {
            writer.write(*container);
        } else {
            visit(*container, entry.version);
            transferDeferredWrites();
        }
        writer.AlignTo(16, 0xAA);
    });
}