whiteoutlib 0.1.5

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

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

/// @file bmp_internal.h
/// @brief BMP packed structs, constants, and helpers.
///
/// Internal header — not part of the public include path.

#pragma once

#include <cstdint>
#include <cstring>

#include <whiteout/common_types.h>
#include <whiteout/textures/texture.h>

namespace whiteout::textures::bmp {

// ============================================================================
// Constants
// ============================================================================

/// BMP file signature: 'BM' (0x4D42 in little-endian).
static constexpr u16 BMP_SIGNATURE = 0x4D42;

/// Compression methods.
static constexpr u32 BI_RGB = 0;
static constexpr u32 BI_BITFIELDS = 3;

// ============================================================================
// Packed Structures
// ============================================================================

#pragma pack(push, 1)

/// 14-byte BMP file header.
struct BmpFileHeader {
    u16 signature;  ///< Must be 0x4D42 ('BM').
    u32 fileSize;   ///< Total file size in bytes.
    u16 reserved1;  ///< Reserved (0).
    u16 reserved2;  ///< Reserved (0).
    u32 dataOffset; ///< Byte offset from file start to pixel data.
};

/// 40-byte BITMAPINFOHEADER (most common DIB header).
struct BmpInfoHeader {
    u32 headerSize;      ///< Size of this header (40).
    i32 width;           ///< Image width in pixels.
    i32 height;          ///< Image height (positive = bottom-up, negative = top-down).
    u16 planes;          ///< Number of color planes (must be 1).
    u16 bitsPerPixel;    ///< Bits per pixel (24 or 32 for our purposes).
    u32 compression;     ///< Compression method (BI_RGB or BI_BITFIELDS).
    u32 imageSize;       ///< Size of raw bitmap data (may be 0 for BI_RGB).
    i32 xPixelsPerMeter; ///< Horizontal resolution.
    i32 yPixelsPerMeter; ///< Vertical resolution.
    u32 colorsUsed;      ///< Number of colors in the palette (0 = default).
    u32 colorsImportant; ///< Number of important colors (0 = all).
};

#pragma pack(pop)

static_assert(sizeof(BmpFileHeader) == 14, "BmpFileHeader must be 14 bytes");
static_assert(sizeof(BmpInfoHeader) == 40, "BmpInfoHeader must be 40 bytes");

// ============================================================================
// Helpers
// ============================================================================

/// Row stride for a BMP row (padded to 4-byte boundary).
inline u32 bmp_row_stride(u32 width, u16 bitsPerPixel) {
    return ((width * bitsPerPixel + 31) / 32) * 4;
}

} // namespace whiteout::textures::bmp