git.sur5r.net Git - i3/i3/blob - include/randr.h

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * For more information on RandR, please see the X.org RandR specification at
   8  * http://cgit.freedesktop.org/xorg/proto/randrproto/tree/randrproto.txt
   9  * (take your time to read it completely, it answers all questions).
  10  *
  11  */
  12 #pragma once
  13
  14 #include "data.h"
  15 #include <xcb/randr.h>
  16
  17 TAILQ_HEAD(outputs_head, xoutput);
  18 extern struct outputs_head outputs;
  19
  20 typedef enum {
  21     CLOSEST_OUTPUT = 0,
  22     FARTHEST_OUTPUT = 1
  23 } output_close_far_t;
  24
  25 /**
  26  * We have just established a connection to the X server and need the initial
  27  * XRandR information to setup workspaces for each screen.
  28  *
  29  */
  30 void randr_init(int *event_base);
  31
  32 /**
  33  * Disables RandR support by creating exactly one output with the size of the
  34  * X11 screen.
  35  *
  36  */
  37 void disable_randr(xcb_connection_t *conn);
  38
  39 /**
  40  * Initializes a CT_OUTPUT Con (searches existing ones from inplace restart
  41  * before) to use for the given Output.
  42  *
  43  */
  44 void output_init_con(Output *output);
  45
  46 /**
  47  * Initializes at least one workspace for this output, trying the following
  48  * steps until there is at least one workspace:
  49  *
  50  * • Move existing workspaces, which are assigned to be on the given output, to
  51  *   the output.
  52  * • Create the first assigned workspace for this output.
  53  * • Create the first unused workspace.
  54  *
  55  */
  56 void init_ws_for_output(Output *output, Con *content);
  57
  58 /**
  59  * Initializes the specified output, assigning the specified workspace to it.
  60  *
  61  */
  62 //void initialize_output(xcb_connection_t *conn, Output *output, Workspace *workspace);
  63
  64 /**
  65  * (Re-)queries the outputs via RandR and stores them in the list of outputs.
  66  *
  67  */
  68 void randr_query_outputs(void);
  69
  70 /**
  71  * Returns the first output which is active.
  72  *
  73  */
  74 Output *get_first_output(void);
  75
  76 /**
  77  * Returns the output with the given name if it is active (!) or NULL.
  78  *
  79  */
  80 Output *get_output_by_name(const char *name);
  81
  82 /**
  83  * Returns the active (!) output which contains the coordinates x, y or NULL
  84  * if there is no output which contains these coordinates.
  85  *
  86  */
  87 Output *get_output_containing(unsigned int x, unsigned int y);
  88
  89 /*
  90  * In contained_by_output, we check if any active output contains part of the container.
  91  * We do this by checking if the output rect is intersected by the Rect.
  92  * This is the 2-dimensional counterpart of get_output_containing.
  93  * Since we don't actually need the outputs intersected by the given Rect (There could
  94  * be many), we just return true or false for convenience.
  95  *
  96  */
  97 bool contained_by_output(Rect rect);
  98
  99 /**
 100  * Gets the output which is the next one in the given direction.
 101  *
 102  * If close_far == CLOSEST_OUTPUT, then the output next to the current one will
 103  * selected.  If close_far == FARTHEST_OUTPUT, the output which is the last one
 104  * in the given direction will be selected.
 105  *
 106  * NULL will be returned when no active outputs are present in the direction
 107  * specified (note that ‘current’ counts as such an output).
 108  *
 109  */
 110 Output *get_output_next(direction_t direction, Output *current, output_close_far_t close_far);
 111
 112 /**
 113  * Like get_output_next with close_far == CLOSEST_OUTPUT, but wraps.
 114  *
 115  * For example if get_output_next(D_DOWN, x, FARTHEST_OUTPUT) = NULL, then
 116  * get_output_next_wrap(D_DOWN, x) will return the topmost output.
 117  *
 118  * This function always returns a output: if no active outputs can be found,
 119  * current itself is returned.
 120  *
 121  */
 122 Output *get_output_next_wrap(direction_t direction, Output *current);