JDK-8312518 : [macos13] setFullScreenWindow() shows black screen on macOS 13 & above

[honkar-jdk]

A black screen is seen on newer versions of macOS (13.3 & above) when a window is set to full-screen using setFullScreenWindow(). The root cause was narrowed down to the shield level of the full-screen window vs the shield level of the captured display.

Following solutions were explored -

1. Setting kCGMaximumWindowLevelKey as the shield level for the full screen window. But setting the fullscreen window to maximum available window level might cause z-order issues when other popup/screen savers are involved.

      int shieldLevel = CGWindowLevelForKey(kCGMaximumWindowLevelKey);
      window.preFullScreenLevel = [nsWindow level];
      [nsWindow setLevel: shieldLevel];
   

2. Raise the window's level slightly (shieldLevel + 1) above the system shield window.

        int shieldLevel = CGShieldingWindowLevel();
        window.preFullScreenLevel = [nsWindow level];
        [nsWindow setLevel: (shieldLevel + 1)]; 
   

3. Keeping the shielding level as-is and bringing the window to the foreground after display is captured. The 3rd approach (also the one Apple recommends) ensures that the full screen window has focus as well as being visible and also maintains the correct z-order. This solution works as expected on older (< 13.3) and newer versions (13.3 & above) of macOS.

      if (CGDisplayCapture(aID) == kCGErrorSuccess) {
            ...
            ...
            int shieldLevel = CGShieldingWindowLevel();
            window.preFullScreenLevel = [nsWindow level];
            [nsWindow setLevel: shieldLevel];
            [nsWindow makeKeyAndOrderFront: nil];
        }
   

---

Progress

• Change must be properly reviewed (1 review required, with at least 1 Reviewer)
• Change must not contain extraneous whitespace
• Commit message must refer to an issue

Issue

• JDK-8312518: [macos13] setFullScreenWindow() shows black screen on macOS 13 & above (Bug - P3)

Reviewers

• Sergey Bylokhov (@mrserb - Reviewer)
• Tejesh R (@TejeshR13 - Committer)
• Alexander Zvegintsev (@azvegint - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/17358/head:pull/17358
$ git checkout pull/17358

Update a local copy of the PR:
$ git checkout pull/17358
$ git pull https://git.openjdk.org/jdk.git pull/17358/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 17358

View PR using the GUI difftool:
$ git pr show -t 17358

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/17358.diff

Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back honkar! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

@honkar-jdk The following label will be automatically applied to this pull request:

• client

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

[mlbridge]

Webrevs

• 00: Full (3fc3afe4)

[mrserb]

How it will work now(and worked before) if the user will call toBack() on the such fullscreen window?

[honkar-jdk]

@mrserb

How it will work now(and worked before) if the user will call toBack() on the such fullscreen window?

Tested both cases

• current fix on macOS 13.3 & above + fullScreenWindow.toBack()
• original code on older macOS version (11.5) + fullScreenWindow.toBack()

It works the same in both cases - the shield window becomes the topmost window and a black screen is seen.

[mrserb]

It works the same in both cases - the shield window becomes the topmost window and a black screen is seen.

That probably is not right, but we can fix that separately.

[openjdk]

@honkar-jdk This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8312518: [macos13] setFullScreenWindow() shows black screen on macOS 13 & above

Reviewed-by: serb, tr, azvegint

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 171 new commits pushed to the master branch:

• 93bedd7: 8323213: Fix some javadoc broken links in ObjectReference, and other misc javadoc cleanups
• b78896b: 8319571: Update jni/nullCaller/NullCallerTest.java to accept flags or mark as flagless
• e10d140: 8321712: C2: "failed: Multiple uses of register" in C2_MacroAssembler::vminmax_fp
• c2e77e2: 8319128: sun/security/pkcs11 tests fail on OL 7.9 aarch64
• 9fd855e: 8322971: KEM.getInstance() should check if a 3rd-party security provider is signed
• b8ae4a8: 8320890: [AIX] Find a better way to mimic dl handle equality
• e5aed6b: 8323276: StressDirListings.java fails on AIX
• b922f8d: 8319793: C2 compilation fails with "Bad graph detected in build_loop_late" after JDK-8279888
• 35e9662: 8314515: java/util/concurrent/SynchronousQueue/Fairness.java failed with "Error: fair=false i=8 j=0"
• cb1d25f: 8323330: [BACKOUT] JDK-8276809: java/awt/font/JNICheck/FreeTypeScalerJNICheck.java shows JNI warning on Windows
• ... and 161 more: https://git.openjdk.org/jdk/compare/84c23792856c5c2374963d78a7a734a467bbb79b...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

[TejeshR13]

Looks good to me. Tested and its working as expected.

[honkar-jdk]

/integrate

[openjdk]

Going to push as commit 999e556.
Since your change was applied there have been 192 commits pushed to the master branch:

• 8b6293f: 8301994: Remove unused code from awt_List.cpp
• e33031b: 8323629: Shenandoah: Fix missing include and declaration
• c5e7245: 8322735: C2: minor improvements of bubble sort used in SuperWord::packset_sort
• 65a0672: 8319773: Avoid inflating monitors when installing hash codes for LM_LIGHTWEIGHT
• e22ab10: 8322537: Parallel: Remove experimental adjustment in PSAdaptiveSizePolicy
• be900f1: 8323425: JFR: Auto-generated filename doesn't work with time-limited recording
• 68c4286: 8323008: filter out harmful -std* flags added by autoconf from CXX
• 7dc9dd6: 8234502: Merge GenCollectedHeap and SerialHeap
• ed18222: 8323190: Segfault during deoptimization of C2-compiled code
• 3e19bf8: 8323529: Relativize test image dependencies in microbenchmarks
• ... and 182 more: https://git.openjdk.org/jdk/compare/84c23792856c5c2374963d78a7a734a467bbb79b...master

Your commit was automatically rebased without conflicts.

[openjdk]

@honkar-jdk Pushed as commit 999e556.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.