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

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

#pragma once

/// @file gif_internal.h
/// @brief GIF89a format constants and packed structures.

#include <whiteout/common_types.h>

#include <cstdint>

namespace whiteout::textures::gif {

// ============================================================================
// GIF89a constants
// ============================================================================

static constexpr u8 GIF_TRAILER = 0x3B;
static constexpr u8 GIF_EXTENSION_INTRODUCER = 0x21;
static constexpr u8 GIF_IMAGE_SEPARATOR = 0x2C;
static constexpr u8 GIF_GRAPHIC_CONTROL_LABEL = 0xF9;
static constexpr u8 GIF_APPLICATION_EXTENSION_LABEL = 0xFF;
static constexpr u8 GIF_BLOCK_TERMINATOR = 0x00;

// ============================================================================
// Packed header structures
// ============================================================================

#pragma pack(push, 1)

struct GifHeader {
    u8 signature[3]; // "GIF"
    u8 version[3];   // "89a"
};
static_assert(sizeof(GifHeader) == 6, "GifHeader must be 6 bytes");

struct LogicalScreenDescriptor {
    u16 width;
    u16 height;
    u8 packed; // Global Color Table Flag | Color Resolution | Sort Flag | Size of GCT
    u8 bgColorIndex;
    u8 pixelAspectRatio;
};
static_assert(sizeof(LogicalScreenDescriptor) == 7, "LogicalScreenDescriptor must be 7 bytes");

struct GraphicControlExtension {
    u8 introducer; // 0x21
    u8 label;      // 0xF9
    u8 blockSize;  // 4
    u8 packed;     // Disposal Method | User Input | Transparent Color Flag
    u16 delayTime; // centiseconds
    u8 transparentIdx;
    u8 terminator; // 0x00
};
static_assert(sizeof(GraphicControlExtension) == 8, "GraphicControlExtension must be 8 bytes");

struct ImageDescriptor {
    u8 separator; // 0x2C
    u16 left;
    u16 top;
    u16 width;
    u16 height;
    u8 packed; // Local Color Table Flag | Interlace | Sort | Size of LCT
};
static_assert(sizeof(ImageDescriptor) == 10, "ImageDescriptor must be 10 bytes");

#pragma pack(pop)

} // namespace whiteout::textures::gif