From 5e5bc14468020ff07219ec340e61d549a7f7177d Mon Sep 17 00:00:00 2001 From: Emmanuel Gil Peyrot Date: Tue, 19 Dec 2017 21:40:21 +0100 Subject: [PATCH] Fix documentation about window decorations --- include/GLFW/glfw3.h | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/include/GLFW/glfw3.h b/include/GLFW/glfw3.h index 6986492d..217b2c5d 100644 --- a/include/GLFW/glfw3.h +++ b/include/GLFW/glfw3.h @@ -2453,10 +2453,11 @@ GLFWAPI void glfwWindowHintString(int hint, const char* value); * GLFW_X11_CLASS_NAME and @ref GLFW_X11_INSTANCE_NAME window hints to override * this. * - * @remark @wayland The window frame is currently unimplemented, as if - * [GLFW_DECORATED](@ref GLFW_DECORATED_hint) was always set to `GLFW_FALSE`. - * A compositor can still emit close, resize or maximize events, using for - * example a keybind mechanism. + * @remark @wayland The window frame is currently very simple, only allowing + * window resize or move. A compositor can still emit close, maximize or + * fullscreen events, using for example a keybind mechanism. Additionally, + * the wp_viewporter protocol is required for this feature, otherwise the + * window will not be decorated. * * @remark @wayland A full screen window will not attempt to change the mode, * no matter what the requested size or refresh rate. @@ -2898,10 +2899,6 @@ GLFWAPI void glfwGetFramebufferSize(GLFWwindow* window, int* width, int* height) * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref * GLFW_PLATFORM_ERROR. * - * @remark @wayland The window frame is currently unimplemented, as if - * [GLFW_DECORATED](@ref GLFW_DECORATED_hint) was always set to `GLFW_FALSE`, - * so the returned values will always be zero. - * * @thread_safety This function must only be called from the main thread. * * @sa @ref window_size