From a12311e596a3bca3b41388b5de5b566374dc9841 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Camilla=20L=C3=B6wy?= Date: Wed, 31 Jan 2024 00:49:53 +0100 Subject: [PATCH] Document GLFW_FLOATING not supported on Wayland --- include/GLFW/glfw3.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/include/GLFW/glfw3.h b/include/GLFW/glfw3.h index 6f8c9b41..f86b176c 100644 --- a/include/GLFW/glfw3.h +++ b/include/GLFW/glfw3.h @@ -4041,11 +4041,14 @@ GLFWAPI int glfwGetWindowAttrib(GLFWwindow* window, int attrib); * * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref * GLFW_INVALID_ENUM, @ref GLFW_INVALID_VALUE, @ref GLFW_PLATFORM_ERROR and @ref - * GLFW_FEATURE_UNAVAILABLE. + * GLFW_FEATURE_UNAVAILABLE (see remarks). * * @remark Calling @ref glfwGetWindowAttrib will always return the latest * value, even if that value is ignored by the current mode of the window. * + * @remark @wayland The [GLFW_FLOATING](@ref GLFW_FLOATING_attrib) window attribute is + * not supported. Setting this will emit @ref GLFW_FEATURE_UNAVAILABLE. + * * @thread_safety This function must only be called from the main thread. * * @sa @ref window_attribs