mirrors/weston
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

libweston: untangle weston_compositor_remove_output doc

Browse Source 
Trying to make it more readable. Things that happen in the same step are
kept in the same paragraph.

v2: talk about "list of enabled outputs"

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
Reviewed-by: Armin Krezović <krezovic.armin@gmail.com>
This commit is contained in:
Pekka Paalanen 2017-03-29 16:07:34 +03:00
parent d2535d7614
commit e6ac4fcbc9
1 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
libweston/compositor.c
View File

@ -4521,19 +4521,25 @@ weston_output_enable_undo(struct weston_output *output)
output->enabled = false; output->enabled = false;
} }
/** Removes output from compositor's output list /** Removes output from compositor's list of enabled outputs
* *
* \param output The weston_output object that is being removed. * \param output The weston_output object that is being removed.
* *
* Presentation feedback is discarded. * The following happens:
* Compositor is notified that outputs were changed and *
* applies the necessary changes. * - The output assignments of all views in the current scenegraph are
* All views assigned to the weston_output object are * recomputed.
* moved to a new output. *
* Signal is emitted to notify all users of the weston_output * - Presentation feedback is discarded.
* object that the output is being destroyed. *
* wl_output protocol objects referencing this weston_output * - Compositor is notified that outputs were changed and
* are made inert. * applies the necessary changes to re-layout outputs.
*
* - Signal is emitted to notify all users of the weston_output
* object that the output is being destroyed.
*
* - wl_output protocol objects referencing this weston_output
* are made inert.
*/ */
static void static void
weston_compositor_remove_output(struct weston_output *output) weston_compositor_remove_output(struct weston_output *output)