From 4fae8f7be39f9a1dab2657858c2f347320ab3149 Mon Sep 17 00:00:00 2001
From: Isaac Freund <mail@isaacfreund.com>
Date: Wed, 13 Oct 2021 16:11:54 +0200
Subject: [PATCH] scene: add functions to place node on top/bottom

These are very common operations for compositors (including tinywl)
to perform.
---
 include/wlr/types/wlr_scene.h |  8 ++++++++
 types/scene/wlr_scene.c       | 18 ++++++++++++++++++
 2 files changed, 26 insertions(+)

diff --git a/include/wlr/types/wlr_scene.h b/include/wlr/types/wlr_scene.h
index 8180183f..7a0801c0 100644
--- 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
index 2dc29247..be44bccc 100644
--- 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);