Skip to content

Commit 002d0fc

Browse files
ocornutIntrets
authored andcommitted
Docs: tweaks. Add reference to imgui-module from main README. (ocornut#9092, ocornut#8868)
1 parent bc84927 commit 002d0fc

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

docs/CHANGELOG.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,8 @@ Other Changes:
5656
- Backends:
5757
- Vulkan: helper for creating a swapchain (used by examples and multi-viewports)
5858
selects `VkSwapchainCreateInfoKHR`'s `compositeAlpha` value based on
59-
`cap.supportedCompositeAlpha`. (#8784) [@FelixStach]
59+
`cap.supportedCompositeAlpha`, which seems to be required on some Android
60+
devices. (#8784) [@FelixStach]
6061

6162

6263
-----------------------------------------------------------------------

docs/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,12 @@ Dear ImGui is particularly suited to integration in game engines (for tooling),
3939

4040
### Usage
4141

42-
**The core of Dear ImGui is self-contained within a few platform-agnostic files** which you can easily compile in your application/engine. They are all the files in the root folder of the repository (imgui*.cpp, imgui*.h). **No specific build process is required**. You can add the .cpp files into your existing project.
42+
**The core of Dear ImGui is self-contained within a few platform-agnostic files** which you can easily compile in your application/engine. They are all the files in the root folder of the repository (`imgui*.cpp`, `imgui*.h`). **No specific build process is required**: you can add all files into your existing project.
4343

4444
**Backends for a variety of graphics API and rendering platforms** are provided in the [backends/](https://github.com/ocornut/imgui/tree/master/backends) folder, along with example applications in the [examples/](https://github.com/ocornut/imgui/tree/master/examples) folder. You may also create your own backend. Anywhere where you can render textured triangles, you can render Dear ImGui.
4545

46+
C++20 users wishing to use a module may the use [stripe2933/imgui-module](https://github.com/stripe2933/imgui-module) third-party extension.
47+
4648
See the [Getting Started & Integration](#getting-started--integration) section of this document for more details.
4749

4850
After Dear ImGui is set up in your application, you can use it from \_anywhere\_ in your program loop:

imgui.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4326,7 +4326,7 @@ void ImGui::Initialize()
43264326
g.Viewports.push_back(viewport);
43274327
g.TempBuffer.resize(1024 * 3 + 1, 0);
43284328

4329-
// Build KeysMayBeCharInput[] lookup table (1 bool per named key)
4329+
// Build KeysMayBeCharInput[] lookup table (1 bit per named key)
43304330
for (ImGuiKey key = ImGuiKey_NamedKey_BEGIN; key < ImGuiKey_NamedKey_END; key = (ImGuiKey)(key + 1))
43314331
if ((key >= ImGuiKey_0 && key <= ImGuiKey_9) || (key >= ImGuiKey_A && key <= ImGuiKey_Z) || (key >= ImGuiKey_Keypad0 && key <= ImGuiKey_Keypad9)
43324332
|| key == ImGuiKey_Tab || key == ImGuiKey_Space || key == ImGuiKey_Apostrophe || key == ImGuiKey_Comma || key == ImGuiKey_Minus || key == ImGuiKey_Period

0 commit comments

Comments
 (0)