blob: 5a4e42130f5e4708767f20584fdf0c7f3bef7c1f [file] [log] [blame] [view]
<!-- Generated by zircon/scripts/update-docs-from-fidl, do not edit! -->
# zx_ticks_per_second
## Summary
Read the number of high-precision timer ticks in a second.
## Declaration
```c
#include <zircon/syscalls.h>
zx_ticks_t zx_ticks_per_second(void);
```
## Description
`zx_ticks_per_second()` returns the number of high-precision timer ticks in a
second.
This can be used together with [`zx_ticks_get()`] to calculate the amount of
time elapsed between two subsequent calls to [`zx_ticks_get()`].
This value can vary from boot to boot of a given system. Once booted,
this value is guaranteed not to change.
## Rights
TODO(fxbug.dev/32253)
## Return value
`zx_ticks_per_second()` returns the number of high-precision timer ticks in a
second.
## Errors
`zx_ticks_per_second()` does not report any error conditions.
## EXAMPLES
```
zx_ticks_t ticks_per_second = zx_ticks_per_second();
zx_ticks_t ticks_start = zx_ticks_get();
// do some more work
zx_ticks_t ticks_end = zx_ticks_get();
double elapsed_seconds = (ticks_end - ticks_start) / (double)ticks_per_second;
```
## See also
- [`zx_ticks_get()`]
[`zx_ticks_get()`]: ticks_get.md