- Qt 5.15
- Qt WebEngine
- Qt WebEngine Platform Notes
- Qt 5.15.19 Reference Documentation

# Qt WebEngine Platform Notes

## Building Qt WebEngine from Source

Static builds are not supported.

The requirements for building Qt 5 modules from source are listed separately for each supported platform:

- Qt for Windows - Requirements
- Qt for X11 Requirements
- Qt for macOS - Building from Source

In addition, the following tools are required for building the Qt WebEngine module:

- All Platforms
- Windows
- Linux
- macOS

The tests for skipping the Qt WebEngine build are located in the `qtwebengine` repository, in the `tools\qmake\mkspecs` subdirectory. They can be found by searching for `skipBuild`.

### All Platforms

On all platforms, the following tools are required at build time:

- Python 2.7.5 or later. Python 3 is not supported.
- Bison, Flex
- GPerf
- Node.js version 8 or later (version 12 or later is recommended)

### Windows

On Windows, the following additional tools are required:

- Visual Studio 2017 version 15.8 or later, or clang-cl version 8 or later
- Active Template Library (ATL), usually included in the Visual Studio installation
- Windows 10 SDK version 10.0.19041 or later

Qt WebEngine can only be built on 64-bit Windows, with a x64-bit toolchain. For building Qt WebEngine for x86 applications, you need to configure and compile Qt with the Visual Studio 2017 x64 to x86 cross-compile toolchain. This toolchain can be set up on the command line by running `vcvarsall.bat amd64_x86`.

### Linux

On Linux, Clang or GCC version 5 or later is required. Supported configurations are `linux-g++`, `linux-clang` and `linux-clang-libc++`

Qt WebEngine requires `pkg-config` to detect most of its dependencies. The following `pkg-config` files are required:

- `dbus-1`
- `fontconfig`

If Qt was configured for `xcb`, the following `pkg-config` files are also required:

- `libdrm`
- `xcomposite`
- `xcursor`
- `xi`
- `xrandr`
- `xscrnsaver`
- `xtst`

Further, development packages for `khr` and `libcap` need to be installed.

### macOS

On macOS, the following are required:

- macOS 10.13 or later
- Xcode 10.0 or later
- macOS 10.13 SDK or later

Note: Qt WebEngine cannot be built for the 32-bit mode of macOS (using the `macx-clang-32` `mkspec`).

Note: Universal debug or debug-and-release builds of Qt WebEngine on macOS are not supported in Qt 5 due to memory constraints of the build toolchain. Use the configure options `-force-debug-info` and `-separate-debug-info` for a build that can be used with a debugger.

## Using Earlier Qt Versions to Build Qt WebEngine

Building Qt WebEngine with earlier Qt versions (down to the last LTS version) is supported. It means that Qt WebEngine 5.15 can be built with Qt 5.12.x, Qt 5.14.x, and Qt 5.15.

To use an earlier Qt version to build Qt Webengine:

1. Download the qtwebengine sources.
2. From the earlier Qt version, run `qmake && make (&& make install)`.

## Mac App Store Compatibility

Applications using Qt WebEngine are not compatible with the Mac App Store, because:

- The Chromium part of the code uses several private API methods, which are prohibited by the App Store.
- Applications submitted to the App Store must be code-signed with the App Sandbox feature enabled. The App Sandbox feature interferes with Chromium's own sandbox initialization, which results in Chromium not being properly initialized. This also ties in with the private API usage. Furthermore, standalone Chromium itself is not officially tested with the App Sandbox enabled, and even if work is done to bypass the App Store's restrictions, that would not guarantee correct behavior of the library.

## macOS Airplay Support on MacBooks with Dual GPUs

To make Qt WebEngine work correctly when streaming to an AppleTV from a MacBook that supports GPU switching, it is important to add the `NSSupportsAutomaticGraphicsSwitching` option to the application Info.plist file, with the value set to `YES`. Otherwise rendering issues might occur when creating new web engine view instances after Airplay is switched on or off.

## Default QSurfaceFormat OpenGL Profile Support

If a new default QSurfaceFormat with a modified OpenGL profile has to be set, it should be set before the application instance is declared, to make sure that all created OpenGL contexts use the same OpenGL profile.

On macOS, if the default QSurfaceFormat is set after the application instance, the application will exit with qFatal(), and print a message that the default QSurfaceFormat should be set before the application instance.

## Sandboxing Support

Qt WebEngine provides out-of-the-box sandboxing support for Chromium render processes.

On Linux, note the following restrictions:

- The kernel has to support the anonymous namespaces feature (kernel version 3.8 or later). However, on Debian, Ubuntu, and other Debian-derived distributions, this feature is off by default. It can be turned on by setting `/proc/sys/kernel/unprivileged_userns_clone` to 1.
- The kernel has to support the `seccomp-bpf` feature (kernel version 3.5 or later).
- Setuid sandboxes are not supported and are thus disabled.

To explicitly disable sandboxing, use one of the following options:

- Set the `QTWEBENGINE_DISABLE_SANDBOX` environment variable to 1.
- Pass the `--no-sandbox` command line argument to the user application executable.
- Set `QTWEBENGINE_CHROMIUM_FLAGS` to `--no-sandbox`.

For more information, see Using Command-Line Arguments.

## Memory Requirements in Docker Environment

When running Qt Web Engine examples in a Docker container and browsing content-heavy sites, BUS errors (SIGBUS) might be reported. Typically, this is caused by Docker running a container with a too small memory space (such as 64MB). To fix this problem, increase the memory space size.

## Accessibility and Performance

Qt WebEngine enables accessibility support for web pages when the following conditions are met:

- Qt Core is configured and built with accessibility support enabled.
- The QPA plugin is notified by the operating system that accessibility should be activated. This happens for example when using a screen reader application on Windows or VoiceOver on macOS.

On some old Linux configurations, accessibility can cause a significant slowdown on large HTML pages.

Because of that, Qt WebEngine accessibility support can be disabled on Linux, by setting the `QTWEBENGINE_ENABLE_LINUX_ACCESSIBILITY` environment variable to 0.

## Popups in Fullscreen Applications on Windows

Because of a limitation in the Windows compositor, applications that show a fullscreen web engine view will not properly display popups or other top-level windows. The reason and workaround for the issue can be found at Fullscreen OpenGL Based Windows and QWindowsWindowFunctions::setHasBorderInFullScreen.