Monado OpenXR Runtime
xrt_system_compositor_info Struct Reference

Capabilities and information about the system compositor (and its wrapped native compositor, if any), and device together. More...

#include <xrt/xrt_compositor.h>

Collaboration diagram for xrt_system_compositor_info:

Data Fields

struct {
   struct {
      uint32_t   width_pixels
 
      uint32_t   height_pixels
 
      uint32_t   sample_count
 
   }   recommended
 Recommended for this view. More...
 
   struct {
      uint32_t   width_pixels
 
      uint32_t   height_pixels
 
      uint32_t   sample_count
 
   }   max
 Maximums for this view. More...
 
views [XRT_MAX_VIEWS]
 View configuration information. More...
 
uint32_t max_layers
 Maximum number of composition layers supported, never changes. More...
 
enum xrt_blend_mode supported_blend_modes [XRT_BLEND_MODE_MAX_ENUM]
 Blend modes supported by the system (the combination of the compositor and the HMD capabilities), never changes. More...
 
uint8_t supported_blend_mode_count
 Number of meaningful elements in xrt_system_compositor_info::supported_blend_modes. More...
 
uint32_t refresh_rate_count
 
float refresh_rates_hz [XRT_MAX_SUPPORTED_REFRESH_RATES]
 
xrt_uuid_t compositor_vk_deviceUUID
 The vk device as used by the compositor, never changes. More...
 
xrt_uuid_t client_vk_deviceUUID
 The vk device suggested for Vulkan clients, never changes. More...
 
xrt_luid_t client_d3d_deviceLUID
 The (Windows) LUID for the GPU device suggested for D3D clients, never changes. More...
 
bool client_d3d_deviceLUID_valid
 Whether client_d3d_deviceLUID is valid. More...
 

Detailed Description

Capabilities and information about the system compositor (and its wrapped native compositor, if any), and device together.

Field Documentation

◆ client_d3d_deviceLUID

xrt_luid_t xrt_system_compositor_info::client_d3d_deviceLUID

The (Windows) LUID for the GPU device suggested for D3D clients, never changes.

Referenced by oxr_d3d_get_requirements().

◆ client_d3d_deviceLUID_valid

bool xrt_system_compositor_info::client_d3d_deviceLUID_valid

Whether client_d3d_deviceLUID is valid.

Referenced by oxr_d3d_get_requirements().

◆ client_vk_deviceUUID

xrt_uuid_t xrt_system_compositor_info::client_vk_deviceUUID

The vk device suggested for Vulkan clients, never changes.

◆ compositor_vk_deviceUUID

xrt_uuid_t xrt_system_compositor_info::compositor_vk_deviceUUID

The vk device as used by the compositor, never changes.

◆ 

struct { ... } xrt_system_compositor_info::max

Maximums for this view.

◆ max_layers

uint32_t xrt_system_compositor_info::max_layers

Maximum number of composition layers supported, never changes.

◆ 

struct { ... } xrt_system_compositor_info::recommended

Recommended for this view.

◆ supported_blend_mode_count

uint8_t xrt_system_compositor_info::supported_blend_mode_count

Number of meaningful elements in xrt_system_compositor_info::supported_blend_modes.

◆ supported_blend_modes

enum xrt_blend_mode xrt_system_compositor_info::supported_blend_modes[XRT_BLEND_MODE_MAX_ENUM]

Blend modes supported by the system (the combination of the compositor and the HMD capabilities), never changes.

In preference order. Based on the modes reported by the device, but the compositor has a chance to modify this.

◆ 

struct { ... } xrt_system_compositor_info::views[XRT_MAX_VIEWS]

View configuration information.


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