Zengtudor/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2025-10-03 13:20:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add statement to docs for glfwTerminate

Browse Source 
At the moment it is safe to call `glfwTerminate` even if the library is not currently initialized (it returns instantly with no side effects), but this is not mentioned in the documentation. Unless you plan to change this behaviour in future (and I don't think you should), it would be great to make this a promise so that users don't need to add their own redundant conditional.
This commit is contained in:
A. Tombs 2020-05-22 14:37:58 +01:00 committed by GitHub
parent 844bc8031c
commit 085f61d951
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/GLFW/glfw3.h
View File

@ -1866,6 +1866,8 @@ GLFWAPI int glfwInit(void);
* call this function, as it is called by @ref glfwInit before it returns
* failure.
*
* This function has no effect if GLFW is not initialized.
*
* @errors Possible errors include @ref GLFW_PLATFORM_ERROR.
*
* @remark This function may be called before @ref glfwInit.