summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Blumenkrantz <zmike@osg.samsung.com>2016-09-09 11:33:55 -0400
committerMike Blumenkrantz <zmike@osg.samsung.com>2016-09-09 11:38:08 -0400
commit013a8e3e4bb0c2e77d0c24650b76a702f02da9f8 (patch)
tree042cf04c7e4d7b15e8a60b0f8100e7ab51da2eb4
parentdc2bad0fcda063ee72b35beb3954cc2fc1eb94ba (diff)
add docs for E_Comp struct members
-rw-r--r--src/bin/e_comp.h94
1 files changed, 47 insertions, 47 deletions
diff --git a/src/bin/e_comp.h b/src/bin/e_comp.h
index 571e1b29d..04865820c 100644
--- a/src/bin/e_comp.h
+++ b/src/bin/e_comp.h
@@ -79,63 +79,63 @@ typedef struct E_Comp_Screen_Iface
79struct _E_Comp 79struct _E_Comp
80{ 80{
81 E_Object e_obj_inherit; 81 E_Object e_obj_inherit;
82 int w, h; 82 int w, h; //overall size of compositor
83 83
84 Ecore_Window win; // input overlay 84 Ecore_Window win; // input overlay
85 Ecore_Window root; 85 Ecore_Window root; //x11 root window
86 Ecore_Evas *ee; 86 Ecore_Evas *ee; //canvas
87 Ecore_Window ee_win; 87 Ecore_Window ee_win; //canvas window
88 Evas_Object *elm; 88 Evas_Object *elm; //elm win base
89 Evas *evas; 89 Evas *evas; //canvas
90 Evas_Object *bg_blank_object; 90 Evas_Object *bg_blank_object; //black blocker rect to cover background artifacts
91 Eina_List *zones; 91 Eina_List *zones; //list of E_Zones
92 E_Pointer *pointer; 92 E_Pointer *pointer;
93 Eina_List *clients; 93 Eina_List *clients; //list of all E_Clients
94 unsigned int new_clients; 94 unsigned int new_clients; //number of clients with new_client set
95 95
96 Eina_List *pre_render_cbs; /* E_Comp_Cb */ 96 Eina_List *pre_render_cbs; /* E_Comp_Cb */
97 97
98 E_Comp_X_Data *x_comp_data; 98 E_Comp_X_Data *x_comp_data; //x11 compositor-specific data
99 E_Comp_Wl_Data *wl_comp_data; 99 E_Comp_Wl_Data *wl_comp_data; //wl compositor-specific data
100 100
101 E_Pixmap_Type comp_type; //for determining X/Wayland/ 101 E_Pixmap_Type comp_type; //for determining X/Wayland primary type
102 102
103 Eina_Stringshare *name; 103 Eina_Stringshare *name;
104 struct { 104 struct {
105 Ecore_Window win; 105 Ecore_Window win; //x11 layer stacking window
106 Evas_Object *obj; 106 Evas_Object *obj; //layer stacking object
107 //Eina_Inlist *objs; /* E_Comp_Object; NOT to be exposed; seems pointless? */ 107 //Eina_Inlist *objs; /* E_Comp_Object; NOT to be exposed; seems pointless? */
108 Eina_Inlist *clients; /* E_Client, bottom to top */ 108 Eina_Inlist *clients; /* E_Client, bottom to top */
109 unsigned int clients_count; 109 unsigned int clients_count; //count of clients on layer
110 } layers[E_LAYER_COUNT]; 110 } layers[E_LAYER_COUNT];
111 111
112 struct 112 struct //autoclose handler for e_comp_object_util_autoclose
113 { 113 {
114 Evas_Object *rect; 114 Evas_Object *rect; //autoclose blocker rect
115 Evas_Object *obj; 115 Evas_Object *obj; //autoclose object
116 Ecore_Event_Handler *key_handler; 116 Ecore_Event_Handler *key_handler;
117 E_Comp_Object_Autoclose_Cb del_cb; 117 E_Comp_Object_Autoclose_Cb del_cb; //cb to call on autoclose delete
118 E_Comp_Object_Key_Cb key_cb; 118 E_Comp_Object_Key_Cb key_cb; //cb to call on key press
119 void *data; 119 void *data; //user data
120 } autoclose; 120 } autoclose;
121 121
122 E_Comp_Screen_Iface *screen; 122 E_Comp_Screen_Iface *screen;
123 123
124 Eina_List *debug_rects; 124 Eina_List *debug_rects; //used when SHAPE_DEBUG is defined in e_comp.c
125 Eina_List *ignore_wins; 125 Eina_List *ignore_wins; //windows to be ignored by the compositor
126 126
127 Eina_List *updates; 127 Eina_List *updates; //E_Clients with render updates
128 Eina_List *post_updates; 128 Eina_List *post_updates; //E_Clients awaiting post render flushing
129 Ecore_Animator *render_animator; 129 Ecore_Animator *render_animator; //animator for fixed time rendering
130 Ecore_Job *shape_job; 130 Ecore_Job *shape_job; //job to update x11 input shapes
131 Ecore_Job *update_job; 131 Ecore_Job *update_job; //job to trigger render updates
132 Evas_Object *fps_bg; 132 Evas_Object *fps_bg;
133 Evas_Object *fps_fg; 133 Evas_Object *fps_fg;
134 Ecore_Job *screen_job; 134 Ecore_Job *screen_job;
135 Ecore_Timer *nocomp_delay_timer; 135 Ecore_Timer *nocomp_delay_timer; //delay before activating nocomp in x11
136 Ecore_Timer *nocomp_override_timer; 136 Ecore_Timer *nocomp_override_timer; //delay before overriding nocomp in x11
137 int animating; 137 int animating; //number of animating comp objects
138 double frametimes[122]; 138 double frametimes[122]; //used for calculating fps
139 int frameskip; 139 int frameskip;
140 140
141 int nocomp_override; //number of times nocomp override has been requested 141 int nocomp_override; //number of times nocomp override has been requested
@@ -143,22 +143,22 @@ struct _E_Comp
143 int block_count; //number of times block window has been requested 143 int block_count; //number of times block window has been requested
144 144
145 Ecore_Window cm_selection; //FIXME: move to comp_x ? 145 Ecore_Window cm_selection; //FIXME: move to comp_x ?
146 E_Client *nocomp_ec; 146 E_Client *nocomp_ec; //window that triggered nocomp mode
147 147
148 int depth; 148 int depth;
149 unsigned int input_key_grabs; 149 unsigned int input_key_grabs; //number of active compositor key grabs
150 unsigned int input_mouse_grabs; 150 unsigned int input_mouse_grabs; //number of active compositor mouse grabs
151 151
152 E_Comp_Cb grab_cb; 152 E_Comp_Cb grab_cb; //callback for grabbing the xserver
153 E_Comp_Cb bindings_grab_cb; 153 E_Comp_Cb bindings_grab_cb; //callback for triggering binding input grab
154 E_Comp_Cb bindings_ungrab_cb; 154 E_Comp_Cb bindings_ungrab_cb; //callback for triggering binding input ungrab
155 155
156 Eina_Bool gl : 1; 156 Eina_Bool gl : 1; //gl is active
157 Eina_Bool grabbed : 1; 157 Eina_Bool grabbed : 1; //xserver is grabbed
158 Eina_Bool nocomp : 1; 158 Eina_Bool nocomp : 1; //nocomp is active
159 Eina_Bool nocomp_want : 1; 159 Eina_Bool nocomp_want : 1; //nocomp is pending
160 Eina_Bool saver : 1; 160 Eina_Bool saver : 1; //screensaver is active
161 Eina_Bool shape_queue_blocked : 1; 161 Eina_Bool shape_queue_blocked : 1; //x11 input shape updates are blocked
162 162
163 Eina_Bool rendering : 1; // we've received a pre-render callback but no post-render yet. 163 Eina_Bool rendering : 1; // we've received a pre-render callback but no post-render yet.
164}; 164};