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

source code of imgui/backends/imgui_impl_allegro5.cpp