Compositor information for a device. More...

#include <xrt/xrt_device.h>

Collaboration diagram for xrt_device_compositor_info:

[legend]

Public Member Functions
	XRT_ALIGNAS (8) int64_t scanout_time_ns
	The amount of time it takes to scanout the display in nanoseconds, from the start of the scanout, to the end of the scanout.

Data Fields
enum xrt_panel_refresh_type	panel_refresh_type
	The type of panel refresh the screen uses.

enum xrt_scanout_direction	scanout_direction
	The direction scanout on the display occurs.

Detailed Description

Compositor information for a device.

Member Function Documentation

◆ XRT_ALIGNAS()

xrt_device_compositor_info::XRT_ALIGNAS ( 8 )

The amount of time it takes to scanout the display in nanoseconds, from the start of the scanout, to the end of the scanout.

Note: alignas for 32 bit client support, see IPC Design and Implementation

Field Documentation

◆ panel_refresh_type

enum xrt_panel_refresh_type xrt_device_compositor_info::panel_refresh_type

The type of panel refresh the screen uses.

This affects how scanout poses are queried for rolling refresh compensation: if the mode is XRT_PANEL_REFRESH_TYPE_GLOBAL, the start and end scanout world poses will be identical; otherwise, separate start and end poses are queried using different predicted timestamps derived from the other members of xrt_device_compositor_info.

The transmission direction (if known) should be specified via scanout_direction. Some features may require this information even for global-refresh panels, e.g. beam racing.

Referenced by calc_scanout_compensation_ns().

◆ scanout_direction

enum xrt_scanout_direction xrt_device_compositor_info::scanout_direction

The direction scanout on the display occurs.