3.9 KiB
cimgui 
This is a thin c-api wrapper programmatically generated for the excellent C++ immediate mode gui Dear ImGui.
All functions are programmatically wrapped except constructors, destructors and ImVector. (Unless someone find a use case for them)
Generated files are: cimgui.cpp, cimgui.h for C compilation. Also for helping in bindings creation, definitions.lua with function definition information and structs_and_enums.lua.
This library is intended as a intermediate layer to be able to use Dear ImGui from other languages that can interface with C (like D - see D-binding)
History:
Initially cimgui was developed by Stephan Dilly as hand-written code but lately turned into an auto-generated version by sonoro1234 in order to keep up with imgui more easily (letting the user select the desired branch and commit)
Notes:
- currently this wrapper is based on version [1.65 of Dear ImGui]
- overloaded function names try to be the most compatible with traditional cimgui names. So all naming is algorithmic except for those names that were in conflict with widely used cimgui names and were thus coded in a table (https://github.com/cimgui/cimgui/blob/master/generator/generator.lua#L40). Current overloaded function names can be found in (https://github.com/cimgui/cimgui/blob/master/generator/output/overloads.txt)
compilation
- clone
- git clone --recursive https://github.com/cimgui/cimgui.git
- git submodule update
- make using makefile on linux/macOS/mingw (Or use CMake to generate project)
auto binding generation
- you will need LuaJIT (https://github.com/LuaJIT/LuaJIT.git better 2.1 branch) or precompiled for linux/macOS/windows in https://luapower.com/luajit/download
- need also gcc compiler for doing preprocessing (In windows MinGW-W64-builds for example)
- update
imguifolder to the version you desire. - run
generator/generator.bat(or make a .sh version and please PR) with gcc and LuaJIT on your PATH. - as a result some files are generated:
cimgui.cppandcimgui.hfor compiling and some lua/json files with information about the binding:definitions.jsonwith function info,structs_and_enums.jsonwith struct and enum info,impl_definitions.jsonwith functions from the implementations info. - build as shown in https://github.com/sonoro1234/LuaJIT-ImGui/tree/master_auto_implementations/build
- generate binding as done in
usage
- use whatever method is in ImGui c++ namespace in the original imgui.h by prepending
ig - methods have the same parameter list and return values (where possible)
- functions that belong to a struct have an extra first argument with a pointer to the struct.
- where a function returns UDT (user defined type) by value some compilers complain so another function with the name
function_name_nonUDTis generated accepting a pointer to the UDT type as the first argument. (or second argument if it is a struct function) - also is generated
function_name_nonUDT2which instead of returning the UDT type returns a simple version (without functions) calledUDTType_Simple(ImVec2_SimpleforImVec2)