Jiga228/glfw
0
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2026-09-20 16:30:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make glfwGetError also provide description

Browse Source 
Related to #970.
This commit is contained in:
Camilla Löwy
2017-05-25 18:23:09 +02:00
parent beaeb0d4af
commit 14a3fe0ac0
17 changed files with 244 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/GLFW/glfw3.h
+10 -3
View File
@@ -1646,13 +1646,20 @@ GLFWAPI const char* glfwGetVersionString(void);
/*! @brief Returns and clears the last error for the calling thread.
*
* This function returns and clears the [error code](@ref error) of the last
* error that occurred on the calling thread. If no error has occurred since
* the last call, it returns @ref GLFW_NO_ERROR.
* error that occurred on the calling thread, and optionally a UTF-8 encoded
* human-readable description of it. If no error has occurred since the last
* call, it returns @ref GLFW_NO_ERROR and the description pointer is set to
* `NULL`.
*
* @param[in] description Where to store the error description pointer, or `NULL`.
* @return The last error code for the calling thread, or @ref GLFW_NO_ERROR.
*
* @errors None.
*
* @pointer_lifetime The returned string is allocated and freed by GLFW. You
* should not free it yourself. It is guaranteed to be valid only until the
* next error occurs or the library is terminated.
*
* @remark This function may be called before @ref glfwInit.
*
* @thread_safety This function may be called from any thread.
@@ -1664,7 +1671,7 @@ GLFWAPI const char* glfwGetVersionString(void);
*
* @ingroup init
*/
GLFWAPI int glfwGetError(void);
GLFWAPI int glfwGetError(const char** description);
/*! @brief Sets the error callback.
*