layer: document intentions of layer structure

[staging/windowmanager.git] / src / layers.hpp

diff --git a/src/layers.hpp b/src/layers.hpp
index aed39c8..a3cb2a9 100644 (file)
--- a/src/layers.hpp
+++ b/src/layers.hpp
@@ -10,14 +10,26 @@
 #include <string>
 
 #include "result.hpp"
+#include "wayland.hpp"
 
 namespace wm {
 
 struct surface_id_to_layer {
+   // Min and max surface ID mapped to this layer
    int id_min = -1;
    int id_max = -1;
+   // A more or less descriptive name?
    std::string name = "";
+   // The actual layer ID
    int layer_id = -1;
+   // The rectangular region surfaces are allowed to draw on
+   // this layer, note however, width and hieght of the rect
+   // can be negative, in which case they specify that
+   // the actual value is computed using MAX + 1 - w
+   // That is; allow us to specify dimensions dependent on
+   // e.g. screen dimension, w/o knowing the actual screen size.
+   genivi::rect rect;
+   // XXX perhaps a zorder is needed here?
 
    explicit surface_id_to_layer(nlohmann::json const &j);
 
@@ -36,6 +48,7 @@ struct surface_id_to_layer_map {
    layers_type layers;
 
    optional<int> get_layer_for_surface(int surface_id);
+   optional<genivi::rect> get_rect_for_surface(int surface_id);
    layers_type::size_type get_layers_count() const {
       return this->layers.size();
    }