anulax
/
glfw
1
0
Fork 0
Code Issues Pull Requests Packages project_board Releases Wiki Activity

Wayland: Enable platform by default

Browse Source 
This changes the default platform for Unix-like systems (other than
macOS) from only X11 to Wayland and X11.  It also removes the backward
compatibility with the older GLFW_USE_WAYLAND CMake option.

If a bisect took you here because your build broke, hello, sorry, set
the GLFW_BUILD_WAYLAND or GLFW_BUILD_X11 CMake option to disable the
associated platform.

This can be done when configuring GLFW with CMake, from a higher-level
CMakeLists.txt if GLFW is part of your project, or at any point after
configuration by updating the CMake cache with the command-line tool or
the GUI.

The next step is to make Wayland the run-time default when enabled, but
that will hopefully not break any builds.

Related to #2439
master
Camilla Löwy ago%!(EXTRA string=2 years)
parent 51920ede68
commit 2590d4cdd4
2 changed files with 37 additions and 57 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 8
      CMakeLists.txt
  2. 86
      docs/compile.dox

8
CMakeLists.txt
Unescape View File

@ -27,11 +27,15 @@ if (GLFW_USE_OSMESA)
message(FATAL_ERROR "GLFW_USE_OSMESA has been removed; set the GLFW_PLATFORM init hint") message(FATAL_ERROR "GLFW_USE_OSMESA has been removed; set the GLFW_PLATFORM init hint")
endif() endif()
if (DEFINED GLFW_USE_WAYLAND AND UNIX AND NOT APPLE)
message(FATAL_ERROR
"GLFW_USE_WAYLAND has been removed; set the GLFW_BUILD_WAYLAND and GLFW_BUILD_X11 options")
endif()
cmake_dependent_option(GLFW_BUILD_WIN32 "Build support for Win32" ON "WIN32" OFF) cmake_dependent_option(GLFW_BUILD_WIN32 "Build support for Win32" ON "WIN32" OFF)
cmake_dependent_option(GLFW_BUILD_COCOA "Build support for Cocoa" ON "APPLE" OFF) cmake_dependent_option(GLFW_BUILD_COCOA "Build support for Cocoa" ON "APPLE" OFF)
cmake_dependent_option(GLFW_BUILD_X11 "Build support for X11" ON "UNIX;NOT APPLE" OFF) cmake_dependent_option(GLFW_BUILD_X11 "Build support for X11" ON "UNIX;NOT APPLE" OFF)
cmake_dependent_option(GLFW_BUILD_WAYLAND "Build support for Wayland" cmake_dependent_option(GLFW_BUILD_WAYLAND "Build support for Wayland" ON "UNIX;NOT APPLE" OFF)
"${GLFW_USE_WAYLAND}" "UNIX;NOT APPLE" OFF)
cmake_dependent_option(GLFW_USE_HYBRID_HPG "Force use of high-performance GPU on hybrid systems" OFF cmake_dependent_option(GLFW_USE_HYBRID_HPG "Force use of high-performance GPU on hybrid systems" OFF
"WIN32" OFF) "WIN32" OFF)

86
docs/compile.dox
Unescape View File

@ -42,73 +42,48 @@ all necessary dependencies for compiling GLFW, but on Unix-like systems like
Linux and FreeBSD you will need a few extra packages. Linux and FreeBSD you will need a few extra packages.
@subsubsection compile_deps_x11 Dependencies for X11
To compile GLFW for X11, you need to have the X11 development packages
installed. They are not needed to build or run programs that use GLFW.
On Debian and derivatives like Ubuntu and Linux Mint the `xorg-dev` meta-package
pulls in the development packages for all of X11.
@code{.sh}
sudo apt install xorg-dev
@endcode
On Fedora and derivatives like Red Hat the X11 extension packages
`libXcursor-devel`, `libXi-devel`, `libXinerama-devel` and `libXrandr-devel`
required by GLFW pull in all its other dependencies.
@code{.sh}
sudo dnf install libXcursor-devel libXi-devel libXinerama-devel libXrandr-devel
@endcode
On FreeBSD the X11 headers are installed along the end-user X11 packages, so if
you have an X server running you should have the headers as well. If not,
install the `xorgproto` package.
@code{.sh}
pkg install xorgproto
@endcode
On Cygwin the `libXcursor-devel`, `libXi-devel`, `libXinerama-devel`,
`libXrandr-devel` and `libXrender-devel` packages in the Libs section of the GUI
installer will install all the headers and other development related files GLFW
requires for X11.
Once you have the required dependencies, move on to @ref compile_generate.
@subsubsection compile_deps_wayland Dependencies for Wayland and X11 @subsubsection compile_deps_wayland Dependencies for Wayland and X11
By default, both the Wayland and X11 backends are enabled on Linux and other Unix-like
systems (except macOS). To disable one or both of these, set the @ref GLFW_BUILD_WAYLAND
or @ref GLFW_BUILD_X11 CMake options in the next step when generating build files.
To compile GLFW for both Wayland and X11, you need to have the X11, Wayland and xkbcommon To compile GLFW for both Wayland and X11, you need to have the X11, Wayland and xkbcommon
development packages installed. They are not needed to build or run programs that use development packages installed. On some systems a few other packages are also required.
GLFW. You will also need to set the @ref GLFW_BUILD_WAYLAND CMake option in the next None of the development packages above are needed to build or run programs that use an
step when generating build files. already compiled GLFW library.
On Debian and derivatives like Ubuntu and Linux Mint you will need the `libwayland-dev` On Debian and derivatives like Ubuntu and Linux Mint you will need the `libwayland-dev`
and `libxkbcommon-dev` packages and the `xorg-dev` meta-package. These will pull in all and `libxkbcommon-dev` packages to compile for Wayland and the `xorg-dev` meta-package to
other dependencies. compile for X11. These will pull in all other dependencies.
@code{.sh} @code{.sh}
sudo apt install libwayland-dev libxkbcommon-dev xorg-dev sudo apt install libwayland-dev libxkbcommon-dev xorg-dev
@endcode @endcode
On Fedora and derivatives like Red Hat you will need the `wayland-devel`, On Fedora and derivatives like Red Hat you will need the `wayland-devel` and
`libxkbcommon-devel`, `libXcursor-devel`, `libXi-devel`, `libXinerama-devel` and `libxkbcommon-devel` packages to compile for Wayland and the `libXcursor-devel`,
`libXrandr-devel` packages. These will pull in all other dependencies. `libXi-devel`, `libXinerama-devel` and `libXrandr-devel` packages to compile for X11.
These will pull in all other dependencies.
@code{.sh} @code{.sh}
sudo dnf install wayland-devel libxkbcommon-devel libXcursor-devel libXi-devel libXinerama-devel libXrandr-devel sudo dnf install wayland-devel libxkbcommon-devel libXcursor-devel libXi-devel libXinerama-devel libXrandr-devel
@endcode @endcode
On FreeBSD you will need the `wayland`, `libxkbcommon` and `evdev-proto` packages. The On FreeBSD you will need the `wayland`, `libxkbcommon` and `evdev-proto` packages to
X11 headers are installed along the end-user X11 packages, so if you have an X server compile for Wayland. The X11 headers are installed along the end-user X11 packages, so if
running you should have the headers as well. If not, install the `xorgproto` package. you have an X server running you should have the headers as well. If not, install the
`xorgproto` package to compile for X11.
@code{.sh} @code{.sh}
pkg install wayland libxkbcommon evdev-proto xorgproto pkg install wayland libxkbcommon evdev-proto xorgproto
@endcode @endcode
On Cygwin Wayland is not supported but you will need the `libXcursor-devel`,
`libXi-devel`, `libXinerama-devel`, `libXrandr-devel` and `libXrender-devel` packages to
compile for X11. These can be found in the Libs section of the GUI installer and will
pull in all other dependencies.
Once you have the required dependencies, move on to @ref compile_generate. Once you have the required dependencies, move on to @ref compile_generate.
@ -143,9 +118,10 @@ If you wish change any CMake variables in the list, press _Configure_ and then
_Generate_ to have the new values take effect. The variable list will be _Generate_ to have the new values take effect. The variable list will be
populated after the first configure step. populated after the first configure step.
By default, GLFW will use X11 on Linux and other Unix-like systems other than macOS. To By default, GLFW will use Wayland and X11 on Linux and other Unix-like systems other than
include support for Wayland as well, set the @ref GLFW_BUILD_WAYLAND option in the GLFW macOS. To disable support for one or both of these, set the @ref GLFW_BUILD_WAYLAND
section of the variable list, then apply the new value as described above. and/or @ref GLFW_BUILD_X11 option in the GLFW section of the variable list, then apply the
new value as described above.
Once you have generated the project files or makefiles for your chosen Once you have generated the project files or makefiles for your chosen
development environment, move on to @ref compile_compile. development environment, move on to @ref compile_compile.
@ -177,12 +153,12 @@ flag.
cmake -S path/to/glfw -B path/to/build -G Xcode cmake -S path/to/glfw -B path/to/build -G Xcode
@endcode @endcode
By default, GLFW will use X11 on Linux and other Unix-like systems other By default, GLFW will use Wayland and X11 on Linux and other Unix-like systems other than
than macOS. To also include support for Wayland, set the @ref GLFW_BUILD_WAYLAND CMake macOS. To disable support for one or both of these, set the @ref GLFW_BUILD_WAYLAND
option. and/or @ref GLFW_BUILD_X11 CMake option.
@code{.sh} @code{.sh}
cmake -S path/to/glfw -B path/to/build -D GLFW_BUILD_WAYLAND=1 cmake -S path/to/glfw -B path/to/build -D GLFW_BUILD_X11=0
@endcode @endcode
Once you have generated the project files or makefiles for your chosen Once you have generated the project files or makefiles for your chosen
@ -315,7 +291,7 @@ default.
@anchor GLFW_BUILD_WAYLAND @anchor GLFW_BUILD_WAYLAND
__GLFW_BUILD_WAYLAND__ determines whether to include support for Wayland when compiling __GLFW_BUILD_WAYLAND__ determines whether to include support for Wayland when compiling
the library. This option is only available when compiling for Linux and other Unix-like the library. This option is only available when compiling for Linux and other Unix-like
systems other than macOS. This is disabled by default. systems other than macOS. This is enabled by default.
@anchor GLFW_BUILD_X11 @anchor GLFW_BUILD_X11
__GLFW_BUILD_X11__ determines whether to include support for X11 when compiling the __GLFW_BUILD_X11__ determines whether to include support for X11 when compiling the

Write Preview
Loading…
Cancel
Save