Implement offscreen rendering in Wayland in OSGLContext

[YakoYakoYokuYoku]

PR Description

What type of PR is this? (Check one of the boxes below)

• New feature (non-breaking change which adds functionality)

What does this pull request do?

This PR adds support for Wayland offscreen rendering through EGL and OpenGL. Due to the OpenGL API is only bindable in EGL versions 1.4 and onwards, the context creation will only admit those versions. And because of the Qt Wayland plugin being introduced in Qt 5 only that version and subsequent ones are supported. An OSGLContext_xdg class was implemented as an interface for both X11 and Wayland OpenGL context handling. In case users may want to force X11 in Natron they'll have to set the QT_QPA_PLATFORM environment variable to xcb and set the NATRON_DISABLE_WAYLAND to any value.

Show a few screenshots (if this is a visual change)

See #764.

Have you tested your changes (if applicable)? If so, how?

By building and running Natron and NatronRenderer (with NatronRenderer --opengl enabled) on a project that uses the Shadertoy plugin.

Futher details of this pull request

With #764 Wayland is now supported by Natron.

[devernay]

Interesting!
Does this mean also headless rendering with NatronRenderer using EGL? Did you test that (with a Shadertoy node, for example)

[YakoYakoYokuYoku]

Could check rendering with OCIOLogConvert in NatronRenderer although Shadertoy is not working at the moment, either with Wayland nor X11.

[devernay]

Shadertoy is not working

Can you be more specific about this?

• Is it not working in RB-2.4?
• RB-2.5?
• this PR?
• Using the GUI?
• Using NatronRenderer with display?
• Using NatronRenderer headless?

Shadertoy being widely used and a supported plugin, this should be considered a serious issue.

[YakoYakoYokuYoku]

Speaking in the context of offscreen rendering in Natron RB-2.5 with a display (either an X11 or a Wayland session), Shadertoy does not work because of an argument named args.openGLEnabled (openfx-misc/Shadertoy/Shadertoy.cpp:1312) is false at the time of the ShadertoyPlugin::render call. I haven't investigated it further yet on why is not being set to true.

[devernay]

Speaking in the context of offscreen rendering in Natron RB-2.5 with a display (either an X11 or a Wayland session), Shadertoy does not work because of an argument named args.openGLEnabled (openfx-misc/Shadertoy/Shadertoy.cpp:1312) is false at the time of the ShadertoyPlugin::render call. I haven't investigated it further yet on why is not being set to true.

Do you see anything in the console output that says OpenGL was disabled for some reason?

I would like to understand more precisely which configurations are broken. Is the execution with the Natron GUI always using hardware-accelerated OpenGL rendering, whether it's 2.4 or 2.5 or 2.5+this_PR? Is NatronRenderer always failing, or only in some configurations?

Do you get the "Available OpenGL renderers" message in the console?
Do you get the "Failed to load OpenGL" message?

[YakoYakoYokuYoku]

Do you see anything in the console output that says OpenGL was disabled for some reason?

I would like to understand more precisely which configurations are broken. Is the execution with the Natron GUI always using hardware-accelerated OpenGL rendering, whether it's 2.4 or 2.5 or 2.5+this_PR?
Is NatronRenderer always failing, or only in some configurations?

My console output doesn't display any mention of OpenGL being disabled, in fact it finds a proper renderer

Found OpenGL Renderer: AMD Radeon R7 200 Series (BONAIRE, DRM 3.44.0, 5.16.10-arch1-1, LLVM 13.0.1) , Vendor: AMD , OpenGL Version: 4.6 (Compatibility Profile) Mesa 21.3.7 , Max. Texture Size 16384 ,Max GPU Memory: "1.91 GiB"

In the GUI it was for sure using OpenGL rendering, which was confirmed by checking the OpenGL settings in Preferences, running Shadertoy and monitoring GPU usage. Shadertoy works under GUI (in X11 with and without this PR) but surprisingly not in Renderer (in X11 with and without this PR).

Is NatronRenderer always failing, or only in some configurations?

As of NatronRenderer it always fails, though I don't know what you may be referring to with configurations.

Although this makes me think that we should defer this conversation under a new issue either in openfx-misc or openfx.

[devernay]

blocked by #779

[YakoYakoYokuYoku]

See #779 as I've found out that it was due to a misconfiguration in the engine and not by this PR itself.

[YakoYakoYokuYoku]

@devernay or @rodlie if you cannot test this PR but you could review this or at least approve it please let me know.

[devernay]

This looks OK to me, I don't have time to test and I'm just wondering if the build was tested on systems that don't support wayland.
I'll approve and let you merge

[YakoYakoYokuYoku]

Thanks so much for approving, I'm very grateful 🙏 🙌 👏

[devernay]

It seems like this broke the CI builds (undefined symbol when linking NatronRenderer) - can you please take a look at it?

[YakoYakoYokuYoku]

Yeah, because I've forgot about including OSGLContext_Wayland.cpp in Engine/Engine.pro 🤧, but #829 includes a fix for it, though it could be committed directly if desired.

[devernay]

Can you commit just that line without a PR? I'm not sure about #829

[YakoYakoYokuYoku]

Happens that I cannot commit directly to protected branches as of now so that's why I need somebody else with that kind of permissions.

[devernay]

Ok I changed your role. You should be able to do it now