sfml.js-imgui 0.0.0-stage → 1.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (270) hide show
  1. package/README.ja.md +113 -0
  2. package/README.ko.md +113 -0
  3. package/README.md +112 -2
  4. package/README.zh-CN.md +113 -0
  5. package/binding.gyp +125 -0
  6. package/dist/callbacks.d.ts +368 -0
  7. package/dist/callbacks.js +310 -0
  8. package/dist/enums/colors.d.ts +779 -0
  9. package/dist/enums/colors.js +766 -0
  10. package/dist/enums/drawing.d.ts +286 -0
  11. package/dist/enums/drawing.js +257 -0
  12. package/dist/enums/input.d.ts +792 -0
  13. package/dist/enums/input.js +731 -0
  14. package/dist/enums/keys.d.ts +1389 -0
  15. package/dist/enums/keys.js +1384 -0
  16. package/dist/enums/selection.d.ts +195 -0
  17. package/dist/enums/selection.js +182 -0
  18. package/dist/enums/style.d.ts +362 -0
  19. package/dist/enums/style.js +349 -0
  20. package/dist/enums/tables.d.ts +681 -0
  21. package/dist/enums/tables.js +644 -0
  22. package/dist/enums/text.d.ts +411 -0
  23. package/dist/enums/text.js +390 -0
  24. package/dist/enums/widgets.d.ts +861 -0
  25. package/dist/enums/widgets.js +800 -0
  26. package/dist/enums/windows.d.ts +487 -0
  27. package/dist/enums/windows.js +458 -0
  28. package/dist/enums.d.ts +10 -0
  29. package/dist/enums.js +26 -0
  30. package/dist/font.d.ts +249 -0
  31. package/dist/font.js +285 -0
  32. package/dist/formatted.d.ts +301 -0
  33. package/dist/formatted.js +342 -0
  34. package/dist/imgui/color.d.ts +493 -0
  35. package/dist/imgui/color.js +532 -0
  36. package/dist/imgui/columns.d.ts +242 -0
  37. package/dist/imgui/columns.js +273 -0
  38. package/dist/imgui/combo.d.ts +322 -0
  39. package/dist/imgui/combo.js +344 -0
  40. package/dist/imgui/context.d.ts +240 -0
  41. package/dist/imgui/context.js +270 -0
  42. package/dist/imgui/debug.d.ts +478 -0
  43. package/dist/imgui/debug.js +526 -0
  44. package/dist/imgui/drag-drop.d.ts +378 -0
  45. package/dist/imgui/drag-drop.js +414 -0
  46. package/dist/imgui/drag.d.ts +1371 -0
  47. package/dist/imgui/drag.js +1447 -0
  48. package/dist/imgui/draw-data.d.ts +139 -0
  49. package/dist/imgui/draw-data.js +154 -0
  50. package/dist/imgui/draw-list-images.d.ts +306 -0
  51. package/dist/imgui/draw-list-images.js +324 -0
  52. package/dist/imgui/draw-list-internals.d.ts +223 -0
  53. package/dist/imgui/draw-list-internals.js +259 -0
  54. package/dist/imgui/draw-list-path.d.ts +451 -0
  55. package/dist/imgui/draw-list-path.js +493 -0
  56. package/dist/imgui/draw-list-primitives.d.ts +297 -0
  57. package/dist/imgui/draw-list-primitives.js +324 -0
  58. package/dist/imgui/draw-list-shapes.d.ts +1258 -0
  59. package/dist/imgui/draw-list-shapes.js +1345 -0
  60. package/dist/imgui/draw-list-state.d.ts +458 -0
  61. package/dist/imgui/draw-list-state.js +515 -0
  62. package/dist/imgui/draw-list-text.d.ts +367 -0
  63. package/dist/imgui/draw-list-text.js +247 -0
  64. package/dist/imgui/drawing.d.ts +151 -0
  65. package/dist/imgui/drawing.js +169 -0
  66. package/dist/imgui/font-atlas.d.ts +726 -0
  67. package/dist/imgui/font-atlas.js +777 -0
  68. package/dist/imgui/font-glyph-ranges.d.ts +260 -0
  69. package/dist/imgui/font-glyph-ranges.js +230 -0
  70. package/dist/imgui/fonts.d.ts +114 -0
  71. package/dist/imgui/fonts.js +132 -0
  72. package/dist/imgui/id-stack.d.ts +363 -0
  73. package/dist/imgui/id-stack.js +309 -0
  74. package/dist/imgui/images.d.ts +310 -0
  75. package/dist/imgui/images.js +331 -0
  76. package/dist/imgui/index.d.ts +57 -0
  77. package/dist/imgui/index.js +73 -0
  78. package/dist/imgui/input-text-callback.d.ts +176 -0
  79. package/dist/imgui/input-text-callback.js +144 -0
  80. package/dist/imgui/inputs.d.ts +1086 -0
  81. package/dist/imgui/inputs.js +1159 -0
  82. package/dist/imgui/io.d.ts +546 -0
  83. package/dist/imgui/io.js +600 -0
  84. package/dist/imgui/item-state.d.ts +766 -0
  85. package/dist/imgui/item-state.js +850 -0
  86. package/dist/imgui/keyboard.d.ts +547 -0
  87. package/dist/imgui/keyboard.js +584 -0
  88. package/dist/imgui/layout.d.ts +927 -0
  89. package/dist/imgui/layout.js +1029 -0
  90. package/dist/imgui/legacy.d.ts +413 -0
  91. package/dist/imgui/legacy.js +461 -0
  92. package/dist/imgui/list-clipper.d.ts +282 -0
  93. package/dist/imgui/list-clipper.js +309 -0
  94. package/dist/imgui/logging.d.ts +113 -0
  95. package/dist/imgui/logging.js +135 -0
  96. package/dist/imgui/memory.d.ts +35 -0
  97. package/dist/imgui/memory.js +45 -0
  98. package/dist/imgui/menus.d.ts +373 -0
  99. package/dist/imgui/menus.js +407 -0
  100. package/dist/imgui/mouse.d.ts +740 -0
  101. package/dist/imgui/mouse.js +803 -0
  102. package/dist/imgui/plots.d.ts +252 -0
  103. package/dist/imgui/plots.js +267 -0
  104. package/dist/imgui/popups.d.ts +711 -0
  105. package/dist/imgui/popups.js +757 -0
  106. package/dist/imgui/scrolling.d.ts +341 -0
  107. package/dist/imgui/scrolling.js +375 -0
  108. package/dist/imgui/selection.d.ts +785 -0
  109. package/dist/imgui/selection.js +845 -0
  110. package/dist/imgui/settings.d.ts +194 -0
  111. package/dist/imgui/settings.js +216 -0
  112. package/dist/imgui/sliders.d.ts +1664 -0
  113. package/dist/imgui/sliders.js +1751 -0
  114. package/dist/imgui/storage.d.ts +344 -0
  115. package/dist/imgui/storage.js +386 -0
  116. package/dist/imgui/style.d.ts +680 -0
  117. package/dist/imgui/style.js +770 -0
  118. package/dist/imgui/tables.d.ts +762 -0
  119. package/dist/imgui/tables.js +831 -0
  120. package/dist/imgui/tabs.d.ts +228 -0
  121. package/dist/imgui/tabs.js +250 -0
  122. package/dist/imgui/text-buffer.d.ts +251 -0
  123. package/dist/imgui/text-buffer.js +239 -0
  124. package/dist/imgui/text-filter.d.ts +181 -0
  125. package/dist/imgui/text-filter.js +151 -0
  126. package/dist/imgui/text.d.ts +506 -0
  127. package/dist/imgui/text.js +425 -0
  128. package/dist/imgui/tooltips.d.ts +202 -0
  129. package/dist/imgui/tooltips.js +221 -0
  130. package/dist/imgui/trees.d.ts +516 -0
  131. package/dist/imgui/trees.js +562 -0
  132. package/dist/imgui/viewport.d.ts +93 -0
  133. package/dist/imgui/viewport.js +105 -0
  134. package/dist/imgui/widgets.d.ts +524 -0
  135. package/dist/imgui/widgets.js +572 -0
  136. package/dist/imgui/windows.d.ts +1210 -0
  137. package/dist/imgui/windows.js +1309 -0
  138. package/dist/index.d.ts +4 -0
  139. package/dist/index.js +19 -0
  140. package/dist/internal/imgui-binding.d.ts +40 -0
  141. package/dist/internal/imgui-binding.js +2 -0
  142. package/dist/internal/native.d.ts +67 -0
  143. package/dist/internal/native.js +7 -0
  144. package/dist/internal/sfml-interop.d.ts +45 -0
  145. package/dist/internal/sfml-interop.js +102 -0
  146. package/dist/references.d.ts +393 -0
  147. package/dist/references.js +372 -0
  148. package/dist/sfml.d.ts +223 -0
  149. package/dist/sfml.js +320 -0
  150. package/dist/struct-views.d.ts +3056 -0
  151. package/dist/struct-views.js +418 -0
  152. package/dist/types.d.ts +508 -0
  153. package/dist/types.js +2 -0
  154. package/native/addon.cc +68 -0
  155. package/native/cimgui.h +12 -0
  156. package/native/imgui-args.h +492 -0
  157. package/native/imgui-bindings.h +35 -0
  158. package/native/imgui-callbacks.cc +376 -0
  159. package/native/imgui-context.cc +117 -0
  160. package/native/imgui-debug.cc +171 -0
  161. package/native/imgui-drag-drop.cc +120 -0
  162. package/native/imgui-drag-widgets.cc +473 -0
  163. package/native/imgui-draw-callbacks.cc +210 -0
  164. package/native/imgui-draw-callbacks.h +25 -0
  165. package/native/imgui-draw-paths.cc +413 -0
  166. package/native/imgui-draw-primitives.cc +317 -0
  167. package/native/imgui-drawing.cc +963 -0
  168. package/native/imgui-font-ranges.cc +73 -0
  169. package/native/imgui-font.cc +488 -0
  170. package/native/imgui-formatted.cc +388 -0
  171. package/native/imgui-frame.cc +56 -0
  172. package/native/imgui-glyph-fields.cc +87 -0
  173. package/native/imgui-glyph-fields.h +12 -0
  174. package/native/imgui-input-widgets.cc +447 -0
  175. package/native/imgui-input.cc +277 -0
  176. package/native/imgui-integration.cc +442 -0
  177. package/native/imgui-io.cc +255 -0
  178. package/native/imgui-items.cc +290 -0
  179. package/native/imgui-layout.cc +349 -0
  180. package/native/imgui-popups.cc +331 -0
  181. package/native/imgui-references.cc +230 -0
  182. package/native/imgui-selection.cc +394 -0
  183. package/native/imgui-slider-widgets.cc +550 -0
  184. package/native/imgui-storage.cc +177 -0
  185. package/native/imgui-struct-views.cc +626 -0
  186. package/native/imgui-style.cc +283 -0
  187. package/native/imgui-tables.cc +267 -0
  188. package/native/imgui-text.cc +291 -0
  189. package/native/imgui-utilities.cc +127 -0
  190. package/native/imgui-values.cc +66 -0
  191. package/native/imgui-widgets.cc +570 -0
  192. package/native/imgui-windows.cc +436 -0
  193. package/native/interop.h +19 -0
  194. package/package.json +72 -3
  195. package/src/callbacks.ts +447 -0
  196. package/src/enums/colors.ts +782 -0
  197. package/src/enums/drawing.ts +293 -0
  198. package/src/enums/input.ts +807 -0
  199. package/src/enums/keys.ts +1390 -0
  200. package/src/enums/selection.ts +198 -0
  201. package/src/enums/style.ts +365 -0
  202. package/src/enums/tables.ts +690 -0
  203. package/src/enums/text.ts +416 -0
  204. package/src/enums/widgets.ts +876 -0
  205. package/src/enums/windows.ts +494 -0
  206. package/src/enums.ts +10 -0
  207. package/src/font.ts +287 -0
  208. package/src/formatted.ts +386 -0
  209. package/src/imgui/color.ts +575 -0
  210. package/src/imgui/columns.ts +274 -0
  211. package/src/imgui/combo.ts +376 -0
  212. package/src/imgui/context.ts +268 -0
  213. package/src/imgui/debug.ts +542 -0
  214. package/src/imgui/drag-drop.ts +423 -0
  215. package/src/imgui/drag.ts +1615 -0
  216. package/src/imgui/draw-data.ts +158 -0
  217. package/src/imgui/draw-list-images.ts +394 -0
  218. package/src/imgui/draw-list-internals.ts +291 -0
  219. package/src/imgui/draw-list-path.ts +568 -0
  220. package/src/imgui/draw-list-primitives.ts +363 -0
  221. package/src/imgui/draw-list-shapes.ts +1593 -0
  222. package/src/imgui/draw-list-state.ts +551 -0
  223. package/src/imgui/draw-list-text.ts +594 -0
  224. package/src/imgui/drawing.ts +170 -0
  225. package/src/imgui/font-atlas.ts +862 -0
  226. package/src/imgui/font-glyph-ranges.ts +357 -0
  227. package/src/imgui/fonts.ts +133 -0
  228. package/src/imgui/id-stack.ts +496 -0
  229. package/src/imgui/images.ts +364 -0
  230. package/src/imgui/index.ts +57 -0
  231. package/src/imgui/input-text-callback.ts +268 -0
  232. package/src/imgui/inputs.ts +1292 -0
  233. package/src/imgui/io.ts +638 -0
  234. package/src/imgui/item-state.ts +856 -0
  235. package/src/imgui/keyboard.ts +590 -0
  236. package/src/imgui/layout.ts +1030 -0
  237. package/src/imgui/legacy.ts +477 -0
  238. package/src/imgui/list-clipper.ts +329 -0
  239. package/src/imgui/logging.ts +135 -0
  240. package/src/imgui/memory.ts +42 -0
  241. package/src/imgui/menus.ts +417 -0
  242. package/src/imgui/mouse.ts +824 -0
  243. package/src/imgui/plots.ts +313 -0
  244. package/src/imgui/popups.ts +779 -0
  245. package/src/imgui/scrolling.ts +378 -0
  246. package/src/imgui/selection.ts +904 -0
  247. package/src/imgui/settings.ts +220 -0
  248. package/src/imgui/sliders.ts +1969 -0
  249. package/src/imgui/storage.ts +415 -0
  250. package/src/imgui/style.ts +781 -0
  251. package/src/imgui/tables.ts +854 -0
  252. package/src/imgui/tabs.ts +259 -0
  253. package/src/imgui/text-buffer.ts +337 -0
  254. package/src/imgui/text-filter.ts +262 -0
  255. package/src/imgui/text.ts +688 -0
  256. package/src/imgui/tooltips.ts +218 -0
  257. package/src/imgui/trees.ts +583 -0
  258. package/src/imgui/viewport.ts +103 -0
  259. package/src/imgui/widgets.ts +599 -0
  260. package/src/imgui/windows.ts +1350 -0
  261. package/src/index.ts +21 -0
  262. package/src/internal/imgui-binding.ts +142 -0
  263. package/src/internal/native.ts +163 -0
  264. package/src/internal/sfml-interop.ts +171 -0
  265. package/src/references.ts +464 -0
  266. package/src/sfml.ts +412 -0
  267. package/src/struct-views.ts +3194 -0
  268. package/src/types.ts +539 -0
  269. package/tools/deps_downloader.cjs +213 -0
  270. package/tsconfig.json +15 -0
package/README.ja.md ADDED
@@ -0,0 +1,113 @@
1
+ # sfml.js-imgui
2
+
3
+ [![npm version](https://img.shields.io/npm/v/sfml.js-imgui.svg?style=for-the-badge&colorA=FF69b4&colorB=cc47a4&label=sfml.js-imgui)](https://www.npmjs.org/package/sfml.js-imgui)
4
+
5
+ [English](README.md) · [简体中文](README.zh-CN.md) · **日本語** · [한국어](README.ko.md)
6
+
7
+ [sfml.js](../sfml.js) のための [Dear ImGui](https://github.com/ocornut/imgui) 1.91.9b 連携。[imgui-sfml](https://github.com/SFML/imgui-sfml) 3.0 に沿っています。JavaScript または TypeScript で、SFML ウィンドウ内にデバッグパネル、シーンインスペクター、ネイティブ編集コントロールを構築できます。
8
+
9
+ [クイックスタート](../../docs/imgui/getting-started.ja.md) · [サンプル](examples/README.ja.md) · [API リファレンス](https://sfml.js.org/ja/reference/imgui/) · [sfml.js](../sfml.js/README.ja.md)
10
+
11
+ ## 機能
12
+
13
+ - Dear ImGui のフルウィジェットセット:ボタン、スライダー、カラー編集、テキスト入力、テーブル、メニュー、モーダル、プロット
14
+ - 型付き配列がネイティブのスカラーパラメーターに直接マップされる永続編集状態
15
+ - CJK カバレッジとカスタム TTF フォントに対応するフォントアトラス制御
16
+ - カスタム描画リスト、ウィンドウごとに独立した ImGui コンテキストとリソース所有権
17
+ - すべてのエクスポート関数、列挙値、ライブ構造体ビューの TypeScript 宣言
18
+
19
+ `ImGui` はウィジェット、列挙値、コールバックラッパー、ネイティブハンドル操作を提供します。`SFML` はウィンドウ連携、イベント転送、フレーム送信を担当します。
20
+
21
+ ## インストール
22
+
23
+ `sfml.js-imgui` は `sfml.js` のピア依存パッケージです。両方を一緒にインストールしてください。
24
+
25
+ ```sh
26
+ npm install sfml.js sfml.js-imgui
27
+ ```
28
+
29
+ sfml.js と同様にインストール時にネイティブアドオンをコンパイルするため、Python、C++20 ツールチェーン、ディスプレイ、OpenGL が必要です。Node.js `^18.19.0 || >=20.5.0` に対応しています。[プラットフォーム要件](../../docs/sfml/getting-started.ja.md#requirements)を参照してください。
30
+
31
+ ## カウンターの例
32
+
33
+ ```javascript
34
+ const sf = require('sfml.js');
35
+ const { ImGui, SFML } = require('sfml.js-imgui');
36
+
37
+ const window = new sf.RenderWindow(
38
+ new sf.VideoMode(new sf.Vector2u(800, 600)),
39
+ 'ImGui counter',
40
+ );
41
+ window.setFramerateLimit(60);
42
+ const clock = new sf.Clock();
43
+ let clicks = 0;
44
+
45
+ SFML.Init(window);
46
+ try {
47
+ while (window.isOpen()) {
48
+ let event;
49
+ while ((event = window.pollEvent()) !== undefined) {
50
+ SFML.ProcessEvent(window, event);
51
+ if (event.is('Closed')) window.close();
52
+ }
53
+
54
+ SFML.Update(window, clock.restart().asSeconds());
55
+ if (ImGui.Begin('Controls')) {
56
+ if (ImGui.Button('Count')) clicks++;
57
+ ImGui.TextUnformatted(`Clicks: ${clicks}`);
58
+ }
59
+ ImGui.End();
60
+
61
+ window.clear(sf.Color.Black);
62
+ SFML.Render(window);
63
+ window.display();
64
+ }
65
+ } finally {
66
+ SFML.Shutdown(window);
67
+ window.close();
68
+ }
69
+ ```
70
+
71
+ ## フレームのライフサイクル
72
+
73
+ | 段階 | 呼び出し | 役割 |
74
+ | --- | --- | --- |
75
+ | 入力収集 | `pollEvent` → `SFML.ProcessEvent` | テキスト、フォーカス、終了イベントを含むすべてのイベントを転送します。 |
76
+ | フレーム開始 | `SFML.Update(window, seconds)` | 入力とタイミングを更新し、ImGui フレームを開始します。 |
77
+ | コントロール宣言 | ウィジェット呼び出し | アプリ状態を読み書きします。すべての `Begin` に `End` を対にします。 |
78
+ | UI 描画 | `SFML.Render(window)` | 記録済み SFML 描画を送信し、ImGui を描画します。 |
79
+ | 表示 | `window.display()` | 完成したフレームを表示します。 |
80
+ | 終了 | `SFML.Shutdown(window)` | 生存中のネイティブウィンドウを閉じる前に ImGui を解放します。 |
81
+
82
+ 時間はミリ秒ではなく**秒**で渡し、シーン入力の制御には `SFML.GetIO().wantCaptureMouse` / `wantCaptureKeyboard` を使います。`ImGui.NewFrame()` や `ImGui.Render()` を自分で呼ばないでください。バックエンドが管理します。
83
+
84
+ ## サンプル
85
+
86
+ ![Dear ImGui ウィジェットデモのウィンドウ](examples/screenshots/demo.png)
87
+
88
+ [`examples`](examples/README.ja.md) には実行可能なサンプルが 3 つあります。Dear ImGui のウィジェットデモ、パネルから SFML の円を操作するシーンインスペクター、テキスト入力・テーブル・モーダル・プロットを組み合わせる workbench です。
89
+
90
+ ```sh
91
+ # monorepo のルートで node tools/bootstrap.cjs を実行した後
92
+ node packages/sfml.js-imgui/examples/demo.cjs
93
+ node packages/sfml.js-imgui/examples/scene-inspector.cjs
94
+ node packages/sfml.js-imgui/examples/workbench.cjs
95
+ ```
96
+
97
+ ## ドキュメント
98
+
99
+ ImGui ガイドは英語、簡体字中国語、日本語、韓国語で提供しています。
100
+
101
+ | 章 | 内容 |
102
+ | --- | --- |
103
+ | [クイックスタート](../../docs/imgui/getting-started.ja.md) | 完全なカウンター、フレーム、入力キャプチャ、安全な終了 |
104
+ | [ウィジェットと状態](../../docs/imgui/widgets.ja.md) | 永続状態、固有 ID、リアルタイムのシーン編集 |
105
+ | [レイアウト](../../docs/imgui/layout.ja.md) | テーブル、メニュー、確認モーダル、スコープの対応 |
106
+ | [入力とコールバック](../../docs/imgui/callbacks.ja.md) | UTF-8 編集、契約、リスト getter、プロット |
107
+ | [フォントとスタイル](../../docs/imgui/fonts.ja.md) | アトラス、CJK、間隔、色、DPI |
108
+ | [描画と複数ウィンドウ](../../docs/imgui/rendering.ja.md) | シーン合成、描画リスト、ウィンドウ別の所有権 |
109
+ | [API ガイド](../../docs/imgui/api.ja.md) | シグネチャ、オーバーロード、寿命の確認 |
110
+
111
+ ## ライセンス
112
+
113
+ [MIT](../sfml.js/LICENSE)。
package/README.ko.md ADDED
@@ -0,0 +1,113 @@
1
+ # sfml.js-imgui
2
+
3
+ [![npm version](https://img.shields.io/npm/v/sfml.js-imgui.svg?style=for-the-badge&colorA=FF69b4&colorB=cc47a4&label=sfml.js-imgui)](https://www.npmjs.org/package/sfml.js-imgui)
4
+
5
+ [English](README.md) · [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · **한국어**
6
+
7
+ [sfml.js](../sfml.js)를 위한 [Dear ImGui](https://github.com/ocornut/imgui) 1.91.9b 연동. [imgui-sfml](https://github.com/SFML/imgui-sfml) 3.0을 따릅니다. JavaScript 또는 TypeScript로 SFML 창 안에 디버그 패널, 장면 검사기, 네이티브 편집 컨트롤을 만듭니다.
8
+
9
+ [빠른 시작](../../docs/imgui/getting-started.ko.md) · [예제](examples/README.ko.md) · [API 레퍼런스](https://sfml.js.org/ko/reference/imgui/) · [sfml.js](../sfml.js/README.ko.md)
10
+
11
+ ## 기능
12
+
13
+ - 버튼, 슬라이더, 색 편집, 텍스트 입력, 테이블, 메뉴, 모달, 그래프 등 Dear ImGui 전체 위젯
14
+ - 타입 배열이 네이티브 스칼라 매개변수에 직접 매핑되는 지속 편집 상태
15
+ - CJK 지원과 사용자 정의 TTF 폰트를 포함하는 폰트 아틀라스 제어
16
+ - 사용자 지정 그리기 목록, 창별 ImGui 컨텍스트와 분리된 리소스 소유권
17
+ - 모든 export 함수, 열거 값, 실시간 구조체 뷰의 TypeScript 선언
18
+
19
+ `ImGui`는 위젯, 열거 값, 콜백 래퍼, 네이티브 핸들 연산을 제공합니다. `SFML`은 창 연동, 이벤트 전달, 프레임 제출을 맡습니다.
20
+
21
+ ## 설치
22
+
23
+ `sfml.js-imgui`는 `sfml.js`의 피어 의존성입니다. 두 패키지를 함께 설치하세요.
24
+
25
+ ```sh
26
+ npm install sfml.js sfml.js-imgui
27
+ ```
28
+
29
+ sfml.js와 마찬가지로 설치 시 네이티브 애드온을 컴파일하므로 Python, C++20 도구 모음, 디스플레이, OpenGL이 필요합니다. Node.js `^18.19.0 || >=20.5.0`을 지원합니다. [플랫폼 요구 사항](../../docs/sfml/getting-started.ko.md#requirements)을 참고하세요.
30
+
31
+ ## 카운터 예제
32
+
33
+ ```javascript
34
+ const sf = require('sfml.js');
35
+ const { ImGui, SFML } = require('sfml.js-imgui');
36
+
37
+ const window = new sf.RenderWindow(
38
+ new sf.VideoMode(new sf.Vector2u(800, 600)),
39
+ 'ImGui counter',
40
+ );
41
+ window.setFramerateLimit(60);
42
+ const clock = new sf.Clock();
43
+ let clicks = 0;
44
+
45
+ SFML.Init(window);
46
+ try {
47
+ while (window.isOpen()) {
48
+ let event;
49
+ while ((event = window.pollEvent()) !== undefined) {
50
+ SFML.ProcessEvent(window, event);
51
+ if (event.is('Closed')) window.close();
52
+ }
53
+
54
+ SFML.Update(window, clock.restart().asSeconds());
55
+ if (ImGui.Begin('Controls')) {
56
+ if (ImGui.Button('Count')) clicks++;
57
+ ImGui.TextUnformatted(`Clicks: ${clicks}`);
58
+ }
59
+ ImGui.End();
60
+
61
+ window.clear(sf.Color.Black);
62
+ SFML.Render(window);
63
+ window.display();
64
+ }
65
+ } finally {
66
+ SFML.Shutdown(window);
67
+ window.close();
68
+ }
69
+ ```
70
+
71
+ ## 프레임 수명
72
+
73
+ | 단계 | 호출 | 책임 |
74
+ | --- | --- | --- |
75
+ | 입력 수집 | `pollEvent` → `SFML.ProcessEvent` | 텍스트, 포커스, 종료 이벤트를 포함한 모든 이벤트를 전달합니다. |
76
+ | 프레임 시작 | `SFML.Update(window, seconds)` | 입력과 타이밍을 갱신하고 ImGui 프레임을 시작합니다. |
77
+ | 컨트롤 선언 | 위젯 호출 | 앱 상태를 읽고 갱신합니다. 모든 `Begin`에는 `End`를 짝지으세요. |
78
+ | UI 그리기 | `SFML.Render(window)` | 기록된 SFML 그리기를 내보내고 ImGui를 렌더링합니다. |
79
+ | 표시 | `window.display()` | 완성된 프레임을 표시합니다. |
80
+ | 종료 | `SFML.Shutdown(window)` | 살아 있는 네이티브 창을 닫기 전에 ImGui를 해제합니다. |
81
+
82
+ 시간은 밀리초가 아니라 경과한**초**를 사용하고, 장면 입력 제한에는 `SFML.GetIO().wantCaptureMouse` / `wantCaptureKeyboard`를 사용하세요. `ImGui.NewFrame()`이나 `ImGui.Render()`을 직접 호출하지 마세요. 백엔드가 관리합니다.
83
+
84
+ ## 예제
85
+
86
+ ![Dear ImGui 위젯 데모 창](examples/screenshots/demo.png)
87
+
88
+ [`examples`](examples/README.ko.md)에는 실행 가능한 예제 3개가 있습니다. Dear ImGui 위젯 데모, 패널로 SFML 원을 조종하는 장면 검사기, 텍스트 입력·테이블·모달·그래프를 조합한 워크벤치입니다.
89
+
90
+ ```sh
91
+ # 모노레포 루트에서 node tools/bootstrap.cjs 실행 후
92
+ node packages/sfml.js-imgui/examples/demo.cjs
93
+ node packages/sfml.js-imgui/examples/scene-inspector.cjs
94
+ node packages/sfml.js-imgui/examples/workbench.cjs
95
+ ```
96
+
97
+ ## 문서
98
+
99
+ ImGui 가이드는 영어, 간체 중국어, 일본어, 한국어로 제공됩니다.
100
+
101
+ | 장 | 내용 |
102
+ | --- | --- |
103
+ | [빠른 시작](../../docs/imgui/getting-started.ko.md) | 완전한 카운터, 프레임 수명, 입력 캡처, 안전한 종료 |
104
+ | [위젯과 상태](../../docs/imgui/widgets.ko.md) | 지속 상태, 고유 ID, 실시간 장면 검사기 |
105
+ | [레이아웃](../../docs/imgui/layout.ko.md) | 테이블, 메뉴, 확인 모달, 범위 짝 |
106
+ | [텍스트와 콜백](../../docs/imgui/callbacks.ko.md) | UTF-8 편집, 계약, 목록 getter, 그래프 |
107
+ | [폰트와 스타일](../../docs/imgui/fonts.ko.md) | 아틀라스, CJK, 간격, 색, DPI |
108
+ | [렌더링과 여러 창](../../docs/imgui/rendering.ko.md) | 장면 합성, 그리기 목록, 창별 소유권 |
109
+ | [API 가이드](../../docs/imgui/api.ko.md) | 시그니처, 오버로드, 수명 확인 |
110
+
111
+ ## 라이선스
112
+
113
+ [MIT](../sfml.js/LICENSE).
package/README.md CHANGED
@@ -1,3 +1,113 @@
1
- # Temporary Holding Version
1
+ # sfml.js-imgui
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ [![npm version](https://img.shields.io/npm/v/sfml.js-imgui.svg?style=for-the-badge&colorA=FF69b4&colorB=cc47a4&label=sfml.js-imgui)](https://www.npmjs.org/package/sfml.js-imgui)
4
+
5
+ **English** · [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [한국어](README.ko.md)
6
+
7
+ [Dear ImGui](https://github.com/ocornut/imgui) 1.91.9b integration for [sfml.js](../sfml.js), following [imgui-sfml](https://github.com/SFML/imgui-sfml) 3.0. Build debug panels, scene inspectors and native editor controls inside an SFML window, in JavaScript or TypeScript.
8
+
9
+ [Quick start](../../docs/imgui/getting-started.md) · [Examples](examples/README.md) · [API reference](https://sfml.js.org/reference/imgui/) · [sfml.js](../sfml.js/README.md)
10
+
11
+ ## Features
12
+
13
+ - The full Dear ImGui widget set: buttons, sliders, color editors, text input, tables, menus, modals and plots
14
+ - Persistent edit state with typed arrays mapped directly to native scalar parameters
15
+ - Font atlas control including CJK coverage and custom TTF fonts
16
+ - Custom draw lists and per-window ImGui contexts with separate resource ownership
17
+ - TypeScript declarations for every exported function, enum and live struct view
18
+
19
+ `ImGui` exports widgets, enums, callback wrappers and native handle operations. `SFML` handles window integration, event forwarding and frame submission.
20
+
21
+ ## Installation
22
+
23
+ `sfml.js-imgui` is a peer of `sfml.js`; install both packages together:
24
+
25
+ ```sh
26
+ npm install sfml.js sfml.js-imgui
27
+ ```
28
+
29
+ Like sfml.js, installation compiles a native addon and requires Python, a C++20 toolchain, a display and OpenGL. Node.js `^18.19.0 || >=20.5.0` is supported. See the [platform requirements](../../docs/sfml/getting-started.md#requirements).
30
+
31
+ ## Counter example
32
+
33
+ ```javascript
34
+ const sf = require('sfml.js');
35
+ const { ImGui, SFML } = require('sfml.js-imgui');
36
+
37
+ const window = new sf.RenderWindow(
38
+ new sf.VideoMode(new sf.Vector2u(800, 600)),
39
+ 'ImGui counter',
40
+ );
41
+ window.setFramerateLimit(60);
42
+ const clock = new sf.Clock();
43
+ let clicks = 0;
44
+
45
+ SFML.Init(window);
46
+ try {
47
+ while (window.isOpen()) {
48
+ let event;
49
+ while ((event = window.pollEvent()) !== undefined) {
50
+ SFML.ProcessEvent(window, event);
51
+ if (event.is('Closed')) window.close();
52
+ }
53
+
54
+ SFML.Update(window, clock.restart().asSeconds());
55
+ if (ImGui.Begin('Controls')) {
56
+ if (ImGui.Button('Count')) clicks++;
57
+ ImGui.TextUnformatted(`Clicks: ${clicks}`);
58
+ }
59
+ ImGui.End();
60
+
61
+ window.clear(sf.Color.Black);
62
+ SFML.Render(window);
63
+ window.display();
64
+ }
65
+ } finally {
66
+ SFML.Shutdown(window);
67
+ window.close();
68
+ }
69
+ ```
70
+
71
+ ## Frame lifecycle
72
+
73
+ | Stage | Call | Responsibility |
74
+ | --- | --- | --- |
75
+ | Collect input | `pollEvent` → `SFML.ProcessEvent` | Forward every event, including text, focus and close events. |
76
+ | Start a frame | `SFML.Update(window, seconds)` | Update input and timing, then start the ImGui frame. |
77
+ | Declare controls | widget calls | Read and update application state; pair every `Begin` with `End`. |
78
+ | Draw the UI | `SFML.Render(window)` | Flush recorded SFML drawing and render ImGui. |
79
+ | Present | `window.display()` | Display the completed frame. |
80
+ | Exit | `SFML.Shutdown(window)` | Release ImGui before closing the still-live native window. |
81
+
82
+ Use elapsed **seconds**, not milliseconds, and gate scene input with `SFML.GetIO().wantCaptureMouse` / `wantCaptureKeyboard`. Do not call `ImGui.NewFrame()` or `ImGui.Render()` yourself; the backend manages them.
83
+
84
+ ## Examples
85
+
86
+ ![Dear ImGui demo window](examples/screenshots/demo.png)
87
+
88
+ Three runnable examples are bundled in [`examples`](examples/README.md): the Dear ImGui widget demo, a scene inspector that drives an SFML circle from a panel, and a workbench combining text input, tables, modals and plots.
89
+
90
+ ```sh
91
+ # From the monorepo root after running node tools/bootstrap.cjs
92
+ node packages/sfml.js-imgui/examples/demo.cjs
93
+ node packages/sfml.js-imgui/examples/scene-inspector.cjs
94
+ node packages/sfml.js-imgui/examples/workbench.cjs
95
+ ```
96
+
97
+ ## Documentation
98
+
99
+ The ImGui guides ship in English, Simplified Chinese, Japanese and Korean:
100
+
101
+ | Chapter | Content |
102
+ | --- | --- |
103
+ | [Quick start](../../docs/imgui/getting-started.md) | Complete counter, frame lifecycle, input capture and safe shutdown |
104
+ | [Widgets and state](../../docs/imgui/widgets.md) | Persistent edit state, unique IDs and the live scene inspector |
105
+ | [Layout](../../docs/imgui/layout.md) | Tables, menus, confirmation modals and scope pairing |
106
+ | [Input and callbacks](../../docs/imgui/callbacks.md) | UTF-8 editing, callback contracts, lists and plots |
107
+ | [Fonts and styles](../../docs/imgui/fonts.md) | Font atlas, CJK coverage, spacing, colors and DPI |
108
+ | [Rendering and windows](../../docs/imgui/rendering.md) | Scene composition, draw lists and per-window ownership |
109
+ | [API guide](../../docs/imgui/api.md) | Signatures, overloads and lifetime constraints |
110
+
111
+ ## License
112
+
113
+ [MIT](../sfml.js/LICENSE).
@@ -0,0 +1,113 @@
1
+ # sfml.js-imgui
2
+
3
+ [![npm version](https://img.shields.io/npm/v/sfml.js-imgui.svg?style=for-the-badge&colorA=FF69b4&colorB=cc47a4&label=sfml.js-imgui)](https://www.npmjs.org/package/sfml.js-imgui)
4
+
5
+ [English](README.md) · **简体中文** · [日本語](README.ja.md) · [한국어](README.ko.md)
6
+
7
+ 面向 [sfml.js](../sfml.js) 的 [Dear ImGui](https://github.com/ocornut/imgui) 1.91.9b 集成,遵循 [imgui-sfml](https://github.com/SFML/imgui-sfml) 3.0。使用 JavaScript 或 TypeScript 在 SFML 窗口中构建调试面板、场景检查器和原生编辑器控件。
8
+
9
+ [快速开始](../../docs/imgui/getting-started.zh-CN.md) · [示例](examples/README.zh-CN.md) · [API 参考](https://sfml.js.org/zh/reference/imgui/) · [sfml.js](../sfml.js/README.zh-CN.md)
10
+
11
+ ## 功能
12
+
13
+ - 完整的 Dear ImGui 控件集:按钮、滑块、颜色编辑、文本输入、表格、菜单、模态弹窗和曲线
14
+ - 持久编辑状态通过类型化数组直接映射原生标量参数
15
+ - 字体图集控制,包括 CJK 覆盖和自定义 TTF 字体
16
+ - 自定义绘制列表,以及按窗口划分的 ImGui 上下文和独立资源所有权
17
+ - 所有导出函数、枚举和实时结构体视图都有 TypeScript 声明
18
+
19
+ `ImGui` 导出控件、枚举、回调包装和原生句柄操作;`SFML` 负责窗口集成、事件转发和帧提交。
20
+
21
+ ## 安装
22
+
23
+ `sfml.js-imgui` 是 `sfml.js` 的对等依赖,请同时安装两个软件包:
24
+
25
+ ```sh
26
+ npm install sfml.js sfml.js-imgui
27
+ ```
28
+
29
+ 与 sfml.js 一样,安装时会编译原生扩展,需要 Python、C++20 工具链、显示器和 OpenGL。支持 Node.js `^18.19.0 || >=20.5.0`。见 [平台要求](../../docs/sfml/getting-started.zh-CN.md#requirements)。
30
+
31
+ ## 计数器示例
32
+
33
+ ```javascript
34
+ const sf = require('sfml.js');
35
+ const { ImGui, SFML } = require('sfml.js-imgui');
36
+
37
+ const window = new sf.RenderWindow(
38
+ new sf.VideoMode(new sf.Vector2u(800, 600)),
39
+ 'ImGui counter',
40
+ );
41
+ window.setFramerateLimit(60);
42
+ const clock = new sf.Clock();
43
+ let clicks = 0;
44
+
45
+ SFML.Init(window);
46
+ try {
47
+ while (window.isOpen()) {
48
+ let event;
49
+ while ((event = window.pollEvent()) !== undefined) {
50
+ SFML.ProcessEvent(window, event);
51
+ if (event.is('Closed')) window.close();
52
+ }
53
+
54
+ SFML.Update(window, clock.restart().asSeconds());
55
+ if (ImGui.Begin('Controls')) {
56
+ if (ImGui.Button('Count')) clicks++;
57
+ ImGui.TextUnformatted(`Clicks: ${clicks}`);
58
+ }
59
+ ImGui.End();
60
+
61
+ window.clear(sf.Color.Black);
62
+ SFML.Render(window);
63
+ window.display();
64
+ }
65
+ } finally {
66
+ SFML.Shutdown(window);
67
+ window.close();
68
+ }
69
+ ```
70
+
71
+ ## 帧生命周期
72
+
73
+ | 阶段 | 调用 | 职责 |
74
+ | --- | --- | --- |
75
+ | 收集输入 | `pollEvent` → `SFML.ProcessEvent` | 转发所有事件,包括文本、焦点和关闭事件。 |
76
+ | 开始一帧 | `SFML.Update(window, seconds)` | 更新输入与计时,然后开始 ImGui 帧。 |
77
+ | 声明控件 | 控件调用 | 读取并更新应用状态;每个 `Begin` 都要配对 `End`。 |
78
+ | 绘制界面 | `SFML.Render(window)` | 提交已录制的 SFML 绘制并渲染 ImGui。 |
79
+ | 呈现 | `window.display()` | 显示完成的帧。 |
80
+ | 退出 | `SFML.Shutdown(window)` | 在关闭仍然存活的原生窗口前释放 ImGui。 |
81
+
82
+ 时间单位使用经过的**秒**而不是毫秒,并用 `SFML.GetIO().wantCaptureMouse` / `wantCaptureKeyboard` 控制场景输入。不要自行调用 `ImGui.NewFrame()` 或 `ImGui.Render()`,后端已经负责这些操作。
83
+
84
+ ## 示例
85
+
86
+ ![Dear ImGui 控件演示窗口](examples/screenshots/demo.png)
87
+
88
+ [`examples`](examples/README.zh-CN.md) 中包含三个可运行示例:Dear ImGui 控件演示、用面板驱动 SFML 圆形的场景检查器,以及组合文本输入、表格、模态弹窗和曲线的工作台。
89
+
90
+ ```sh
91
+ # 在 monorepo 根目录执行 node tools/bootstrap.cjs 之后
92
+ node packages/sfml.js-imgui/examples/demo.cjs
93
+ node packages/sfml.js-imgui/examples/scene-inspector.cjs
94
+ node packages/sfml.js-imgui/examples/workbench.cjs
95
+ ```
96
+
97
+ ## 文档
98
+
99
+ ImGui 指南提供英文、简体中文、日文和韩文版本:
100
+
101
+ | 章节 | 内容 |
102
+ | --- | --- |
103
+ | [快速开始](../../docs/imgui/getting-started.zh-CN.md) | 完整计数器、帧生命周期、输入捕获与安全退出 |
104
+ | [控件与状态](../../docs/imgui/widgets.zh-CN.md) | 持久编辑状态、唯一 ID 和实时场景检查器 |
105
+ | [布局](../../docs/imgui/layout.zh-CN.md) | 表格、菜单、确认弹窗与作用域配对 |
106
+ | [文本输入与回调](../../docs/imgui/callbacks.zh-CN.md) | UTF-8 编辑、回调契约、列表与曲线 |
107
+ | [字体与样式](../../docs/imgui/fonts.zh-CN.md) | 字体图集、CJK 覆盖、间距、颜色与 DPI |
108
+ | [渲染与多窗口](../../docs/imgui/rendering.zh-CN.md) | 场景合成、绘制列表与按窗口划分的所有权 |
109
+ | [API 使用指南](../../docs/imgui/api.zh-CN.md) | 签名、重载和生命周期约束 |
110
+
111
+ ## 许可证
112
+
113
+ [MIT](../sfml.js/LICENSE)。
package/binding.gyp ADDED
@@ -0,0 +1,125 @@
1
+ {
2
+ "variables": {
3
+ "sfml_include": "<!(node -e \"process.stdout.write(require('sfml.js-interop/paths').sfmlInclude)\")",
4
+ "sfml_lib": "<!(node -e \"process.stdout.write(require('sfml.js-interop/paths').sfmlLib)\")",
5
+ "sfml_bin": "<!(node -e \"process.stdout.write(require('sfml.js-interop/paths').sfmlBin)\")",
6
+ "interop_include": "<!(node -e \"process.stdout.write(require('sfml.js-interop'))\")"
7
+ },
8
+ "targets": [{
9
+ "target_name": "imgui",
10
+ "sources": [
11
+ "native/addon.cc",
12
+ "native/imgui-context.cc",
13
+ "native/imgui-integration.cc",
14
+ "native/imgui-formatted.cc",
15
+ "native/imgui-font-ranges.cc",
16
+ "native/imgui-callbacks.cc",
17
+ "native/imgui-references.cc",
18
+ "native/imgui-values.cc",
19
+ "native/imgui-draw-callbacks.cc",
20
+ "native/imgui-frame.cc",
21
+ "native/imgui-debug.cc",
22
+ "native/imgui-windows.cc",
23
+ "native/imgui-style.cc",
24
+ "native/imgui-layout.cc",
25
+ "native/imgui-items.cc",
26
+ "native/imgui-text.cc",
27
+ "native/imgui-widgets.cc",
28
+ "native/imgui-drag-widgets.cc",
29
+ "native/imgui-slider-widgets.cc",
30
+ "native/imgui-input-widgets.cc",
31
+ "native/imgui-selection.cc",
32
+ "native/imgui-popups.cc",
33
+ "native/imgui-tables.cc",
34
+ "native/imgui-drag-drop.cc",
35
+ "native/imgui-input.cc",
36
+ "native/imgui-io.cc",
37
+ "native/imgui-storage.cc",
38
+ "native/imgui-utilities.cc",
39
+ "native/imgui-drawing.cc",
40
+ "native/imgui-draw-paths.cc",
41
+ "native/imgui-draw-primitives.cc",
42
+ "native/imgui-font.cc",
43
+ "native/imgui-glyph-fields.cc",
44
+ "native/imgui-struct-views.cc",
45
+ "third_party/imgui/imgui.cpp",
46
+ "third_party/imgui/imgui_draw.cpp",
47
+ "third_party/imgui/imgui_tables.cpp",
48
+ "third_party/imgui/imgui_widgets.cpp",
49
+ "third_party/imgui/imgui_demo.cpp",
50
+ "third_party/imgui/misc/cpp/imgui_stdlib.cpp",
51
+ "third_party/imgui-sfml/imgui-SFML.cpp",
52
+ "third_party/dcimgui/dcimgui.cpp"
53
+ ],
54
+ "include_dirs": [
55
+ ".",
56
+ "<!(node -e \"require('nan')\")",
57
+ "<(sfml_include)",
58
+ "<(interop_include)",
59
+ "native",
60
+ "third_party/imgui",
61
+ "third_party/imgui/misc/cpp",
62
+ "third_party/imgui-sfml",
63
+ "third_party/dcimgui"
64
+ ],
65
+ "defines": [
66
+ "IMGUI_USER_CONFIG=\"imconfig-SFML.h\"",
67
+ "IMGUI_DEFINE_MATH_OPERATORS"
68
+ ],
69
+ "cflags_cc": ["-std=c++20", "-ffp-contract=off"],
70
+ "cflags_cc!": ["-fno-exceptions"],
71
+ "conditions": [
72
+ ["OS=='mac'", {
73
+ "xcode_settings": {
74
+ "CLANG_CXX_LANGUAGE_STANDARD": "c++20",
75
+ "GCC_ENABLE_CPP_EXCEPTIONS": "YES",
76
+ "OTHER_CPLUSPLUSFLAGS": ["-ffp-contract=off"],
77
+ "MACOSX_DEPLOYMENT_TARGET": "13.0"
78
+ },
79
+ "libraries": [
80
+ "<(sfml_lib)/libsfml-graphics.dylib",
81
+ "<(sfml_lib)/libsfml-window.dylib",
82
+ "<(sfml_lib)/libsfml-system.dylib",
83
+ "-framework",
84
+ "OpenGL",
85
+ "-Wl,-rpath,<(sfml_lib)"
86
+ ]
87
+ }],
88
+ ["OS=='linux'", {
89
+ "libraries": [
90
+ "-L<(sfml_lib)",
91
+ "-lsfml-graphics",
92
+ "-lsfml-window",
93
+ "-lsfml-system",
94
+ "-lGL"
95
+ ],
96
+ "ldflags": [
97
+ "-Wl,-rpath,<(sfml_lib)"
98
+ ]
99
+ }],
100
+ ["OS=='win'", {
101
+ "defines": ["NOMINMAX"],
102
+ "msvs_settings": {
103
+ "VCCLCompilerTool": {
104
+ "ExceptionHandling": 1,
105
+ "AdditionalOptions": ["/std:c++20", "/fp:strict"]
106
+ }
107
+ },
108
+ "libraries": [
109
+ "<(sfml_lib)/sfml-graphics.lib",
110
+ "<(sfml_lib)/sfml-window.lib",
111
+ "<(sfml_lib)/sfml-system.lib",
112
+ "opengl32.lib"
113
+ ],
114
+ "copies": [{
115
+ "destination": "<(PRODUCT_DIR)",
116
+ "files": [
117
+ "<(sfml_bin)/sfml-graphics-3.dll",
118
+ "<(sfml_bin)/sfml-window-3.dll",
119
+ "<(sfml_bin)/sfml-system-3.dll"
120
+ ]
121
+ }]
122
+ }]
123
+ ]
124
+ }]
125
+ }