This object acts as a root object for Monado, it either wraps a xrt_prober or forms a connection to a out of process XR service. More...

#include <xrt/xrt_instance.h>

Data Fields
int(*	select )(struct xrt_instance xinst, struct xrt_device *xdevs, size_t num_xdevs)
	Returns the devices of the system represented as xrt_device, see xrt_prober::select, should only be called once. More...

int(*	create_fd_compositor )(struct xrt_instance xinst, struct xrt_device xdev, bool flip_y, struct xrt_compositor_fd **out_xcfd)
	Creates a xrt_compositor_fd, should only be called once. More...

int(*	get_prober )(struct xrt_instance xinst, struct xrt_prober *out_xp)
	Get the instance xrt_prober, the instance might not be using a xrt_prober and may return null, the instance still owns the prober and will destroy it. More...

void(*	destroy )(struct xrt_instance *xinst)
	Use helper `xrt_instance_destroy`. More...

Detailed Description

This object acts as a root object for Monado, it either wraps a xrt_prober or forms a connection to a out of process XR service.

As close to a singleton object there is in Monado, you should not create more then one of these.

Field Documentation

◆ create_fd_compositor

int(* xrt_instance::create_fd_compositor) (struct xrt_instance *xinst, struct xrt_device *xdev, bool flip_y, struct xrt_compositor_fd **out_xcfd)

Creates a xrt_compositor_fd, should only be called once.

◆ destroy

void(* xrt_instance::destroy) (struct xrt_instance *xinst)

Use helper xrt_instance_destroy.

◆ get_prober

int(* xrt_instance::get_prober) (struct xrt_instance *xinst, struct xrt_prober **out_xp)

Get the instance xrt_prober, the instance might not be using a xrt_prober and may return null, the instance still owns the prober and will destroy it.

Can be called multiple times.

◆ select

int(* xrt_instance::select) (struct xrt_instance *xinst, struct xrt_device **xdevs, size_t num_xdevs)

Returns the devices of the system represented as xrt_device, see xrt_prober::select, should only be called once.

Referenced by xrt_instance_create().

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

include/xrt/xrt_instance.h