aboutsummaryrefslogtreecommitdiff
path: root/src/nvim/ui_compositor.c
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2019-02-04 13:21:35 +0100
committerJustin M. Keyes <justinkz@gmail.com>2019-03-26 19:55:33 +0100
commitfbaee922d1182f7bd7b43ddce7cf983b41021d14 (patch)
tree1b9aac36323812c9f9884928532ef53c50030dc6 /src/nvim/ui_compositor.c
parent2d50bf349883958bff1bb584fb3ad5cb97990993 (diff)
downloadrneovim-fbaee922d1182f7bd7b43ddce7cf983b41021d14.tar.gz
rneovim-fbaee922d1182f7bd7b43ddce7cf983b41021d14.tar.bz2
rneovim-fbaee922d1182f7bd7b43ddce7cf983b41021d14.zip
doc [ci skip]
closes #9719
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()