Working splash screen in Linux GameLauncher #17913

Fireronin · 2024-05-13T09:36:48Z

What does this PR do?

This PR allows for setting of splash screen that is rendered using xcb, therefore it removes black screen while renderer is working.

Splash screen image is passed via xxd generated .h file during compilation, from png file named logo.png

The use of generic malloc for data vector and not AZ vectors is due to the fact that functions like xcb_destroy_image, expect ability to deallocate vector with data.

It adds dependency on libxcb-image0-dev

How was this PR tested?

It was tested in debug builds, of project.

michalpelka

I cannot accept a change, since it needs a hardcoded location of the cache folder concerning executable. It, most probably, works only with developers' setup when the GameLauncher target is built. I would suggest testing the monolithic build and trying to run the install target.
Refer to https://development--o3deorg.netlify.app/docs/user-guide/interactivity/robotics/deploying-simulation/ https://development--o3deorg.netlify.app/docs/user-guide/packaging/

Code/Framework/AzFramework/Platform/Common/Xcb/AzFramework/XcbNativeWindow.cpp

spham-amzn

We cannot use the approach of checking in the splash screen as binary data for the splash screen since the splash screen will be specific to the launcher. It needs to be an image that is specific to the project itself, so there probably needs a mechanism to do this that is outside of the asset processor itself during the build to generate the splash screen image as part of the build process.

Code/Framework/AzFramework/Platform/Common/Xcb/AzFramework/XcbNativeWindow.cpp

Code/Framework/AzFramework/Platform/Common/Xcb/azframework_xcb_files.cmake

spham-amzn · 2024-05-14T20:18:39Z

cmake/Platform/Linux/Packaging_linux.cmake

@@ -48,6 +48,7 @@ elseif("$ENV{O3DE_PACKAGE_TYPE}" STREQUAL "DEB")
        libxkbcommon-dev                        # For xcb keyboard input
        libxcb-xfixes0-dev                      # For mouse input
        libxcb-xinput-dev                       # For mouse input
+        libxcb-image0-dev                       # For xcb image support


If we are adding another xcb package dependency, then it also needs to be added to the build node initialization list, i.e. https://github.com/o3de/o3de/blob/development/scripts/build/build_node/Platform/Linux/package-list.ubuntu-jammy.txt .
And also in order for AR to run successfully, the linux nodes will need to be rebuilt first with the new nodes, which means that change may need a separate PR to go in first, and then coordination with sig-build is needed to propogate the changes.

@Fireronin could you prepare a separate PR as @spham-amzn proposed and link here.

Here is pr you asked for

#17925

This will also require an update the documentation here:

Also note that you will need to work with sig-build to get the changes to the AR jenkins nodes from #17925 before this change, otherwise it will not pass AR.

Code/Framework/AzFramework/Platform/Common/Xcb/AzFramework/XcbNativeWindow.cpp

spham-amzn · 2024-05-14T20:25:02Z

I think the logic to process the splash screen for the launcher belongs in the LauncherUnified project and not in AzFramework. The generation of the logo.h should be based on a png file that exists in the game project itself, and that file should go into the intermediate build folder with the include path appended instead of placing it directly in AzFramework.

Code/Framework/AzFramework/Platform/Common/Xcb/azframework_xcb_files.cmake

By mistake.

Code/Framework/AzFramework/Platform/Common/Xcb/AzFramework/XcbNativeWindow.cpp

Code/Framework/AzFramework/Platform/Common/Xcb/AzFramework/XcbNativeWindow.h

Fireronin · 2024-06-05T14:38:07Z

Ok, changes applied

Code/Framework/AzFramework/Platform/Linux/platform_nativeui_linux.cmake

Code/Framework/AzFramework/Platform/Common/Xcb/generate_splash_screen_header.cmake

Code/Framework/AzFramework/Platform/Common/Xcb/azframework_xcb_files.cmake

Fireronin · 2024-06-07T10:23:39Z

Ok this should do the trick, if you will give it a green light I will squash it all

michalpelka · 2024-06-07T11:46:41Z

Please rebase and squash, fix DCO.
I also found that you have to have cmake 3.27.0 to configure project. xcb-image was introduced to FindX11.cmake recently: Kitware/CMake@858fd8e

spham-amzn · 2024-06-07T15:00:23Z

Please rebase and squash, fix DCO. I also found that you have to have cmake 3.27.0 to configure project. xcb-image was introduced to FindX11.cmake recently: Kitware/CMake@858fd8e

If this is true, then we either have to update the minimum version of cmake in the documentation and in the cmake scripts.

The other alternative is explicitly do a FindLibrary for xcb-image with the 3rdParty::X11:: prefix in the cmake file for XCB.

Fireronin · 2024-06-11T07:55:49Z

This version builds with older cmake

Code/Framework/AzFramework/Platform/Linux/platform_nativeui_linux.cmake

Fireronin · 2024-06-17T08:53:09Z

Hi, @spham-amzn
This pr was reviewed by @michalpelka, and here is updated documentation pr, o3de/o3de.org#2557

michalpelka · 2024-06-17T08:55:24Z

Also there is update of build config: #17925

michalpelka · 2024-06-17T09:55:52Z

@spham-amzn thank you for the help on this PR. It would be beneficial for this PR, if you would consider a second review.

spham-amzn

I think you will still need to work with sig-build to get the new xcb library on the jenkins build machines for AR or this may not pass. And you may want to send out an impactful change message on discord to broadcast the fact that new packages are needed now to build on Linux

byrcolin · 2024-06-18T15:48:31Z

@amzn-changml I think we need a issue for adding for xcb on build machines

adamdbrw · 2024-07-18T15:06:18Z

https://github.com/amzn-changml is there any update on this?

amzn-changml · 2024-07-25T04:09:24Z

The required dependencies have been updated. I ran AR, but it appears be failing on Windows. You might want to merge latest in Development

Fireronin · 2024-08-28T13:41:32Z

@amzn-changml Hi, do you know what might be the deal with failed tests there are failed tests in Android and windows but both of those mention libraries I haven't even touched and are not even remotely connected with this pr

Signed-off-by: Krzysztof Rymski <[email protected]> Initial fixes Signed-off-by: Krzysztof Rymski <[email protected]> Undoing formating part2 Signed-off-by: Krzysztof Rymski <[email protected]> Undoing formating part3 Signed-off-by: Krzysztof Rymski <[email protected]> Undoing formating part4 Signed-off-by: Krzysztof Rymski <[email protected]> Undoing formating part4 Signed-off-by: Krzysztof Rymski <[email protected]> Undoing formating part4 Signed-off-by: Krzysztof Rymski <[email protected]> Undoing formating part4 Signed-off-by: Krzysztof Rymski <[email protected]> Cleanup Signed-off-by: Krzysztof Rymski <[email protected]> Cleanup - move function as private Signed-off-by: Krzysztof Rymski <[email protected]> Now generates logo.h based on logo.png, this is then unpacked using lib png, so user can specify logo.png on compile time Signed-off-by: Krzysztof Rymski <[email protected]> Now generates logo.h based on logo.png, this is then unpacked using lib png, so user can specify logo.png on compile time Signed-off-by: Krzysztof Rymski <[email protected]> Now generates logo.h based on logo.png, this is then unpacked using lib png, so user can specify logo.png on compile time. (cleanup) Signed-off-by: Krzysztof Rymski <[email protected]> Now generates logo.h based on logo.png, this is then unpacked using lib png, so user can specify logo.png on compile time. (cleanup 2) Signed-off-by: Krzysztof Rymski <[email protected]> Now generates logo.h based on logo.png, this is then unpacked using lib png, so user can specify logo.png on compile time. (cleanup 3) Signed-off-by: Krzysztof Rymski <[email protected]> Now generates logo.h based on logo.png, this is then unpacked using lib png, so user can specify logo.png on compile time. (cleanup 4) Signed-off-by: Krzysztof Rymski <[email protected]> Now generates logo.h based on logo.png, this is then unpacked using lib png, so user can specify logo.png on compile time. (cleanup 4) Signed-off-by: Krzysztof Rymski <[email protected]> Removed lambda and logo is now tracked may change this later Signed-off-by: Krzysztof Rymski <[email protected]> Cleanup of variables Signed-off-by: Krzysztof Rymski <[email protected]> Now works with new file per project and all is behind ifdef so if file is not present functionality will not be compiled in Signed-off-by: Krzysztof Rymski <[email protected]> Fancy cmake, and bug fix Removed todo Signed-off-by: Krzysztof Rymski <[email protected]> Reduced macro use, dco retrigger Signed-off-by: Krzysztof Rymski <[email protected]> Applying requested changes xcb 3rdParty prefix removed xdd existance check Signed-off-by: Krzysztof Rymski <[email protected]> Removed prefix Signed-off-by: Krzysztof Rymski <[email protected]> Update Code/Framework/AzFramework/Platform/Linux/platform_nativeui_linux.cmake Co-authored-by: Michał Pełka <[email protected]> Signed-off-by: Krzysztof Rymski <[email protected]> Added license Added copyright license Signed-off-by: Krzysztof Rymski <[email protected]>

Fireronin · 2024-08-28T14:09:49Z

Rebased onto development

Fireronin requested review from a team as code owners May 13, 2024 09:36

Fireronin force-pushed the xcb-splashScreen branch from 9d5b905 to c2eeeb3 Compare May 13, 2024 09:48

michalpelka changed the title ~~Working splash screen~~ Working splash screen in Linux GameLauncher May 13, 2024

michalpelka requested changes May 13, 2024

View reviewed changes

michalpelka reviewed May 13, 2024

View reviewed changes

Code/Framework/AzFramework/Platform/Common/Xcb/AzFramework/XcbNativeWindow.cpp Outdated Show resolved Hide resolved

Fireronin requested a review from michalpelka May 13, 2024 15:03

Fireronin force-pushed the xcb-splashScreen branch from d14dbdd to 9ce726b Compare May 13, 2024 15:50

spham-amzn requested changes May 13, 2024

View reviewed changes

PawelLiberadzki reviewed May 14, 2024

View reviewed changes

Fireronin mentioned this pull request May 14, 2024

Splash screen for linux modification o3de/o3de.org#2557

Open

4 tasks

byrcolin added sig/build Categorizes an issue or PR as relevant to SIG Build. sig/core Categorizes an issue or PR as relevant to SIG Core labels May 14, 2024

byrcolin requested review from a team May 14, 2024 16:15

spham-amzn reviewed May 14, 2024

View reviewed changes

Code/Framework/AzFramework/Platform/Common/Xcb/azframework_xcb_files.cmake Outdated Show resolved Hide resolved

spham-amzn reviewed May 14, 2024

View reviewed changes

Code/Framework/AzFramework/Platform/Common/Xcb/AzFramework/XcbNativeWindow.cpp Outdated Show resolved Hide resolved

michalpelka previously approved these changes May 16, 2024

View reviewed changes

Code/Framework/AzFramework/Platform/Common/Xcb/azframework_xcb_files.cmake Outdated Show resolved Hide resolved

Fireronin mentioned this pull request May 16, 2024

libxcb-image0-dev and xxd added to dependencies of build nodes #17925

Merged

michalpelka self-requested a review May 16, 2024 14:03

lemonade-dm reviewed May 17, 2024

View reviewed changes

Code/Framework/AzFramework/Platform/Common/Xcb/AzFramework/XcbNativeWindow.cpp Outdated Show resolved Hide resolved

lemonade-dm reviewed May 17, 2024

View reviewed changes

Code/Framework/AzFramework/Platform/Common/Xcb/AzFramework/XcbNativeWindow.cpp Outdated Show resolved Hide resolved

Fireronin force-pushed the xcb-splashScreen branch from 564b59a to 88a7357 Compare May 21, 2024 07:55

Fireronin requested a review from spham-amzn May 22, 2024 09:16

michalpelka reviewed May 22, 2024

View reviewed changes

Code/Framework/AzFramework/Platform/Common/Xcb/AzFramework/XcbNativeWindow.h Outdated Show resolved Hide resolved

Fireronin commented Jun 5, 2024

View reviewed changes

Code/Framework/AzFramework/Platform/Linux/platform_nativeui_linux.cmake Outdated Show resolved Hide resolved

spham-amzn reviewed Jun 5, 2024

View reviewed changes

Code/Framework/AzFramework/Platform/Common/Xcb/generate_splash_screen_header.cmake Outdated Show resolved Hide resolved

spham-amzn reviewed Jun 5, 2024

View reviewed changes

Code/Framework/AzFramework/Platform/Common/Xcb/azframework_xcb_files.cmake Outdated Show resolved Hide resolved

Fireronin requested a review from spham-amzn June 7, 2024 10:23

Fireronin force-pushed the xcb-splashScreen branch 3 times, most recently from dbc608d to 9184367 Compare June 7, 2024 13:20

Fireronin force-pushed the xcb-splashScreen branch from 0e96b45 to 65d48cb Compare June 11, 2024 07:55

michalpelka reviewed Jun 13, 2024

View reviewed changes

Code/Framework/AzFramework/Platform/Linux/platform_nativeui_linux.cmake Outdated Show resolved Hide resolved

michalpelka approved these changes Jun 14, 2024

View reviewed changes

spham-amzn approved these changes Jun 17, 2024

View reviewed changes

byrcolin removed request for a team June 25, 2024 16:27

Fireronin force-pushed the xcb-splashScreen branch 2 times, most recently from d7067dc to 3efde82 Compare July 25, 2024 14:46

Fireronin force-pushed the xcb-splashScreen branch from 3efde82 to 6952798 Compare August 28, 2024 14:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Working splash screen in Linux GameLauncher #17913

Working splash screen in Linux GameLauncher #17913

Fireronin commented May 13, 2024 •

edited

Loading

michalpelka left a comment

spham-amzn left a comment

spham-amzn May 14, 2024

michalpelka May 16, 2024

Fireronin May 16, 2024

spham-amzn Jun 4, 2024

spham-amzn Jun 4, 2024 •

edited

Loading

spham-amzn commented May 14, 2024

Fireronin commented Jun 5, 2024

Fireronin commented Jun 7, 2024

michalpelka commented Jun 7, 2024

spham-amzn commented Jun 7, 2024

Fireronin commented Jun 11, 2024

Fireronin commented Jun 17, 2024

michalpelka commented Jun 17, 2024

michalpelka commented Jun 17, 2024

spham-amzn left a comment

byrcolin commented Jun 18, 2024 •

edited

Loading

adamdbrw commented Jul 18, 2024

amzn-changml commented Jul 25, 2024

Fireronin commented Aug 28, 2024

Fireronin commented Aug 28, 2024

Working splash screen in Linux GameLauncher #17913

Are you sure you want to change the base?

Working splash screen in Linux GameLauncher #17913

Conversation

Fireronin commented May 13, 2024 • edited Loading

What does this PR do?

How was this PR tested?

michalpelka left a comment

Choose a reason for hiding this comment

spham-amzn left a comment

Choose a reason for hiding this comment

spham-amzn May 14, 2024

Choose a reason for hiding this comment

michalpelka May 16, 2024

Choose a reason for hiding this comment

Fireronin May 16, 2024

Choose a reason for hiding this comment

spham-amzn Jun 4, 2024

Choose a reason for hiding this comment

spham-amzn Jun 4, 2024 • edited Loading

Choose a reason for hiding this comment

spham-amzn commented May 14, 2024

Fireronin commented Jun 5, 2024

Fireronin commented Jun 7, 2024

michalpelka commented Jun 7, 2024

spham-amzn commented Jun 7, 2024

Fireronin commented Jun 11, 2024

Fireronin commented Jun 17, 2024

michalpelka commented Jun 17, 2024

michalpelka commented Jun 17, 2024

spham-amzn left a comment

Choose a reason for hiding this comment

byrcolin commented Jun 18, 2024 • edited Loading

adamdbrw commented Jul 18, 2024

amzn-changml commented Jul 25, 2024

Fireronin commented Aug 28, 2024

Fireronin commented Aug 28, 2024

Fireronin commented May 13, 2024 •

edited

Loading

spham-amzn Jun 4, 2024 •

edited

Loading

byrcolin commented Jun 18, 2024 •

edited

Loading