ipc: Doc comments

This commit is contained in:
Ryan Pavlik 2020-06-09 17:02:46 -05:00
parent eaa4c186ce
commit f407fb9461
2 changed files with 25 additions and 2 deletions

View file

@ -73,14 +73,37 @@ struct ipc_shared_device
uint32_t first_output_index;
};
/*!
* Data for a single composition layer.
*
* Similar in function to @ref comp_layer
*
* @ingroup ipc
*/
struct ipc_layer_entry
{
//! @todo what is this used for?
uint32_t xdev_id;
/*!
* Up to two indices of swapchains to use.
*
* How many are actually used depends on the value of @p data.type
*/
uint32_t swapchain_ids[2];
/*!
* All basic (trivially-serializable) data associated with a layer,
* aside from which swapchain(s) are used.
*/
struct xrt_layer_data data;
};
/*!
* Render state for a single client, including all layers.
*
* @ingroup ipc
*/
struct ipc_layer_slot
{
enum xrt_blend_mode env_blend_mode;
@ -151,7 +174,7 @@ struct ipc_shared_memory
/*
*
* Reset of protocol is generated.
* Rest of protocol is generated.
*
*/

View file

@ -582,7 +582,7 @@ _update_layers(struct comp_compositor *c,
&active_client->render_state;
if (*num_layers != render_state->num_layers) {
// TODO: Resizing here would be faster
//! @todo Resizing here would be faster
*num_layers = render_state->num_layers;
comp_renderer_destroy_layers(c->r);
comp_renderer_allocate_layers(c->r, render_state->num_layers);