From 645730b2bdad252db46d5382f736be0be5e4e11c Mon Sep 17 00:00:00 2001 From: Michael Pennington Date: Fri, 27 May 2022 00:44:10 -0400 Subject: [PATCH] Add documentation for wayland app_id --- CONTRIBUTORS.md | 1 + README.md | 2 ++ docs/news.dox | 5 +++++ docs/window.dox | 8 ++++++++ include/GLFW/glfw3.h | 7 ++++--- 5 files changed, 20 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 030abf7c..444657e6 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -157,6 +157,7 @@ video tutorials. - Peoro - Braden Pellett - Christopher Pelloux + - Michael Pennington - Arturo J. Pérez - Vladimir Perminov - Anthony Pesch diff --git a/README.md b/README.md index 72cbef36..ab32a570 100644 --- a/README.md +++ b/README.md @@ -121,6 +121,8 @@ information on what to include when reporting a bug. ## Changelog + - Added `GLFW_WAYLAND_APP_ID` window hint string for wayland app_id selection + (#2121) - Added `GLFW_PLATFORM` init hint for runtime platform selection (#1958) - Added `GLFW_ANY_PLATFORM`, `GLFW_PLATFORM_WIN32`, `GLFW_PLATFORM_COCOA`, `GLFW_PLATFORM_WAYLAND`, `GLFW_PLATFORM_X11` and `GLFW_PLATFORM_NULL` symbols to diff --git a/docs/news.dox b/docs/news.dox index fbf60319..c18dc581 100644 --- a/docs/news.dox +++ b/docs/news.dox @@ -9,6 +9,11 @@ @subsection features_34 New features in version 3.4 +@subsubsection wayland_app_id_32 Wayland app_id specification + +GLFW now supports specifying the app_id for a wayland window using the +@ref GLFW_WAYLAND_APP_ID window hint string. + @subsubsection runtime_platform_34 Runtime platform selection GLFW now supports being compiled for multiple backends and selecting between diff --git a/docs/window.dox b/docs/window.dox index 32271e3a..15c48615 100644 --- a/docs/window.dox +++ b/docs/window.dox @@ -492,6 +492,13 @@ __GLFW_X11_CLASS_NAME__ and __GLFW_X11_INSTANCE_NAME__ specifies the desired ASCII encoded class and instance parts of the ICCCM `WM_CLASS` window property. These are set with @ref glfwWindowHintString. +@subsubsection window_hints_wayland Wayland specific window hints + +@anchor GLFW_WAYLAND_APP_ID_hint +__GLFW_WAYLAND_APP_ID__ specifies the wayland app_id for a wayland window, used +by window managers to identify types of windows. This is set with +@ref glfwWindowHintString. + @subsubsection window_hints_values Supported and default values @@ -540,6 +547,7 @@ GLFW_COCOA_FRAME_NAME | `""` | A UTF-8 encoded fr GLFW_COCOA_GRAPHICS_SWITCHING | `GLFW_FALSE` | `GLFW_TRUE` or `GLFW_FALSE` GLFW_X11_CLASS_NAME | `""` | An ASCII encoded `WM_CLASS` class name GLFW_X11_INSTANCE_NAME | `""` | An ASCII encoded `WM_CLASS` instance name +GLFW_WAYLAND_APP_ID | `""` | An ASCII encoded wayland `app_id` name @section window_events Window event processing diff --git a/include/GLFW/glfw3.h b/include/GLFW/glfw3.h index f1ce07f5..9d8d41e8 100644 --- a/include/GLFW/glfw3.h +++ b/include/GLFW/glfw3.h @@ -1104,11 +1104,12 @@ extern "C" { * [window hint](@ref GLFW_X11_CLASS_NAME_hint). */ #define GLFW_X11_INSTANCE_NAME 0x00024002 - -#define GLFW_WAYLAND_APP_ID 0x00026001 /*! @brief Wayland specific - * [window hint](@ref GLDW_WAYLAND_CLASS_NAME_hint). + * [window hint](@ref GLFW_WAYLAND_APP_ID_hint). + * + * Allows specification of the wayland app_id. */ +#define GLFW_WAYLAND_APP_ID 0x00026001 #define GLFW_WIN32_KEYBOARD_MENU 0x00025001 /*! @} */