caio/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2026-08-28 12:25:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

Documentation work.

Browse Source
This commit is contained in:
Camilla Berglund
2014-12-17 01:31:36 +01:00
parent 2a1375e97c
commit 44372b89f6
4 changed files with 24 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
include/GLFW/glfw3.h
View File

@@ -1049,8 +1049,6 @@ typedef struct GLFWgammaramp
} GLFWgammaramp;
/*! @brief Image data.
*
* @ingroup window
*/
typedef struct GLFWimage
{
@@ -1644,7 +1642,8 @@ GLFWAPI void glfwWindowHint(int target, int hint);
* @remarks __X11:__ Some window managers will not respect the placement of
* initially hidden windows.
*
* @note This function may not be called from a callback.
* @par Reentrancy
* This function may not be called from a callback.
*
* @par Thread Safety
* This function may only be called from the main thread.
@@ -1672,11 +1671,12 @@ GLFWAPI GLFWwindow* glfwCreateWindow(int width, int height, const char* title, G
*
* @param[in] window The window to destroy.
*
* @note This function may not be called from a callback.
*
* @note The context of the specified window must not be current on any other
* thread when this function is called.
*
* @par Reentrancy
* This function may not be called from a callback.
*
* @par Thread Safety
* This function may only be called from the main thread.
*
@@ -2338,7 +2338,8 @@ GLFWAPI GLFWframebuffersizefun glfwSetFramebufferSizeCallback(GLFWwindow* window
*
* Event processing is not required for joystick input to work.
*
* @note This function may not be called from a callback.
* @par Reentrancy
* This function may not be called from a callback.
*
* @par Thread Safety
* This function may only be called from the main thread.
@@ -2381,11 +2382,12 @@ GLFWAPI void glfwPollEvents(void);
*
* Event processing is not required for joystick input to work.
*
* @note This function may not be called from a callback.
*
* @note On some platforms, certain callbacks may be called outside of a call
* to one of the event processing functions.
*
* @par Reentrancy
* This function may not be called from a callback.
*
* @par Thread Safety
* This function may only be called from the main thread.
*
@@ -2659,11 +2661,12 @@ GLFWAPI void glfwSetCursorPos(GLFWwindow* window, double xpos, double ypos);
* @return A new cursor ready to use or `NULL` if an
* [error](@ref error_handling) occurred.
*
* @note This function may not be called from a callback.
*
* @par Pointer Lifetime
* The specified image data is copied before this function returns.
*
* @par Reentrancy
* This function may not be called from a callback.
*
* @par Thread Safety
* This function may only be called from the main thread.
*
@@ -2688,7 +2691,8 @@ GLFWAPI GLFWcursor* glfwCreateCursor(const GLFWimage* image, int xhot, int yhot)
* @return A new cursor ready to use or `NULL` if an
* [error](@ref error_handling) occurred.
*
* @note This function may not be called from a callback.
* @par Reentrancy
* This function may not be called from a callback.
*
* @par Thread Safety
* This function may only be called from the main thread.
@@ -2711,7 +2715,8 @@ GLFWAPI GLFWcursor* glfwCreateStandardCursor(int shape);
*
* @param[in] cursor The cursor object to destroy.
*
* @note This function may not be called from a callback.
* @par Reentrancy
* This function may not be called from a callback.
*
* @par Thread Safety
* This function may only be called from the main thread.