From 25f91b0b2e405b145ca658a3c95f61641527c773 Mon Sep 17 00:00:00 2001 From: Joonas Javanainen Date: Thu, 20 Aug 2015 23:02:10 +0300 Subject: [PATCH] Update README --- README.markdown | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.markdown b/README.markdown index ea66097..cea3821 100644 --- a/README.markdown +++ b/README.markdown @@ -2,8 +2,6 @@ **Ultra hyper turbo cyber mega extra über experimental!!!** -ffi module (low-level API) is complete, the safe API is not! - ![Hello world](hello_world.png) ```rust @@ -19,6 +17,28 @@ frame.window() }) ``` +## Currently implemented things + +* Low-level API (ffi module) +* Renderer for easy integration with [Glium](https://github.com/tomaka/glium) projects (optional) +* Parts of high-level API +* Not horrible way of defining and passing null-terminated UTF-8 to ImGui +* Parts of imgui\_demo.cpp reimplemented in Rust as an API usage example (examples/test\_window.rs) + +## Important but unimplemented things + +* Documentation (rustdoc) +* Support passing a custom Program to Glium renderer (e.g. from a shader cache, or custom shader) + +## Core design questions and current choices + +* Closures VS begin/end pairs (current choice: closures) +* Mutable references VS return values (current choice: return values) +* Passing around Frame<'fr> VS passing around &'fr Frame (current choice: Frame<'fr>) +* Splitting the API to smaller pieces VS all draw calls in Frame (current choice: all draw calls in Frame) +* Builder pattern for optional arguments VS something else (current choice: builder) +* Mutation functions in builders VS self-consuming functions in builders (current choice: self-consuming) + ## Compiling and running the demos git clone https://github.com/Gekkio/imgui-rs