Browse Source

Merge pull request #3333 from blob1807/change-time-sleep-doc

time.accurate_sleep Windows Doc update
gingerBill 1 year ago
parent
commit
c59f6d548b
1 changed files with 2 additions and 1 deletions
  1. 2 1
      core/time/time.odin

+ 2 - 1
core/time/time.odin

@@ -238,8 +238,9 @@ time_add :: proc "contextless" (t: Time, d: Duration) -> Time {
 //
 //
 // Accuracy seems to be pretty good out of the box on Linux, to within around 4µs worst case.
 // Accuracy seems to be pretty good out of the box on Linux, to within around 4µs worst case.
 // On Windows it depends but is comparable with regular sleep in the worst case.
 // On Windows it depends but is comparable with regular sleep in the worst case.
-// To get the same kind of accuracy as on Linux, have your program call `win32.time_begin_period(1)` to
+// To get the same kind of accuracy as on Linux, have your program call `windows.timeBeginPeriod(1)` to
 // tell Windows to use a more accurate timer for your process.
 // tell Windows to use a more accurate timer for your process.
+// Additionally your program should call `windows.timeEndPeriod(1)` once you're done with `accurate_sleep`. 
 accurate_sleep :: proc "contextless" (d: Duration) {
 accurate_sleep :: proc "contextless" (d: Duration) {
 	to_sleep, estimate, mean, m2, count: Duration
 	to_sleep, estimate, mean, m2, count: Duration