function bitmapFileHeader
bitmapFileHeader(): Coder<BitmapFileHeader>

Creates a coder for the 14-byte BITMAPFILEHEADER.

Field layout (little-endian throughout):

  • signature 2 bytes — ASCII, "BM"
  • fileSize 4 bytes — u32
  • reserved1 2 bytes — u16
  • reserved2 2 bytes — u16
  • pixelOffset 4 bytes — u32

Examples

Round-trip a BITMAPFILEHEADER

import { assertEquals } from "@std/assert";
import { bitmapFileHeader } from "@binstruct/bmp";

const coder = bitmapFileHeader();
const header = {
  signature: "BM",
  fileSize: 70,
  reserved1: 0,
  reserved2: 0,
  pixelOffset: 54,
};

const buffer = new Uint8Array(14);
const bytesWritten = coder.encode(header, buffer);
const [decoded, bytesRead] = coder.decode(buffer);

assertEquals(bytesWritten, 14);
assertEquals(bytesRead, 14);
assertEquals(decoded, header);

Return Type

A coder for BitmapFileHeader.

Usage

import { bitmapFileHeader } from ".";