From c0394a06605f3a75d334498ed89aedd6a7c78725 Mon Sep 17 00:00:00 2001 From: Stephan Dilly Date: Thu, 9 Apr 2015 15:45:19 +0200 Subject: [PATCH] Update README.md --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6334613..e4ac369 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,16 @@ # cimgui -c-api for [imgui](https://github.com/ocornut/imgui) +![sample](https://raw.github.com/extrawurst/cimgui/master/Screen Shot 2015-04-09.png) -this is a work in progress since imgui contains a lot of functionality already and we wrap on a as needed basis. +This is a thin c-api wrapper for the excellent C++ intermediate gui [imgui](https://github.com/ocornut/imgui). +Most of the functions have wrapper counterparts now, missing stuff is added on a as-needed basis (PR welcome). +This library is intended as a intermediate layer to be able to use imgui from other languages that can interface with C (like D - see [D-binding](https://github.com/Extrawurst/DerelictImgui)) + +Note: currently this wrapper is based on a WIP version of imgui 1.38 + +# usage + +* clone +* make using makefile on linux/osx (linux makefile not tested) +* use whatever method is in ImGui c++ namespace in the original [imgui.h](https://github.com/ocornut/imgui/blob/master/imgui.h) by prepending `ig_` (most of the time) +* methods have the same parameter list and return values (where possible)