derivator / egui_vulkano

Vulkano rendering backend for egui

Vulkano backend for egui

This is a drawing backend to use egui with Vulkano. It can be used with egui-winit for input handling.

Usage

let mut egui_painter = egui_vulkano::Painter::new(
    device.clone(), // your Vulkano Device
    queue.clone(), // your Vulkano Queue
    Subpass::from(render_pass.clone(), 1).unwrap(), // subpass that you set up to render the gui
)
.unwrap();

// ...

// Get the shapes from egui
let egui_output = egui_ctx.end_frame();
let result = egui_painter.update_textures(egui_output.textures_delta, &mut builder).unwrap();
// If using egui-winit:
egui_winit.handle_platform_output(surface.window(), &egui_ctx, egui_output.platform_output);

// Do your own rendering ...

// Automatically start the next render subpass and draw the gui
egui_painter
    .draw(
        &mut builder, // your vulkano AutoCommandBufferBuilder
        [width, height], // window size
        &egui_ctx, // your egui CtxRef
        egui_output.shapes // shapes from egui,
    )
    .unwrap();

Check the included working example for more info.

Pull requests are welcome!

Credits

With inspiration from egui_winit_ash_vk_mem, egui_sdl2_gl and egui_glium.

egui_vulkano's Issues

Running the example causes panic

Result::unwrap() on an Err value: FormatColorSpaceNotSupported', examples/example.rs:143:10

update to Vulkano 0.28, winit 0.26, egui 0.16

Hi, I've forked this repo for use in a personal project and managed to get the example running with Vulkano 0.28, winit 0.16, and egui 0.16. I figured I'd submit a PR just in case you or anyone else wanted to take a look.

Weird Transparency glitch on Intel Integrated Graphics

Running on main branch's example. Getting reported info:

> cargo run --release --example example
MESA-INTEL: warning: Performance support disabled, consider sysctl dev.i915.perf_stream_paranoid=0
Using device: Intel(R) Xe Graphics (TGL GT2) (type: IntegratedGpu)

Incorrect rendering in example for 5120x2160, scale factor 175%

As you can see in the image the clipped rects are not properly scaled according to the scale factor.

Incorrect egui presentation on Wayland.

OS: Arch linux
DE: Plasma 5.22.5
CPU: 11th Gen Intel i5-1135G7
GPU: Intel TigerLake-LP GT2 [Iris Xe Graphics]
session type: Wayland.

Example:

Egui and vulcano individually work great.
PS: Rust compiler complain that src/shaders/mod.rs can't find shaders.