History

omar 9c8671e7b0 Tables: Add empty file, skeleton.		2020-12-04 19:15:19 +01:00
..
README.md	Moving backends code from examples/ to backends/ (step 3: fixing project files)	2020-10-14 14:41:40 +02:00
example_allegro5.vcxproj	Tables: Add empty file, skeleton.	2020-12-04 19:15:19 +01:00
example_allegro5.vcxproj.filters	Tables: Add empty file, skeleton.	2020-12-04 19:15:19 +01:00
imconfig_allegro5.h	Examples: Renamed example folders. (#1870 )	2018-06-10 15:42:14 +02:00
main.cpp	Moving backends code from examples/ to backends/ (step 6: update markdown documentation)	2020-10-14 14:42:00 +02:00

README.md

Configuration

Dear ImGui outputs 16-bit vertex indices by default. Allegro doesn't support them natively, so we have two solutions: convert the indices manually in imgui_impl_allegro5.cpp, or compile dear imgui with 32-bit indices. You can either modify imconfig.h that comes with Dear ImGui (easier), or set a C++ preprocessor option IMGUI_USER_CONFIG to find to a filename. We are providing imconfig_allegro5.h that enables 32-bit indices. Note that the backend supports BOTH 16-bit and 32-bit indices, but 32-bit indices will be slightly faster as they won't require a manual conversion.

How to Build

On Ubuntu 14.04+ and macOS

g++ -DIMGUI_USER_CONFIG=\"examples/example_allegro5/imconfig_allegro5.h\" -I .. -I ../.. main.cpp ../../backends/imgui_impl_allegro5.cpp ../../imgui*.cpp -lallegro -lallegro_main -lallegro_primitives -o allegro5_example

On macOS, install Allegro with homebrew: brew install allegro.

On Windows with Visual Studio's CLI

You may install Allegro using vcpkg:

git clone https://github.com/Microsoft/vcpkg
cd vcpkg
.\bootstrap-vcpkg.bat
.\vcpkg install allegro5
.\vcpkg integrate install    ; optional, automatically register include/libs in Visual Studio

Build:

set ALLEGRODIR=path_to_your_allegro5_folder
cl /Zi /MD /I %ALLEGRODIR%\include /DIMGUI_USER_CONFIG=\"examples/example_allegro5/imconfig_allegro5.h\" /I .. /I ..\.. main.cpp ..\..\backends\imgui_impl_allegro5.cpp ..\..\imgui*.cpp /link /LIBPATH:%ALLEGRODIR%\lib allegro-5.0.10-monolith-md.lib user32.lib