Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vape committed Oct 6, 2024
1 parent 1edb7df commit 32eaa26
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ Immediate mode GUI framework made specifically for Unity. It has zero per-frame

## How it works

The basic principle is the same as in Dear ImGui: every frame, we generate a mesh with all the controls in it, split into different draw calls when needed, and render it to the render texture. For simple cases, the UI can be drawn with a single draw call (when no masks or different materials are involved). Using the `ImuiGraphic` component, the whole UI can be integrated into the `Canvas` hierarchy and used like any other UGUI component.
The basic principle is the same as in Dear ImGui: every frame, we generate a mesh with all the controls in it, split into different draw calls when needed, and render it to the render texture. For simple cases, the UI can be drawn with a single draw call (when no masks or different materials are involved). Using the `ImCanvasBackend` component, the whole UI can be integrated into the `Canvas` hierarchy and used like any other UGUI component.

## Installation

You can install Imui as a git package in Unity Package Manager

## Themes

Dark and light themes are supported, check out demo [here](https://vape.github.io/imui_demo/).
Dark and light themes are supported, check out demo [here](https://vape.github.io/imui_demo_030/).

## Controls

Expand All @@ -27,10 +27,14 @@ Supports a very basic set of controls:
* Slider
* Label
* Image
* Text Editor
* Text/Number Editor
* Dropdown
* Scroll Bar
* Foldout
* Separator
* Tree
* Radio Group
* Listbox

## Layout

Expand Down

0 comments on commit 32eaa26

Please sign in to comment.