# Upgrade Dear Imgui Stack

> Use when a user asks to upgrade Dear ImGui, cimgui, ImPlot, ImPlot3D, ImNodes, ImGuizmo, Dear ImGui Test Engine, or related bindings in this repository. Refresh submodules, regenerate pregenerated native/WASM bindings, audit safe Rust API and backend shim changes, update examples/docs/changelog/versioning, and validate release readiness.

- Skill: `tomevault-io/upgrade-dear-imgui-stack` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/upgrade-dear-imgui-stack`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/upgrade-dear-imgui-stack/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Security
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/upgrade-dear-imgui-stack

---


# Upgrade Dear ImGui Stack

Use this skill for repository-local Dear ImGui stack upgrades in `dear-imgui-rs`.

Read `references/workspace-upgrade-checklist.md` before making changes.

## Quick start

1. Confirm the requested upstream targets and whether this is just an integration bump or a release cut.
2. Use primary sources for upstream changes: Dear ImGui release notes / changelog, `cimgui`, `cimplot`, `cimplot3d`, and `imgui_test_engine` commits or changelogs.
3. Prefer the repository scripts for submodule refresh, bindings generation, version bumps, pre-publish checks, and publishing.

## Workflow

1. Define scope.
   - Minimum scope for a Dear ImGui core bump is `dear-imgui-sys` + `dear-imgui-rs`.
   - Common coupled scope also includes `dear-implot-sys`, `dear-implot3d-sys`, and `dear-imgui-test-engine-sys`.
   - If upstream backends or platform callbacks changed, include backend crates, `backend_shim`, and mobile/SDL examples in the audit scope.
   - If the target release is breaking, scan the previous release notes for deprecations promised for removal in this release and remove them now.

2. Refresh submodules and pregenerated bindings.
   - Prefer `tools/update_submodule_and_bindings.py` over manual per-crate binding steps.
   - Regenerate both native pregenerated bindings and WASM pregenerated bindings when ABI or public header shape changes.
   - Keep `imgui_test_engine` in sync when the new Dear ImGui version changes internal hooks or test-engine integration points.

3. Audit the sys layer and safe layer together.
   - Compare upstream release notes and generated binding diffs against current safe wrappers.
   - Look for new functions, enums, flags, struct fields, renamed APIs, callback ABI changes, backend/platform hooks, and new style/spec fields.
   - For Dear ImGui core bumps, re-audit the local stack layout compatibility patch: the `imgui.cpp` `ItemSize()` / `ItemAdd()` hook markers, `dear-imgui-sys/src/stack_layout_shim.cpp`, the `stack_layout_imgui_*.cpp.inc` snippets, native prebuilt manifest feature detection, and the `node_editor_showcase` blueprints layout.
   - Do not stop at raw compatibility. If upstream semantics changed, prefer a coherent safe API refactor over thin shims.
   - When Dear ImGui backends move, audit `dear-imgui-sys::backend_shim`, backend crates, and any examples that expose the changed integration path.

4. Update examples and docs.
   - Add or adjust examples that exercise newly exposed safe APIs, especially for ImPlot / ImPlot3D / test-engine / backend changes.
   - Update `CHANGELOG.md`, compatibility docs, publishing docs, and release notes.
   - For an actual release, convert the top `Unreleased` notes into a dated release entry and add a concise `Highlights` section.

5. Align versions and release metadata.
   - Keep the published workspace on a single release train minor unless there is a strong reason not to.
   - Update `dear-imgui-build-support` and every `*-sys` dependency edge when the workspace release train changes.
   - Refresh workspace and example lockfiles after version changes.
   - Re-check publish order and packaging assumptions whenever a new published helper crate is introduced or repriced.

6. Validate.
   - Run formatting and workspace checks.
   - Run the repository pre-publish checks.
   - Run targeted tests and example checks for the upgraded surface.
   - Dry-run the publish flow before considering the work done.

## Bundled Resources

- `references/workspace-upgrade-checklist.md`
  Use this for the repository-specific upstream map, command recipes, validation matrix, and release/doc checklist.

---
> Source: [Latias94/dear-imgui-rs](https://github.com/Latias94/dear-imgui-rs) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-06-29 -->