diff options
Diffstat (limited to 'docs/guide.md')
| -rw-r--r-- | docs/guide.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/guide.md b/docs/guide.md index 2926011..4949f88 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -154,6 +154,12 @@ is unpaced: scheduling continuously will use CPU continuously. Use an applicatio timer to limit redraws there. Suspended/hidden windows need not draw at each requested interval. +`yasl_surface_read_pixels()` copies the last presented CPU frame, for example +for a screenshot or a debugging tool. Call it outside draw callbacks. A frame +is available from a successful present until the next draw starts, and again +once that draw presents. Call it with no buffer first to learn the extent. The +copy is YASL's frame, not the composited screen, and native rendering has none. + `yasl_surface_timing()` reports estimates and their provenance. All timestamps are monotonic nanoseconds. `YASL_TIMING_SUBMISSION` is CPU submission time, `YASL_TIMING_FRAME_CALLBACK` is a compositor pacing signal, and only |