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

Documentation work

Browse Source
This commit is contained in:
Camilla Löwy
2017-09-14 15:04:24 +02:00
parent c4b73750b7
commit 8429402f9e
2 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
include/GLFW/glfw3.h
View File

@@ -3368,15 +3368,19 @@ GLFWAPI GLFWframebuffersizefun glfwSetFramebufferSizeCallback(GLFWwindow* window
/*! @brief Returns the time of the last input event.
*
* This function returns the time, in seconds, of the last event occurence. The
* only events queried are the input events button-press, button-release,
* key-press, key-release and cursor motion, and the proper place to call this
* function is in one of the input callbacks.
* This function returns the time, in seconds, that the last input event
* occurred. The time is collected for key, mouse button, scrolling and cursor
* position events including enter and leave. The function is intended to be
* called from the relevant event callback.
*
* @return The value, in seconds, of the last input event occurence.
* @return The time of the input event, in seconds, or zero if an
* [error](@ref error_handling) occurred.
*
* @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
*
* @remarks The event timestamps provided by most platforms have much lower
* resolution than the GLFW timer.
*
* @thread_safety This function must only be called from the main thread.
*
* @sa @ref events