aboutsummaryrefslogtreecommitdiff
path: root/src/nvim/ui_compositor.c
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2019-03-26 21:36:33 +0100
committerGitHub <noreply@github.com>2019-03-26 21:36:33 +0100
commitbe676eccf1b85719441c66b0ced4f2234335f0ff (patch)
tree66e684b1af977b9660388ae22ed109daaaa34597 /src/nvim/ui_compositor.c
parent2d50bf349883958bff1bb584fb3ad5cb97990993 (diff)
parentbec40660330764c59731fbb736af58ffc445bd8c (diff)
downloadrneovim-be676eccf1b85719441c66b0ced4f2234335f0ff.tar.gz
rneovim-be676eccf1b85719441c66b0ced4f2234335f0ff.tar.bz2
rneovim-be676eccf1b85719441c66b0ced4f2234335f0ff.zip
Merge #9600 'doc, gen_vimdoc.py'
Diffstat (limited to 'src/nvim/ui_compositor.c')
-rw-r--r--src/nvim/ui_compositor.c5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/nvim/ui_compositor.c b/src/nvim/ui_compositor.c
index 50432dd119..e24ab11a3a 100644
--- a/src/nvim/ui_compositor.c
+++ b/src/nvim/ui_compositor.c
@@ -3,6 +3,8 @@
// Compositor: merge floating grids with the main grid for display in
// TUI and non-multigrid UIs.
+//
+// Layer-based compositing: https://en.wikipedia.org/wiki/Digital_compositing
#include <assert.h>
#include <stdbool.h>
@@ -104,6 +106,9 @@ bool ui_comp_should_draw(void)
return composed_uis != 0 && valid_screen;
}
+/// Places `grid` at (col,row) position with (width * height) size.
+/// Adds `grid` as the top layer if it is a new layer.
+///
/// TODO(bfredl): later on the compositor should just use win_float_pos events,
/// though that will require slight event order adjustment: emit the win_pos
/// events in the beginning of update_screen(0), rather than in ui_flush()