OpenGL Renderer

[Kethku]

I recently swapped to an OpenGL backend away from the vulkan one with the hope that it would increase linux compatibility. However it seems that some folks are having issues.

I don't have the tools or know-how required to fix these problems on my own.

The opengl binding is handled via https://github.com/rust-windowing/glutin and is done here: https://github.com/Kethku/neovide/blob/main/src/window/window_wrapper/renderer.rs which was based in part on alacritty's implementation https://github.com/alacritty/alacritty/tree/master/alacritty/src/display and the sample in skia-safe https://github.com/rust-skia/rust-skia/blob/master/skia-safe/examples/gl-window/main.rs.

If anybody is able to synthesize something that works more consistently that would be amazing.

NOTE: I reverted the main change as it wasn't ready for prime time like I thought. The code is currently held in the OpenGL branch

[kinooyume]

❯ ./neovide
Ignored client type property: "methods"
Ignored client type property: "attributes"
fish: “./neovide” terminated by signal SIGSEGV (Address boundary error

Arch Linux, build from: 7c18e92

[calvinkosmatka]

Building from 4aec0d5

I was able to at least get a window open on my old X201T, Ubuntu 20.04, sway wm, wayland-only with a little massaging.

1. A couple dependency issues - typeface-open-stream was merged upstream, so I had to change the skia-safe url to git = "https://github.com/rust-skia/rust-skia". flexi_logger was causing a version conflix for regex so I switched it to flexi_logger = { version = "0.15", default-features = false }.
2. I didn't have the consolas font, so had to switch the fallback to a font I had installed (not really an issue)
3. Had to comment out .with_double_buffer(Some(true)) at src/window/window_wrapper/mod.rs L425 to get a window to open, otherise it would panic with the message thread 'main' panicked at 'called 'Result::unwrap()' on an 'Err' value: NoAvailablePixelFormat', src/window/window_wrapper/mod.rs:430:10. This might just be a quirk of my hardware, but others might hit this as well. Also tried running with LIBGL_ALWAYS_SOFTWARE=1 (which I need to make Alacritty run on this machine), made no difference.
4. I can't type most special characters, only @ and :. Looks like the issue is that glutin WindowEvent::KeyboardInput events already take the modifier state into account and they don't have virtual_keycodes for most special characters. I really want to get this running on this machine so I'd be willing to take a crack a refactoring keyboard input to make this work

[Kethku]

This gives traction. I will try these things. I didn't realize the double buffer could be the issue.

[Kethku]

I built a Ubuntu install on an extra harddrive explicitly for testing this stuff out. The experience was predictably mixed.

At the moment I ran into a segmentation fault on run. After running in lldb, I got this:

* thread #1, name = 'neovide', stop reason = signal SIGSEGV: invalid address (fault address: 0xfffffffffffffc68)
  * frame #0: 0x0000555556620b1e neovide`eat_space_sep_strings(SkTArray<SkString, false>*, char const*) + 46
    frame #1: 0x0000555556620851 neovide`GrGLExtensions::init(GrGLStandard, GrGLFunction<unsigned char const* (unsigned int)>, GrGLFunction<unsigned char const* (unsigned int, unsigned int)>, GrGLFunction<void (unsigned int, int*)>, GrGLFunction<char const* (void*, int)>, void*) + 577
    frame #2: 0x00005555569f5e5b neovide`GrGLMakeAssembledGLInterface(void*, void (* (*)(void*, char const*))()) + 475
    frame #3: 0x0000555556933330 neovide`GrGLMakeAssembledInterface(void*, void (* (*)(void*, char const*))()) + 224
    frame #4: 0x00005555567261ae neovide`::C_GrGLInterface_MakeAssembledInterface(ctx=0x00007fffffffa9a8, get=(neovide`skia_safe::gpu::gl::interface::gl_get_proc_fn_wrapper::h359798421d1ad615 at interface.rs:32)) at gl.cpp:147:38
    frame #5: 0x0000555555739595 neovide`skia_safe::gpu::gl::interface::_$LT$impl$u20$skia_safe..prelude..RCHandle$LT$skia_bindings..bindings..GrGLInterface$GT$$GT$::new_load_with::h10453dd3aeb4a6b8(loadfn=closure-1 @ 0x00007fffffffa9a8) at interface.rs:24:13
    frame #6: 0x00005555556fe4ee neovide`neovide::window::window_wrapper::renderer::SkiaRenderer::new::hfdf2e1af3baa2074(windowed_context=0x00007fffffffc0f0) at renderer.rs:53:25
    frame #7: 0x00005555557b3a1e neovide`neovide::window::window_wrapper::start_loop::h2e07a824b49b4e33(window_command_receiver=Receiver<neovide::editor::WindowCommand> @ 0x00007fffffffabb0, ui_command_sender=TxBlocking<neovide::bridge::ui_commands::UiCommand, crossfire::mpsc::unbounded::UnboundedSharedFuture> @ 0x00007fffffffd5f0, running=Arc<core::sync::atomic::AtomicBool> @ 0x00007fffffffabc0, logical_size=(__0 = 804, __1 = 801), renderer=Renderer @ 0x00007fffffffd610) at mod.rs:435:25
    frame #8: 0x000055555576f70d neovide`neovide::window::create_window::he86e9e84cff00986(batched_draw_command_receiver=Receiver<alloc::vec::Vec<neovide::editor::DrawCommand, alloc::alloc::Global>> @ 0x00007fffffffd320, window_command_receiver=Receiver<neovide::editor::WindowCommand> @ 0x00007fffffffd330, ui_command_sender=TxBlocking<neovide::bridge::ui_commands::UiCommand, crossfire::mpsc::unbounded::UnboundedSharedFuture> @ 0x00007fffffffdd50, running=Arc<core::sync::atomic::AtomicBool> @ 0x00007fffffffd340) at mod.rs:106:5
    frame #9: 0x00005555558a8538 neovide`neovide::main::h8a34d2494d865a2e at main.rs:179:5
    frame #10: 0x000055555571767b neovide`core::ops::function::FnOnce::call_once::hb6835360d127917d((null)=(neovide`neovide::main::h8a34d2494d865a2e at main.rs:34), (null)=<unavailable>) at function.rs:227:5
    frame #11: 0x000055555570192e neovide`std::sys_common::backtrace::__rust_begin_short_backtrace::h98ed3d2a87357883(f=(neovide`neovide::main::h8a34d2494d865a2e at main.rs:34)) at backtrace.rs:125:18
    frame #12: 0x00005555556cb001 neovide`std::rt::lang_start::_$u7b$$u7b$closure$u7d$$u7d$::h8129eb8637f80ccd at rt.rs:66:18
    frame #13: 0x0000555556a43b2a neovide`std::rt::lang_start_internal::h965c28c9ce06ee73 [inlined] core::ops::function::impls::_$LT$impl$u20$core..ops..function..FnOnce$LT$A$GT$$u20$for$u20$$RF$F$GT$::call_once::hbcc915e668c7ca11 at function.rs:259:13
    frame #14: 0x0000555556a43b23 neovide`std::rt::lang_start_internal::h965c28c9ce06ee73 [inlined] std::panicking::try::do_call::h6b0f430d48122ddf at panicking.rs:379
    frame #15: 0x0000555556a43b23 neovide`std::rt::lang_start_internal::h965c28c9ce06ee73 [inlined] std::panicking::try::h6ba420e2e21b5afa at panicking.rs:343
    frame #16: 0x0000555556a43b23 neovide`std::rt::lang_start_internal::h965c28c9ce06ee73 [inlined] std::panic::catch_unwind::h8366719d1f615eee at panic.rs:431
    frame #17: 0x0000555556a43b23 neovide`std::rt::lang_start_internal::h965c28c9ce06ee73 at rt.rs:51
    frame #18: 0x00005555556cafe0 neovide`std::rt::lang_start::ha74f856e07cf29c4(main=(neovide`neovide::main::h8a34d2494d865a2e at main.rs:34), argc=1, argv=0x00007fffffffe068) at rt.rs:65:5
    frame #19: 0x00005555558a888c neovide`main + 28
    frame #20: 0x00007ffff795e0b3 libc.so.6`__libc_start_main + 243
    frame #21: 0x00005555556b909e neovide`_start + 46

Which says to me that running is failing at creating the interface here: https://github.com/Kethku/neovide/blob/opengl/src/window/window_wrapper/renderer.rs#L53

@calvinkosmatka did you install any particular drivers? I'm running with an rtx 3070, so maybe driver support is the issue given that the gpu is relatively new? I installed the nvidia drivers, because I couldn't get multiple monitors to display with the default ones.

[Kethku]

Weirdly I get passed that segmentation fault when run in the rr debugger. Not sure what thats about...
Edit: nope egl fails before, so I think rr screws something else up and was a distraction. The real problem is constructing the interface as mentioned in the above comment

[Kethku]

I pushed changes matching your suggestions (including some default font fixes).

[kinooyume]

It seems to work ! I gonna give a try today and let you know if I have any issue :)

[kinooyume]

I didn't have any issue during the all day, I guess it's fine now :)

[Kethku]

@kiuKisas were you running from the opengl branch? I reverted the opengl change on main because it was causing problems.

[calvinkosmatka]

@Kethku the machine I'm testing this on just has intel integrated graphics (I don't recall ever installing any special drivers, if I did it would have been 8ish years ago). I have yet to hit a SIGSEV.

I did a little more digging into my keyboard input issues - looks like it's (mostly) an upstream issue in winit/glutin and there's not much hope of solving it on the Neovide end (see rust-windowing/winit#1806). Winit just don't send a bunch of virtual keycodes on Wayland/X11 (didn't check other platforms). Good news is I think this would give Neovide non-qwerty support basically for free once this is fixed.

[Kethku]

I'm watching rust-windowing/winit#1788 as my hope for revamping the text input. In the meantime, we could likely create another keyboard layout like this: https://github.com/Kethku/neovide/blob/main/src/window/winit/layouts/qwerty.rs for whatever layout you need. This would fix your issues in the short run.

[calvinkosmatka]

Ooh that branch looks promising. Have you tried building against it? I'm going to give it a shot right now.

I would need to change the API a bit to make a new layout work since I'd have to rely on scancodes - think I'd rather look towards a more permanent solution