Repository files navigation

Renderer for [imgui-rs][imgui] using the [glow] library for OpenGL.

This is heavily influenced by theexample from upstream.

A few codeexamplesare provided in the source.

In short, create either an [AutoRenderer] (for basic usage) or [Renderer]for slightly more customizable operation, then call therender(...)method with draw data from [imgui].

This renderer is expected to work with OpenGL version 3.3 and above, andOpenGL ES version 3.0 or above. This should cover the vast majority of evenfairly dated hardware. Please submit an issue for any incompatibilitiesfound with these OpenGL versions, pull requests to extend support to earlierversions are welcomed.

Consider this an example renderer. It is intended to be sufficent for simpleapplications running imgui-rs as the final rendering step. If your applicationhas more specific needs, it's probably best to write your own renderer, inwhich case this can be a useful starting point. This renderer is also notfoolproof (largely due to the global nature of the OpenGL state). For example,a few "internal" functions are markedpub to allow the user morefine-grained control at the cost of allowing potential rendering errors.

When outputting colors to a screen, colors need to be converted from alinear color space to a non-linear space matching the monitor (e.g. sRGB).When using the [AutoRenderer], this library will convert colors to sRGBas a step in the shader. When initialising a [Renderer], you can choosewhether or not to include this step in the shader or not when calling[Renderer::initialize].

This library also assumes that textures have their internal formatset appropriately when uploaded to OpenGL. That is, assuming your textureis sRGB (if you don't know, it probably is) theinternal_format isone of theSRGB* values.

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE orhttps://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT orhttps://opensource.org/licenses/MIT)

at your option.