Monado OpenXR Runtime
frame Struct Reference
Collaboration diagram for frame:

Data Fields

int64_t frame_id
 An arbitrary id that identifies this frame. Set in create_frame. More...
 
int64_t when_predict_ns
 When this frame was last used for a prediction. Set in predict_next_frame. More...
 
int64_t wake_up_time_ns
 When should the compositor wake up. Set in predict_next_frame. More...
 
int64_t when_woke_ns
 When we last woke up the compositor after its equivalent of wait_frame. More...
 
int64_t when_began_ns
 When the compositor started rendering a frame. More...
 
int64_t when_submitted_ns
 When the compositor finished rendering a frame. More...
 
int64_t when_infoed_ns
 When new frame timing info was last added. More...
 
int64_t current_comp_time_ns
 How much time we currently expect the compositor to take rendering a frame. Updated in predict_next_frame More...
 
int64_t expected_done_time_ns
 When we expect the compositor to be done with its frame. More...
 
int64_t desired_present_time_ns
 The GPU should start scanning out at this time. More...
 
int64_t predicted_display_time_ns
 At what time have we predicted that pixels turns to photons. More...
 
int64_t present_margin_ns
 
int64_t actual_present_time_ns
 
int64_t earliest_present_time_ns
 
enum frame_state state
 
int64_t predicted_wake_up_time_ns
 When should the compositor wake up. Set in pc_predict. More...
 
int64_t predicted_present_time_ns
 When should the compositor present the frame. More...
 
int64_t predicted_display_period_ns
 The period that the pacer used for this frame. More...
 
int64_t when_submit_began_ns
 When the compositor began submitting the work to the GPU, after it completed building the command buffers. More...
 
int64_t when_submit_end_ns
 When the compositor completed submitting the work to the GPU. More...
 

Field Documentation

◆ current_comp_time_ns

int64_t frame::current_comp_time_ns

How much time we currently expect the compositor to take rendering a frame. Updated in predict_next_frame

◆ desired_present_time_ns

int64_t frame::desired_present_time_ns

The GPU should start scanning out at this time.

◆ expected_done_time_ns

int64_t frame::expected_done_time_ns

When we expect the compositor to be done with its frame.

◆ frame_id

int64_t frame::frame_id

An arbitrary id that identifies this frame. Set in create_frame.

An arbitrary id that identifies this frame. Set in pc_predict.

Referenced by create_frame(), and get_frame().

◆ predicted_display_period_ns

int64_t frame::predicted_display_period_ns

The period that the pacer used for this frame.

◆ predicted_display_time_ns

int64_t frame::predicted_display_time_ns

At what time have we predicted that pixels turns to photons.

When should the frame be displayed.

◆ predicted_present_time_ns

int64_t frame::predicted_present_time_ns

When should the compositor present the frame.

◆ predicted_wake_up_time_ns

int64_t frame::predicted_wake_up_time_ns

When should the compositor wake up. Set in pc_predict.

◆ wake_up_time_ns

int64_t frame::wake_up_time_ns

When should the compositor wake up. Set in predict_next_frame.

◆ when_began_ns

int64_t frame::when_began_ns

When the compositor started rendering a frame.

When the compositor began rendering a frame.

Set in pc_mark_point with U_TIMING_POINT_BEGIN.

◆ when_infoed_ns

int64_t frame::when_infoed_ns

When new frame timing info was last added.

◆ when_predict_ns

int64_t frame::when_predict_ns

When this frame was last used for a prediction. Set in predict_next_frame.

When this frame was last used for a prediction. Set in pc_predict.

◆ when_submit_began_ns

int64_t frame::when_submit_began_ns

When the compositor began submitting the work to the GPU, after it completed building the command buffers.

Set in pc_mark_point with U_TIMING_POINT_SUBMIT_BEGIN.

◆ when_submit_end_ns

int64_t frame::when_submit_end_ns

When the compositor completed submitting the work to the GPU.

Set in pc_mark_point with U_TIMING_POINT_SUBMIT_END.

◆ when_submitted_ns

int64_t frame::when_submitted_ns

When the compositor finished rendering a frame.

◆ when_woke_ns

int64_t frame::when_woke_ns

When we last woke up the compositor after its equivalent of wait_frame.

When the compositor woke up after its equivalent of wait_frame.

Set in pc_mark_point with U_TIMING_POINT_WAKE_UP.


The documentation for this struct was generated from the following files: