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

source code of imgui/backends/imgui_impl_allegro5.cpp