djkato/egui
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Emil Ernerfeldt 2019-03-12 08:54:17 +01:00
parent 192b59ebb0
commit 733df46a0a
1 changed files with 26 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -1,34 +1,46 @@
# Emigui # Emigui
Experimental, Modularized Immediate mode Graphical User Interface (Experimental, Modularized Immediate mode Graphical User Interface)
A GUI library written in Rust, compiled to WASM. Inspired by game tech. An immediate mode GUI library written in Rust. Compiles to WASM.
## Goals:
* Easy to use
* Platform independent (the same code should run on web and native)
* Responsive
## How it works: ## How it works:
Loop: Loop:
* Gather input: mouse, touches, screen size, ... * Gather input: mouse, touches, screen size, ...
* Run app code (Immediate Mode GUI) * Run application code (Immediate Mode GUI)
* Output is a triangle mesh * Output is a triangle mesh
* Render with WebGL * Render with WebGL
## Demos ## Demos
[Emigui feature demo](https://emilk.github.io/emigui/index.html) [Emigui feature demo](https://emilk.github.io/emigui/index.html), source: https://github.com/emilk/emigui/blob/master/example/src/app.rs
[Hobogo: A small game using Emigui](https://emilk.github.io/hobogo/index.html) [Hobogo: A small game using Emigui](https://emilk.github.io/hobogo/index.html), source: https://github.com/emilk/hobogo
## State ## State
More of a tech demo than anything else. Features: Mostly a tech demo at this point. I hope to find time to work more on this in the future.
Features:
* Buttons
* Sliders
* Text * Text
* Buttons, checkboxes, radio buttons and sliders
* Horizontal or vertical layout * Horizontal or vertical layout
* Columns * Column layout
* Collapsible headers * Collapsible headers (sections)
* Anti-aliased rendering of circles, rounded rectangles and lines.
## Roadmap:
* Native backend
* Some examples / documentation
* Text input
## Inspiration ## Inspiration
[Dear ImGui](https://github.com/ocornut/imgui) [Dear ImGui](https://github.com/ocornut/imgui) is a great Immediate Mode GUI for C++ which works with many backends.
## Credits / Licenses ## Credits / Licenses
ProggyClean.ttf, Copyright (c) 2004, 2005 Tristan Grimmer. MIT License. http://www.proggyfonts.net/ Fonts:
Roboto-Regular.ttf: Apache License, Version 2.0 * ProggyClean.ttf, Copyright (c) 2004, 2005 Tristan Grimmer. MIT License. http://www.proggyfonts.net/
* Roboto-Regular.ttf: Apache License, Version 2.0