egui/README.md

# Emigui
(Experimental, Modularized Immediate mode Graphical User Interface)

An immediate mode GUI library written in Rust. For web apps or native apps.

## Goals:
* Lightweight
* Short, conveniant syntax
* Responsive (60 Hz without breaking a sweat)
* Portable
* Platform independent (the same code works on the web and as a native app)

## How it works:
Loop:
* Gather input: mouse, touches, screen size, ...
* Run application code (Immediate Mode GUI)
* Output is a triangle mesh
* Render with e.g. OpenGL

## Available backends:
Wherever you can render textured triangles you can use Emigui.

Currently two backends have been tested:
* WebAssembly (emigui_wasm) for making a web app
* [Glium](https://github.com/glium/glium) for native apps (see example_glium).
* [miniquad](https://github.com/not-fl3/emigui-miniquad) [web demo](https://not-fl3.github.io/miniquad-samples/emigui.html) [demo source](https://github.com/not-fl3/good-web-game/blob/master/examples/emigui.rs)

The same application code can thus be compiled to either into a native app or a web app.

## Demos
[Emigui feature demo](https://emilk.github.io/emigui/index.html), (partial) source: https://github.com/emilk/emigui/blob/master/emigui/src/examples/app.rs

[Hobogo: A small game using Emigui](https://emilk.github.io/hobogo/index.html), source: https://github.com/emilk/hobogo

## State
Mostly a tech demo at this point. I hope to find time to work more on this in the future.

Features:

* Labels
* Buttons, checkboxes, radio buttons and sliders
* Horizontal or vertical layout
* Column layout
* Collapsible headers (sections)
* Windows
* Resizable regions
* Vertical scolling
* Simple text input
* Anti-aliased rendering of circles, rounded rectangles and lines.

## Conventions
* All coordinates are screen space coordinates, in locial "points" (which may consist of many physical pixels).
* All colors have premultiplied alpha

## Inspiration
The one and only [Dear ImGui](https://github.com/ocornut/imgui) is a great Immediate Mode GUI for C++ which works with many backends. That library revolutionized how I think about GUI code from something I hated to do to something I now like to do.

## Credits / Licenses
Fonts:
* Comfortaa: Open Font License, see OFT.txt
* ProggyClean.ttf, Copyright (c) 2004, 2005 Tristan Grimmer. MIT License. http://www.proggyfonts.net/
* Roboto-Regular.ttf: Apache License, Version 2.0
Update readme 2019-03-10 20:01:07 +00:00			`# Emigui`
Update README.md 2019-03-12 07:54:17 +00:00			`(Experimental, Modularized Immediate mode Graphical User Interface)`
Initial commit: Closed loop of TS->Rust->TS 2018-12-23 18:42:30 +00:00
Add native glium backend 2019-03-12 21:59:55 +00:00			`An immediate mode GUI library written in Rust. For web apps or native apps.`
Initial commit: Closed loop of TS->Rust->TS 2018-12-23 18:42:30 +00:00
Update README.md 2019-03-12 07:54:17 +00:00			`## Goals:`
Basic text input support 2020-04-29 19:25:49 +00:00			`* Lightweight`
			`* Short, conveniant syntax`
			`* Responsive (60 Hz without breaking a sweat)`
			`* Portable`
Add native glium backend 2019-03-12 21:59:55 +00:00			`* Platform independent (the same code works on the web and as a native app)`
Initial commit: Closed loop of TS->Rust->TS 2018-12-23 18:42:30 +00:00
Update README.md 2019-03-12 07:54:17 +00:00			`## How it works:`
Update readme 2019-03-10 20:01:07 +00:00			`Loop:`
			`* Gather input: mouse, touches, screen size, ...`
Update README.md 2019-03-12 07:54:17 +00:00			`* Run application code (Immediate Mode GUI)`
Update readme 2019-03-10 20:01:07 +00:00			`* Output is a triangle mesh`
Add native glium backend 2019-03-12 21:59:55 +00:00			`* Render with e.g. OpenGL`

			`## Available backends:`
			`Wherever you can render textured triangles you can use Emigui.`

			`Currently two backends have been tested:`
			`* WebAssembly (emigui_wasm) for making a web app`
			`* [Glium](https://github.com/glium/glium) for native apps (see example_glium).`
Mention miniquad backend in readme 2020-05-01 04:16:45 +00:00			`* [miniquad](https://github.com/not-fl3/emigui-miniquad) [web demo](https://not-fl3.github.io/miniquad-samples/emigui.html) [demo source](https://github.com/not-fl3/good-web-game/blob/master/examples/emigui.rs)`
Add native glium backend 2019-03-12 21:59:55 +00:00
			`The same application code can thus be compiled to either into a native app or a web app.`
Initial commit: Closed loop of TS->Rust->TS 2018-12-23 18:42:30 +00:00
Update readme 2019-03-10 20:01:07 +00:00			`## Demos`
Add a fractal clock example to showcase painting performance 2020-05-11 18:21:24 +00:00			`[Emigui feature demo](https://emilk.github.io/emigui/index.html), (partial) source: https://github.com/emilk/emigui/blob/master/emigui/src/examples/app.rs`
Initial commit: Closed loop of TS->Rust->TS 2018-12-23 18:42:30 +00:00
Update README.md 2019-03-12 07:54:17 +00:00			`[Hobogo: A small game using Emigui](https://emilk.github.io/hobogo/index.html), source: https://github.com/emilk/hobogo`
Nicer rust code 2018-12-23 23:15:18 +00:00
Update readme 2019-03-10 20:01:07 +00:00			`## State`
Update README.md 2019-03-12 07:54:17 +00:00			`Mostly a tech demo at this point. I hope to find time to work more on this in the future.`

			`Features:`
Nicer rust code 2018-12-23 23:15:18 +00:00
Store/restore emigui memory state (window positions, sizes etc) 2020-05-02 09:37:12 +00:00			`* Labels`
Update README.md 2019-03-12 07:54:17 +00:00			`* Buttons, checkboxes, radio buttons and sliders`
Update readme 2019-03-10 20:01:07 +00:00			`* Horizontal or vertical layout`
Update README.md 2019-03-12 07:54:17 +00:00			`* Column layout`
			`* Collapsible headers (sections)`
Store/restore emigui memory state (window positions, sizes etc) 2020-05-02 09:37:12 +00:00			`* Windows`
			`* Resizable regions`
			`* Vertical scolling`
			`* Simple text input`
Update README.md 2019-03-12 07:54:17 +00:00			`* Anti-aliased rendering of circles, rounded rectangles and lines.`

Use premultiplied alpha for all colors + improve painting of thin lines 2020-05-11 15:57:11 +00:00			`## Conventions`
			`* All coordinates are screen space coordinates, in locial "points" (which may consist of many physical pixels).`
			`* All colors have premultiplied alpha`
WIP: rust WebGL rendering 2019-01-04 13:14:32 +00:00
Update readme 2019-03-10 20:01:07 +00:00			`## Inspiration`
Remove roadmap and replace with emigui/README.md with a TODO section 2020-04-19 09:15:35 +00:00			`The one and only [Dear ImGui](https://github.com/ocornut/imgui) is a great Immediate Mode GUI for C++ which works with many backends. That library revolutionized how I think about GUI code from something I hated to do to something I now like to do.`
WIP: rust WebGL rendering 2019-01-04 13:14:32 +00:00
Update readme 2019-03-10 20:01:07 +00:00			`## Credits / Licenses`
Update README.md 2019-03-12 07:54:17 +00:00			`Fonts:`
New font: Comfortaa 2019-03-16 12:37:29 +00:00			`* Comfortaa: Open Font License, see OFT.txt`
Update README.md 2019-03-12 07:54:17 +00:00			`* ProggyClean.ttf, Copyright (c) 2004, 2005 Tristan Grimmer. MIT License. http://www.proggyfonts.net/`
			`* Roboto-Regular.ttf: Apache License, Version 2.0`