LwjglCanvas using lwjgl-jawt #2153

JNightRider · 2023-11-29T23:58:19Z

Would this be an acceptable solution for now?

This solves the problem of integrating https://github.com/LWJGLX/lwjgl3-awt (#1868)

There is just one small detail, removing the canvas from its main component and integrating it again breaks it. This issue occurs on the lwjgl3-awt side (LWJGLX/lwjgl3-awt#40)

DontingK · 2023-11-30T08:52:10Z

extends LwjglContext ,LwjglWindow , Which one is better? LwjglWindow Mainly to initialize glfw window

tonihele · 2023-12-01T12:15:30Z

This would solve #1192 and make #1868 obsolete.

I didn't test it. But code wise it looks good. Very simple (or rather low LoC count :) ).

tonihele · 2023-12-01T12:16:33Z

jme3-lwjgl3/src/main/java/com/jme3/system/lwjgl/LwjglCanvas.java

+         synchronized (lock) {
+            canvas.deleteContext();
+        }
+        //// request the cleanup


Code in comments generally should not be. Is this something that is incomplete?

It shouldn't be there, I forgot to delete it. Sorry for causing confusion...

tonihele · 2023-12-17T17:21:18Z

I tried to test this but I couldn't get it running. I was always greeted with:

And the appsettings at least indicate I have renderer set accordingly

JNightRider · 2023-12-18T02:02:59Z

Did you check the dependencies?; You might be using lwjgl (on my Linux it throws a lot of errors)

In the examples module I did not change anything (in the tests I did but I reverted the changes)

It looks like a version issue... if so, it's probably line 199 (working to locate the error).

tonihele · 2023-12-18T15:24:40Z

It looks like a version issue... if so, it's probably line 199 (working to locate the error).

Yeah, if I just remove glData.profile = GLData.Profile.CORE;, then it works. But it is a little bit volatile then:

Closing the app causes NPE (at LwjglAWTGLCanvas.deleteContext)
Switching the canvas to another tab just results in a black canvas. I can't see the cube anymore

I'm talking about the jme3test.awt.TestCanvas.

tonihele · 2023-12-18T15:30:52Z

To actually use the profiles you need to do as the error message I posted, but it of course refers to the library settings:

        glData.majorVersion = 3;
        glData.minorVersion = 2;
        glData.profile = GLData.Profile.CORE;

The above works but the canvas is just black and the test cube is not showing.

tonihele · 2023-12-18T16:06:03Z

Core profile I didn't get to work. Compatibility profile works. Here is an example how I tested this then to conform to jME's rendered setting (although I'm not sure if this is required or not...). But note that these didn't fix any of the problems encountered:

private static final Map<String, Consumer<GLData>> RENDER_CONFIGS = new HashMap<>();

    static {
        RENDER_CONFIGS.put(AppSettings.LWJGL_OPENGL30, (data) -> {
            data.majorVersion = 3;
            data.minorVersion = 0;
        });
        RENDER_CONFIGS.put(AppSettings.LWJGL_OPENGL31, (data) -> {
            data.majorVersion = 3;
            data.minorVersion = 1;
        });
        RENDER_CONFIGS.put(AppSettings.LWJGL_OPENGL32, (data) -> {
            data.forwardCompatible = true;
            data.majorVersion = 3;
            data.minorVersion = 2;
            data.profile = GLData.Profile.COMPATIBILITY;
        });
        RENDER_CONFIGS.put(AppSettings.LWJGL_OPENGL33, (data) -> {
            data.forwardCompatible = true;
            data.majorVersion = 3;
            data.minorVersion = 3;
            data.profile = GLData.Profile.COMPATIBILITY;
        });
        RENDER_CONFIGS.put(AppSettings.LWJGL_OPENGL40, (data) -> {
            data.forwardCompatible = true;
            data.majorVersion = 4;
            data.minorVersion = 0;
            data.profile = GLData.Profile.COMPATIBILITY;
        });
        RENDER_CONFIGS.put(AppSettings.LWJGL_OPENGL41, (data) -> {
            data.forwardCompatible = true;
            data.majorVersion = 4;
            data.minorVersion = 1;
            data.profile = GLData.Profile.COMPATIBILITY;
        });
        RENDER_CONFIGS.put(AppSettings.LWJGL_OPENGL42, (data) -> {
            data.forwardCompatible = true;
            data.majorVersion = 4;
            data.minorVersion = 2;
            data.profile = GLData.Profile.COMPATIBILITY;
        });
        RENDER_CONFIGS.put(AppSettings.LWJGL_OPENGL43, (data) -> {
            data.forwardCompatible = true;
            data.majorVersion = 4;
            data.minorVersion = 3;
            data.profile = GLData.Profile.COMPATIBILITY;
        });
        RENDER_CONFIGS.put(AppSettings.LWJGL_OPENGL44, (data) -> {
            data.forwardCompatible = true;
            data.majorVersion = 4;
            data.minorVersion = 4;
            data.profile = GLData.Profile.COMPATIBILITY;
        });
        RENDER_CONFIGS.put(AppSettings.LWJGL_OPENGL45, (data) -> {
            data.forwardCompatible = true;
            data.majorVersion = 4;
            data.minorVersion = 5;
            data.profile = GLData.Profile.COMPATIBILITY;
        });
    }

        RENDER_CONFIGS.computeIfAbsent(settings.getRenderer(), (t) -> {
            return (data) -> {
                data.majorVersion = 2;
                data.minorVersion = 0;
            };
        }).accept(glData);

JNightRider · 2023-12-18T18:17:59Z

Switching the canvas to another tab just results in a black canvas. I can't see the cube anymore

As I mentioned before, removing the canvas from the parent component and adding it back (or to any other component) breaks it, which is a problem that lwjgl3-awt currently has; TestCanvas performs this same procedure (removing the canvas).

Closing the app causes NPE (at LwjglAWTGLCanvas.deleteContext)

This is an unexpected issue, thanks for reporting; Just out of curiosity, what operating system are you using (version)

JNightRider · 2023-12-18T18:19:39Z

To actually use the profiles you need to do as the error message I posted, but it of course refers to the library settings:
        glData.majorVersion = 3;
        glData.minorVersion = 2;
        glData.profile = GLData.Profile.CORE;
The above works but the canvas is just black and the test cube is not showing.

Still trying to switch tabs?

tonihele · 2023-12-18T18:31:04Z

This is an unexpected issue, thanks for reporting; Just out of curiosity, what operating system are you using (version)

Windows 10.

Still trying to switch tabs?

No, this was just in general. I was trying stuff out. As the CORE profile doesn't work at all for me.

JNightRider · 2023-12-18T21:28:18Z

No, this was just in general. I was trying stuff out. As the CORE profile doesn't work at all for me.

When setting data.forwardCompatible = true to true, for some reason they don't work even though the lwjgl3-awt documentation recommends it... strange; For now this should work.

*Closing the app causes NPE (at LwjglAWTGLCanvas.deleteContext)

Now, it's pending... I'm testing on Windows 10 to fix it...

…ata for the context in case it fails.

JNightRider · 2023-12-20T19:13:43Z

At the moment I can run it on Windows-10 and there is no problem with Linux.

JNightRider · 2023-12-27T20:40:41Z

With this patch (if it can be considered), LwjglCanvas works with Linux without problems (100%)

Now you can delete and re-add the canvas without any problem.

Now I'm working on getting it to work with Windows, MacOS shouldn't be a problem.

scenemax3d · 2024-01-12T12:39:13Z

With this patch (if it can be considered), LwjglCanvas works with Linux without problems (100%)

Now you can delete and re-add the canvas without any problem.

Now I'm working on getting it to work with Windows, MacOS shouldn't be a problem.

Hi,
What is the status of getting it to work with Windows / MacOS ?
Is there anything preventing us from merging it to v3.7.0?
Thanks :)

JNightRider · 2024-01-12T19:07:04Z

What is the status of getting it to work with Windows / MacOS ?

In the case of Windows it is currently pending. The option to remove and re-add the canvas is the only issue present.

Regarding MacOS; Removing and re-adding the canvas is no problem (it basically totally works; according to the lwjgl3-awt guys),

Is there anything preventing us from merging it to v3.7.0?

The Windows platform that still has the aforementioned problem.

tonihele · 2024-01-19T09:12:36Z

Looks like #1868 just went in. I suppose that is ok, it should not cause any harm. But I'm in favor of overwriting the said PR with this. As this is hardware accelerated, a real solution to the problem.

scenemax3d · 2024-01-19T12:27:38Z

Looks like #1868 just went in. I suppose that is ok, it should not cause any harm. But I'm in favor of overwriting the said PR with this. As this is hardware accelerated, a real solution to the problem.

Yes. there is a current pending issue with Windows. I will merge it as soon as it is resolved

scenemax3d · 2024-01-29T19:36:44Z

Hi @JNightRide
You mentioned in the forum that more commits are planned for this PR.
What is your estimation for adding them?

@tonihele - if we decide to merge this PR, should we need to pay attention to some of your #1868 PR code or we can just merge this PR as-is without warring about the changes that you have made?

Thanks :)

JNightRider · 2024-01-30T23:10:51Z

What is your estimation for adding them?

To answer this question.

I should first mention that the "commits" I plan to release are bugfixes (JME3 side) and javadoc.
It is possible that it will be finished on February 4.

[ NOTE ]
This PR still has a conflict with Windows (the issue of removing and re-adding the canvas).

This current issue is on the lwjgl3-awt side, it can't be patched from JME3 (as far as I know), lwjgl3-awt may need to be modified to fix it (source code), I'm working on it; However, at the moment I do not have the time necessary to present a definitive solution.

Is JME3 willing to accept this "PR"? And in a future version (3.7.x), this issue may be fixed.

scenemax3d · 2024-01-31T07:37:30Z

It is possible that it will be finished on February 4.
Excellent! thank you.

Is JME3 willing to accept this "PR"? And in a future version (3.7.x), this issue may be fixed
I will get the core dev. advise and get back with answer

tonihele · 2024-02-01T07:51:00Z

@tonihele - if we decide to merge this PR, should we need to pay attention to some of your #1868 PR code or we can just merge this PR as-is without warring about the changes that you have made?

This can and should override my PR. No need to worry about the stuff I made.

Merge conflicts just no need to be resolved accordingly.

Also notable that as of currently this PR will change jme-examples to run on LWJGL 3. I suppose this is fine as we should really start advocating it as default.

tonihele · 2024-02-01T07:52:08Z

jme3-examples/src/main/java/jme3test/awt/TestCanvas.java

@@ -172,6 +172,10 @@ public void actionPerformed(ActionEvent e) {
                currentPanel.remove(canvas);
                app.stop(true);

+                try {
+                    Thread.sleep(1000);


This is a test yes but looks like a hack of sorts. Better at least to comment why this is needed. Should consumer add this to their production code?

Should consumer add this to their production code?

It is an important part for lwjgl3-awt to work correctly (the consumer will have to implement it), in the pending commits I plan to document this part.

[ EDIT ]
It's better to have "LwjglCanvas" handle this internally (I'll put it on my list of things to fix).

It's better to have "LwjglCanvas" handle this internally (I'll put it on my list of things to fix).

Definitely. Optimally users should not care whether they are running LWJGL 2 or 3. Identical code should work. Any shenanigans should be hidden from the user (exist in the library itself).

tonihele · 2024-02-01T07:53:57Z

jme3-examples/src/main/java/jme3test/awt/TestCanvas.java

@@ -234,7 +238,7 @@ public static void createCanvas(String appClass){
    }

    public static void startApp(){
-        app.startCanvas();
+        /*app.startCanvas();*/


Code in comments are bad. Also this test should still work on both LWJGL 2 and LWJGL 3. I think it is important that LwjglCanvas works the same. It should handle all disparities internally and not require any shenanigans from the user.

Correction in pending commits....

riccardobl · 2024-02-02T09:10:03Z

Thanks for your PR 💯

Anyone can test this with Wayland on linux? It seems it is using X11 apis, so i wonder if it will work as expected

riccardobl · 2024-02-02T09:13:00Z

There is just one small detail, removing the canvas from its main component and integrating it again breaks it. This issue occurs on the lwjgl3-awt side (LWJGLX/lwjgl3-awt#40)

Can you add a test to reproduce this issue?

tonihele · 2024-02-02T09:21:31Z

Can you add a test to reproduce this issue?

There is the https://github.com/jMonkeyEngine/jmonkeyengine/blob/master/jme3-examples/src/main/java/jme3test/awt/TestCanvas.java general test. It has the context menu where this can be caused.

JNightRider · 2024-02-04T17:46:08Z

With this, this PR now has the necessary documentation and reported bug fixes.

JNightRider · 2024-02-04T17:50:22Z

Can you add a test to reproduce this issue?

It seems that this question has already been answered for you; Thank you @tonihele for your quick response.

tonihele · 2024-02-06T07:40:20Z

Note that this PR changed the jME tests to run on LWJGL3. While this is fine and desirable. Our TestChooser is still written in Swing, and by using TestChooser people might run into errors...

Canvas rendering solution using lwjgl-jawt

3a96def

tonihele reviewed Dec 1, 2023

View reviewed changes

GL Compatibility Support.

0786bfd

wil added 3 commits December 18, 2023 15:50

module change: lwjgl to lwjgl3

e251961

Stop/Start Canvas

04a1676

Enable vsync for LWJGL3-AWT, A debugger that displays the effective d…

9e3952c

…ata for the context in case it fails.

Solution (Linux): Remove/Add Canvas

732f92a

wil added 4 commits December 27, 2023 15:04

MacOS compatibility (no drastic changes)

67e029b

Solution (Windows): Remove/Add Canvas

29a2ff7

Auxiliary class 'LwjglxDefaultGLPlatform'

9cd0ea9

Java-doc

7e70449

wil added 2 commits January 22, 2024 16:17

To check who will do the 'swap buffer'

b2ce047

swap buffers

7b33a14

tonihele reviewed Feb 1, 2024

View reviewed changes

Change: from "LOGGER.warning()" to "LOGGER.log()"

5546cc1

wil added 2 commits February 3, 2024 17:20

Format...

c8f2f5f

Bug fixes and Javadoc

375f74d

Merge branch 'master' into LwjglCanvas_lwjgl-jawt

49d00d0

scenemax3d added this to the v3.7.0 milestone Feb 5, 2024

scenemax3d merged commit 22bf58a into jMonkeyEngine:master Feb 5, 2024

JNightRider deleted the LwjglCanvas_lwjgl-jawt branch February 15, 2024 23:18

stephengold mentioned this pull request Mar 27, 2024

Gradle build (zip) #2235

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

LwjglCanvas using lwjgl-jawt #2153

LwjglCanvas using lwjgl-jawt #2153

JNightRider commented Nov 29, 2023

DontingK commented Nov 30, 2023

tonihele commented Dec 1, 2023

tonihele Dec 1, 2023

JNightRider Dec 1, 2023

tonihele commented Dec 17, 2023

JNightRider commented Dec 18, 2023 •

edited

Loading

tonihele commented Dec 18, 2023

tonihele commented Dec 18, 2023

tonihele commented Dec 18, 2023

JNightRider commented Dec 18, 2023

JNightRider commented Dec 18, 2023

tonihele commented Dec 18, 2023

JNightRider commented Dec 18, 2023

JNightRider commented Dec 20, 2023

JNightRider commented Dec 27, 2023 •

edited

Loading

scenemax3d commented Jan 12, 2024

JNightRider commented Jan 12, 2024 •

edited

Loading

tonihele commented Jan 19, 2024

scenemax3d commented Jan 19, 2024

scenemax3d commented Jan 29, 2024

JNightRider commented Jan 30, 2024 •

edited

Loading

scenemax3d commented Jan 31, 2024

tonihele commented Feb 1, 2024

tonihele Feb 1, 2024

JNightRider Feb 1, 2024 •

edited

Loading

tonihele Feb 2, 2024

tonihele Feb 1, 2024

JNightRider Feb 1, 2024

riccardobl commented Feb 2, 2024 •

edited

Loading

riccardobl commented Feb 2, 2024

tonihele commented Feb 2, 2024

JNightRider commented Feb 4, 2024

JNightRider commented Feb 4, 2024

tonihele commented Feb 6, 2024

LwjglCanvas using lwjgl-jawt #2153

LwjglCanvas using lwjgl-jawt #2153

Conversation

JNightRider commented Nov 29, 2023

DontingK commented Nov 30, 2023

tonihele commented Dec 1, 2023

tonihele Dec 1, 2023

Choose a reason for hiding this comment

JNightRider Dec 1, 2023

Choose a reason for hiding this comment

tonihele commented Dec 17, 2023

JNightRider commented Dec 18, 2023 • edited Loading

tonihele commented Dec 18, 2023

tonihele commented Dec 18, 2023

tonihele commented Dec 18, 2023

JNightRider commented Dec 18, 2023

JNightRider commented Dec 18, 2023

tonihele commented Dec 18, 2023

JNightRider commented Dec 18, 2023

JNightRider commented Dec 20, 2023

JNightRider commented Dec 27, 2023 • edited Loading

scenemax3d commented Jan 12, 2024

JNightRider commented Jan 12, 2024 • edited Loading

tonihele commented Jan 19, 2024

scenemax3d commented Jan 19, 2024

scenemax3d commented Jan 29, 2024

JNightRider commented Jan 30, 2024 • edited Loading

scenemax3d commented Jan 31, 2024

tonihele commented Feb 1, 2024

tonihele Feb 1, 2024

Choose a reason for hiding this comment

JNightRider Feb 1, 2024 • edited Loading

Choose a reason for hiding this comment

tonihele Feb 2, 2024

Choose a reason for hiding this comment

tonihele Feb 1, 2024

Choose a reason for hiding this comment

JNightRider Feb 1, 2024

Choose a reason for hiding this comment

riccardobl commented Feb 2, 2024 • edited Loading

riccardobl commented Feb 2, 2024

tonihele commented Feb 2, 2024

JNightRider commented Feb 4, 2024

JNightRider commented Feb 4, 2024

tonihele commented Feb 6, 2024

JNightRider commented Dec 18, 2023 •

edited

Loading

JNightRider commented Dec 27, 2023 •

edited

Loading

JNightRider commented Jan 12, 2024 •

edited

Loading

JNightRider commented Jan 30, 2024 •

edited

Loading

JNightRider Feb 1, 2024 •

edited

Loading

riccardobl commented Feb 2, 2024 •

edited

Loading