8000 Fix documentation for glfwGetTimerValue by TusharGautam29 · Pull Request #2664 · glfw/glfw · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Fix documentation for glfwGetTimerValue #2664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File f 8000 ilter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/input.md
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down
9 changes: 6 additions & 3 deletions include/GLFW/glfw3.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading
0