summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-08-07 15:54:50 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-08-07 15:55:01 +0100
commit9a44777481eb2426d334209631c0ff97d83c0cb0 (patch)
tree0480920414b0e5a01dc158c3fb0f77fa72d8888b
parent7a475249ddf5e5cd3142ab9c51af413720d2ff4d (diff)
glview: convert docs
-rw-r--r--src/lib/elm_glview.eo199
1 files changed, 82 insertions, 117 deletions
diff --git a/src/lib/elm_glview.eo b/src/lib/elm_glview.eo
index 3c9d02ed4..feb684c64 100644
--- a/src/lib/elm_glview.eo
+++ b/src/lib/elm_glview.eo
@@ -3,7 +3,7 @@ class Elm.Glview (Elm.Widget)
3 eo_prefix: elm_obj_glview; 3 eo_prefix: elm_obj_glview;
4 methods { 4 methods {
5 version_constructor { 5 version_constructor {
6 /*@ Constructor with context version number. */ 6 [[Constructor with context version number.]]
7 legacy: null; 7 legacy: null;
8 params { 8 params {
9 @in version: Evas_GL_Context_Version; 9 @in version: Evas_GL_Context_Version;
@@ -11,199 +11,164 @@ class Elm.Glview (Elm.Widget)
11 } 11 }
12 @property size { 12 @property size {
13 set { 13 set {
14 /*@ 14 [[Sets the size of the glview.]]
15 Sets the size of the glview
16
17 @ingroup GLView */
18 } 15 }
19 get { 16 get {
20 /*@ 17 [[Get the size of the glview.
21 Get the size of the glview.
22
23 Note that this function returns the actual image size of the
24 glview. This means that when the scale policy is set to
25 #ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
26 size.
27 18
28 @ingroup GLView */ 19 Note: This function returns the actual image size of the
20 glview. This means that when the scale policy is set to
21 #ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
22 size.
23 ]]
29 } 24 }
30 values { 25 values {
31 w: int; /*@ width of the glview object */ 26 w: int; [[Width of the glview object.]]
32 h: int; /*@ height of the glview object */ 27 h: int; [[Height of the glview object.]]
33 } 28 }
34 } 29 }
35 @property resize_policy { 30 @property resize_policy {
36 set { 31 set {
37 /*@ 32 [[Set the resize policy for the glview object.
38 Set the resize policy for the glview object. 33
39 34 By default, the resize policy is set to
40 By default, the resize policy is set to #ELM_GLVIEW_RESIZE_POLICY_RECREATE. 35 #ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called
41 When resize is called it destroys the previous surface and recreates the 36 it destroys the previous surface and recreates the newly
42 newly specified size. If the policy is set to 37 specified size. If the policy is set to
43 #ELM_GLVIEW_RESIZE_POLICY_SCALE, however, glview only scales the image 38 #ELM_GLVIEW_RESIZE_POLICY_SCALE, however, glview only
44 object and not the underlying GL Surface. 39 scales the image object and not the underlying GL Surface.
45 40 ]]
46 @ingroup GLView */
47 return: bool; 41 return: bool;
48 } 42 }
49 values { 43 values {
50 policy: Elm_GLView_Resize_Policy; /*@ The scaling policy. */ 44 policy: Elm_GLView_Resize_Policy; [[The scaling policy.]]
51 } 45 }
52 } 46 }
53 @property changed { 47 @property changed {
54 set { 48 set {
55 /*@ 49 [[Notifies that there has been changes in the GLView.]]
56 Notifies that there has been changes in the GLView.
57
58 @ingroup GLView */
59 } 50 }
60 } 51 }
61 @property resize_func { 52 @property resize_func {
62 set { 53 set {
63 /*@ 54 [[Set the resize function that gets called when resize happens.
64 Set the resize function that gets called when resize happens.
65 55
66 The resize function gets called during the render loop. 56 The resize function gets called during the render loop.
67 This function allows glview to hide all the rendering context/surface 57 This function allows glview to hide all the rendering
68 details and have the user just call GL calls that they desire 58 context/surface details and have the user just call GL
69 when resize happens. 59 alls that they desire when resize happens.
70 60 ]]
71 @ingroup GLView */
72 } 61 }
73 values { 62 values {
74 func: Elm_GLView_Func_Cb; /*@ The resize function to be registered. */ 63 func: Elm_GLView_Func_Cb; [[The resize function to be registered.]]
75 } 64 }
76 } 65 }
77 @property del_func { 66 @property del_func {
78 set { 67 set {
79 /*@ 68 [[Set the render function that runs in the main loop.
80 Set the render function that runs in the main loop.
81
82 The registered del function gets called when GLView object is deleted.
83 This function allows glview to hide all the rendering context/surface
84 details and have the user just call GL calls that they desire
85 when delete happens.
86 69
87 @ingroup GLView */ 70 The registered del function gets called when GLView object
71 is deleted. This function allows glview to hide all the
72 rendering context/surface details and have the user just
73 call GL calls that they desire when delete happens.
74 ]]
88 } 75 }
89 values { 76 values {
90 func: Elm_GLView_Func_Cb @nullable; /*@ The delete function to be registered. */ 77 func: Elm_GLView_Func_Cb @nullable; [[The delete function to be registered.]]
91 } 78 }
92 } 79 }
93 @property init_func { 80 @property init_func {
94 set { 81 set {
95 /*@ 82 [[Set the init function that runs once in the main loop.
96 Set the init function that runs once in the main loop.
97
98 The registered init function gets called once during the render loop.
99 This function allows glview to hide all the rendering context/surface
100 details and have the user just call GL calls that they desire
101 for initialization GL calls.
102 83
103 @ingroup GLView */ 84 The registered init function gets called once during the
85 render loop. This function allows glview to hide all the
86 rendering context/surface details and have the user just
87 call GL calls that they desire for initialization GL calls.
88 ]]
104 } 89 }
105 values { 90 values {
106 func: Elm_GLView_Func_Cb @nullable; /*@ The init function to be registered. */ 91 func: Elm_GLView_Func_Cb @nullable; [[The init function to be registered.]]
107 } 92 }
108 } 93 }
109 @property render_policy { 94 @property render_policy {
110 set { 95 set {
111 /*@ 96 [[Set the render policy for the glview object.
112 Set the render policy for the glview object. 97
113 98 By default, the render policy is set to
114 By default, the render policy is set to #ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. 99 #ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set
115 This policy is set such that during the render loop, glview is only 100 such that during the render loop, glview is only redrawn
116 redrawn if it needs to be redrawn. (i.e. when it is visible) If the policy 101 if it needs to be redrawn. (i.e. when it is visible) If the
117 is set to #ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of 102 policy is set to #ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it
118 whether it is visible or needs redrawing. 103 redraws regardless of whether it is visible or needs
119 104 redrawing.
120 @ingroup GLView */ 105 ]]
121 return: bool; 106 return: bool;
122 } 107 }
123 values { 108 values {
124 policy: Elm_GLView_Render_Policy; /*@ The render policy. */ 109 policy: Elm_GLView_Render_Policy; [[The render policy.]]
125 } 110 }
126 } 111 }
127 @property mode { 112 @property mode {
128 set { 113 set {
129 /*@ 114 [[Set the mode of the GLView. Supports alpha, depth, stencil.
130 Set the mode of the GLView. Supports alpha, depth, stencil.
131 115
132 @return True if set properly. 116 Direct is a hint for the elm_glview to render directly to
133 117 the window given that the right conditions are met. Otherwise
134 Direct is a hint for the elm_glview to render directly to the window 118 it falls back to rendering to an offscreen buffer before it
135 given that the right conditions are met. Otherwise it falls back 119 gets composited to the window.
136 to rendering to an offscreen buffer before it gets composited to the 120 ]]
137 window.
138
139 @ingroup GLView */
140 return: bool; 121 return: bool;
141 } 122 }
142 values { 123 values {
143 mode: Elm_GLView_Mode; /*@ The mode Options OR'ed enabling Alpha, Depth, Stencil, Direct. */ 124 mode: Elm_GLView_Mode; [[The mode Options OR'ed enabling Alpha, Depth, Stencil, Direct.]]
144 } 125 }
145 } 126 }
146 @property render_func { 127 @property render_func {
147 set { 128 set {
148 /*@ 129 [[Set the render function that runs in the main loop.
149 Set the render function that runs in the main loop.
150
151 The render function gets called in the main loop but whether it runs
152 depends on the rendering policy and whether elm_glview_changed_set()
153 gets called.
154 130
155 @ingroup GLView */ 131 The render function gets called in the main loop but whether
132 it runs depends on the rendering policy and whether
133 @.changed.set gets called.
134 ]]
156 } 135 }
157 values { 136 values {
158 func: Elm_GLView_Func_Cb @nullable; /*@ The render function to be registered. */ 137 func: Elm_GLView_Func_Cb @nullable; [[The render function to be registered.]]
159 } 138 }
160 } 139 }
161 @property gl_api { 140 @property gl_api {
162 get { 141 get {
163 /*@ 142 [[Get the gl api struct for gl rendering.]]
164 Get the gl api struct for gl rendering
165
166 @return The api object or NULL if it cannot be created
167
168 @ingroup GLView */
169 return: Evas_GL_API *; 143 return: Evas_GL_API *;
170 } 144 }
171 } 145 }
172 @property evas_gl { 146 @property evas_gl {
173 get { 147 get {
174 /*@ 148 [[Get the internal Evas GL attached to this view.
175 Get the internal Evas GL attached to this view.
176 149
177 @note The returned Evas_GL must not be destroyed as it is still owned 150 Note: The returned Evas_GL must not be destroyed as it is
178 by the view. But this pointer can be used then to call all the evas_gl_ 151 still owned by the view. But this pointer can be used then
179 functions. 152 to call all the evas_gl_ functions.
180 153
181 @since 1.12 154 @since 1.12
182 155 ]]
183 @return The Evas_GL used by this GLView.
184
185 @ingroup GLView */
186 return: Evas_GL *; 156 return: Evas_GL *;
187 } 157 }
188 } 158 }
189 @property rotation { 159 @property rotation {
190 get { 160 get {
191 /*@ 161 [[Get the current GL view's rotation when using direct rendering
192 Get the current GL view's rotation when using direct rendering
193
194 @return A window rotation in degrees (0, 90, 180 or 270)
195
196 @note This rotation can be different from the device orientation. This
197 rotation value must be used in case of direct rendering and should be
198 taken into account by the application when setting the internal rotation
199 matrix for the view.
200
201 @see ELM_GLVIEW_CLIENT_SIDE_ROTATION
202 162
203 @since 1.12 163 Note: This rotation can be different from the device
164 orientation. This rotation value must be used in case of
165 direct rendering and should be taken into account by the
166 application when setting the internal rotation matrix for
167 the view.
204 168
205 @ingroup GLView */ 169 @since 1.12
206 return: int; 170 ]]
171 return: int; [[A window rotation in degrees (0, 90, 180 or 270).]]
207 } 172 }
208 } 173 }
209 } 174 }