commit a12311e596a3bca3b41388b5de5b566374dc9841
author Camilla Löwy <elmindreda@elmindreda.org> Wed Jan 31 00:49:53 2024 +0100
committer Camilla Löwy <elmindreda@elmindreda.org> Mon Feb 12 22:50:25 2024 +0100
tree 586405e7692991f2717130e8ccc155a1f0e32029
parent bb951b4b712b3ebcbb9e07fee48b7ee3247b033a

Document GLFW_FLOATING not supported on Wayland

include/GLFW/glfw3.h

diff --git a/include/GLFW/glfw3.h b/include/GLFW/glfw3.h
index 6f8c9b4..f86b176 100644
--- a/include/GLFW/glfw3.h
+++ b/include/GLFW/glfw3.h
@@ -4041,11 +4041,14 @@
  *
  *  @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