Merge 09efa97ef5 into 7ef6efeb66

CONTRIBUTORS.md

@@ -55,7 +55,6 @@ video tutorials.
  - Jason Daly
  - danhambleton
  - Jarrod Davis
- - decce
  - Olivier Delannoy
  - Paul R. Deppe
  - Michael Dickens

README.md

@@ -134,6 +134,7 @@ information on what to include when reporting a bug.
  - [Wayland] Bugfix: Ignore key repeat events when no window has keyboard focus (#2727)
  - [Wayland] Bugfix: Reset key repeat timer when window destroyed (#2741,#2727)
  - [Wayland] Bugfix: Memory would leak if reading a data offer failed midway
+ - [Wayland] Bugfix: Keyboard leave event handler now processes key repeats (#2736)
  - [Wayland] Bugfix: Retrieved cursor position would be incorrect when hovering over
                      fallback decorations
  - [Wayland] Bugfix: Fallback decorations would report scroll events

docs/monitor.md

@@ -255,7 +255,3 @@ hardware gamma correction, which today is typically an approximation of sRGB
 gamma.  This means that setting a perfectly linear ramp, or gamma 1.0, will
 produce the default (usually sRGB-like) behavior.
 
-@note @wayland An application cannot read or modify the monitor gamma ramp.  The
-@ref glfwGetGammaRamp, @ref glfwSetGammaRamp and @ref glfwSetGamma functions
-emit @ref GLFW_FEATURE_UNAVAILABLE.
-

docs/window.md

@@ -893,12 +893,6 @@ int xpos, ypos;
 glfwGetWindowPos(window, &xpos, &ypos);
 ```
 
-@note @wayland An applications cannot know the positions of its windows or
-whether one has been moved.  The @ref GLFW_POSITION_X and @ref GLFW_POSITION_Y
-window hints are ignored.  The @ref glfwGetWindowPos and @ref glfwSetWindowPos
-functions emit @ref GLFW_FEATURE_UNAVAILABLE.  The window position callback will
-not be called.
-
 
 ### Window title {#window_title}
 
@@ -1044,12 +1038,6 @@ You can also get the current iconification state with @ref glfwGetWindowAttrib.
 int iconified = glfwGetWindowAttrib(window, GLFW_ICONIFIED);
 ```
 
-@note @wayland An application cannot know if any of its windows have been
-iconified or restore one from iconification.  The @ref glfwRestoreWindow
-function can only restore windows from maximization and the iconify callback
-will not be called.  The [GLFW_ICONIFIED](@ref GLFW_ICONIFIED_attrib) attribute
-will be false.  The @ref glfwIconifyWindow function works normally.
-
 
 ### Window maximization {#window_maximize}
 

include/GLFW/glfw3.h

@@ -2916,8 +2916,8 @@ GLFWAPI const GLFWvidmode* glfwGetVideoMode(GLFWmonitor* monitor);
  *  @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref GLFW_INVALID_VALUE,
  *  @ref GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
  *
- *  @remark @wayland Monitor gamma is a privileged protocol, so this function
+ *  @remark @wayland Gamma handling is a privileged protocol, this function
- *  cannot be implemented and emits @ref GLFW_FEATURE_UNAVAILABLE.
+ *  will thus never be implemented and emits @ref GLFW_FEATURE_UNAVAILABLE.
  *
  *  @thread_safety This function must only be called from the main thread.
  *
@@ -2940,8 +2940,8 @@ GLFWAPI void glfwSetGamma(GLFWmonitor* monitor, float gamma);
  *  @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref GLFW_PLATFORM_ERROR
  *  and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
  *
- *  @remark @wayland Monitor gamma is a privileged protocol, so this function
+ *  @remark @wayland Gamma handling is a privileged protocol, this function
- *  cannot be implemented and emits @ref GLFW_FEATURE_UNAVAILABLE while
+ *  will thus never be implemented and emits @ref GLFW_FEATURE_UNAVAILABLE while
  *  returning `NULL`.
  *
  *  @pointer_lifetime The returned structure and its arrays are allocated and
@@ -2984,8 +2984,8 @@ GLFWAPI const GLFWgammaramp* glfwGetGammaRamp(GLFWmonitor* monitor);
  *
  *  @remark @win32 The gamma ramp size must be 256.
  *
- *  @remark @wayland Monitor gamma is a privileged protocol, so this function
+ *  @remark @wayland Gamma handling is a privileged protocol, this function
- *  cannot be implemented and emits @ref GLFW_FEATURE_UNAVAILABLE.
+ *  will thus never be implemented and emits @ref GLFW_FEATURE_UNAVAILABLE.
  *
  *  @pointer_lifetime The specified gamma ramp is copied before this function
  *  returns.
@@ -3431,8 +3431,8 @@ GLFWAPI void glfwSetWindowIcon(GLFWwindow* window, int count, const GLFWimage* i
  *  @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
  *  GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
  *
- *  @remark @wayland Window positions are not currently part of any common
+ *  @remark @wayland There is no way for an application to retrieve the global
- *  Wayland protocol, so this function cannot be implemented and will emit @ref
+ *  position of its windows.  This function will emit @ref
  *  GLFW_FEATURE_UNAVAILABLE.
  *
  *  @thread_safety This function must only be called from the main thread.
@@ -3465,8 +3465,8 @@ GLFWAPI void glfwGetWindowPos(GLFWwindow* window, int* xpos, int* ypos);
  *  @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
  *  GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
  *
- *  @remark @wayland Window positions are not currently part of any common
+ *  @remark @wayland There is no way for an application to set the global
- *  Wayland protocol, so this function cannot be implemented and will emit @ref
+ *  position of its windows.  This function will emit @ref
  *  GLFW_FEATURE_UNAVAILABLE.
  *
  *  @thread_safety This function must only be called from the main thread.
@@ -3808,6 +3808,10 @@ GLFWAPI void glfwSetWindowOpacity(GLFWwindow* window, float opacity);
  *  @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
  *  GLFW_PLATFORM_ERROR.
  *
+ *  @remark @wayland Once a window is iconified, @ref glfwRestoreWindow won’t
+ *  be able to restore it.  This is a design decision of the xdg-shell
+ *  protocol.
+ *
  *  @thread_safety This function must only be called from the main thread.
  *
  *  @sa @ref window_iconify
@@ -3835,10 +3839,6 @@ GLFWAPI void glfwIconifyWindow(GLFWwindow* window);
  *  @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
  *  GLFW_PLATFORM_ERROR.
  *
- *  @remark @wayland Restoring a window from maximization is not currently part
- *  of any common Wayland protocol, so this function can only restore windows
- *  from maximization.
- *
  *  @thread_safety This function must only be called from the main thread.
  *
  *  @sa @ref window_iconify
@@ -4059,8 +4059,8 @@ GLFWAPI GLFWmonitor* glfwGetWindowMonitor(GLFWwindow* window);
  *  affected by any resizing or mode switching, although you may need to update
  *  your viewport if the framebuffer size has changed.
  *
- *  @remark @wayland Window positions are not currently part of any common
+ *  @remark @wayland The desired window position is ignored, as there is no way
- *  Wayland protocol.  The window position arguments are ignored.
+ *  for an application to set this property.
  *
  *  @thread_safety This function must only be called from the main thread.
  *
@@ -4097,9 +4097,8 @@ GLFWAPI void glfwSetWindowMonitor(GLFWwindow* window, GLFWmonitor* monitor, int
  *  errors.  However, this function should not fail as long as it is passed
  *  valid arguments and the library has been [initialized](@ref intro_init).
  *
- *  @remark @wayland Checking whether a window is iconified is not currently
+ *  @remark @wayland The Wayland protocol provides no way to check whether a
- *  part of any common Wayland protocol, so the @ref GLFW_ICONIFIED attribute
+ *  window is iconfied, so @ref GLFW_ICONIFIED always returns `GLFW_FALSE`.
- *  cannot be implemented and is always `GLFW_FALSE`.
  *
  *  @thread_safety This function must only be called from the main thread.
  *
@@ -4221,8 +4220,8 @@ GLFWAPI void* glfwGetWindowUserPointer(GLFWwindow* window);
  *
  *  @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
  *
- *  @remark @wayland This callback will not be called.  The Wayland protocol
+ *  @remark @wayland This callback will never be called, as there is no way for
- *  provides no way to be notified of when a window is moved.
+ *  an application to know its global position.
  *
  *  @thread_safety This function must only be called from the main thread.
  *
@@ -4397,10 +4396,6 @@ GLFWAPI GLFWwindowfocusfun glfwSetWindowFocusCallback(GLFWwindow* window, GLFWwi
  *
  *  @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
  *
- *  @remark @wayland This callback will not be called.  The Wayland protocol
- *  provides no way to be notified of when a window is iconified, and no way to
- *  check whether a window is currently iconified.
- *
  *  @thread_safety This function must only be called from the main thread.
  *
  *  @sa @ref window_iconify