Skip to content

Commit

Permalink
Documentation.
Browse files Browse the repository at this point in the history
Documentation.
  • Loading branch information
xzripper authored Jun 22, 2024
1 parent 9a590b6 commit 70bd500
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions jlimgui-doc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<h3 align="center">Minimalistic JlImGui documentation.</h3><hr>
<h3 align="center">JlImGui Documentation.</h3><hr>

- `JaylibImGui` :<br>ImGui binding for Raylib bindings for Java.
- `public static String jlImGuiVersion` = `1.1.1` :<br>JlImGui Version.
- `public static String jlImGuiVersion` = `1.2.1` :<br>JlImGui Version.

- `public static void setupImGui(int glslV, String font, int fontSize, boolean useIni)` :<br>Setup ImGui;
- `glslV` - Integer; GLSL Version (`330` / `100`).
Expand All @@ -14,9 +14,11 @@
- `font` - String; Path to font.
- `fontSize` - Integer; Font size in pixels.

- `public static void setupImGui(int glslV)` :<br>Setup ImGui; Set `useIni` to `false` by default; Set `font` to `null` and `fontSize` to `0` by default.
- `public static void setupImGui(int glslV)` :<br>Setup ImGui; Set `font` to `null` and `fontSize` to `0` by default; Set `useIni` to `false` by default.
- `glslV` - Integer; GLSL Version (`330` / `100`).

- `public static void setupImGui()` :<br>Setup ImGui; Set `glslV` to `330`; Set `font` to `null` and `fontSize` to `0` by default; Set `useIni` to `false` by default.

- `public static void process()` :<br>Process ImGui things (keyboard/mouse/deltas/etc).

- `public static void render()` :<br>Render ImGui window & draw data.
Expand Down Expand Up @@ -83,4 +85,8 @@

- `public static ImGuiImplGl3 getGl3Impl()` :<br>Get GL ImGui implementation (`imgui-java` class).

<hr><p align="center">JlImGui v1.1.1</p>
- `public static int[] getKeysMap()` :<br>Get Raylib keys map.

- `public static String getVersion()` :<br>Get JlImGui version.

<hr><p align="center"><b>JlImGui v1.2.1</b></p>

0 comments on commit 70bd500

Please sign in to comment.