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

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

/// @file bcn.cpp
/// @brief Unified BCn encode/decode dispatcher implementation.

#include "bcn.h"

#include "bcn/bc1.h"
#include "bcn/bc2.h"
#include "bcn/bc3.h"
#include "bcn/bc4.h"
#include "bcn/bc5.h"
#include "bcn/bc6h.h"
#include "bcn/bc7.h"

namespace whiteout::textures::bcn {

// ============================================================================
// encode
// ============================================================================

std::optional<Texture> encode(const Texture& src, PixelFormat target, std::string* out_error,
                              interfaces::WorkerPool* pool) {
    if (!isCompressed(target)) {
        if (out_error)
            *out_error = "bcn::encode: target is not a BCn format";
        return std::nullopt;
    }

    if (!can_encode(src.format(), target)) {
        if (out_error)
            *out_error = "bcn::encode: source format is not compatible with target";
        return std::nullopt;
    }

    switch (target) {
    case PixelFormat::BC1:
        return bc1::encodeTexture(src, /*alpha=*/false, out_error, pool);
    case PixelFormat::BC2:
        return bc2::encodeTexture(src, out_error, pool);
    case PixelFormat::BC3:
        return bc3::encodeTexture(src, out_error, pool);
    case PixelFormat::BC4:
        return bc4::encodeTexture(src, out_error, pool);
    case PixelFormat::BC5:
        return bc5::encodeTexture(src, out_error, pool);
    case PixelFormat::BC6H:
        return bc6h::encodeTexture(src, out_error, pool);
    case PixelFormat::BC7:
        return bc7::encodeTexture(src, bc7::Quality::High, out_error, pool);
    default:
        if (out_error)
            *out_error = "bcn::encode: unsupported target format";
        return std::nullopt;
    }
}

// ============================================================================
// decode
// ============================================================================

std::optional<Texture> decode(const Texture& src, std::string* out_error,
                              interfaces::WorkerPool* pool) {
    if (!isCompressed(src.format())) {
        if (out_error)
            *out_error = "bcn::decode: source is not a BCn format";
        return std::nullopt;
    }

    switch (src.format()) {
    case PixelFormat::BC1:
        return bc1::decodeTexture(src, out_error, pool);
    case PixelFormat::BC2:
        return bc2::decodeTexture(src, out_error, pool);
    case PixelFormat::BC3:
        return bc3::decodeTexture(src, out_error, pool);
    case PixelFormat::BC4:
        return bc4::decodeTexture(src, out_error, pool);
    case PixelFormat::BC5:
        return bc5::decodeTexture(src, out_error, pool);
    case PixelFormat::BC6H:
        return bc6h::decodeTexture(src, out_error, pool);
    case PixelFormat::BC7:
        return bc7::decodeTexture(src, out_error, pool);
    default:
        if (out_error)
            *out_error = "bcn::decode: unsupported source format";
        return std::nullopt;
    }
}

} // namespace whiteout::textures::bcn