mirror/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-09-19 21:32:16 +00: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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -138,6 +138,8 @@ information on what to include when reporting a bug.
for retrieving gamepad input state (#900) for retrieving gamepad input state (#900)
- Added `glfwRequestWindowAttention` function for requesting attention from the - Added `glfwRequestWindowAttention` function for requesting attention from the
user (#732,#988) user (#732,#988)
- Added `glfwGetEventTime` function for querying the time of the last input
event (#1012)
- Added `glfwGetKeyScancode` function that allows retrieving platform dependent - Added `glfwGetKeyScancode` function that allows retrieving platform dependent
scancodes for keys (#830) scancodes for keys (#830)
- Added `glfwSetWindowMaximizeCallback` and `GLFWwindowmaximizefun` for - Added `glfwSetWindowMaximizeCallback` and `GLFWwindowmaximizefun` for

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. /*! @brief Returns the time of the last input event.
* *
* This function returns the time, in seconds, of the last event occurence. The * This function returns the time, in seconds, that the last input event
* only events queried are the input events button-press, button-release, * occurred. The time is collected for key, mouse button, scrolling and cursor
* key-press, key-release and cursor motion, and the proper place to call this * position events including enter and leave. The function is intended to be
* function is in one of the input callbacks. * 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. * @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. * @thread_safety This function must only be called from the main thread.
* *
* @sa @ref events * @sa @ref events