Merge branch 'release-4.16.1'

[i3/i3] / include / randr.h

diff --git a/include/randr.h b/include/randr.h
index d14d04788aeb7ea283b66ff085f9af0b1a2ff6dd..ec533a28045f92f4719c4f810efd8b56d0fa90f2 100644 (file)
--- a/include/randr.h
+++ b/include/randr.h
@@ -1,35 +1,35 @@
 /*
- * vim:ts=8:expandtab
+ * vim:ts=4:sw=4:expandtab
  *
  * i3 - an improved dynamic tiling window manager
+ * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
  *
- * © 2009-2010 Michael Stapelberg and contributors
- *
- * See file LICENSE for license information.
+ * For more information on RandR, please see the X.org RandR specification at
+ * https://cgit.freedesktop.org/xorg/proto/randrproto/tree/randrproto.txt
+ * (take your time to read it completely, it answers all questions).
  *
  */
+#pragma once
+
+#include <config.h>
+
 #include "data.h"
 #include <xcb/randr.h>
 
-#ifndef _RANDR_H
-#define _RANDR_H
-
 TAILQ_HEAD(outputs_head, xoutput);
 extern struct outputs_head outputs;
 
+typedef enum {
+    CLOSEST_OUTPUT = 0,
+    FARTHEST_OUTPUT = 1
+} output_close_far_t;
+
 /**
  * We have just established a connection to the X server and need the initial
  * XRandR information to setup workspaces for each screen.
  *
  */
-void randr_init(int *event_base);
-
-/**
- * Disables RandR support by creating exactly one output with the size of the
- * X11 screen.
- *
- */
-void disable_randr(xcb_connection_t *conn);
+void randr_init(int *event_base, const bool disable_randr15);
 
 /**
  * Initializes a CT_OUTPUT Con (searches existing ones from inplace restart
@@ -60,35 +60,85 @@ void init_ws_for_output(Output *output, Con *content);
  * (Re-)queries the outputs via RandR and stores them in the list of outputs.
  *
  */
-void randr_query_outputs();
+void randr_query_outputs(void);
+
+/**
+ * Disables the output and moves its content.
+ *
+ */
+void randr_disable_output(Output *output);
 
 /**
  * Returns the first output which is active.
  *
  */
-Output *get_first_output();
+Output *get_first_output(void);
 
 /**
- * Returns the output with the given name if it is active (!) or NULL.
+ * Returns the output with the given name or NULL.
+ * If require_active is true, only active outputs are considered.
  *
  */
-Output *get_output_by_name(const char *name);
+Output *get_output_by_name(const char *name, const bool require_active);
 
 /**
  * Returns the active (!) output which contains the coordinates x, y or NULL
  * if there is no output which contains these coordinates.
  *
  */
-Output *get_output_containing(int x, int y);
+Output *get_output_containing(unsigned int x, unsigned int y);
 
 /**
- * Gets the output which is the last one in the given direction, for example
- * the output on the most bottom when direction == D_DOWN, the output most
- * right when direction == D_RIGHT and so on.
+ * Returns the active output which contains the midpoint of the given rect. If
+ * such an output doesn't exist, returns the output which contains most of the
+ * rectangle or NULL if there is no output which intersects with it.
  *
- * This function always returns a output.
+ */
+Output *get_output_from_rect(Rect rect);
+
+/**
+ * Returns the active output which spans exactly the area specified by
+ * rect or NULL if there is no output like this.
  *
  */
-Output *get_output_most(direction_t direction, Output *current);
+Output *get_output_with_dimensions(Rect rect);
 
-#endif
+/**
+ * In output_containing_rect, we check if any active output contains part of the container.
+ * We do this by checking if the output rect is intersected by the Rect.
+ * This is the 2-dimensional counterpart of get_output_containing.
+ * Returns the output with the maximum intersecting area.
+ *
+ */
+Output *output_containing_rect(Rect rect);
+
+/**
+ * Gets the output which is the next one in the given direction.
+ *
+ * If close_far == CLOSEST_OUTPUT, then the output next to the current one will
+ * selected.  If close_far == FARTHEST_OUTPUT, the output which is the last one
+ * in the given direction will be selected.
+ *
+ * NULL will be returned when no active outputs are present in the direction
+ * specified (note that ‘current’ counts as such an output).
+ *
+ */
+Output *get_output_next(direction_t direction, Output *current, output_close_far_t close_far);
+
+/**
+ * Like get_output_next with close_far == CLOSEST_OUTPUT, but wraps.
+ *
+ * For example if get_output_next(D_DOWN, x, FARTHEST_OUTPUT) = NULL, then
+ * get_output_next_wrap(D_DOWN, x) will return the topmost output.
+ *
+ * This function always returns a output: if no active outputs can be found,
+ * current itself is returned.
+ *
+ */
+Output *get_output_next_wrap(direction_t direction, Output *current);
+
+/**
+ * Creates an output covering the root window.
+ *
+ */
+Output *create_root_output(xcb_connection_t *conn);