Skip to content

docs: C API and BugSplat.dll dynamic library for Windows C++#160

Open
bobbyg603 wants to merge 6 commits into
masterfrom
docs/cpp-dynamic-library
Open

docs: C API and BugSplat.dll dynamic library for Windows C++#160
bobbyg603 wants to merge 6 commits into
masterfrom
docs/cpp-dynamic-library

Conversation

@bobbyg603

Copy link
Copy Markdown
Member

Summary

Documents the new flat C API (BugSplatC.h) and dynamic link model (BugSplat.dll) added in bugsplat-windows#155.

Changes

BugSplat for Windows (C++) — new Dynamic Library section:

  • When to choose BugSplat.dll over the static BugSplat.lib: CRT independence (/MT vs /MD no longer needs to match the SDK), and foreign-language bindings via P/Invoke or FFI (e.g. bugsplat-unity)
  • Linking against the dynamic\BugSplat.lib import library and shipping BugSplat.dll
  • C API initialization example, plus a note that static consumers can use the C API by defining BUGSPLAT_STATIC

BugSplat Native API Documentation — new C API (BugSplatC.h) section:

  • Linkage notes (dynamic vs static), string/bool ABI conventions
  • BugSplat_Init / BugSplat_IsInitialized reference
  • Mapping table for the forwarding functions → existing class method docs
  • Usage example

⚠️ Merge timing

Hold until bugsplat-windows#155 ships in a release and the release packaging (MakeZips) includes the dynamic\ folder and BugSplatC.h in BugSplat.zip — otherwise the docs describe files customers can't download yet.

🤖 Generated with Claude Code

bobbyg603 and others added 6 commits June 11, 2026 17:27
Documents the new flat C API (BugSplatC.h) and dynamic link model added
in BugSplat-Git/bugsplat-windows#155:

- Integration page: new "Dynamic Library" section covering when to choose
  the DLL (CRT independence, foreign-language bindings), linking against
  dynamic\BugSplat.lib, and shipping BugSplat.dll
- API documentation: new "C API (BugSplatC.h)" section with linkage
  notes, BugSplat_Init/BugSplat_IsInitialized, a mapping table for the
  forwarding functions, and a usage example

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
… C API

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Supersedes the SetTerminateAfterCrash boolean docs.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant