mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2025-01-19 21:28:50 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

xrt: Tidy xrt_compositor.h

Browse source
This commit is contained in:
Jakob Bornecrantz 2020-07-02 16:45:30 +01:00 committed by Jakob Bornecrantz
parent ad266672f4
commit 1b11abe6eb
1 changed files with 31 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

80
src/xrt/include/xrt/xrt_compositor.h
View file

@ -16,26 +16,41 @@ extern "C" {
#endif #endif
/*
*
* Pre-declare things, also they should not be in the xrt_iface group.
*
*/
struct xrt_device; struct xrt_device;
typedef struct VkCommandBuffer_T *VkCommandBuffer;
#ifdef XRT_64_BIT
typedef struct VkImage_T *VkImage;
typedef struct VkDeviceMemory_T *VkDeviceMemory;
#else
typedef uint64_t VkImage;
typedef uint64_t VkDeviceMemory;
#endif
/*!
* @ingroup xrt_iface
* @{
*/
/*! /*!
* Max swapchain images, artificial limit. * Max swapchain images, artificial limit.
*
* @ingroup xrt_iface
*/ */
#define XRT_MAX_SWAPCHAIN_IMAGES 8 #define XRT_MAX_SWAPCHAIN_IMAGES 8
/*! /*!
* Max formats supported by a compositor, artificial limit. * Max formats supported by a compositor, artificial limit.
*
* @ingroup xrt_iface
*/ */
#define XRT_MAX_SWAPCHAIN_FORMATS 8 #define XRT_MAX_SWAPCHAIN_FORMATS 8
/*! /*!
* Special flags for creating swapchain images. * Special flags for creating swapchain images.
*
* @ingroup xrt_iface
*/ */
enum xrt_swapchain_create_flags enum xrt_swapchain_create_flags
{ {
@ -44,8 +59,6 @@ enum xrt_swapchain_create_flags
/*! /*!
* Usage of the swapchain images. * Usage of the swapchain images.
*
* @ingroup xrt_iface
*/ */
enum xrt_swapchain_usage_bits enum xrt_swapchain_usage_bits
{ {
@ -60,8 +73,6 @@ enum xrt_swapchain_usage_bits
/*! /*!
* View type to be rendered to by the compositor. * View type to be rendered to by the compositor.
*
* @ingroup xrt_iface
*/ */
enum xrt_view_type enum xrt_view_type
{ {
@ -71,8 +82,6 @@ enum xrt_view_type
/*! /*!
* Layer type. * Layer type.
*
* @ingroup xrt_iface
*/ */
enum xrt_layer_type enum xrt_layer_type
{ {
@ -82,8 +91,6 @@ enum xrt_layer_type
/*! /*!
* Bit field for holding information about how a layer should be composited. * Bit field for holding information about how a layer should be composited.
*
* @ingroup xrt_iface
*/ */
enum xrt_layer_composition_flags enum xrt_layer_composition_flags
{ {
@ -103,8 +110,6 @@ enum xrt_layer_composition_flags
* Used for quad layers. * Used for quad layers.
* *
* @note Doesn't have the same values as the OpenXR counterpart! * @note Doesn't have the same values as the OpenXR counterpart!
*
* @ingroup xrt_iface
*/ */
enum xrt_layer_eye_visibility enum xrt_layer_eye_visibility
{ {
@ -116,8 +121,6 @@ enum xrt_layer_eye_visibility
/*! /*!
* Specifies a sub-image in a layer. * Specifies a sub-image in a layer.
*
* @ingroup xrt_iface
*/ */
struct xrt_sub_image struct xrt_sub_image
{ {
@ -134,8 +137,6 @@ struct xrt_sub_image
* *
* The @ref xrt_swapchain references and @ref xrt_device are provided outside of * The @ref xrt_swapchain references and @ref xrt_device are provided outside of
* this struct. * this struct.
*
* @ingroup xrt_iface
*/ */
struct xrt_layer_quad_data struct xrt_layer_quad_data
{ {
@ -153,8 +154,6 @@ struct xrt_layer_quad_data
* *
* The @ref xrt_swapchain references and @ref xrt_device are provided outside of * The @ref xrt_swapchain references and @ref xrt_device are provided outside of
* this struct. * this struct.
*
* @ingroup xrt_iface
*/ */
struct xrt_layer_projection_view_data struct xrt_layer_projection_view_data
{ {
@ -169,8 +168,6 @@ struct xrt_layer_projection_view_data
* *
* The @ref xrt_swapchain references and @ref xrt_device are provided outside of * The @ref xrt_swapchain references and @ref xrt_device are provided outside of
* this struct. * this struct.
*
* @ingroup xrt_iface
*/ */
struct xrt_layer_stereo_projection_data struct xrt_layer_stereo_projection_data
{ {
@ -182,8 +179,6 @@ struct xrt_layer_stereo_projection_data
* *
* The @ref xrt_swapchain references and @ref xrt_device are provided outside of * The @ref xrt_swapchain references and @ref xrt_device are provided outside of
* this struct. * this struct.
*
* @ingroup xrt_iface
*/ */
struct xrt_layer_data struct xrt_layer_data
{ {
@ -240,8 +235,6 @@ struct xrt_layer_data
/*! /*!
* @interface xrt_swapchain * @interface xrt_swapchain
* Common swapchain interface/base. * Common swapchain interface/base.
*
* @ingroup xrt_iface
*/ */
struct xrt_swapchain struct xrt_swapchain
{ {
@ -347,6 +340,9 @@ xrt_swapchain_destroy(struct xrt_swapchain **xsc_ptr)
*xsc_ptr = NULL; *xsc_ptr = NULL;
} }
/*!
* Event type for compositor events, none means no event was returned.
*/
enum xrt_compositor_event_type enum xrt_compositor_event_type
{ {
XRT_COMPOSITOR_EVENT_NONE = 0, XRT_COMPOSITOR_EVENT_NONE = 0,
@ -356,8 +352,6 @@ enum xrt_compositor_event_type
/*! /*!
* Session state changes event. * Session state changes event.
*
* @ingroup xrt_iface
*/ */
struct xrt_compositor_event_state_change struct xrt_compositor_event_state_change
{ {
@ -368,8 +362,6 @@ struct xrt_compositor_event_state_change
/*! /*!
* Primary session state changes event. * Primary session state changes event.
*
* @ingroup xrt_iface
*/ */
struct xrt_compositor_event_overlay struct xrt_compositor_event_overlay
{ {
@ -379,8 +371,6 @@ struct xrt_compositor_event_overlay
/*! /*!
* Compositor events union. * Compositor events union.
*
* @ingroup xrt_iface
*/ */
union xrt_compositor_event { union xrt_compositor_event {
enum xrt_compositor_event_type type; enum xrt_compositor_event_type type;
@ -388,12 +378,8 @@ union xrt_compositor_event {
struct xrt_compositor_event_state_change overlay; struct xrt_compositor_event_state_change overlay;
}; };
/*! /*!
* Session prepare information, mostly overlay extension data. * Session prepare information, mostly overlay extension data.
*
* @ingroup xrt_iface
*/ */
struct xrt_session_prepare_info struct xrt_session_prepare_info
{ {
@ -406,8 +392,6 @@ struct xrt_session_prepare_info
* @interface xrt_compositor * @interface xrt_compositor
* *
* Common compositor client interface/base. * Common compositor client interface/base.
*
* @ingroup xrt_iface
*/ */
struct xrt_compositor struct xrt_compositor
{ {
@ -760,6 +744,7 @@ xrt_comp_destroy(struct xrt_compositor **xc_ptr)
/*! /*!
* Base class for an OpenGL (ES) client swapchain. * Base class for an OpenGL (ES) client swapchain.
*
* @ingroup xrt_iface comp_client * @ingroup xrt_iface comp_client
* @extends xrt_swapchain * @extends xrt_swapchain
*/ */
@ -776,6 +761,7 @@ struct xrt_swapchain_gl
/*! /*!
* Base class for an OpenGL (ES) client compositor. * Base class for an OpenGL (ES) client compositor.
*
* @ingroup xrt_iface comp_client * @ingroup xrt_iface comp_client
* @extends xrt_compositor * @extends xrt_compositor
*/ */
@ -817,15 +803,6 @@ xrt_compositor_gl(struct xrt_compositor *xc)
* *
*/ */
typedef struct VkCommandBuffer_T *VkCommandBuffer;
#ifdef XRT_64_BIT
typedef struct VkImage_T *VkImage;
typedef struct VkDeviceMemory_T *VkDeviceMemory;
#else
typedef uint64_t VkImage;
typedef uint64_t VkDeviceMemory;
#endif
/*! /*!
* Base class for a Vulkan client swapchain. * Base class for a Vulkan client swapchain.
* *
@ -982,6 +959,11 @@ xrt_comp_fd_destroy(struct xrt_compositor_fd **xcfd_ptr)
} }
/*!
* @}
*/
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif