The open source OpenXR runtime
doc: Clean up render timing docs.
+11
-15
+11
-15
doc/frame-timing.md
+11
-15
doc/frame-timing.md
···
5
5
SPDX-License-Identifier: BSL-1.0
6
6
-->
7
7
8
-
9
8
A "brief" overview of the various time-points that a frame goes through, from
10
9
when the application gets go ahead to render the frame to when pixels are turned
11
10
into photons. This only a single frame, where all of the timings are hit and the
···
28
27
* During the vblank period the display lights up turning the pixels into
29
28
photons. We refer to this time as **display**, same as in OpenXR.
30
29
31
-
32
30
The names for timepoints are chosen to align with the naming in
33
31
[`VK_GOOGLE_display_timing`][], reading that extension can provide further
34
32
information.
35
33
36
-
37
34
## Main compositor perspective
38
35
39
-
* @ref xrt_comp_wait_frame - It is within this function that the frame timing is
40
-
predicted, see @ref u_frame_timing_predict. The compositor will then wait to
41
-
**waku_up** time and then return from this function.
42
-
* @ref xrt_comp_begin_frame - The app or IPC server calls this function when it
43
-
is done with CPU work and ready to do GPU work.
44
-
* @ref xrt_comp_discard_frame - The frame is discarded.
45
-
* @ref xrt_comp_layer_begin - Called during transfers of layers.
46
-
* @ref xrt_comp_layer_stereo_projection - This and other layer functions are
47
-
called to list the layers the compositor should render.
48
-
* @ref xrt_comp_layer_commit - The compositor starts to render the frame,
49
-
trying to hit the **present** time.
50
-
36
+
* @ref xrt_comp_wait_frame - It is within this function that the frame timing is
37
+
predicted, see @ref u_rt_predict. The compositor will then wait to
38
+
**wake_up** time and then return from this function.
39
+
* @ref xrt_comp_begin_frame - The app or IPC server calls this function when it
40
+
is done with CPU work and ready to do GPU work.
41
+
* @ref xrt_comp_discard_frame - The frame is discarded.
42
+
* @ref xrt_comp_layer_begin - Called during transfers of layers.
43
+
* @ref xrt_comp_layer_stereo_projection - This and other layer functions are
44
+
called to list the layers the compositor should render.
45
+
* @ref xrt_comp_layer_commit - The compositor starts to render the frame,
46
+
trying to hit the **present** time.
51
47
52
48
[`VK_GOOGLE_display_timing`]: https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/VK_GOOGLE_display_timing.html