You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-12Lines changed: 13 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Please read **Binding notice** to get more info about specific of the binding AP
12
12
See official [documentation](https://github.com/ocornut/imgui#usage) and [wiki](https://github.com/ocornut/imgui/wiki) to get more info about how to do things in ImGui.
13
13
14
14
Binding doesn't force you to use backend renderer which is introduced here. Feel free to use your own render engine if you need so.
15
-
See how things are done in [ImGuiImplGl3](https://github.com/SpaiR/imgui-java/blob/v1.75-0.7/imgui-lwjgl3/src/main/java/imgui/gl3/ImGuiImplGl3.java).
15
+
See how things are done in [ImGuiImplGl3](https://github.com/SpaiR/imgui-java/blob/v1.75-0.7.1/imgui-lwjgl3/src/main/java/imgui/gl3/ImGuiImplGl3.java).
16
16
17
17
Binding has the next version naming: `imguiVersion-bindingVersion`.<br>
18
18
For example `1.74-0.1` means that binding uses `1.74` version of **ImGui** and binding itself has version `0.1`.
@@ -25,13 +25,13 @@ _Make sure you have installed Java 8 or higher._
25
25
You can try this binding by yourself in a three simple steps:
That's it! This will start an example app [ImGuiGlfwExample](https://github.com/SpaiR/imgui-java/blob/v1.75-0.7/imgui-lwjgl3/src/test/java/ImGuiGlfwExample.java)
34
-
which relies on GLFW and LWJGL3. Feel free to modify [ImGuiGlfwExample#showUi](https://github.com/SpaiR/imgui-java/blob/v1.75-0.7/imgui-lwjgl3/src/test/java/ImGuiGlfwExample.java#L346)
33
+
That's it! This will start an example app [ImGuiGlfwExample](https://github.com/SpaiR/imgui-java/blob/v1.75-0.7.1/imgui-lwjgl3/src/test/java/ImGuiGlfwExample.java)
34
+
which relies on GLFW and LWJGL3. Feel free to modify [ImGuiGlfwExample#showUi](https://github.com/SpaiR/imgui-java/blob/v1.75-0.7.1/imgui-lwjgl3/src/test/java/ImGuiGlfwExample.java#L346)
35
35
method to try different ImGui widgets in action.
36
36
37
37
**GIF with example:**https://imgur.com/a/E2rfuCR
@@ -57,7 +57,7 @@ method to try different ImGui widgets in action.
57
57
58
58
ext {
59
59
lwjglVersion = '3.2.3'
60
-
imguiVersion = '1.75-0.7'
60
+
imguiVersion = '1.75-0.7.1'
61
61
}
62
62
63
63
dependencies {
@@ -85,13 +85,13 @@ repositories {
85
85
### Step 2
86
86
Add binding dependency:
87
87
```
88
-
implementation 'io.imgui.java:binding:1.75-0.7'
88
+
implementation 'io.imgui.java:binding:1.75-0.7.1'
89
89
```
90
90
91
91
### Step 3
92
92
If you want to use LWJGL3 renderer:
93
93
```
94
-
implementation 'io.imgui.java:lwjgl3:1.75-0.7'
94
+
implementation 'io.imgui.java:lwjgl3:1.75-0.7.1'
95
95
```
96
96
**Disclaimer!**<br>
97
97
LWJGL3 renderer is based on the `3.2.3` version of the [LWJGL](https://www.lwjgl.org/).
@@ -101,7 +101,7 @@ You can find how to do that [here](https://www.lwjgl.org/customize).
@@ -113,21 +113,22 @@ _(`x86` suffix is to get 32bit library)_
113
113
114
114
Or alternatively you can download binaries manually:<br>
115
115
Go to the `/bin` folder and pick a native library for your OS. Then you'll need to provide `imgui.library.path` or `java.library.path`
116
-
VM option with path to a folder where you placed downloaded file.
116
+
VM option with path to a folder where you've placed downloaded file.
117
117
118
118
**You are ready to use imgui-java binding!**
119
119
120
120
#### Binding notice:
121
121
* All ImGui methods are available in `camelCase`, not in `PascalCase`.
122
-
* In places where in C++ you need to pass `ImVec2` or `ImVec4`, here you'll need to pass two or four float parameters respectively.
123
-
* When you need to get an input/output to/from the Dear-ImGui use primitive wrappers: `ImBool`, `ImInt` etc.
122
+
* In places where you need to **pass**`ImVec2` or `ImVec4` you'll need to pass two or four float parameters respectively.
123
+
If you need to **get**`ImVec2` or `ImVec4`, you'll need to pass a destination object as method parameter.
124
+
* When you need to get an input/output to/from Dear ImGui - use primitive wrappers: `ImBool`, `ImInt` etc.
124
125
* Due to the Java and JNI restrictions we can't provide a fully fledged callbacks to the ImGui::InputText*() methods.
125
126
Partly you could replace some of the features (like setting of the allowed chars to input) by using the ImGuiInputTextData class.
126
127
Read [javadoc](https://javadoc.io/doc/io.imgui.java/binding) to get more info.
127
128
128
129
## How to build
129
130
To build native libraries you should install `mingw-w64` and `ant`. Modify [GenerateLibs](https://github.com/SpaiR/imgui-java/blob/master/buildSrc/src/main/groovy/imgui/generate/GenerateLibs.groovy)
130
-
to build specific binaries you need. After everything is configure run `gradlew :imgui-binding:generateLibs` task.
131
+
to build specific binaries you need. After everything is configured, run `gradlew :imgui-binding:generateLibs`.
131
132
This will build native libraries and place them in `~/imgui-binding/build/libsNative` folder.
0 commit comments