imgui/backends/imgui_impl_allegro5.h

// dear imgui: Renderer + Platform Backend for Allegro 5
// (Info: Allegro 5 is a cross-platform general purpose library for handling windows, inputs, graphics, etc.)

// Implemented features:
//  [X] Renderer: User texture binding. Use 'ALLEGRO_BITMAP*' as ImTextureID. Read the FAQ about ImTextureID!
//  [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]
//  [X] Platform: Clipboard support (from Allegro 5.1.12)
//  [X] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'.
// Issues:
//  [ ] Renderer: The renderer is suboptimal as we need to unindex our buffers and convert vertices manually.
//  [ ] Platform: Missing gamepad support.

// You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
// Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
// If you are new to Dear ImGui, read documentation from the docs/ folder + read the top of imgui.cpp.
// Read online: https://github.com/ocornut/imgui/tree/master/docs

#pragma once
#include "imgui.h"      // IMGUI_IMPL_API
#ifndef IMGUI_DISABLE

struct ALLEGRO_DISPLAY;
union ALLEGRO_EVENT;

IMGUI_IMPL_API bool     ImGui_ImplAllegro5_Init(ALLEGRO_DISPLAY* display);
IMGUI_IMPL_API void     ImGui_ImplAllegro5_Shutdown();
IMGUI_IMPL_API void     ImGui_ImplAllegro5_NewFrame();
IMGUI_IMPL_API void     ImGui_ImplAllegro5_RenderDrawData(ImDrawData* draw_data);
IMGUI_IMPL_API bool     ImGui_ImplAllegro5_ProcessEvent(ALLEGRO_EVENT* event);

// Use if you want to reset your rendering device without losing Dear ImGui state.
IMGUI_IMPL_API bool     ImGui_ImplAllegro5_CreateDeviceObjects();
IMGUI_IMPL_API void     ImGui_ImplAllegro5_InvalidateDeviceObjects();

#endif // #ifndef IMGUI_DISABLE
Docs: Renamed all occurences of "binding" and "back-end" to "backend" in comments and documentations, for consistency. 2020-10-12 23:34:22 +08:00			`// dear imgui: Renderer + Platform Backend for Allegro 5`
Big example binding refactor (manually imported from Viewport branch, stripped out of Viewport code). (#1870) Read examples/README.txt for some details. ImDrawData: Added DisplayPos, DisplaySize fields honored by all backends (not strictly necessary to honor just now, but doing it to be ahead) 2018-06-09 01:37:33 +08:00			`// (Info: Allegro 5 is a cross-platform general purpose library for handling windows, inputs, graphics, etc.)`
Examples: Organized header files to make available features more visible. 2018-02-06 03:34:11 +08:00
			`// Implemented features:`
Fixed more FAQ links. (#2848) 2019-10-16 17:23:15 +08:00			`// [X] Renderer: User texture binding. Use 'ALLEGRO_BITMAP*' as ImTextureID. Read the FAQ about ImTextureID!`
Backends: Allegro5: Update to use io.AddEventKey() will full key map (#2625, #4858) 2021-12-12 18:58:50 +08:00			`// [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]`
Examples: Referring to missing gamepad support in back-end that are missing it. 2018-09-20 16:37:55 +08:00			`// [X] Platform: Clipboard support (from Allegro 5.1.12)`
Examples: Comments to make ImGuiConfigFlags_NoMouseCursorChange more visible (#1027). + Allegro5: Added support for ImGuiConfigFlags_NoMouseCursorChange flag. 2018-06-11 18:33:51 +08:00			`// [X] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags \|= ImGuiConfigFlags_NoMouseCursorChange'.`
			`// Issues:`
Examples: Referring to missing gamepad support in back-end that are missing it. 2018-09-20 16:37:55 +08:00			`// [ ] Renderer: The renderer is suboptimal as we need to unindex our buffers and convert vertices manually.`
			`// [ ] Platform: Missing gamepad support.`
FAQ and comments about the use of ImTextureID (#562, #561, #521, #510, #497, #475 ...) 2016-03-24 18:00:47 +08:00
Backends: Allegro5: Update to use io.AddEventKey() will full key map (#2625, #4858) 2021-12-12 18:58:50 +08:00			`// You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.`
Backends: Comments. 2021-05-27 19:59:35 +08:00			`// Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.`
Moving backends code from examples/ to backends/ (step 6: update markdown documentation) 2020-10-14 18:22:53 +08:00			`// If you are new to Dear ImGui, read documentation from the docs/ folder + read the top of imgui.cpp.`
			`// Read online: https://github.com/ocornut/imgui/tree/master/docs`
Allegro5 example: added example from https://github.com/bggd/a5imgui_example 2015-07-09 01:34:36 +08:00
			`#pragma once`
Backends: Comments next to include, misc minor comments/tweaks, fix imgui_impl_osx.h using IMGUI_API instead of IMGUI_IMPL_API. (#3105) 2020-04-07 17:02:29 +08:00			`#include "imgui.h" // IMGUI_IMPL_API`
Backends: Made all backends sources files support global IMGUI_DISABLE. (#6601) 2023-07-13 17:27:52 +08:00			`#ifndef IMGUI_DISABLE`
Backends: Include imgui.h in implementation headers. (#3105) Currently, the implementation headers don't include the imgui.h header. Which means that the compilation will fail if the implementation header was included before the imgui.h header in the compilation unit. For instance, a compilation unit with the following will work: #include "imgui.h" #include "imgui_impl_glfw.h" #include "imgui_impl_opengl3.h" But a compilation unit with the following will fail because IMGUI_IMPL_API and possibly other symbols will not be defined: #include "imgui_impl_glfw.h" #include "imgui_impl_opengl3.h" #include "imgui.h" This patch includes imgui.h in the implementation headers to make inclusions order-invariant, which is a recommended practice. 2020-04-07 02:23:57 +08:00
Allegro5 example: added example from https://github.com/bggd/a5imgui_example 2015-07-09 01:34:36 +08:00			`struct ALLEGRO_DISPLAY;`
			`union ALLEGRO_EVENT;`

Examples: The functions in imgui_impl_xxx.cpp are prefixed with IMGUI_IMPL_API (which defaults to IMGUI_API) to facilitate some uses. (#1888) + Comments in imgui.h 2018-06-21 18:04:00 +08:00			`IMGUI_IMPL_API bool ImGui_ImplAllegro5_Init(ALLEGRO_DISPLAY* display);`
			`IMGUI_IMPL_API void ImGui_ImplAllegro5_Shutdown();`
			`IMGUI_IMPL_API void ImGui_ImplAllegro5_NewFrame();`
			`IMGUI_IMPL_API void ImGui_ImplAllegro5_RenderDrawData(ImDrawData* draw_data);`
			`IMGUI_IMPL_API bool ImGui_ImplAllegro5_ProcessEvent(ALLEGRO_EVENT* event);`
Allegro5 example: added example from https://github.com/bggd/a5imgui_example 2015-07-09 01:34:36 +08:00
Backends: Comments next to include, misc minor comments/tweaks, fix imgui_impl_osx.h using IMGUI_API instead of IMGUI_IMPL_API. (#3105) 2020-04-07 17:02:29 +08:00			`// Use if you want to reset your rendering device without losing Dear ImGui state.`
Examples: The functions in imgui_impl_xxx.cpp are prefixed with IMGUI_IMPL_API (which defaults to IMGUI_API) to facilitate some uses. (#1888) + Comments in imgui.h 2018-06-21 18:04:00 +08:00			`IMGUI_IMPL_API bool ImGui_ImplAllegro5_CreateDeviceObjects();`
			`IMGUI_IMPL_API void ImGui_ImplAllegro5_InvalidateDeviceObjects();`
Backends: Made all backends sources files support global IMGUI_DISABLE. (#6601) 2023-07-13 17:27:52 +08:00
			`#endif // #ifndef IMGUI_DISABLE`