comp_main_interface.h

Go to the documentation of this file.

// Copyright 2019-2022, Collabora, Ltd.
// SPDX-License-Identifier: BSL-1.0
/*!
 * @file
 * @brief  Header for the main compositor interface.
 * @author Jakob Bornecrantz <jakob@collabora.com>
 * @ingroup comp_main
 *
 * Formerly a header for defining an XRT graphics provider.
 */
 
#pragma once
 
#include "xrt/xrt_device.h"
#include "xrt/xrt_compositor.h"
 
struct comp_target_factory;
struct u_pacing_app_factory;
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/*!
 * Creates the main compositor, it doesn't return itself but instead wraps
 * itself with a system compositor. The main compositor is a native compositor.
 *
 * @ingroup comp_main
 * @relates xrt_system_compositor
 *
 * @param xdev The head device
 * @param ctf A compositor target factory to force the output device, must remain valid for the lifetime of the
 * compositor. If NULL, factory is automatically selected
 * @param upaf A pacing app factory to customize the application pacer, compositor takes ownership.
 * If NULL, a default factory is used
 * @param out_xsysc The output compositor
 */
xrt_result_t
comp_main_create_system_compositor(struct xrt_device *xdev,
                                   const struct comp_target_factory *ctf,
                                   struct u_pacing_app_factory *upaf,
                                   struct xrt_system_compositor **out_xsysc);
 
 
#ifdef __cplusplus
}
#endif