Skip to content

README.md

Latest commit

 

History

History
43 lines (35 loc) · 1.72 KB

README.md

File metadata and controls

43 lines (35 loc) · 1.72 KB
Raw

SharpGUI

GitHub Repo stars GitHub License

Load Dear ImGui into any Application.

Supported Backends

  • DX9
  • DX11
  • OpenGL 2
  • OpenGL 3
  • Overlay renderer (universal)

Features

  • Intercept input
  • Unlock mouse cursor
  • Easy to use C# API

How does it work?

SharpGUI uses custom builds of cimgui and ImGui.NET which include all backends. SharpGUINative contains all the code for hooking and rendering the imgui backends. The C# side of the application invokes exported methods from SharpGUINative.

Note: SharpGUINative could also be used without C#.

Usage

Reference SharpGUI and the custom version of ImGui.NET(can be found in SharpGUI/Resources) in your C# project. An example for a BepInEx 6 IL2CPP Plugin can be found in the SharpGUI BepInEx Plugin Directory.

Change backends

Go into sharpconfig.hpp and select the backends you want to include.

Example: Remove DX11 backend

#define SHARPGUI_INCLUDE_DX11		1

should be changed into:

#define SHARPGUI_INCLUDE_DX11		0

Used Libraries