imgui_impl_allegro5.cpp 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583
  1. // dear imgui: Renderer + Platform Backend for Allegro 5
  2. // (Info: Allegro 5 is a cross-platform general purpose library for handling windows, inputs, graphics, etc.)
  3. // Implemented features:
  4. // [X] Renderer: User texture binding. Use 'ALLEGRO_BITMAP*' as ImTextureID. Read the FAQ about ImTextureID!
  5. // [X] Platform: Keyboard support. Since 1.87 we are using the io.AddKeyEvent() function. Pass ImGuiKey values to all key functions e.g. ImGui::IsKeyPressed(ImGuiKey_Space). [Legacy ALLEGRO_KEY_* values will also be supported unless IMGUI_DISABLE_OBSOLETE_KEYIO is set]
  6. // [X] Platform: Clipboard support (from Allegro 5.1.12)
  7. // [X] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'.
  8. // Issues:
  9. // [ ] Renderer: The renderer is suboptimal as we need to unindex our buffers and convert vertices manually.
  10. // [ ] Platform: Missing gamepad support.
  11. // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
  12. // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
  13. // If you are new to Dear ImGui, read documentation from the docs/ folder + read the top of imgui.cpp.
  14. // Read online: https://github.com/ocornut/imgui/tree/master/docs
  15. // CHANGELOG
  16. // (minor and older changes stripped away, please see git history for details)
  17. // 2022-10-11: Using 'nullptr' instead of 'NULL' as per our switch to C++11.
  18. // 2022-09-26: Inputs: Renamed ImGuiKey_ModXXX introduced in 1.87 to ImGuiMod_XXX (old names still supported).
  19. // 2022-01-26: Inputs: replaced short-lived io.AddKeyModsEvent() (added two weeks ago) with io.AddKeyEvent() using ImGuiKey_ModXXX flags. Sorry for the confusion.
  20. // 2022-01-17: Inputs: calling new io.AddMousePosEvent(), io.AddMouseButtonEvent(), io.AddMouseWheelEvent() API (1.87+).
  21. // 2022-01-17: Inputs: always calling io.AddKeyModsEvent() next and before key event (not in NewFrame) to fix input queue with very low framerates.
  22. // 2022-01-10: Inputs: calling new io.AddKeyEvent(), io.AddKeyModsEvent() + io.SetKeyEventNativeData() API (1.87+). Support for full ImGuiKey range.
  23. // 2021-12-08: Renderer: Fixed mishandling of the the ImDrawCmd::IdxOffset field! This is an old bug but it never had an effect until some internal rendering changes in 1.86.
  24. // 2021-08-17: Calling io.AddFocusEvent() on ALLEGRO_EVENT_DISPLAY_SWITCH_OUT/ALLEGRO_EVENT_DISPLAY_SWITCH_IN events.
  25. // 2021-06-29: Reorganized backend to pull data from a single structure to facilitate usage with multiple-contexts (all g_XXXX access changed to bd->XXXX).
  26. // 2021-05-19: Renderer: Replaced direct access to ImDrawCmd::TextureId with a call to ImDrawCmd::GetTexID(). (will become a requirement)
  27. // 2021-02-18: Change blending equation to preserve alpha in output buffer.
  28. // 2020-08-10: Inputs: Fixed horizontal mouse wheel direction.
  29. // 2019-12-05: Inputs: Added support for ImGuiMouseCursor_NotAllowed mouse cursor.
  30. // 2019-07-21: Inputs: Added mapping for ImGuiKey_KeyPadEnter.
  31. // 2019-05-11: Inputs: Don't filter character value from ALLEGRO_EVENT_KEY_CHAR before calling AddInputCharacter().
  32. // 2019-04-30: Renderer: Added support for special ImDrawCallback_ResetRenderState callback to reset render state.
  33. // 2018-11-30: Platform: Added touchscreen support.
  34. // 2018-11-30: Misc: Setting up io.BackendPlatformName/io.BackendRendererName so they can be displayed in the About Window.
  35. // 2018-06-13: Platform: Added clipboard support (from Allegro 5.1.12).
  36. // 2018-06-13: Renderer: Use draw_data->DisplayPos and draw_data->DisplaySize to setup projection matrix and clipping rectangle.
  37. // 2018-06-13: Renderer: Backup/restore transform and clipping rectangle.
  38. // 2018-06-11: Misc: Setup io.BackendFlags ImGuiBackendFlags_HasMouseCursors flag + honor ImGuiConfigFlags_NoMouseCursorChange flag.
  39. // 2018-04-18: Misc: Renamed file from imgui_impl_a5.cpp to imgui_impl_allegro5.cpp.
  40. // 2018-04-18: Misc: Added support for 32-bit vertex indices to avoid conversion at runtime. Added imconfig_allegro5.h to enforce 32-bit indices when included from imgui.h.
  41. // 2018-02-16: Misc: Obsoleted the io.RenderDrawListsFn callback and exposed ImGui_ImplAllegro5_RenderDrawData() in the .h file so you can call it yourself.
  42. // 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves.
  43. // 2018-02-06: Inputs: Added mapping for ImGuiKey_Space.
  44. #include <stdint.h> // uint64_t
  45. #include <cstring> // memcpy
  46. #include "imgui.h"
  47. #include "imgui_impl_allegro5.h"
  48. // Allegro
  49. #include <allegro5/allegro.h>
  50. #include <allegro5/allegro_primitives.h>
  51. #ifdef _WIN32
  52. #include <allegro5/allegro_windows.h>
  53. #endif
  54. #define ALLEGRO_HAS_CLIPBOARD (ALLEGRO_VERSION_INT >= ((5 << 24) | (1 << 16) | (12 << 8))) // Clipboard only supported from Allegro 5.1.12
  55. // Visual Studio warnings
  56. #ifdef _MSC_VER
  57. #pragma warning (disable: 4127) // condition expression is constant
  58. #endif
  59. // Allegro Data
  60. struct ImGui_ImplAllegro5_Data
  61. {
  62. ALLEGRO_DISPLAY* Display;
  63. ALLEGRO_BITMAP* Texture;
  64. double Time;
  65. ALLEGRO_MOUSE_CURSOR* MouseCursorInvisible;
  66. ALLEGRO_VERTEX_DECL* VertexDecl;
  67. char* ClipboardTextData;
  68. ImGui_ImplAllegro5_Data() { memset((void*)this, 0, sizeof(*this)); }
  69. };
  70. // Backend data stored in io.BackendPlatformUserData to allow support for multiple Dear ImGui contexts
  71. // It is STRONGLY preferred that you use docking branch with multi-viewports (== single Dear ImGui context + multiple windows) instead of multiple Dear ImGui contexts.
  72. // FIXME: multi-context support is not well tested and probably dysfunctional in this backend.
  73. static ImGui_ImplAllegro5_Data* ImGui_ImplAllegro5_GetBackendData() { return ImGui::GetCurrentContext() ? (ImGui_ImplAllegro5_Data*)ImGui::GetIO().BackendPlatformUserData : nullptr; }
  74. struct ImDrawVertAllegro
  75. {
  76. ImVec2 pos;
  77. ImVec2 uv;
  78. ALLEGRO_COLOR col;
  79. };
  80. static void ImGui_ImplAllegro5_SetupRenderState(ImDrawData* draw_data)
  81. {
  82. // Setup blending
  83. al_set_separate_blender(ALLEGRO_ADD, ALLEGRO_ALPHA, ALLEGRO_INVERSE_ALPHA, ALLEGRO_ADD, ALLEGRO_ONE, ALLEGRO_INVERSE_ALPHA);
  84. // Setup orthographic projection matrix
  85. // Our visible imgui space lies from draw_data->DisplayPos (top left) to draw_data->DisplayPos+data_data->DisplaySize (bottom right).
  86. {
  87. float L = draw_data->DisplayPos.x;
  88. float R = draw_data->DisplayPos.x + draw_data->DisplaySize.x;
  89. float T = draw_data->DisplayPos.y;
  90. float B = draw_data->DisplayPos.y + draw_data->DisplaySize.y;
  91. ALLEGRO_TRANSFORM transform;
  92. al_identity_transform(&transform);
  93. al_use_transform(&transform);
  94. al_orthographic_transform(&transform, L, T, 1.0f, R, B, -1.0f);
  95. al_use_projection_transform(&transform);
  96. }
  97. }
  98. // Render function.
  99. void ImGui_ImplAllegro5_RenderDrawData(ImDrawData* draw_data)
  100. {
  101. // Avoid rendering when minimized
  102. if (draw_data->DisplaySize.x <= 0.0f || draw_data->DisplaySize.y <= 0.0f)
  103. return;
  104. // Backup Allegro state that will be modified
  105. ImGui_ImplAllegro5_Data* bd = ImGui_ImplAllegro5_GetBackendData();
  106. ALLEGRO_TRANSFORM last_transform = *al_get_current_transform();
  107. ALLEGRO_TRANSFORM last_projection_transform = *al_get_current_projection_transform();
  108. int last_clip_x, last_clip_y, last_clip_w, last_clip_h;
  109. al_get_clipping_rectangle(&last_clip_x, &last_clip_y, &last_clip_w, &last_clip_h);
  110. int last_blender_op, last_blender_src, last_blender_dst;
  111. al_get_blender(&last_blender_op, &last_blender_src, &last_blender_dst);
  112. // Setup desired render state
  113. ImGui_ImplAllegro5_SetupRenderState(draw_data);
  114. // Render command lists
  115. for (int n = 0; n < draw_data->CmdListsCount; n++)
  116. {
  117. const ImDrawList* cmd_list = draw_data->CmdLists[n];
  118. // Allegro's implementation of al_draw_indexed_prim() for DX9 is completely broken. Unindex our buffers ourselves.
  119. // FIXME-OPT: Unfortunately Allegro doesn't support 32-bit packed colors so we have to convert them to 4 float as well..
  120. static ImVector<ImDrawVertAllegro> vertices;
  121. vertices.resize(cmd_list->IdxBuffer.Size);
  122. for (int i = 0; i < cmd_list->IdxBuffer.Size; i++)
  123. {
  124. const ImDrawVert* src_v = &cmd_list->VtxBuffer[cmd_list->IdxBuffer[i]];
  125. ImDrawVertAllegro* dst_v = &vertices[i];
  126. dst_v->pos = src_v->pos;
  127. dst_v->uv = src_v->uv;
  128. unsigned char* c = (unsigned char*)&src_v->col;
  129. dst_v->col = al_map_rgba(c[0], c[1], c[2], c[3]);
  130. }
  131. const int* indices = nullptr;
  132. if (sizeof(ImDrawIdx) == 2)
  133. {
  134. // FIXME-OPT: Unfortunately Allegro doesn't support 16-bit indices.. You can '#define ImDrawIdx int' in imconfig.h to request Dear ImGui to output 32-bit indices.
  135. // Otherwise, we convert them from 16-bit to 32-bit at runtime here, which works perfectly but is a little wasteful.
  136. static ImVector<int> indices_converted;
  137. indices_converted.resize(cmd_list->IdxBuffer.Size);
  138. for (int i = 0; i < cmd_list->IdxBuffer.Size; ++i)
  139. indices_converted[i] = (int)cmd_list->IdxBuffer.Data[i];
  140. indices = indices_converted.Data;
  141. }
  142. else if (sizeof(ImDrawIdx) == 4)
  143. {
  144. indices = (const int*)cmd_list->IdxBuffer.Data;
  145. }
  146. // Render command lists
  147. ImVec2 clip_off = draw_data->DisplayPos;
  148. for (int cmd_i = 0; cmd_i < cmd_list->CmdBuffer.Size; cmd_i++)
  149. {
  150. const ImDrawCmd* pcmd = &cmd_list->CmdBuffer[cmd_i];
  151. if (pcmd->UserCallback)
  152. {
  153. // User callback, registered via ImDrawList::AddCallback()
  154. // (ImDrawCallback_ResetRenderState is a special callback value used by the user to request the renderer to reset render state.)
  155. if (pcmd->UserCallback == ImDrawCallback_ResetRenderState)
  156. ImGui_ImplAllegro5_SetupRenderState(draw_data);
  157. else
  158. pcmd->UserCallback(cmd_list, pcmd);
  159. }
  160. else
  161. {
  162. // Project scissor/clipping rectangles into framebuffer space
  163. ImVec2 clip_min(pcmd->ClipRect.x - clip_off.x, pcmd->ClipRect.y - clip_off.y);
  164. ImVec2 clip_max(pcmd->ClipRect.z - clip_off.x, pcmd->ClipRect.w - clip_off.y);
  165. if (clip_max.x <= clip_min.x || clip_max.y <= clip_min.y)
  166. continue;
  167. // Apply scissor/clipping rectangle, Draw
  168. ALLEGRO_BITMAP* texture = (ALLEGRO_BITMAP*)pcmd->GetTexID();
  169. al_set_clipping_rectangle(clip_min.x, clip_min.y, clip_max.x - clip_min.x, clip_max.y - clip_min.y);
  170. al_draw_prim(&vertices[0], bd->VertexDecl, texture, pcmd->IdxOffset, pcmd->IdxOffset + pcmd->ElemCount, ALLEGRO_PRIM_TRIANGLE_LIST);
  171. }
  172. }
  173. }
  174. // Restore modified Allegro state
  175. al_set_blender(last_blender_op, last_blender_src, last_blender_dst);
  176. al_set_clipping_rectangle(last_clip_x, last_clip_y, last_clip_w, last_clip_h);
  177. al_use_transform(&last_transform);
  178. al_use_projection_transform(&last_projection_transform);
  179. }
  180. bool ImGui_ImplAllegro5_CreateDeviceObjects()
  181. {
  182. // Build texture atlas
  183. ImGui_ImplAllegro5_Data* bd = ImGui_ImplAllegro5_GetBackendData();
  184. ImGuiIO& io = ImGui::GetIO();
  185. unsigned char* pixels;
  186. int width, height;
  187. io.Fonts->GetTexDataAsRGBA32(&pixels, &width, &height);
  188. // Create texture
  189. // (Bilinear sampling is required by default. Set 'io.Fonts->Flags |= ImFontAtlasFlags_NoBakedLines' or 'style.AntiAliasedLinesUseTex = false' to allow point/nearest sampling)
  190. int flags = al_get_new_bitmap_flags();
  191. int fmt = al_get_new_bitmap_format();
  192. al_set_new_bitmap_flags(ALLEGRO_MEMORY_BITMAP | ALLEGRO_MIN_LINEAR | ALLEGRO_MAG_LINEAR);
  193. al_set_new_bitmap_format(ALLEGRO_PIXEL_FORMAT_ABGR_8888_LE);
  194. ALLEGRO_BITMAP* img = al_create_bitmap(width, height);
  195. al_set_new_bitmap_flags(flags);
  196. al_set_new_bitmap_format(fmt);
  197. if (!img)
  198. return false;
  199. ALLEGRO_LOCKED_REGION* locked_img = al_lock_bitmap(img, al_get_bitmap_format(img), ALLEGRO_LOCK_WRITEONLY);
  200. if (!locked_img)
  201. {
  202. al_destroy_bitmap(img);
  203. return false;
  204. }
  205. memcpy(locked_img->data, pixels, sizeof(int) * width * height);
  206. al_unlock_bitmap(img);
  207. // Convert software texture to hardware texture.
  208. ALLEGRO_BITMAP* cloned_img = al_clone_bitmap(img);
  209. al_destroy_bitmap(img);
  210. if (!cloned_img)
  211. return false;
  212. // Store our identifier
  213. io.Fonts->SetTexID((ImTextureID)(intptr_t)cloned_img);
  214. bd->Texture = cloned_img;
  215. // Create an invisible mouse cursor
  216. // Because al_hide_mouse_cursor() seems to mess up with the actual inputs..
  217. ALLEGRO_BITMAP* mouse_cursor = al_create_bitmap(8, 8);
  218. bd->MouseCursorInvisible = al_create_mouse_cursor(mouse_cursor, 0, 0);
  219. al_destroy_bitmap(mouse_cursor);
  220. return true;
  221. }
  222. void ImGui_ImplAllegro5_InvalidateDeviceObjects()
  223. {
  224. ImGuiIO& io = ImGui::GetIO();
  225. ImGui_ImplAllegro5_Data* bd = ImGui_ImplAllegro5_GetBackendData();
  226. if (bd->Texture)
  227. {
  228. io.Fonts->SetTexID(nullptr);
  229. al_destroy_bitmap(bd->Texture);
  230. bd->Texture = nullptr;
  231. }
  232. if (bd->MouseCursorInvisible)
  233. {
  234. al_destroy_mouse_cursor(bd->MouseCursorInvisible);
  235. bd->MouseCursorInvisible = nullptr;
  236. }
  237. }
  238. #if ALLEGRO_HAS_CLIPBOARD
  239. static const char* ImGui_ImplAllegro5_GetClipboardText(void*)
  240. {
  241. ImGui_ImplAllegro5_Data* bd = ImGui_ImplAllegro5_GetBackendData();
  242. if (bd->ClipboardTextData)
  243. al_free(bd->ClipboardTextData);
  244. bd->ClipboardTextData = al_get_clipboard_text(bd->Display);
  245. return bd->ClipboardTextData;
  246. }
  247. static void ImGui_ImplAllegro5_SetClipboardText(void*, const char* text)
  248. {
  249. ImGui_ImplAllegro5_Data* bd = ImGui_ImplAllegro5_GetBackendData();
  250. al_set_clipboard_text(bd->Display, text);
  251. }
  252. #endif
  253. static ImGuiKey ImGui_ImplAllegro5_KeyCodeToImGuiKey(int key_code)
  254. {
  255. switch (key_code)
  256. {
  257. case ALLEGRO_KEY_TAB: return ImGuiKey_Tab;
  258. case ALLEGRO_KEY_LEFT: return ImGuiKey_LeftArrow;
  259. case ALLEGRO_KEY_RIGHT: return ImGuiKey_RightArrow;
  260. case ALLEGRO_KEY_UP: return ImGuiKey_UpArrow;
  261. case ALLEGRO_KEY_DOWN: return ImGuiKey_DownArrow;
  262. case ALLEGRO_KEY_PGUP: return ImGuiKey_PageUp;
  263. case ALLEGRO_KEY_PGDN: return ImGuiKey_PageDown;
  264. case ALLEGRO_KEY_HOME: return ImGuiKey_Home;
  265. case ALLEGRO_KEY_END: return ImGuiKey_End;
  266. case ALLEGRO_KEY_INSERT: return ImGuiKey_Insert;
  267. case ALLEGRO_KEY_DELETE: return ImGuiKey_Delete;
  268. case ALLEGRO_KEY_BACKSPACE: return ImGuiKey_Backspace;
  269. case ALLEGRO_KEY_SPACE: return ImGuiKey_Space;
  270. case ALLEGRO_KEY_ENTER: return ImGuiKey_Enter;
  271. case ALLEGRO_KEY_ESCAPE: return ImGuiKey_Escape;
  272. case ALLEGRO_KEY_QUOTE: return ImGuiKey_Apostrophe;
  273. case ALLEGRO_KEY_COMMA: return ImGuiKey_Comma;
  274. case ALLEGRO_KEY_MINUS: return ImGuiKey_Minus;
  275. case ALLEGRO_KEY_FULLSTOP: return ImGuiKey_Period;
  276. case ALLEGRO_KEY_SLASH: return ImGuiKey_Slash;
  277. case ALLEGRO_KEY_SEMICOLON: return ImGuiKey_Semicolon;
  278. case ALLEGRO_KEY_EQUALS: return ImGuiKey_Equal;
  279. case ALLEGRO_KEY_OPENBRACE: return ImGuiKey_LeftBracket;
  280. case ALLEGRO_KEY_BACKSLASH: return ImGuiKey_Backslash;
  281. case ALLEGRO_KEY_CLOSEBRACE: return ImGuiKey_RightBracket;
  282. case ALLEGRO_KEY_TILDE: return ImGuiKey_GraveAccent;
  283. case ALLEGRO_KEY_CAPSLOCK: return ImGuiKey_CapsLock;
  284. case ALLEGRO_KEY_SCROLLLOCK: return ImGuiKey_ScrollLock;
  285. case ALLEGRO_KEY_NUMLOCK: return ImGuiKey_NumLock;
  286. case ALLEGRO_KEY_PRINTSCREEN: return ImGuiKey_PrintScreen;
  287. case ALLEGRO_KEY_PAUSE: return ImGuiKey_Pause;
  288. case ALLEGRO_KEY_PAD_0: return ImGuiKey_Keypad0;
  289. case ALLEGRO_KEY_PAD_1: return ImGuiKey_Keypad1;
  290. case ALLEGRO_KEY_PAD_2: return ImGuiKey_Keypad2;
  291. case ALLEGRO_KEY_PAD_3: return ImGuiKey_Keypad3;
  292. case ALLEGRO_KEY_PAD_4: return ImGuiKey_Keypad4;
  293. case ALLEGRO_KEY_PAD_5: return ImGuiKey_Keypad5;
  294. case ALLEGRO_KEY_PAD_6: return ImGuiKey_Keypad6;
  295. case ALLEGRO_KEY_PAD_7: return ImGuiKey_Keypad7;
  296. case ALLEGRO_KEY_PAD_8: return ImGuiKey_Keypad8;
  297. case ALLEGRO_KEY_PAD_9: return ImGuiKey_Keypad9;
  298. case ALLEGRO_KEY_PAD_DELETE: return ImGuiKey_KeypadDecimal;
  299. case ALLEGRO_KEY_PAD_SLASH: return ImGuiKey_KeypadDivide;
  300. case ALLEGRO_KEY_PAD_ASTERISK: return ImGuiKey_KeypadMultiply;
  301. case ALLEGRO_KEY_PAD_MINUS: return ImGuiKey_KeypadSubtract;
  302. case ALLEGRO_KEY_PAD_PLUS: return ImGuiKey_KeypadAdd;
  303. case ALLEGRO_KEY_PAD_ENTER: return ImGuiKey_KeypadEnter;
  304. case ALLEGRO_KEY_PAD_EQUALS: return ImGuiKey_KeypadEqual;
  305. case ALLEGRO_KEY_LCTRL: return ImGuiKey_LeftCtrl;
  306. case ALLEGRO_KEY_LSHIFT: return ImGuiKey_LeftShift;
  307. case ALLEGRO_KEY_ALT: return ImGuiKey_LeftAlt;
  308. case ALLEGRO_KEY_LWIN: return ImGuiKey_LeftSuper;
  309. case ALLEGRO_KEY_RCTRL: return ImGuiKey_RightCtrl;
  310. case ALLEGRO_KEY_RSHIFT: return ImGuiKey_RightShift;
  311. case ALLEGRO_KEY_ALTGR: return ImGuiKey_RightAlt;
  312. case ALLEGRO_KEY_RWIN: return ImGuiKey_RightSuper;
  313. case ALLEGRO_KEY_MENU: return ImGuiKey_Menu;
  314. case ALLEGRO_KEY_0: return ImGuiKey_0;
  315. case ALLEGRO_KEY_1: return ImGuiKey_1;
  316. case ALLEGRO_KEY_2: return ImGuiKey_2;
  317. case ALLEGRO_KEY_3: return ImGuiKey_3;
  318. case ALLEGRO_KEY_4: return ImGuiKey_4;
  319. case ALLEGRO_KEY_5: return ImGuiKey_5;
  320. case ALLEGRO_KEY_6: return ImGuiKey_6;
  321. case ALLEGRO_KEY_7: return ImGuiKey_7;
  322. case ALLEGRO_KEY_8: return ImGuiKey_8;
  323. case ALLEGRO_KEY_9: return ImGuiKey_9;
  324. case ALLEGRO_KEY_A: return ImGuiKey_A;
  325. case ALLEGRO_KEY_B: return ImGuiKey_B;
  326. case ALLEGRO_KEY_C: return ImGuiKey_C;
  327. case ALLEGRO_KEY_D: return ImGuiKey_D;
  328. case ALLEGRO_KEY_E: return ImGuiKey_E;
  329. case ALLEGRO_KEY_F: return ImGuiKey_F;
  330. case ALLEGRO_KEY_G: return ImGuiKey_G;
  331. case ALLEGRO_KEY_H: return ImGuiKey_H;
  332. case ALLEGRO_KEY_I: return ImGuiKey_I;
  333. case ALLEGRO_KEY_J: return ImGuiKey_J;
  334. case ALLEGRO_KEY_K: return ImGuiKey_K;
  335. case ALLEGRO_KEY_L: return ImGuiKey_L;
  336. case ALLEGRO_KEY_M: return ImGuiKey_M;
  337. case ALLEGRO_KEY_N: return ImGuiKey_N;
  338. case ALLEGRO_KEY_O: return ImGuiKey_O;
  339. case ALLEGRO_KEY_P: return ImGuiKey_P;
  340. case ALLEGRO_KEY_Q: return ImGuiKey_Q;
  341. case ALLEGRO_KEY_R: return ImGuiKey_R;
  342. case ALLEGRO_KEY_S: return ImGuiKey_S;
  343. case ALLEGRO_KEY_T: return ImGuiKey_T;
  344. case ALLEGRO_KEY_U: return ImGuiKey_U;
  345. case ALLEGRO_KEY_V: return ImGuiKey_V;
  346. case ALLEGRO_KEY_W: return ImGuiKey_W;
  347. case ALLEGRO_KEY_X: return ImGuiKey_X;
  348. case ALLEGRO_KEY_Y: return ImGuiKey_Y;
  349. case ALLEGRO_KEY_Z: return ImGuiKey_Z;
  350. case ALLEGRO_KEY_F1: return ImGuiKey_F1;
  351. case ALLEGRO_KEY_F2: return ImGuiKey_F2;
  352. case ALLEGRO_KEY_F3: return ImGuiKey_F3;
  353. case ALLEGRO_KEY_F4: return ImGuiKey_F4;
  354. case ALLEGRO_KEY_F5: return ImGuiKey_F5;
  355. case ALLEGRO_KEY_F6: return ImGuiKey_F6;
  356. case ALLEGRO_KEY_F7: return ImGuiKey_F7;
  357. case ALLEGRO_KEY_F8: return ImGuiKey_F8;
  358. case ALLEGRO_KEY_F9: return ImGuiKey_F9;
  359. case ALLEGRO_KEY_F10: return ImGuiKey_F10;
  360. case ALLEGRO_KEY_F11: return ImGuiKey_F11;
  361. case ALLEGRO_KEY_F12: return ImGuiKey_F12;
  362. default: return ImGuiKey_None;
  363. }
  364. }
  365. bool ImGui_ImplAllegro5_Init(ALLEGRO_DISPLAY* display)
  366. {
  367. ImGuiIO& io = ImGui::GetIO();
  368. IM_ASSERT(io.BackendPlatformUserData == nullptr && "Already initialized a platform backend!");
  369. // Setup backend capabilities flags
  370. ImGui_ImplAllegro5_Data* bd = IM_NEW(ImGui_ImplAllegro5_Data)();
  371. io.BackendPlatformUserData = (void*)bd;
  372. io.BackendPlatformName = io.BackendRendererName = "imgui_impl_allegro5";
  373. io.BackendFlags |= ImGuiBackendFlags_HasMouseCursors; // We can honor GetMouseCursor() values (optional)
  374. bd->Display = display;
  375. // Create custom vertex declaration.
  376. // Unfortunately Allegro doesn't support 32-bit packed colors so we have to convert them to 4 floats.
  377. // We still use a custom declaration to use 'ALLEGRO_PRIM_TEX_COORD' instead of 'ALLEGRO_PRIM_TEX_COORD_PIXEL' else we can't do a reliable conversion.
  378. ALLEGRO_VERTEX_ELEMENT elems[] =
  379. {
  380. { ALLEGRO_PRIM_POSITION, ALLEGRO_PRIM_FLOAT_2, IM_OFFSETOF(ImDrawVertAllegro, pos) },
  381. { ALLEGRO_PRIM_TEX_COORD, ALLEGRO_PRIM_FLOAT_2, IM_OFFSETOF(ImDrawVertAllegro, uv) },
  382. { ALLEGRO_PRIM_COLOR_ATTR, 0, IM_OFFSETOF(ImDrawVertAllegro, col) },
  383. { 0, 0, 0 }
  384. };
  385. bd->VertexDecl = al_create_vertex_decl(elems, sizeof(ImDrawVertAllegro));
  386. #if ALLEGRO_HAS_CLIPBOARD
  387. io.SetClipboardTextFn = ImGui_ImplAllegro5_SetClipboardText;
  388. io.GetClipboardTextFn = ImGui_ImplAllegro5_GetClipboardText;
  389. io.ClipboardUserData = nullptr;
  390. #endif
  391. return true;
  392. }
  393. void ImGui_ImplAllegro5_Shutdown()
  394. {
  395. ImGui_ImplAllegro5_Data* bd = ImGui_ImplAllegro5_GetBackendData();
  396. IM_ASSERT(bd != nullptr && "No platform backend to shutdown, or already shutdown?");
  397. ImGuiIO& io = ImGui::GetIO();
  398. ImGui_ImplAllegro5_InvalidateDeviceObjects();
  399. if (bd->VertexDecl)
  400. al_destroy_vertex_decl(bd->VertexDecl);
  401. if (bd->ClipboardTextData)
  402. al_free(bd->ClipboardTextData);
  403. io.BackendPlatformUserData = nullptr;
  404. io.BackendPlatformName = io.BackendRendererName = nullptr;
  405. IM_DELETE(bd);
  406. }
  407. // ev->keyboard.modifiers seems always zero so using that...
  408. static void ImGui_ImplAllegro5_UpdateKeyModifiers()
  409. {
  410. ImGuiIO& io = ImGui::GetIO();
  411. ALLEGRO_KEYBOARD_STATE keys;
  412. al_get_keyboard_state(&keys);
  413. io.AddKeyEvent(ImGuiMod_Ctrl, al_key_down(&keys, ALLEGRO_KEY_LCTRL) || al_key_down(&keys, ALLEGRO_KEY_RCTRL));
  414. io.AddKeyEvent(ImGuiMod_Shift, al_key_down(&keys, ALLEGRO_KEY_LSHIFT) || al_key_down(&keys, ALLEGRO_KEY_RSHIFT));
  415. io.AddKeyEvent(ImGuiMod_Alt, al_key_down(&keys, ALLEGRO_KEY_ALT) || al_key_down(&keys, ALLEGRO_KEY_ALTGR));
  416. io.AddKeyEvent(ImGuiMod_Super, al_key_down(&keys, ALLEGRO_KEY_LWIN) || al_key_down(&keys, ALLEGRO_KEY_RWIN));
  417. }
  418. // You can read the io.WantCaptureMouse, io.WantCaptureKeyboard flags to tell if dear imgui wants to use your inputs.
  419. // - When io.WantCaptureMouse is true, do not dispatch mouse input data to your main application, or clear/overwrite your copy of the mouse data.
  420. // - When io.WantCaptureKeyboard is true, do not dispatch keyboard input data to your main application, or clear/overwrite your copy of the keyboard data.
  421. // Generally you may always pass all inputs to dear imgui, and hide them from your application based on those two flags.
  422. bool ImGui_ImplAllegro5_ProcessEvent(ALLEGRO_EVENT* ev)
  423. {
  424. ImGuiIO& io = ImGui::GetIO();
  425. ImGui_ImplAllegro5_Data* bd = ImGui_ImplAllegro5_GetBackendData();
  426. switch (ev->type)
  427. {
  428. case ALLEGRO_EVENT_MOUSE_AXES:
  429. if (ev->mouse.display == bd->Display)
  430. {
  431. io.AddMousePosEvent(ev->mouse.x, ev->mouse.y);
  432. io.AddMouseWheelEvent(-ev->mouse.dw, ev->mouse.dz);
  433. }
  434. return true;
  435. case ALLEGRO_EVENT_MOUSE_BUTTON_DOWN:
  436. case ALLEGRO_EVENT_MOUSE_BUTTON_UP:
  437. if (ev->mouse.display == bd->Display && ev->mouse.button > 0 && ev->mouse.button <= 5)
  438. io.AddMouseButtonEvent(ev->mouse.button - 1, ev->type == ALLEGRO_EVENT_MOUSE_BUTTON_DOWN);
  439. return true;
  440. case ALLEGRO_EVENT_TOUCH_MOVE:
  441. if (ev->touch.display == bd->Display)
  442. io.AddMousePosEvent(ev->touch.x, ev->touch.y);
  443. return true;
  444. case ALLEGRO_EVENT_TOUCH_BEGIN:
  445. case ALLEGRO_EVENT_TOUCH_END:
  446. case ALLEGRO_EVENT_TOUCH_CANCEL:
  447. if (ev->touch.display == bd->Display && ev->touch.primary)
  448. io.AddMouseButtonEvent(0, ev->type == ALLEGRO_EVENT_TOUCH_BEGIN);
  449. return true;
  450. case ALLEGRO_EVENT_MOUSE_LEAVE_DISPLAY:
  451. if (ev->mouse.display == bd->Display)
  452. io.AddMousePosEvent(-FLT_MAX, -FLT_MAX);
  453. return true;
  454. case ALLEGRO_EVENT_KEY_CHAR:
  455. if (ev->keyboard.display == bd->Display)
  456. if (ev->keyboard.unichar != 0)
  457. io.AddInputCharacter((unsigned int)ev->keyboard.unichar);
  458. return true;
  459. case ALLEGRO_EVENT_KEY_DOWN:
  460. case ALLEGRO_EVENT_KEY_UP:
  461. if (ev->keyboard.display == bd->Display)
  462. {
  463. ImGui_ImplAllegro5_UpdateKeyModifiers();
  464. ImGuiKey key = ImGui_ImplAllegro5_KeyCodeToImGuiKey(ev->keyboard.keycode);
  465. io.AddKeyEvent(key, (ev->type == ALLEGRO_EVENT_KEY_DOWN));
  466. io.SetKeyEventNativeData(key, ev->keyboard.keycode, -1); // To support legacy indexing (<1.87 user code)
  467. }
  468. return true;
  469. case ALLEGRO_EVENT_DISPLAY_SWITCH_OUT:
  470. if (ev->display.source == bd->Display)
  471. io.AddFocusEvent(false);
  472. return true;
  473. case ALLEGRO_EVENT_DISPLAY_SWITCH_IN:
  474. if (ev->display.source == bd->Display)
  475. {
  476. io.AddFocusEvent(true);
  477. #if defined(ALLEGRO_UNSTABLE)
  478. al_clear_keyboard_state(bd->Display);
  479. #endif
  480. }
  481. return true;
  482. }
  483. return false;
  484. }
  485. static void ImGui_ImplAllegro5_UpdateMouseCursor()
  486. {
  487. ImGuiIO& io = ImGui::GetIO();
  488. if (io.ConfigFlags & ImGuiConfigFlags_NoMouseCursorChange)
  489. return;
  490. ImGui_ImplAllegro5_Data* bd = ImGui_ImplAllegro5_GetBackendData();
  491. ImGuiMouseCursor imgui_cursor = ImGui::GetMouseCursor();
  492. if (io.MouseDrawCursor || imgui_cursor == ImGuiMouseCursor_None)
  493. {
  494. // Hide OS mouse cursor if imgui is drawing it or if it wants no cursor
  495. al_set_mouse_cursor(bd->Display, bd->MouseCursorInvisible);
  496. }
  497. else
  498. {
  499. ALLEGRO_SYSTEM_MOUSE_CURSOR cursor_id = ALLEGRO_SYSTEM_MOUSE_CURSOR_DEFAULT;
  500. switch (imgui_cursor)
  501. {
  502. case ImGuiMouseCursor_TextInput: cursor_id = ALLEGRO_SYSTEM_MOUSE_CURSOR_EDIT; break;
  503. case ImGuiMouseCursor_ResizeAll: cursor_id = ALLEGRO_SYSTEM_MOUSE_CURSOR_MOVE; break;
  504. case ImGuiMouseCursor_ResizeNS: cursor_id = ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_N; break;
  505. case ImGuiMouseCursor_ResizeEW: cursor_id = ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_E; break;
  506. case ImGuiMouseCursor_ResizeNESW: cursor_id = ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_NE; break;
  507. case ImGuiMouseCursor_ResizeNWSE: cursor_id = ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_NW; break;
  508. case ImGuiMouseCursor_NotAllowed: cursor_id = ALLEGRO_SYSTEM_MOUSE_CURSOR_UNAVAILABLE; break;
  509. }
  510. al_set_system_mouse_cursor(bd->Display, cursor_id);
  511. }
  512. }
  513. void ImGui_ImplAllegro5_NewFrame()
  514. {
  515. ImGui_ImplAllegro5_Data* bd = ImGui_ImplAllegro5_GetBackendData();
  516. IM_ASSERT(bd != nullptr && "Did you call ImGui_ImplAllegro5_Init()?");
  517. if (!bd->Texture)
  518. ImGui_ImplAllegro5_CreateDeviceObjects();
  519. ImGuiIO& io = ImGui::GetIO();
  520. // Setup display size (every frame to accommodate for window resizing)
  521. int w, h;
  522. w = al_get_display_width(bd->Display);
  523. h = al_get_display_height(bd->Display);
  524. io.DisplaySize = ImVec2((float)w, (float)h);
  525. // Setup time step
  526. double current_time = al_get_time();
  527. io.DeltaTime = bd->Time > 0.0 ? (float)(current_time - bd->Time) : (float)(1.0f / 60.0f);
  528. bd->Time = current_time;
  529. // Setup mouse cursor shape
  530. ImGui_ImplAllegro5_UpdateMouseCursor();
  531. }