Zengtudor/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2025-01-30 11:52:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix documentation for glfwGetTimerValue

Browse Source
This commit is contained in:
TusharGautam29 2024-12-26 00:57:39 +05:30
parent 21fea01161
commit 662454b552
2 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/input.md
View File

@ -940,9 +940,10 @@ with @ref glfwGetTimerValue.
uint64_t value = glfwGetTimerValue();
```
This value is in 1 / frequency seconds. The frequency of the raw
timer varies depending on the operating system and hardware. You can query the
frequency, in Hz, with @ref glfwGetTimerFrequency.
This function returns the current value of the raw timer. To get the current time in
1 / frequency seconds, use `glfwGetTimerValue() / glfwGetTimerFrequency()`.
The frequency of the rawtimer varies depending on the operating system and hardware.
You can query the frequency, in Hz, with @ref glfwGetTimerFrequency.
```c
uint64_t frequency = glfwGetTimerFrequency();

9
include/GLFW/glfw3.h
View File

@ -6037,9 +6037,12 @@ GLFWAPI void glfwSetTime(double time);
/*! @brief Returns the current value of the raw timer.
*
* This function returns the current value of the raw timer, measured in
* 1 / frequency seconds. To get the frequency, call @ref
* glfwGetTimerFrequency.
* This function returns the current value of the raw timer. To get the
* current time measured in 1 / frequency seconds, use
* @ref glfwGetTimerValue / @ref glfwGetTimerFrequency.
* To get the frequency, call @ref glfwGetTimerFrequency.
*
*
*
* @return The value of the timer, or zero if an
* [error](@ref error_handling) occurred.