Clarify documentation re X11 asynchronicity

Related to #575.
This commit is contained in:
Camilla Berglund 2015-08-12 21:31:54 +02:00
parent a02aeaf972
commit 20ed0a15a4

View File

@ -1631,6 +1631,11 @@ GLFWAPI void glfwWindowHint(int target, int hint);
* @remarks __X11:__ Some window managers will not respect the placement of * @remarks __X11:__ Some window managers will not respect the placement of
* initially hidden windows. * initially hidden windows.
* *
* @remarks __X11:__ Due to the asynchronous nature of X11, it may take
* a moment for a window to reach its requested state. This means you may not
* be able to query the final size, position or other attributes directly after
* window creation.
*
* @par Reentrancy * @par Reentrancy
* This function may not be called from a callback. * This function may not be called from a callback.
* *
@ -2574,9 +2579,9 @@ GLFWAPI void glfwGetCursorPos(GLFWwindow* window, double* xpos, double* ypos);
* @param[in] ypos The desired y-coordinate, relative to the top edge of the * @param[in] ypos The desired y-coordinate, relative to the top edge of the
* client area. * client area.
* *
* @remarks __X11:__ Due to the asynchronous nature of a modern X desktop, it * @remarks __X11:__ Due to the asynchronous nature of X11, it may take
* may take a moment for the window focus event to arrive. This means you will * a moment for the window focus event to arrive. This means you may not be
* not be able to set the cursor position directly after window creation. * able to set the cursor position directly after window creation.
* *
* @par Thread Safety * @par Thread Safety
* This function may only be called from the main thread. * This function may only be called from the main thread.