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.
- package/README.ja.md +113 -0
- package/README.ko.md +113 -0
- package/README.md +112 -2
- package/README.zh-CN.md +113 -0
- package/binding.gyp +125 -0
- package/dist/callbacks.d.ts +368 -0
- package/dist/callbacks.js +310 -0
- package/dist/enums/colors.d.ts +779 -0
- package/dist/enums/colors.js +766 -0
- package/dist/enums/drawing.d.ts +286 -0
- package/dist/enums/drawing.js +257 -0
- package/dist/enums/input.d.ts +792 -0
- package/dist/enums/input.js +731 -0
- package/dist/enums/keys.d.ts +1389 -0
- package/dist/enums/keys.js +1384 -0
- package/dist/enums/selection.d.ts +195 -0
- package/dist/enums/selection.js +182 -0
- package/dist/enums/style.d.ts +362 -0
- package/dist/enums/style.js +349 -0
- package/dist/enums/tables.d.ts +681 -0
- package/dist/enums/tables.js +644 -0
- package/dist/enums/text.d.ts +411 -0
- package/dist/enums/text.js +390 -0
- package/dist/enums/widgets.d.ts +861 -0
- package/dist/enums/widgets.js +800 -0
- package/dist/enums/windows.d.ts +487 -0
- package/dist/enums/windows.js +458 -0
- package/dist/enums.d.ts +10 -0
- package/dist/enums.js +26 -0
- package/dist/font.d.ts +249 -0
- package/dist/font.js +285 -0
- package/dist/formatted.d.ts +301 -0
- package/dist/formatted.js +342 -0
- package/dist/imgui/color.d.ts +493 -0
- package/dist/imgui/color.js +532 -0
- package/dist/imgui/columns.d.ts +242 -0
- package/dist/imgui/columns.js +273 -0
- package/dist/imgui/combo.d.ts +322 -0
- package/dist/imgui/combo.js +344 -0
- package/dist/imgui/context.d.ts +240 -0
- package/dist/imgui/context.js +270 -0
- package/dist/imgui/debug.d.ts +478 -0
- package/dist/imgui/debug.js +526 -0
- package/dist/imgui/drag-drop.d.ts +378 -0
- package/dist/imgui/drag-drop.js +414 -0
- package/dist/imgui/drag.d.ts +1371 -0
- package/dist/imgui/drag.js +1447 -0
- package/dist/imgui/draw-data.d.ts +139 -0
- package/dist/imgui/draw-data.js +154 -0
- package/dist/imgui/draw-list-images.d.ts +306 -0
- package/dist/imgui/draw-list-images.js +324 -0
- package/dist/imgui/draw-list-internals.d.ts +223 -0
- package/dist/imgui/draw-list-internals.js +259 -0
- package/dist/imgui/draw-list-path.d.ts +451 -0
- package/dist/imgui/draw-list-path.js +493 -0
- package/dist/imgui/draw-list-primitives.d.ts +297 -0
- package/dist/imgui/draw-list-primitives.js +324 -0
- package/dist/imgui/draw-list-shapes.d.ts +1258 -0
- package/dist/imgui/draw-list-shapes.js +1345 -0
- package/dist/imgui/draw-list-state.d.ts +458 -0
- package/dist/imgui/draw-list-state.js +515 -0
- package/dist/imgui/draw-list-text.d.ts +367 -0
- package/dist/imgui/draw-list-text.js +247 -0
- package/dist/imgui/drawing.d.ts +151 -0
- package/dist/imgui/drawing.js +169 -0
- package/dist/imgui/font-atlas.d.ts +726 -0
- package/dist/imgui/font-atlas.js +777 -0
- package/dist/imgui/font-glyph-ranges.d.ts +260 -0
- package/dist/imgui/font-glyph-ranges.js +230 -0
- package/dist/imgui/fonts.d.ts +114 -0
- package/dist/imgui/fonts.js +132 -0
- package/dist/imgui/id-stack.d.ts +363 -0
- package/dist/imgui/id-stack.js +309 -0
- package/dist/imgui/images.d.ts +310 -0
- package/dist/imgui/images.js +331 -0
- package/dist/imgui/index.d.ts +57 -0
- package/dist/imgui/index.js +73 -0
- package/dist/imgui/input-text-callback.d.ts +176 -0
- package/dist/imgui/input-text-callback.js +144 -0
- package/dist/imgui/inputs.d.ts +1086 -0
- package/dist/imgui/inputs.js +1159 -0
- package/dist/imgui/io.d.ts +546 -0
- package/dist/imgui/io.js +600 -0
- package/dist/imgui/item-state.d.ts +766 -0
- package/dist/imgui/item-state.js +850 -0
- package/dist/imgui/keyboard.d.ts +547 -0
- package/dist/imgui/keyboard.js +584 -0
- package/dist/imgui/layout.d.ts +927 -0
- package/dist/imgui/layout.js +1029 -0
- package/dist/imgui/legacy.d.ts +413 -0
- package/dist/imgui/legacy.js +461 -0
- package/dist/imgui/list-clipper.d.ts +282 -0
- package/dist/imgui/list-clipper.js +309 -0
- package/dist/imgui/logging.d.ts +113 -0
- package/dist/imgui/logging.js +135 -0
- package/dist/imgui/memory.d.ts +35 -0
- package/dist/imgui/memory.js +45 -0
- package/dist/imgui/menus.d.ts +373 -0
- package/dist/imgui/menus.js +407 -0
- package/dist/imgui/mouse.d.ts +740 -0
- package/dist/imgui/mouse.js +803 -0
- package/dist/imgui/plots.d.ts +252 -0
- package/dist/imgui/plots.js +267 -0
- package/dist/imgui/popups.d.ts +711 -0
- package/dist/imgui/popups.js +757 -0
- package/dist/imgui/scrolling.d.ts +341 -0
- package/dist/imgui/scrolling.js +375 -0
- package/dist/imgui/selection.d.ts +785 -0
- package/dist/imgui/selection.js +845 -0
- package/dist/imgui/settings.d.ts +194 -0
- package/dist/imgui/settings.js +216 -0
- package/dist/imgui/sliders.d.ts +1664 -0
- package/dist/imgui/sliders.js +1751 -0
- package/dist/imgui/storage.d.ts +344 -0
- package/dist/imgui/storage.js +386 -0
- package/dist/imgui/style.d.ts +680 -0
- package/dist/imgui/style.js +770 -0
- package/dist/imgui/tables.d.ts +762 -0
- package/dist/imgui/tables.js +831 -0
- package/dist/imgui/tabs.d.ts +228 -0
- package/dist/imgui/tabs.js +250 -0
- package/dist/imgui/text-buffer.d.ts +251 -0
- package/dist/imgui/text-buffer.js +239 -0
- package/dist/imgui/text-filter.d.ts +181 -0
- package/dist/imgui/text-filter.js +151 -0
- package/dist/imgui/text.d.ts +506 -0
- package/dist/imgui/text.js +425 -0
- package/dist/imgui/tooltips.d.ts +202 -0
- package/dist/imgui/tooltips.js +221 -0
- package/dist/imgui/trees.d.ts +516 -0
- package/dist/imgui/trees.js +562 -0
- package/dist/imgui/viewport.d.ts +93 -0
- package/dist/imgui/viewport.js +105 -0
- package/dist/imgui/widgets.d.ts +524 -0
- package/dist/imgui/widgets.js +572 -0
- package/dist/imgui/windows.d.ts +1210 -0
- package/dist/imgui/windows.js +1309 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +19 -0
- package/dist/internal/imgui-binding.d.ts +40 -0
- package/dist/internal/imgui-binding.js +2 -0
- package/dist/internal/native.d.ts +67 -0
- package/dist/internal/native.js +7 -0
- package/dist/internal/sfml-interop.d.ts +45 -0
- package/dist/internal/sfml-interop.js +102 -0
- package/dist/references.d.ts +393 -0
- package/dist/references.js +372 -0
- package/dist/sfml.d.ts +223 -0
- package/dist/sfml.js +320 -0
- package/dist/struct-views.d.ts +3056 -0
- package/dist/struct-views.js +418 -0
- package/dist/types.d.ts +508 -0
- package/dist/types.js +2 -0
- package/native/addon.cc +68 -0
- package/native/cimgui.h +12 -0
- package/native/imgui-args.h +492 -0
- package/native/imgui-bindings.h +35 -0
- package/native/imgui-callbacks.cc +376 -0
- package/native/imgui-context.cc +117 -0
- package/native/imgui-debug.cc +171 -0
- package/native/imgui-drag-drop.cc +120 -0
- package/native/imgui-drag-widgets.cc +473 -0
- package/native/imgui-draw-callbacks.cc +210 -0
- package/native/imgui-draw-callbacks.h +25 -0
- package/native/imgui-draw-paths.cc +413 -0
- package/native/imgui-draw-primitives.cc +317 -0
- package/native/imgui-drawing.cc +963 -0
- package/native/imgui-font-ranges.cc +73 -0
- package/native/imgui-font.cc +488 -0
- package/native/imgui-formatted.cc +388 -0
- package/native/imgui-frame.cc +56 -0
- package/native/imgui-glyph-fields.cc +87 -0
- package/native/imgui-glyph-fields.h +12 -0
- package/native/imgui-input-widgets.cc +447 -0
- package/native/imgui-input.cc +277 -0
- package/native/imgui-integration.cc +442 -0
- package/native/imgui-io.cc +255 -0
- package/native/imgui-items.cc +290 -0
- package/native/imgui-layout.cc +349 -0
- package/native/imgui-popups.cc +331 -0
- package/native/imgui-references.cc +230 -0
- package/native/imgui-selection.cc +394 -0
- package/native/imgui-slider-widgets.cc +550 -0
- package/native/imgui-storage.cc +177 -0
- package/native/imgui-struct-views.cc +626 -0
- package/native/imgui-style.cc +283 -0
- package/native/imgui-tables.cc +267 -0
- package/native/imgui-text.cc +291 -0
- package/native/imgui-utilities.cc +127 -0
- package/native/imgui-values.cc +66 -0
- package/native/imgui-widgets.cc +570 -0
- package/native/imgui-windows.cc +436 -0
- package/native/interop.h +19 -0
- package/package.json +72 -3
- package/src/callbacks.ts +447 -0
- package/src/enums/colors.ts +782 -0
- package/src/enums/drawing.ts +293 -0
- package/src/enums/input.ts +807 -0
- package/src/enums/keys.ts +1390 -0
- package/src/enums/selection.ts +198 -0
- package/src/enums/style.ts +365 -0
- package/src/enums/tables.ts +690 -0
- package/src/enums/text.ts +416 -0
- package/src/enums/widgets.ts +876 -0
- package/src/enums/windows.ts +494 -0
- package/src/enums.ts +10 -0
- package/src/font.ts +287 -0
- package/src/formatted.ts +386 -0
- package/src/imgui/color.ts +575 -0
- package/src/imgui/columns.ts +274 -0
- package/src/imgui/combo.ts +376 -0
- package/src/imgui/context.ts +268 -0
- package/src/imgui/debug.ts +542 -0
- package/src/imgui/drag-drop.ts +423 -0
- package/src/imgui/drag.ts +1615 -0
- package/src/imgui/draw-data.ts +158 -0
- package/src/imgui/draw-list-images.ts +394 -0
- package/src/imgui/draw-list-internals.ts +291 -0
- package/src/imgui/draw-list-path.ts +568 -0
- package/src/imgui/draw-list-primitives.ts +363 -0
- package/src/imgui/draw-list-shapes.ts +1593 -0
- package/src/imgui/draw-list-state.ts +551 -0
- package/src/imgui/draw-list-text.ts +594 -0
- package/src/imgui/drawing.ts +170 -0
- package/src/imgui/font-atlas.ts +862 -0
- package/src/imgui/font-glyph-ranges.ts +357 -0
- package/src/imgui/fonts.ts +133 -0
- package/src/imgui/id-stack.ts +496 -0
- package/src/imgui/images.ts +364 -0
- package/src/imgui/index.ts +57 -0
- package/src/imgui/input-text-callback.ts +268 -0
- package/src/imgui/inputs.ts +1292 -0
- package/src/imgui/io.ts +638 -0
- package/src/imgui/item-state.ts +856 -0
- package/src/imgui/keyboard.ts +590 -0
- package/src/imgui/layout.ts +1030 -0
- package/src/imgui/legacy.ts +477 -0
- package/src/imgui/list-clipper.ts +329 -0
- package/src/imgui/logging.ts +135 -0
- package/src/imgui/memory.ts +42 -0
- package/src/imgui/menus.ts +417 -0
- package/src/imgui/mouse.ts +824 -0
- package/src/imgui/plots.ts +313 -0
- package/src/imgui/popups.ts +779 -0
- package/src/imgui/scrolling.ts +378 -0
- package/src/imgui/selection.ts +904 -0
- package/src/imgui/settings.ts +220 -0
- package/src/imgui/sliders.ts +1969 -0
- package/src/imgui/storage.ts +415 -0
- package/src/imgui/style.ts +781 -0
- package/src/imgui/tables.ts +854 -0
- package/src/imgui/tabs.ts +259 -0
- package/src/imgui/text-buffer.ts +337 -0
- package/src/imgui/text-filter.ts +262 -0
- package/src/imgui/text.ts +688 -0
- package/src/imgui/tooltips.ts +218 -0
- package/src/imgui/trees.ts +583 -0
- package/src/imgui/viewport.ts +103 -0
- package/src/imgui/widgets.ts +599 -0
- package/src/imgui/windows.ts +1350 -0
- package/src/index.ts +21 -0
- package/src/internal/imgui-binding.ts +142 -0
- package/src/internal/native.ts +163 -0
- package/src/internal/sfml-interop.ts +171 -0
- package/src/references.ts +464 -0
- package/src/sfml.ts +412 -0
- package/src/struct-views.ts +3194 -0
- package/src/types.ts +539 -0
- package/tools/deps_downloader.cjs +213 -0
- package/tsconfig.json +15 -0
|
@@ -0,0 +1,547 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Test whether a key is held down.
|
|
3
|
+
*
|
|
4
|
+
* @zh 判断按键是否处于按下状态。
|
|
5
|
+
* @ja キーが押されているかを調べます。
|
|
6
|
+
* @ko 키가 눌려 있는지 확인합니다.
|
|
7
|
+
*
|
|
8
|
+
* @remarks
|
|
9
|
+
* - the ImGuiKey enum contains all possible keyboard, mouse and gamepad inputs
|
|
10
|
+
* (e.g. ImGuiKey.A, ImGuiKey.MouseLeft, ImGuiKey.GamepadDpadUp...).
|
|
11
|
+
*
|
|
12
|
+
* - (legacy: before v1.87, we used ImGuiKey to carry native/user indices as
|
|
13
|
+
* defined by each backends. This was obsoleted in 1.87 (2022-02) and
|
|
14
|
+
* completely removed in 1.91.5 (2024-11). See
|
|
15
|
+
* https://github.com/ocornut/imgui/issues/4921)
|
|
16
|
+
* - (legacy: any use of ImGuiKey will assert when key < 512 to detect passing
|
|
17
|
+
* legacy native/user indices)
|
|
18
|
+
*
|
|
19
|
+
* is key being held.
|
|
20
|
+
* @zh
|
|
21
|
+
* 输入工具:键盘/鼠标/手柄。
|
|
22
|
+
*
|
|
23
|
+
* - ImGuiKey 枚举包含所有可能的键盘、鼠标和手柄输入(例如
|
|
24
|
+
* ImGuiKey.A、ImGuiKey.MouseLeft、ImGuiKey.GamepadDpadUp 等)。
|
|
25
|
+
*
|
|
26
|
+
* - 旧版:v1.87 之前使用 ImGuiKey 携带各后端定义的原生/用户索引,此机制在 1.87(2022-02)废弃,于
|
|
27
|
+
* 1.91.5(2024-11)完全移除。见 https://github.com/ocornut/imgui/issues/4921 。
|
|
28
|
+
*
|
|
29
|
+
* - 旧版:任何 ImGuiKey 用法在 key < 512 时都会触发断言,以检测传入旧式原生/用户索引的情况。按键是否正被按住。
|
|
30
|
+
* @ja
|
|
31
|
+
* 入力ユーティリティ:キーボード/マウス/ゲームパッド。
|
|
32
|
+
*
|
|
33
|
+
* - ImGuiKey
|
|
34
|
+
* 列挙には利用可能なすべてのキーボード、マウス、ゲームパッド入力が含まれます(ImGuiKey.A、ImGuiKey.MouseLeft、
|
|
35
|
+
* ImGuiKey.GamepadDpadUp など)。
|
|
36
|
+
*
|
|
37
|
+
* - 旧仕様:v1.87 より前は各バックエンドのネイティブ/ユーザーインデックスを ImGuiKey
|
|
38
|
+
* に格納していました。1.87(2022-02)で廃止予定となり、1.91.5(2024-11)で完全に削除されました。https://
|
|
39
|
+
* github.com/ocornut/imgui/issues/4921 参照。
|
|
40
|
+
*
|
|
41
|
+
* - 旧仕様:古いネイティブ/ユーザーインデックスの受け渡しを検出するため、ImGuiKey を使うとき key < 512
|
|
42
|
+
* ならアサートします。キーが押され続けているかを調べます。
|
|
43
|
+
* @ko
|
|
44
|
+
* 입력 유틸리티: 키보드/마우스/게임패드.
|
|
45
|
+
*
|
|
46
|
+
* - ImGuiKey 열거형에는 가능한 모든 키보드, 마우스 및 게임패드 입력이 포함됩니다(예: ImGuiKey.A,
|
|
47
|
+
* ImGuiKey.MouseLeft, ImGuiKey.GamepadDpadUp 등).
|
|
48
|
+
*
|
|
49
|
+
* - 레거시: v1.87 이전에는 ImGuiKey에 각 백엔드가 정의한 네이티브/사용자 인덱스를 담았습니다. 이 방식은
|
|
50
|
+
* 1.87(2022-02)에서 폐기 예정이 되었고 1.91.5(2024-11)에서 완전히 제거되었습니다.
|
|
51
|
+
* https://github.com/ocornut/imgui/issues/4921 참조.
|
|
52
|
+
*
|
|
53
|
+
* - 레거시: 이전 네이티브/사용자 인덱스 전달을 감지하기 위해 ImGuiKey를 사용할 때 key < 512이면 단언이 발생합니다. 키를
|
|
54
|
+
* 누르고 있는지 검사합니다.
|
|
55
|
+
*
|
|
56
|
+
* @param key - ImGuiKey logical key identifier, not a platform-native key code.
|
|
57
|
+
* @zh key - ImGuiKey 逻辑按键标识符,不是平台原生键码。
|
|
58
|
+
* @ja key - ImGuiKey の論理キー識別子です。プラットフォーム固有のキーコードではありません。
|
|
59
|
+
* @ko key - ImGuiKey 논리 키 식별자이며 플랫폼 네이티브 키 코드가 아닙니다.
|
|
60
|
+
*
|
|
61
|
+
* @returns True if the key is currently held down; false otherwise.
|
|
62
|
+
* @zh 按键当前被按住时为 true,否则为 false。
|
|
63
|
+
* @ja キーが現在押されている場合は true、それ以外は false です。
|
|
64
|
+
* @ko 키를 현재 누르고 있으면 true이며 아니면 false입니다.
|
|
65
|
+
*/
|
|
66
|
+
export declare function IsKeyDown(key: number): boolean;
|
|
67
|
+
/**
|
|
68
|
+
* Test whether a key was newly pressed or generated a repeat event this frame.
|
|
69
|
+
*
|
|
70
|
+
* @zh 检查按键是否在本帧刚被按下或产生了重复事件。
|
|
71
|
+
* @ja このフレームでキーが新たに押されたか、リピートイベントが発生したかを調べます。
|
|
72
|
+
* @ko 이번 프레임에 키가 새로 눌렸거나 반복 이벤트가 발생했는지 확인합니다.
|
|
73
|
+
*
|
|
74
|
+
* @remarks
|
|
75
|
+
* was key pressed (went from !Down to Down)?
|
|
76
|
+
*
|
|
77
|
+
* if repeat=true, uses io.KeyRepeatDelay / KeyRepeatRate
|
|
78
|
+
*
|
|
79
|
+
* Implied repeat = true
|
|
80
|
+
* @zh
|
|
81
|
+
* 按键是否被按下(从 !Down 变为 Down)?
|
|
82
|
+
*
|
|
83
|
+
* 若 repeat=true,使用 io.KeyRepeatDelay / KeyRepeatRate。
|
|
84
|
+
*
|
|
85
|
+
* 隐含参数:repeat = true。
|
|
86
|
+
* @ja
|
|
87
|
+
* キーが押されましたか(!Down から Down に変化)?
|
|
88
|
+
*
|
|
89
|
+
* repeat=true の場合は io.KeyRepeatDelay / KeyRepeatRate を使用します。
|
|
90
|
+
*
|
|
91
|
+
* 暗黙の引数:repeat = true。
|
|
92
|
+
* @ko
|
|
93
|
+
* 키가 눌렸습니까(!Down에서 Down으로 변경)?
|
|
94
|
+
*
|
|
95
|
+
* repeat=true이면 io.KeyRepeatDelay / KeyRepeatRate를 사용합니다.
|
|
96
|
+
*
|
|
97
|
+
* 암묵적 인수: repeat = true.
|
|
98
|
+
*
|
|
99
|
+
* @param key - ImGuiKey logical key identifier, not a platform-native key code.
|
|
100
|
+
* @zh key - ImGuiKey 逻辑按键标识符,不是平台原生键码。
|
|
101
|
+
* @ja key - ImGuiKey の論理キー識別子です。プラットフォーム固有のキーコードではありません。
|
|
102
|
+
* @ko key - ImGuiKey 논리 키 식별자이며 플랫폼 네이티브 키 코드가 아닙니다.
|
|
103
|
+
*
|
|
104
|
+
* @returns True if the key was pressed this frame, including held-key repeats
|
|
105
|
+
* when enabled; false otherwise.
|
|
106
|
+
* @zh 本帧按键被按下,启用重复时包含持续按住产生的重复时为 true,否则为 false。
|
|
107
|
+
* @ja このフレームでキーを押した(有効ならリピートも含む)場合は true、それ以外は false です。
|
|
108
|
+
* @ko 이번 프레임에 키를 눌렀으면(활성화된 경우 반복 포함) true이며 아니면 false입니다.
|
|
109
|
+
*/
|
|
110
|
+
export declare function IsKeyPressed(key: number): boolean;
|
|
111
|
+
/**
|
|
112
|
+
* Test whether a key was pressed.
|
|
113
|
+
*
|
|
114
|
+
* @zh 判断按键是否被按下。
|
|
115
|
+
* @ja キーが押されたかを調べます。
|
|
116
|
+
* @ko 키를 눌렀는지 확인합니다.
|
|
117
|
+
*
|
|
118
|
+
* @remarks
|
|
119
|
+
* was key pressed (went from !Down to Down)?
|
|
120
|
+
*
|
|
121
|
+
* if repeat=true, uses io.KeyRepeatDelay / KeyRepeatRate
|
|
122
|
+
* @zh
|
|
123
|
+
* 按键是否被按下(从 !Down 变为 Down)?
|
|
124
|
+
*
|
|
125
|
+
* 若 repeat=true,使用 io.KeyRepeatDelay / KeyRepeatRate。
|
|
126
|
+
* @ja
|
|
127
|
+
* キーが押されましたか(!Down から Down に変化)?
|
|
128
|
+
*
|
|
129
|
+
* repeat=true の場合は io.KeyRepeatDelay / KeyRepeatRate を使用します。
|
|
130
|
+
* @ko
|
|
131
|
+
* 키가 눌렸습니까(!Down에서 Down으로 변경)?
|
|
132
|
+
*
|
|
133
|
+
* repeat=true이면 io.KeyRepeatDelay / KeyRepeatRate를 사용합니다.
|
|
134
|
+
*
|
|
135
|
+
* @param key - ImGuiKey logical key identifier, not a platform-native key code.
|
|
136
|
+
* @zh key - ImGuiKey 逻辑按键标识符,不是平台原生键码。
|
|
137
|
+
* @ja key - ImGuiKey の論理キー識別子です。プラットフォーム固有のキーコードではありません。
|
|
138
|
+
* @ko key - ImGuiKey 논리 키 식별자이며 플랫폼 네이티브 키 코드가 아닙니다.
|
|
139
|
+
*
|
|
140
|
+
* @param repeat - Whether holding the key or button generates repeated
|
|
141
|
+
* activations using ImGui repeat timing.
|
|
142
|
+
* @zh repeat - 是否按照 ImGui 重复时序,在按住按键或按钮时产生重复激活。
|
|
143
|
+
* @ja repeat - キーやボタンを押し続けたとき ImGui のリピート設定で繰り返し反応するかどうかです。
|
|
144
|
+
* @ko repeat - 키나 버튼을 누르고 있을 때 ImGui 반복 시간 설정으로 반복 활성화할지 여부입니다.
|
|
145
|
+
*
|
|
146
|
+
* @returns True if the key was pressed this frame, including held-key repeats
|
|
147
|
+
* when enabled; false otherwise.
|
|
148
|
+
* @zh 本帧按键被按下,启用重复时包含持续按住产生的重复时为 true,否则为 false。
|
|
149
|
+
* @ja このフレームでキーを押した(有効ならリピートも含む)場合は true、それ以外は false です。
|
|
150
|
+
* @ko 이번 프레임에 키를 눌렀으면(활성화된 경우 반복 포함) true이며 아니면 false입니다.
|
|
151
|
+
*/
|
|
152
|
+
export declare function IsKeyPressedEx(key: number, repeat?: boolean): boolean;
|
|
153
|
+
/**
|
|
154
|
+
* Test whether a key was released.
|
|
155
|
+
*
|
|
156
|
+
* @zh 判断按键是否被释放。
|
|
157
|
+
* @ja キーが離されたかを調べます。
|
|
158
|
+
* @ko 키를 놓았는지 확인합니다.
|
|
159
|
+
*
|
|
160
|
+
* @remarks
|
|
161
|
+
* was key released (went from Down to !Down)?
|
|
162
|
+
* @zh
|
|
163
|
+
* 按键是否被松开(从 Down 变为 !Down)?
|
|
164
|
+
* @ja
|
|
165
|
+
* キーが離されましたか(Down から !Down に変化)?
|
|
166
|
+
* @ko
|
|
167
|
+
* 키를 놓았습니까(Down에서 !Down으로 변경)?
|
|
168
|
+
*
|
|
169
|
+
* @param key - ImGuiKey logical key identifier, not a platform-native key code.
|
|
170
|
+
* @zh key - ImGuiKey 逻辑按键标识符,不是平台原生键码。
|
|
171
|
+
* @ja key - ImGuiKey の論理キー識別子です。プラットフォーム固有のキーコードではありません。
|
|
172
|
+
* @ko key - ImGuiKey 논리 키 식별자이며 플랫폼 네이티브 키 코드가 아닙니다.
|
|
173
|
+
*
|
|
174
|
+
* @returns True if the key transitioned from down to up this frame; false
|
|
175
|
+
* otherwise.
|
|
176
|
+
* @zh 本帧按键由按下变为释放时为 true,否则为 false。
|
|
177
|
+
* @ja キーがこのフレームで押下から解放に変わった場合は true、それ以外は false です。
|
|
178
|
+
* @ko 이번 프레임에 키가 눌림에서 해제로 바뀌면 true이며 아니면 false입니다.
|
|
179
|
+
*/
|
|
180
|
+
export declare function IsKeyReleased(key: number): boolean;
|
|
181
|
+
/**
|
|
182
|
+
* Test whether a key chord was pressed.
|
|
183
|
+
*
|
|
184
|
+
* @zh 判断组合键是否被按下。
|
|
185
|
+
* @ja キーと修飾キーの組み合わせが押されたかを調べます。
|
|
186
|
+
* @ko 키 조합을 눌렀는지 확인합니다.
|
|
187
|
+
*
|
|
188
|
+
* @remarks
|
|
189
|
+
* was key chord (mods + key) pressed, e.g. you can pass 'ImGuiKey.ModCtrl |
|
|
190
|
+
* ImGuiKey.S' as a key-chord.
|
|
191
|
+
*
|
|
192
|
+
* This doesn't do any routing or focus check, please consider using Shortcut()
|
|
193
|
+
* function instead.
|
|
194
|
+
* @zh
|
|
195
|
+
* 组合键(修饰键 + 按键)是否被按下?
|
|
196
|
+
*
|
|
197
|
+
* 例如可传入 'ImGuiKey.ModCtrl | ImGuiKey.S'。
|
|
198
|
+
*
|
|
199
|
+
* 此函数不进行路由或焦点检查,请考虑改用 Shortcut()。
|
|
200
|
+
* @ja
|
|
201
|
+
* キーの組み合わせ(修飾キー + キー)が押されましたか?
|
|
202
|
+
*
|
|
203
|
+
* 例えば 'ImGuiKey.ModCtrl | ImGuiKey.S' を渡せます。
|
|
204
|
+
*
|
|
205
|
+
* ルーティングもフォーカス確認も行わないので、代わりに Shortcut() の使用を検討してください。
|
|
206
|
+
* @ko
|
|
207
|
+
* 키 조합(수정 키 + 키)이 눌렸습니까?
|
|
208
|
+
*
|
|
209
|
+
* 예를 들어 'ImGuiKey.ModCtrl | ImGuiKey.S'를 전달할 수 있습니다.
|
|
210
|
+
*
|
|
211
|
+
* 라우팅이나 포커스 검사는 하지 않으므로 Shortcut() 사용을 고려하세요.
|
|
212
|
+
*
|
|
213
|
+
* @param key_chord - ImGuiKeyChord combining an ImGuiKey with ImGuiMod modifier
|
|
214
|
+
* bits.
|
|
215
|
+
* @zh key_chord - 由 ImGuiKey 和 ImGuiMod 修饰位组合成的 ImGuiKeyChord。
|
|
216
|
+
* @ja key_chord - ImGuiKey と ImGuiMod の修飾ビットを組み合わせた ImGuiKeyChord です。
|
|
217
|
+
* @ko key_chord - ImGuiKey와 ImGuiMod 보조 비트를 결합한 ImGuiKeyChord입니다.
|
|
218
|
+
*
|
|
219
|
+
* @returns True if the key chord was pressed this frame with the specified
|
|
220
|
+
* modifiers; false otherwise.
|
|
221
|
+
* @zh 本帧带指定修饰键的组合键被按下时为 true,否则为 false。
|
|
222
|
+
* @ja このフレームで指定修飾キー付きのキーコードが押された場合は true、それ以外は false です。
|
|
223
|
+
* @ko 이번 프레임에 지정 보조 키와 함께 키 조합을 눌렀으면 true이며 아니면 false입니다.
|
|
224
|
+
*/
|
|
225
|
+
export declare function IsKeyChordPressed(key_chord: number): boolean;
|
|
226
|
+
/**
|
|
227
|
+
* Count key presses using the supplied repeat delay and rate.
|
|
228
|
+
*
|
|
229
|
+
* @zh 根据指定重复延迟和频率计算按键次数。
|
|
230
|
+
* @ja 指定したリピート遅延と間隔でキー入力回数を数えます。
|
|
231
|
+
* @ko 지정한 반복 지연과 간격으로 키 입력 횟수를 계산합니다.
|
|
232
|
+
*
|
|
233
|
+
* @remarks
|
|
234
|
+
* uses provided repeat rate/delay.
|
|
235
|
+
*
|
|
236
|
+
* return a count, most often 0 or 1 but might be >1 if RepeatRate is small
|
|
237
|
+
* enough that DeltaTime > RepeatRate
|
|
238
|
+
* @zh
|
|
239
|
+
* 使用给定的重复速率/延迟。
|
|
240
|
+
*
|
|
241
|
+
* 返回次数,通常为 0 或 1;但若 RepeatRate 足够小而使 DeltaTime > RepeatRate,则可能 >1。
|
|
242
|
+
* @ja
|
|
243
|
+
* 指定したリピート間隔/遅延を使用します。
|
|
244
|
+
*
|
|
245
|
+
* 回数を返し、通常は 0 または 1 ですが、RepeatRate が十分小さく DeltaTime > RepeatRate なら >1
|
|
246
|
+
* になることがあります。
|
|
247
|
+
* @ko
|
|
248
|
+
* 지정한 반복 주기/지연을 사용합니다.
|
|
249
|
+
*
|
|
250
|
+
* 횟수를 반환하며 대개 0 또는 1이지만 RepeatRate가 충분히 작아 DeltaTime > RepeatRate이면 >1일 수 있습니다.
|
|
251
|
+
*
|
|
252
|
+
* @param key - ImGuiKey logical key identifier, not a platform-native key code.
|
|
253
|
+
* @zh key - ImGuiKey 逻辑按键标识符,不是平台原生键码。
|
|
254
|
+
* @ja key - ImGuiKey の論理キー識別子です。プラットフォーム固有のキーコードではありません。
|
|
255
|
+
* @ko key - ImGuiKey 논리 키 식별자이며 플랫폼 네이티브 키 코드가 아닙니다.
|
|
256
|
+
*
|
|
257
|
+
* @param repeat_delay - Delay in seconds before held-key repeats begin.
|
|
258
|
+
* @zh repeat_delay - 按住按键后开始重复前的延迟秒数。
|
|
259
|
+
* @ja repeat_delay - キーを押してからリピート開始までの秒数です。
|
|
260
|
+
* @ko repeat_delay - 키를 누른 후 반복 시작 전 지연 시간(초)입니다.
|
|
261
|
+
*
|
|
262
|
+
* @param rate - Interval in seconds between held-key repeats.
|
|
263
|
+
* @zh rate - 按住按键时两次重复之间的秒数。
|
|
264
|
+
* @ja rate - キーリピート間の秒数です。
|
|
265
|
+
* @ko rate - 키 반복 사이의 시간 간격(초)입니다.
|
|
266
|
+
*
|
|
267
|
+
* @returns Number of initial/repeated key presses in the current frame using
|
|
268
|
+
* the requested repeat timing; can exceed 1 for long frames.
|
|
269
|
+
* @zh 按指定重复时序计算的本帧首次及重复按键次数;长帧可能大于 1。
|
|
270
|
+
* @ja 指定リピート間隔による現在フレームの押下回数です。長いフレームでは 1 を超える場合があります。
|
|
271
|
+
* @ko 지정 반복 시간으로 계산한 현재 프레임의 최초 및 반복 누름 수입니다. 긴 프레임에서는 1보다 클 수 있습니다.
|
|
272
|
+
*/
|
|
273
|
+
export declare function GetKeyPressedAmount(key: number, repeat_delay: number, rate: number): number;
|
|
274
|
+
/**
|
|
275
|
+
* Returns English name of the key.
|
|
276
|
+
*
|
|
277
|
+
* @zh [调试] 返回按键的英文名称。
|
|
278
|
+
* @ja [デバッグ] キーの英語名を返します。
|
|
279
|
+
* @ko [디버그] 키의 영어 이름을 반환합니다.
|
|
280
|
+
*
|
|
281
|
+
* @remarks
|
|
282
|
+
* Those names are provided for debugging purpose and are not meant to be saved
|
|
283
|
+
* persistently nor compared.
|
|
284
|
+
* @zh
|
|
285
|
+
* 名称仅供调试,不应用于持久保存或比较。
|
|
286
|
+
* @ja
|
|
287
|
+
* これらの名前はデバッグ用であり、永続的な保存や比較には使わないでください。
|
|
288
|
+
* @ko
|
|
289
|
+
* 이 이름은 디버깅용이며 영구 저장하거나 비교하는 용도가 아닙니다.
|
|
290
|
+
*
|
|
291
|
+
* @param key - ImGuiKey logical key identifier, not a platform-native key code.
|
|
292
|
+
* @zh key - ImGuiKey 逻辑按键标识符,不是平台原生键码。
|
|
293
|
+
* @ja key - ImGuiKey の論理キー識別子です。プラットフォーム固有のキーコードではありません。
|
|
294
|
+
* @ko key - ImGuiKey 논리 키 식별자이며 플랫폼 네이티브 키 코드가 아닙니다.
|
|
295
|
+
*
|
|
296
|
+
* @returns Debug/display name of the ImGuiKey, not text produced by keyboard
|
|
297
|
+
* input.
|
|
298
|
+
* @zh ImGuiKey 的调试或显示名称,不是键盘输入产生的文本。
|
|
299
|
+
* @ja ImGuiKey のデバッグ・表示名です。キー入力から生成された文字ではありません。
|
|
300
|
+
* @ko ImGuiKey의 디버그 또는 표시 이름이며 키보드 입력으로 생성된 텍스트가 아닙니다.
|
|
301
|
+
*/
|
|
302
|
+
export declare function GetKeyName(key: number): string | null;
|
|
303
|
+
/**
|
|
304
|
+
* Override keyboard input capture for the next frame.
|
|
305
|
+
*
|
|
306
|
+
* @zh 覆盖下一帧的键盘输入捕获状态。
|
|
307
|
+
* @ja 次のフレームのキーボード入力キャプチャを上書きします。
|
|
308
|
+
* @ko 다음 프레임의 키보드 입력 캡처 상태를 재정의합니다.
|
|
309
|
+
*
|
|
310
|
+
* @remarks
|
|
311
|
+
* Override io.WantCaptureKeyboard flag next frame (said flag is left for your
|
|
312
|
+
* application to handle, typically when true it instructs your app to ignore
|
|
313
|
+
* inputs).
|
|
314
|
+
*
|
|
315
|
+
* e.g. force capture keyboard when your widget is being hovered.
|
|
316
|
+
*
|
|
317
|
+
* This is equivalent to setting "io.WantCaptureKeyboard =
|
|
318
|
+
* want_capture_keyboard"; after the next NewFrame() call.
|
|
319
|
+
* @zh
|
|
320
|
+
* 覆盖下一帧的 io.WantCaptureKeyboard 标志(此标志由应用处理,通常为 true 时指示应用忽略输入)。
|
|
321
|
+
*
|
|
322
|
+
* 例如控件悬停时强制捕获键盘。
|
|
323
|
+
*
|
|
324
|
+
* 这等同于在下一次 NewFrame() 调用之后设置 "io.WantCaptureKeyboard = want_capture_keyboard"。
|
|
325
|
+
* @ja
|
|
326
|
+
* 次のフレームの io.WantCaptureKeyboard フラグを上書きします(このフラグはアプリケーション側で処理し、通常 true
|
|
327
|
+
* なら入力を無視させます)。
|
|
328
|
+
*
|
|
329
|
+
* 例えばウィジェットへのホバー中にキーボードを強制的にキャプチャします。
|
|
330
|
+
*
|
|
331
|
+
* 次の NewFrame() 呼び出し後に "io.WantCaptureKeyboard = want_capture_keyboard"
|
|
332
|
+
* を設定するのと同等です。
|
|
333
|
+
* @ko
|
|
334
|
+
* 다음 프레임의 io.WantCaptureKeyboard 플래그를 재정의합니다(이 플래그는 응용 프로그램이 처리하며 보통 true이면 입력을
|
|
335
|
+
* 무시하도록 지시).
|
|
336
|
+
*
|
|
337
|
+
* 예를 들어 위젯 위에 마우스가 있을 때 키보드 입력을 강제로 캡처합니다.
|
|
338
|
+
*
|
|
339
|
+
* 다음 NewFrame() 호출 후 "io.WantCaptureKeyboard = want_capture_keyboard"를 설정하는 것과
|
|
340
|
+
* 같습니다.
|
|
341
|
+
*
|
|
342
|
+
* @param want_capture_keyboard - Override io.WantCaptureKeyboard on the next
|
|
343
|
+
* frame; this does not itself consume OS events.
|
|
344
|
+
* @zh want_capture_keyboard - 覆盖下一帧的 io.WantCaptureKeyboard 标志;本身不消费操作系统事件。
|
|
345
|
+
* @ja want_capture_keyboard - 次フレームの io.WantCaptureKeyboard フラグを上書きします。OS
|
|
346
|
+
* イベント自体は消費しません。
|
|
347
|
+
* @ko want_capture_keyboard - 다음 프레임의 io.WantCaptureKeyboard 플래그를 재정의합니다. OS
|
|
348
|
+
* 이벤트 자체를
|
|
349
|
+
* 소비하지는 않습니다.
|
|
350
|
+
*/
|
|
351
|
+
export declare function SetNextFrameWantCaptureKeyboard(want_capture_keyboard: boolean): void;
|
|
352
|
+
/**
|
|
353
|
+
* Test and route a keyboard shortcut.
|
|
354
|
+
*
|
|
355
|
+
* @zh 检测并路由键盘快捷键。
|
|
356
|
+
* @ja キーボードショートカットを判定し、ルーティングします。
|
|
357
|
+
* @ko 키보드 단축키를 확인하고 라우팅합니다.
|
|
358
|
+
*
|
|
359
|
+
* @remarks
|
|
360
|
+
* A key chord combines one `ImGuiKey` with optional `ImGuiKey.ModAlt`,
|
|
361
|
+
* `ImGuiKey.ModCtrl`, `ImGuiKey.ModShift`, or `ImGuiKey.ModSuper` modifiers.
|
|
362
|
+
* Never combine two `ImGuiKey` values.
|
|
363
|
+
*
|
|
364
|
+
* ```text
|
|
365
|
+
* ImGuiKey.C // A key or chord
|
|
366
|
+
* ImGuiKey.ModCtrl | ImGuiKey.C // A chord
|
|
367
|
+
* ```
|
|
368
|
+
*
|
|
369
|
+
* Several callers may request the same shortcut, but only one owner receives
|
|
370
|
+
* it. Routing is independent of call order:
|
|
371
|
+
*
|
|
372
|
+
* - A focused parent that requests Ctrl+S receives it.
|
|
373
|
+
* - A focused child that also requests Ctrl+S overrides its parent.
|
|
374
|
+
* - A focused child that does not request Ctrl+S leaves it with its parent.
|
|
375
|
+
*
|
|
376
|
+
* `IsKeyChordPressed()` only compares modifiers and tests the key, without
|
|
377
|
+
* routing side effects. `Shortcut()` registers a route and tests the chord when
|
|
378
|
+
* that route is granted; it can prevent another caller from receiving the
|
|
379
|
+
* shortcut.
|
|
380
|
+
*
|
|
381
|
+
* Inspect registered routes in Metrics/Debugger > Inputs. This routing API is
|
|
382
|
+
* marked beta upstream.
|
|
383
|
+
* @zh
|
|
384
|
+
* 组合键由一个 `ImGuiKey` 和可选的 `ImGuiKey.ModAlt`
|
|
385
|
+
* 、`ImGuiKey.ModCtrl`、`ImGuiKey.ModShift` 或
|
|
386
|
+
* `ImGuiKey.ModSuper` 修饰键组成。不能组合两个 `ImGuiKey` 值。
|
|
387
|
+
*
|
|
388
|
+
* ```text
|
|
389
|
+
* ImGuiKey.C // 按键或组合键
|
|
390
|
+
* ImGuiKey.ModCtrl | ImGuiKey.C // 组合键
|
|
391
|
+
* ```
|
|
392
|
+
*
|
|
393
|
+
* 多个调用方可请求同一快捷键,但只有一个所有者会接收它。路由结果不依赖调用顺序:
|
|
394
|
+
*
|
|
395
|
+
* - 获得焦点的父级请求 Ctrl+S 时,由父级接收。
|
|
396
|
+
* - 获得焦点的子级也请求 Ctrl+S 时,会覆盖父级。
|
|
397
|
+
* - 获得焦点的子级不请求 Ctrl+S 时,仍由父级接收。
|
|
398
|
+
*
|
|
399
|
+
* `IsKeyChordPressed()` 只比较修饰键并检测按键,不产生路由副作用。`Shortcut()`
|
|
400
|
+
* 注册路由,在获得路由后检测组合键;这可能阻止其他调用方收到该快捷键。
|
|
401
|
+
*
|
|
402
|
+
* 可在 Metrics/Debugger > Inputs 查看已注册路由。此路由 API 在上游标记为测试版。
|
|
403
|
+
* @ja
|
|
404
|
+
* キーコードの組み合わせは 1 つの `ImGuiKey` と任意の修飾キー
|
|
405
|
+
* `ImGuiKey.ModAlt` 、`ImGuiKey.ModCtrl`、`ImGuiKey.ModShift`、`ImGuiKey.ModSuper`
|
|
406
|
+
* で構成します。2 つの
|
|
407
|
+
* `ImGuiKey` 値を組み合わせることはできません。
|
|
408
|
+
*
|
|
409
|
+
* ```text
|
|
410
|
+
* ImGuiKey.C // キーまたは組み合わせ
|
|
411
|
+
* ImGuiKey.ModCtrl | ImGuiKey.C // キーの組み合わせ
|
|
412
|
+
* ```
|
|
413
|
+
*
|
|
414
|
+
* 複数の呼び出し元が同じショートカットを要求できますが、受け取る所有者は 1 つだけです。ルーティングは呼び出し順に依存しません。
|
|
415
|
+
*
|
|
416
|
+
* - フォーカスされた親が Ctrl+S を要求すると、親が受け取ります。
|
|
417
|
+
* - フォーカスされた子も Ctrl+S を要求すると、親より優先されます。
|
|
418
|
+
* - フォーカスされた子が Ctrl+S を要求しなければ、親が受け取ります。
|
|
419
|
+
*
|
|
420
|
+
* `IsKeyChordPressed()` は修飾キーの比較とキーの判定だけを行い、ルーティングの副作用はありません。`Shortcut()`
|
|
421
|
+
* は経路を登録し、経路を得たときにキーを判定します。その結果、別の呼び出し元への配信を防ぐ場合があります。
|
|
422
|
+
*
|
|
423
|
+
* 登録された経路は Metrics/Debugger > Inputs で確認できます。このルーティング API は上流でベータ版とされています。
|
|
424
|
+
* @ko
|
|
425
|
+
* 키 조합은 하나의 `ImGuiKey`에 선택적으로 `ImGuiKey.ModAlt`, `ImGuiKey.ModCtrl`,
|
|
426
|
+
* `ImGuiKey.ModShift` , `ImGuiKey.ModSuper` 수정 키를 결합합니다. 두 `ImGuiKey` 값을 결합하면 안
|
|
427
|
+
* 됩니다.
|
|
428
|
+
*
|
|
429
|
+
* ```text
|
|
430
|
+
* ImGuiKey.C // 키 또는 키 조합
|
|
431
|
+
* ImGuiKey.ModCtrl | ImGuiKey.C // 키 조합
|
|
432
|
+
* ```
|
|
433
|
+
*
|
|
434
|
+
* 여러 호출자가 같은 단축키를 요청할 수 있지만 한 소유자만 받습니다. 라우팅은 호출 순서와 무관합니다.
|
|
435
|
+
*
|
|
436
|
+
* - 포커스된 부모가 Ctrl+S를 요청하면 부모가 받습니다.
|
|
437
|
+
* - 포커스된 자식도 Ctrl+S를 요청하면 부모보다 우선합니다.
|
|
438
|
+
* - 포커스된 자식이 Ctrl+S를 요청하지 않으면 부모가 받습니다.
|
|
439
|
+
*
|
|
440
|
+
* `IsKeyChordPressed()`는 수정 키를 비교하고 키만 확인하므로 라우팅 부수 효과가 없습니다. `Shortcut()`은 경로를
|
|
441
|
+
* 등록하고 경로를 받았을 때 키 조합을 확인하며, 다른 호출자가 해당 단축키를 받지 못하게 할 수 있습니다.
|
|
442
|
+
*
|
|
443
|
+
* 등록된 경로는 Metrics/Debugger > Inputs에서 확인할 수 있습니다. 이 라우팅 API는 상위 프로젝트에서 베타로
|
|
444
|
+
* 표시됩니다.
|
|
445
|
+
*
|
|
446
|
+
* @param key_chord - ImGuiKeyChord combining an ImGuiKey with ImGuiMod modifier
|
|
447
|
+
* bits.
|
|
448
|
+
* @zh key_chord - 由 ImGuiKey 和 ImGuiMod 修饰位组合成的 ImGuiKeyChord。
|
|
449
|
+
* @ja key_chord - ImGuiKey と ImGuiMod の修飾ビットを組み合わせた ImGuiKeyChord です。
|
|
450
|
+
* @ko key_chord - ImGuiKey와 ImGuiMod 보조 비트를 결합한 ImGuiKeyChord입니다.
|
|
451
|
+
*
|
|
452
|
+
* @param flags - ImGuiInputFlags options controlling this operation; combine
|
|
453
|
+
* compatible flag bits with |.
|
|
454
|
+
* @zh flags - 控制此操作的 ImGuiInputFlags 选项;可用 | 组合兼容的标志位。
|
|
455
|
+
* @ja flags - この操作を制御する ImGuiInputFlags オプションです。互換性のあるフラグは | で組み合わせます。
|
|
456
|
+
* @ko flags - 이 동작을 제어하는 ImGuiInputFlags 옵션입니다. 호환되는 비트는 |로 결합합니다.
|
|
457
|
+
*
|
|
458
|
+
* @returns True if the chord was pressed and this call won shortcut routing
|
|
459
|
+
* under the supplied flags; false otherwise.
|
|
460
|
+
* @zh 组合键被按下且此调用按指定标志赢得快捷键路由时为 true,否则为 false。
|
|
461
|
+
* @ja キーコードが押され、この呼び出しが指定条件のショートカットルーティングを獲得した場合は true、それ以外は false です。
|
|
462
|
+
* @ko 키 조합이 눌리고 이 호출이 지정 플래그의 단축키 라우팅을 얻으면 true이며 아니면 false입니다.
|
|
463
|
+
*/
|
|
464
|
+
export declare function Shortcut(key_chord: number, flags?: number): boolean;
|
|
465
|
+
/**
|
|
466
|
+
* Assign a routed keyboard shortcut to activate the next item.
|
|
467
|
+
*
|
|
468
|
+
* @zh 为下一个控件分配经过路由的键盘快捷键以激活它。
|
|
469
|
+
* @ja 次の項目をアクティブにする、ルーティング対象のキーボードショートカットを割り当てます。
|
|
470
|
+
* @ko 다음 항목을 활성화할 라우팅 대상 키보드 단축키를 지정합니다.
|
|
471
|
+
*
|
|
472
|
+
* @param key_chord - ImGuiKeyChord combining an ImGuiKey with ImGuiMod modifier
|
|
473
|
+
* bits.
|
|
474
|
+
* @zh key_chord - 由 ImGuiKey 和 ImGuiMod 修饰位组合成的 ImGuiKeyChord。
|
|
475
|
+
* @ja key_chord - ImGuiKey と ImGuiMod の修飾ビットを組み合わせた ImGuiKeyChord です。
|
|
476
|
+
* @ko key_chord - ImGuiKey와 ImGuiMod 보조 비트를 결합한 ImGuiKeyChord입니다.
|
|
477
|
+
*
|
|
478
|
+
* @param flags - ImGuiInputFlags options controlling this operation; combine
|
|
479
|
+
* compatible flag bits with |.
|
|
480
|
+
* @zh flags - 控制此操作的 ImGuiInputFlags 选项;可用 | 组合兼容的标志位。
|
|
481
|
+
* @ja flags - この操作を制御する ImGuiInputFlags オプションです。互換性のあるフラグは | で組み合わせます。
|
|
482
|
+
* @ko flags - 이 동작을 제어하는 ImGuiInputFlags 옵션입니다. 호환되는 비트는 |로 결합합니다.
|
|
483
|
+
*/
|
|
484
|
+
export declare function SetNextItemShortcut(key_chord: number, flags?: number): void;
|
|
485
|
+
/**
|
|
486
|
+
* Assign input ownership to the last item.
|
|
487
|
+
*
|
|
488
|
+
* @zh 将输入所有权分配给最后一个条目。
|
|
489
|
+
* @ja 最後のアイテムに入力の所有権を割り当てます。
|
|
490
|
+
* @ko 마지막 항목에 입력 소유권을 할당합니다.
|
|
491
|
+
*
|
|
492
|
+
* @remarks
|
|
493
|
+
* - One common use case would be to allow your items to disable standard inputs
|
|
494
|
+
* behaviors such as Tab or Alt key handling, Mouse Wheel scrolling, etc. e.g.
|
|
495
|
+
* Button(...); SetItemKeyOwner(ImGuiKey.MouseWheelY); to make
|
|
496
|
+
* hovering/activating a button disable wheel for scrolling.
|
|
497
|
+
*
|
|
498
|
+
* - Reminder ImGuiKey enum include access to mouse buttons and gamepad, so key
|
|
499
|
+
* ownership can apply to them.
|
|
500
|
+
*
|
|
501
|
+
* - Many related features are still in imgui_internal.h. For instance, most
|
|
502
|
+
* IsKeyXXX()/IsMouseXXX() functions have an owner-id-aware version.
|
|
503
|
+
*
|
|
504
|
+
* Call SetItemKeyOwner(key) to assign the key to the last item when that item
|
|
505
|
+
* is hovered or active. The lower-level native ownership API is not exported.
|
|
506
|
+
* @zh
|
|
507
|
+
* 输入工具:按键/输入所有权 [BETA]。
|
|
508
|
+
*
|
|
509
|
+
* - 常见用法是让项目禁用 Tab、Alt 键处理、鼠标滚轮滚动等标准输入行为。例如 Button(...);
|
|
510
|
+
* SetItemKeyOwner(ImGuiKey.MouseWheelY); 可在按钮悬停/激活时禁用滚轮滚动。
|
|
511
|
+
*
|
|
512
|
+
* - 注意 ImGuiKey 枚举也包含鼠标按钮和手柄,因此按键所有权同样适用于它们。
|
|
513
|
+
*
|
|
514
|
+
* - 许多相关功能仍位于 imgui_internal.h,例如大多数 IsKeyXXX()/IsMouseXXX() 函数有支持 owner-id
|
|
515
|
+
* 的版本。调用 SetItemKeyOwner(key),可在最后一个项目悬停或激活时将按键所有权分配给它。
|
|
516
|
+
* 底层原生所有权 API 未导出。
|
|
517
|
+
* @ja
|
|
518
|
+
* 入力ユーティリティ:キー/入力の所有権 [BETA]。
|
|
519
|
+
*
|
|
520
|
+
* - よくある用途は、Tab や Alt キー処理、マウスホイールのスクロールなど標準の入力動作を項目から無効化することです。例えば
|
|
521
|
+
* Button(...); SetItemKeyOwner(ImGuiKey.MouseWheelY);
|
|
522
|
+
* で、ボタンへのホバー/アクティブ化中にホイールのスクロールを無効にします。
|
|
523
|
+
*
|
|
524
|
+
* - ImGuiKey 列挙にはマウスボタンとゲームパッドも含まれるため、それらにも所有権を適用できます。
|
|
525
|
+
*
|
|
526
|
+
* - 関連機能の多くはまだ imgui_internal.h にあります。例えばほとんどの IsKeyXXX()/IsMouseXXX() 関数には
|
|
527
|
+
* owner-id 対応版があります。SetItemKeyOwner(key) を呼ぶと、最後の項目がホバー中またはアクティブなときに
|
|
528
|
+
* その項目へキーの所有権を割り当てます。低レベルのネイティブ所有権 API は公開されていません。
|
|
529
|
+
* @ko
|
|
530
|
+
* 입력 유틸리티: 키/입력 소유권 [BETA].
|
|
531
|
+
*
|
|
532
|
+
* - 일반적인 용도는 항목이 Tab이나 Alt 키 처리, 마우스 휠 스크롤 같은 표준 입력 동작을 비활성화하도록 하는 것입니다. 예를 들어
|
|
533
|
+
* Button(...); SetItemKeyOwner(ImGuiKey.MouseWheelY); 는 버튼에 마우스를 올리거나 활성화하면 휠
|
|
534
|
+
* 스크롤을 비활성화합니다.
|
|
535
|
+
*
|
|
536
|
+
* - ImGuiKey 열거형에는 마우스 버튼과 게임패드도 포함되므로 이들에도 키 소유권을 적용할 수 있습니다.
|
|
537
|
+
*
|
|
538
|
+
* - 많은 관련 기능은 아직 imgui_internal.h에 있습니다. 예를 들어 대부분의 IsKeyXXX()/IsMouseXXX()
|
|
539
|
+
* 함수에는 owner-id 지원 버전이 있습니다. SetItemKeyOwner(key)를 호출하면 마지막 항목이 호버 또는 활성 상태일 때
|
|
540
|
+
* 해당 항목에 키 소유권을 부여합니다. 저수준 네이티브 소유권 API는 내보내지 않습니다.
|
|
541
|
+
*
|
|
542
|
+
* @param key - ImGuiKey logical key identifier, not a platform-native key code.
|
|
543
|
+
* @zh key - ImGuiKey 逻辑按键标识符,不是平台原生键码。
|
|
544
|
+
* @ja key - ImGuiKey の論理キー識別子です。プラットフォーム固有のキーコードではありません。
|
|
545
|
+
* @ko key - ImGuiKey 논리 키 식별자이며 플랫폼 네이티브 키 코드가 아닙니다.
|
|
546
|
+
*/
|
|
547
|
+
export declare function SetItemKeyOwner(key: number): void;
|