labwc/include/overlay.h

/* SPDX-License-Identifier: GPL-2.0-only */
#ifndef LABWC_OVERLAY_H
#define LABWC_OVERLAY_H

#include <wlr/util/box.h>
#include "common/graphic-helpers.h"
#include "regions.h"
#include "view.h"

/* TODO: replace this with single lab_scene_rect */
struct overlay_rect {
	struct wlr_scene_tree *tree;

	bool bg_enabled;
	struct wlr_scene_rect *bg_rect;

	bool border_enabled;
	struct lab_scene_rect *border_rect;
};

struct overlay {
	struct overlay_rect region_rect, edge_rect;

	/* Represents currently shown or delayed overlay */
	struct {
		/* Region overlay */
		struct region *region;

		/* Snap-to-edge overlay */
		enum lab_edge edge;
		struct output *output;
	} active;

	/* For delayed snap-to-edge overlay */
	struct wl_event_source *timer;
};

void overlay_reconfigure(struct seat *seat);

/* Calls overlay_hide() internally if there's no overlay to show */
void overlay_update(struct seat *seat);

/* This function must be called when server->grabbed_view is destroyed */
void overlay_hide(struct seat *seat);

/* This function is called to clean up the timer on exit */
void overlay_finish(struct seat *seat);

#endif