extension-imgui

KO | EN

gitlite — search

#python #typescript #golang #go #machine-learning #rust #linux #windows #awesome #cli #kubernetes #vue #security #openai

extension-imgui

(★ 82)

Dear ImGUI extension for Defold

파일 탐색기

최종 버전 다운로드 (.zip)

- - add-issue-to-backlog.yml
  - bob.yml
  - issue-score.yml
- example.collection
- example.script
- fonts.lua
- images.lua
- style.lua
- tab1.lua
- tab2.lua
- tab3.lua
- tab4.lua
- tab5.lua
- tab6.lua
- - imgui.lua
  - imgui.script_api
- - imgui.input_binding
- - extension_imgui.h
- - extension_imgui.cpp
- ext.manifest
- imgui.script
.gitattributes
.gitignore
game.project
LICENSE.md
opengl.appmanifest
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Dear ImGUI extension for Defold
This project adds support for [Dear ImGUI](https://github.com/ocornut/imgui) in Defold. Dear ImGUI is described as a "Bloat-free Graphical User interface for C++ with minimal dependencies". It is perfect for quickly creating a debug interface or for creation of in-game tools and settings.

![imgui1](https://user-images.githubusercontent.com/1300688/118636082-983cc000-b7d4-11eb-9a02-55785e4651ac.png)
![imgui2](https://user-images.githubusercontent.com/1300688/118636087-996ded00-b7d4-11eb-88e6-e90d15ede189.png)

## Why no auto-generated bindings?
Projects such as [cimgui](https://github.com/cimgui/cimgui) offers Dear ImGUI bindings for a number of different languages, including Lua. It could be used  to generate the bindings for this extension, but this extension was initially created as a way to learn more about the Dear ImGUI API and as such it made more sense to write the bindings by hand.

## Platforms support
The current state of platform support:

* ✅ macOS
* ✅ Linux
* ✅ Windows
* ✅ Android
* ✅ iOS
* ✅ HTML5

## Usage
Refer to [example/example.script](/example/example.script) to learn how to use the extension. Also check the bindings in `LuaInit()` in `extension_imgui.cpp`.

### Input
You need to update the input state in Dear ImGUI each frame to accurately reflect user input:

* `imgui.set_key_down(key, pressed)` - Set the pressed state of a key. The key must be one of the `imgui.KEY_` constants
* `imgui.set_key_modifier_super(pressed)`
* `imgui.set_key_modifier_alt(pressed)`
* `imgui.set_key_modifier_ctrl(pressed)`
* `imgui.set_key_modifier_shift(pressed)`
* `imgui.add_input_character(text)` - Add keyboard input
* `imgui.set_mouse_input(x, y, left, right, middle, wheel)` - Set mouse state (position, buttons and wheel)

You can add the `imgui/imgui.script` to a game object and let that handle input for you (also make sure to use imgui/bindings/imgui.input_bindings).

### Display size
You need to let Dear ImGUI know of any changes to the window size by calling `imgui.set_display_size(w, h)` when the screen size changes.

### Native C/C++ draw callbacks
Native extensions can register a draw callback invoked after `ImGui::NewFrame()` and before `ImGui::Render()`:

```cpp
#include "extension_imgui.h"
#include "imgui/src/imgui/imgui.h"

static void Draw(void* user_data) {
    ImGui::Begin("Native Window");
    ImGui::Text("Hello");
    ImGui::End();
}

DefoldImGui_RegisterDrawCallback(Draw, 0);
```

Callbacks run on the render thread/post-render callback where extension-imgui renders. Do not call `ImGui::NewFrame()`, `ImGui::Render()`, or backend render functions from the callback.

### How to generate API docs

* Download and unpack https://github.com/britzl/generatedocs/archive/refs/heads/main.zip
* From the root of this project run `path/to/generatedocs.py imgui extension_imgui.cpp`

extension-imgui

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

extension-imgui

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README