@bun-win32/gdi32

@bun-win32/gdi32

Zero-dependency, zero-overhead Win32 GDI32 bindings for Bun on Windows.

Overview

@bun-win32/gdi32 exposes the gdi32.dll exports using Bun's FFI. It provides a single class, GDI32, which lazily binds native symbols on first use. You can optionally preload a subset or all symbols up-front via Preload().

The bindings are strongly typed for a smooth DX in TypeScript.

Features

• Bun-first ergonomics on Windows 10/11.
• Direct FFI to gdi32.dll (device contexts, bitmaps, palettes, metrics, and painting helpers).
• In-source docs in structs/GDI32.ts with links to Microsoft Docs.
• Lazy binding on first call; optional eager preload (GDI32.Preload()).
• No wrapper overhead; calls map 1:1 to native APIs.
• Strongly-typed Win32 aliases (see types/GDI32.ts).

Requirements

• Bun runtime
• Windows 10 or later

Installation

bun add @bun-win32/gdi32

Quick Start

import GDI32 from '@bun-win32/gdi32';

// Preload a subset for hot paths (optional)
GDI32.Preload(['CreateCompatibleDC', 'DeleteDC']);

const hdc = GDI32.CreateCompatibleDC();

// ... do work with the device context ...

GDI32.DeleteDC(hdc);

AI agents: see AI.md for the package binding contract and source-navigation guidance. It explains how to use the package without scanning the entire implementation.

Examples

Run the included examples:

bun run example              # Basic GDI32 usage

Notes

• Either rely on lazy binding or call GDI32.Preload().
• Windows only. Bun runtime required.
• SAL types & naming: nullability is in the type — Optional<T> (formally optional, SAL _*opt_) and Nullable<T> (plain [in]/[out] the docs say can be NULL), the null sentinel derived from T (null for pointers LP*/P*, 0n for handles/by-value addresses); direction is in the parameter name — _out (_Out_), _in_out (_Inout_), _In_ bare. See AI.md and the repo AGENTS.md.