scene: add functions to place node on top/bottom

These are very common operations for compositors (including tinywl) to perform.
swaywm · Oct 14, 2021 · 88024d3 · 88024d3
1 parent a7148de
commit 88024d3
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/include/wlr/types/wlr_scene.h b/include/wlr/types/wlr_scene.h
@@ -139,6 +139,14 @@ void wlr_scene_node_place_above(struct wlr_scene_node *node,
  */
 void wlr_scene_node_place_below(struct wlr_scene_node *node,
 	struct wlr_scene_node *sibling);
+/**
+ * Move the node above all of its sibling nodes.
+ */
+void wlr_scene_node_raise_to_top(struct wlr_scene_node *node);
+/**
+ * Move the node below all of its sibling nodes.
+ */
+void wlr_scene_node_lower_to_bottom(struct wlr_scene_node *node);
 /**
  * Move the node to another location in the tree.
  */

diff --git a/types/scene/wlr_scene.c b/types/scene/wlr_scene.c
@@ -470,6 +470,24 @@ void wlr_scene_node_place_below(struct wlr_scene_node *node,
 	scene_node_damage_whole(sibling);
 }
 
+void wlr_scene_node_raise_to_top(struct wlr_scene_node *node) {
+	struct wlr_scene_node *current_top = wl_container_of(
+		node->parent->state.children.prev, current_top, state.link);
+	if (node == current_top) {
+		return;
+	}
+	wlr_scene_node_place_above(node, current_top);
+}
+
+void wlr_scene_node_lower_to_bottom(struct wlr_scene_node *node) {
+	struct wlr_scene_node *current_bottom = wl_container_of(
+		node->parent->state.children.prev, current_bottom, state.link);
+	if (node == current_bottom) {
+		return;
+	}
+	wlr_scene_node_place_below(node, current_bottom);
+}
+
 void wlr_scene_node_reparent(struct wlr_scene_node *node,
 		struct wlr_scene_node *new_parent) {
 	assert(node->type != WLR_SCENE_NODE_ROOT && new_parent != NULL);