summaryrefslogtreecommitdiff
path: root/src/lib/evas/canvas/evas_canvas3d_light.eo
diff options
context:
space:
mode:
authorSrivardhan Hebbar <sri.hebbar@samsung.com>2015-07-16 11:16:45 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-07-16 11:18:26 +0100
commitf0cef9a56b2e34d1bec1edff074ee43a28a05937 (patch)
tree72c9cf5d19d187af018ba479b7481231d866a993 /src/lib/evas/canvas/evas_canvas3d_light.eo
parent83f4ee89d0104f9e46f57fa0dcca08cecefa514c (diff)
evas canvas3d: Eolian doc conversion of canvas3d_light.
Summary: Apart from evas_canvas3d_node_look_at_set() all other things are referenced. Tried to reference it to @Evas.Canvas3D.Node.look_at_set(). But getting error. Signed-off-by: Srivardhan Hebbar <sri.hebbar@samsung.com> Reviewers: cedric, tasn, q66 Reviewed By: q66 Subscribers: cedric Differential Revision: https://phab.enlightenment.org/D2822
Diffstat (limited to 'src/lib/evas/canvas/evas_canvas3d_light.eo')
-rw-r--r--src/lib/evas/canvas/evas_canvas3d_light.eo286
1 files changed, 94 insertions, 192 deletions
diff --git a/src/lib/evas/canvas/evas_canvas3d_light.eo b/src/lib/evas/canvas/evas_canvas3d_light.eo
index 54221e0..91a286e 100644
--- a/src/lib/evas/canvas/evas_canvas3d_light.eo
+++ b/src/lib/evas/canvas/evas_canvas3d_light.eo
@@ -6,8 +6,7 @@ class Evas.Canvas3D.Light (Evas.Canvas3D.Object, Evas.Common_Interface)
6 methods { 6 methods {
7 @property directional { 7 @property directional {
8 set { 8 set {
9 /*@ 9 [[Set the directional flag of the given light.
10 Set the directional flag of the given light.
11 10
12 Directional light is a type of light which is infinitely far away with no 11 Directional light is a type of light which is infinitely far away with no
13 attenuation. The light direction is determined by the containing node's 12 attenuation. The light direction is determined by the containing node's
@@ -15,29 +14,21 @@ class Evas.Canvas3D.Light (Evas.Canvas3D.Object, Evas.Common_Interface)
15 14
16 By default, directional is not enabled. 15 By default, directional is not enabled.
17 16
18 @see evas_canvas3d_node_look_at_set() 17 \@ref evas_canvas3d_node_look_at_set]]
19
20 @ingroup Evas_Canvas3D_Light
21 */
22 } 18 }
23 get { 19 get {
24 /*@ 20 [[Get the directional flag of the given light.
25 Get the directional flag of the given light.
26
27 @see evas_canvas3d_light_directional_set()
28 21
29 @ingroup Evas_Canvas3D_Light 22 See also @.directional.set]]
30 */
31 } 23 }
32 values { 24 values {
33 directional: bool; /*@ Whether the light is directional (@c EINA_TRUE), or not (@c EINA_FALSE).*/ 25 directional: bool; [[Whether the light is directional ($true), or not ($false).]]
34 } 26 }
35 } 27 }
36 28
37 @property spot_exponent { 29 @property spot_exponent {
38 set { 30 set {
39 /*@ 31 [[Set the spot exponent of the given light.
40 Set the spot exponent of the given light.
41 32
42 Higher spot exponent means intensity at the center of the cone is relatively 33 Higher spot exponent means intensity at the center of the cone is relatively
43 stronger. Zero exponent means the light intensity is evenly distibuted. The 34 stronger. Zero exponent means the light intensity is evenly distibuted. The
@@ -46,174 +37,126 @@ class Evas.Canvas3D.Light (Evas.Canvas3D.Object, Evas.Common_Interface)
46 37
47 Default spot exponent is 0. 38 Default spot exponent is 0.
48 39
49 @see evas_canvas3d_light_spot_cutoff_set() 40 See also @.spot_cutoff.set]]
50
51 @ingroup Evas_Canvas3D_Light
52 */
53 } 41 }
54 get { 42 get {
55 /*@ 43 [[Get the spot exponent of the given light.
56 Get the spot exponent of the given light.
57 44
58 @see evas_canvas3d_light_spot_exponent_set() 45 See also @.spot_exponent.set]]
59
60 @ingroup Evas_Canvas3D_Light
61 */
62 } 46 }
63 values { 47 values {
64 exponent: Evas_Real; /*@ Spot exponent value..*/ 48 exponent: Evas_Real; [[Spot exponent value.]]
65 } 49 }
66 } 50 }
67 51
68 @property spot_cutoff { 52 @property spot_cutoff {
69 set { 53 set {
70 /*@ 54 [[Set the spot cutoff angle of the given light.
71 Set the spot cutoff angle of the given light.
72 55
73 Only angle less than 180 degree will make it spot light, so that other spot 56 Only angle less than 180 degree will make it spot light, so that other spot
74 light attribute will take effect. 57 light attribute will take effect.
75 58
76 Default spot cutoff angle is 180. 59 Default spot cutoff angle is 180.]]
77
78 @ingroup Evas_Canvas3D_Light
79 */
80 } 60 }
81 get { 61 get {
82 /*@ 62 [[Get the spot cutoff angle of the given light.
83 Get the spot cutoff angle of the given light.
84
85 @see evas_canvas3d_light_spot_cutoff_set()
86 63
87 @ingroup Evas_Canvas3D_Light 64 See also @.spot_cutoff.set]]
88 */
89 } 65 }
90 values { 66 values {
91 cutoff: Evas_Real; /*@ Cutoff angle in degree..*/ 67 cutoff: Evas_Real; [[Cutoff angle in degree..]]
92 } 68 }
93 } 69 }
94 70
95 @property attenuation_enable { 71 @property attenuation_enable {
96 set { 72 set {
97 /*@ 73 [[Set the attenuation enable flag of the given light.
98 Set the attenuation enable flag of the given light.
99 74
100 By default, light attenuation is not enabled. 75 By default, light attenuation is not enabled.
101 76
102 @see evas_canvas3d_light_attenuation_set() 77 See also @.attenuation_set]]
103
104 @ingroup Evas_Canvas3D_Light
105 */
106 } 78 }
107 get { 79 get {
108 /*@ 80 [[Get the attenuation enable flag of the given light.
109 Get the attenuation enable flag of the given light.
110
111 @see evas_canvas3d_light_attenuation_enable_set()
112 81
113 @ingroup Evas_Canvas3D_Light 82 See also @.attenuation_enable.set]]
114 */
115 } 83 }
116 values { 84 values {
117 enable: bool; /*@ Whether to enable attenuation (@c EINA_TRUE), or not (@c EINA_FALSE)..*/ 85 enable: bool; [[Whether to enable attenuation ($true), or not ($false)..]]
118 } 86 }
119 } 87 }
120 88
121 ambient_set { 89 ambient_set {
122 /*@ 90 [[Set the ambient color of the given light.
123 Set the ambient color of the given light.
124
125 Default ambient color is (0.0, 0.0, 0.0, 1.0).
126 91
127 @ingroup Evas_Canvas3D_Light 92 Default ambient color is (0.0, 0.0, 0.0, 1.0).]]
128 */
129 params { 93 params {
130 @in r: Evas_Real; /*@ Red component of the ambient color between [0.0, 1.0]. */ 94 @in r: Evas_Real; [[Red component of the ambient color between [0.0, 1.0].]]
131 @in g: Evas_Real; /*@ Green component of the ambient color between [0.0, 1.0]. */ 95 @in g: Evas_Real; [[Green component of the ambient color between [0.0, 1.0].]]
132 @in b: Evas_Real; /*@ Blue component of the ambient color between [0.0, 1.0]. */ 96 @in b: Evas_Real; [[Blue component of the ambient color between [0.0, 1.0].]]
133 @in a: Evas_Real; /*@ Alpha component of the ambient color between [0.0, 1.0]. */ 97 @in a: Evas_Real; [[Alpha component of the ambient color between [0.0, 1.0].]]
134 } 98 }
135 } 99 }
136 ambient_get @const { 100 ambient_get @const {
137 /*@ 101 [[Get the ambient color of the given light.
138 Get the ambient color of the given light.
139 102
140 @see evas_canvas3d_light_ambient_set() 103 See also @.ambient_set]]
141
142 @ingroup Evas_Canvas3D_Light
143 */
144 params { 104 params {
145 @out r: Evas_Real; /*@ Red component of the ambient color between [0.0, 1.0]. */ 105 @out r: Evas_Real; [[Red component of the ambient color between [0.0, 1.0].]]
146 @out g: Evas_Real; /*@ Green component of the ambient color between [0.0, 1.0]. */ 106 @out g: Evas_Real; [[Green component of the ambient color between [0.0, 1.0].]]
147 @out b: Evas_Real; /*@ Blue component of the ambient color between [0.0, 1.0]. */ 107 @out b: Evas_Real; [[Blue component of the ambient color between [0.0, 1.0].]]
148 @out a: Evas_Real; /*@ Alpha component of the ambient color between [0.0, 1.0]. */ 108 @out a: Evas_Real; [[Alpha component of the ambient color between [0.0, 1.0].]]
149 } 109 }
150 } 110 }
151 111
152 diffuse_set { 112 diffuse_set {
153 /*@ 113 [[Set the diffuse color of the given light.
154 Set the diffuse color of the given light.
155
156 Default diffuse color is (1.0, 1.0, 1.0, 1.0).
157 114
158 @ingroup Evas_Canvas3D_Light 115 Default diffuse color is (1.0, 1.0, 1.0, 1.0).]]
159 */
160 params { 116 params {
161 @in r: Evas_Real; /*@ Red component of the diffuse color between [0.0, 1.0]. */ 117 @in r: Evas_Real; [[Red component of the diffuse color between [0.0, 1.0].]]
162 @in g: Evas_Real; /*@ Green component of the diffuse color between [0.0, 1.0]. */ 118 @in g: Evas_Real; [[Green component of the diffuse color between [0.0, 1.0].]]
163 @in b: Evas_Real; /*@ Blue component of the diffuse color between [0.0, 1.0]. */ 119 @in b: Evas_Real; [[Blue component of the diffuse color between [0.0, 1.0].]]
164 @in a: Evas_Real; /*@ Alpha component of the diffuse color between [0.0, 1.0]. */ 120 @in a: Evas_Real; [[Alpha component of the diffuse color between [0.0, 1.0].]]
165 } 121 }
166 } 122 }
167 diffuse_get @const { 123 diffuse_get @const {
168 /*@ 124 [[Get the diffuse color of the given light.
169 Get the diffuse color of the given light.
170
171 @see evas_canvas3d_light_diffuse_set()
172 125
173 @ingroup Evas_Canvas3D_Light 126 See also @.diffuse_set]]
174 */
175 params { 127 params {
176 @out r: Evas_Real; /*@ Red component of the diffuse color between [0.0, 1.0]. */ 128 @out r: Evas_Real; [[Red component of the diffuse color between [0.0, 1.0].]]
177 @out g: Evas_Real; /*@ Green component of the diffuse color between [0.0, 1.0]. */ 129 @out g: Evas_Real; [[Green component of the diffuse color between [0.0, 1.0].]]
178 @out b: Evas_Real; /*@ Blue component of the diffuse color between [0.0, 1.0]. */ 130 @out b: Evas_Real; [[Blue component of the diffuse color between [0.0, 1.0].]]
179 @out a: Evas_Real; /*@ Alpha component of the diffuse color between [0.0, 1.0]. */ 131 @out a: Evas_Real; [[Alpha component of the diffuse color between [0.0, 1.0].]]
180 } 132 }
181 } 133 }
182 134
183 specular_set { 135 specular_set {
184 /*@ 136 [[Set the specular color of the given light.
185 Set the specular color of the given light.
186 137
187 Default specular color is (1.0, 1.0, 1.0, 1.0). 138 Default specular color is (1.0, 1.0, 1.0, 1.0).]]
188
189 @ingroup Evas_Canvas3D_Light
190 */
191 params { 139 params {
192 @in r: Evas_Real; /*@ Red component of the specular color between [0.0, 1.0]. */ 140 @in r: Evas_Real; [[Red component of the specular color between [0.0, 1.0].]]
193 @in g: Evas_Real; /*@ Green component of the specular color between [0.0, 1.0]. */ 141 @in g: Evas_Real; [[Green component of the specular color between [0.0, 1.0].]]
194 @in b: Evas_Real; /*@ Blue component of the specular color between [0.0, 1.0]. */ 142 @in b: Evas_Real; [[Blue component of the specular color between [0.0, 1.0].]]
195 @in a: Evas_Real; /*@ Alpha component of the specular color between [0.0, 1.0]. */ 143 @in a: Evas_Real; [[Alpha component of the specular color between [0.0, 1.0].]]
196 } 144 }
197 } 145 }
198 specular_get @const { 146 specular_get @const {
199 /*@ 147 [[Get the specular color of the given light.
200 Get the specular color of the given light.
201
202 @see evas_canvas3d_light_specular_set()
203 148
204 @ingroup Evas_Canvas3D_Light 149 See also @.specular_set]]
205 */
206 params { 150 params {
207 @out r: Evas_Real; /*@ Red component of the specular color between [0.0, 1.0]. */ 151 @out r: Evas_Real; [[Red component of the specular color between [0.0, 1.0].]]
208 @out g: Evas_Real; /*@ Green component of the specular color between [0.0, 1.0]. */ 152 @out g: Evas_Real; [[Green component of the specular color between [0.0, 1.0].]]
209 @out b: Evas_Real; /*@ Blue component of the specular color between [0.0, 1.0]. */ 153 @out b: Evas_Real; [[Blue component of the specular color between [0.0, 1.0].]]
210 @out a: Evas_Real; /*@ Alpha component of the specular color between [0.0, 1.0]. */ 154 @out a: Evas_Real; [[Alpha component of the specular color between [0.0, 1.0].]]
211 } 155 }
212 } 156 }
213 157
214 attenuation_set { 158 attenuation_set {
215 /*@ 159 [[Set the attenuation of the given light.
216 Set the attenuation of the given light.
217 160
218 Light attenuation has no effect with directional light. And the attenuation 161 Light attenuation has no effect with directional light. And the attenuation
219 should be enabled first to take effect. The attenuation factor is calculated 162 should be enabled first to take effect. The attenuation factor is calculated
@@ -223,123 +166,82 @@ class Evas.Canvas3D.Light (Evas.Canvas3D.Object, Evas.Common_Interface)
223 166
224 Default attenuation is constant = 1.0, linear = 0.0, quadratic = 0.0. 167 Default attenuation is constant = 1.0, linear = 0.0, quadratic = 0.0.
225 168
226 @see evas_canvas3d_light_attenuation_enable_set() 169 See also @.attenuation_enable.set]]
227
228 @ingroup Evas_Canvas3D_Light
229 */
230 params { 170 params {
231 @in constant: Evas_Real; /*@ Constant attenuation term..*/ 171 @in constant: Evas_Real; [[Constant attenuation term..]]
232 @in linear: Evas_Real; /*@ Linear attenuation term..*/ 172 @in linear: Evas_Real; [[Linear attenuation term..]]
233 @in quadratic: Evas_Real; /*@ Quadratic attenuation term..*/ 173 @in quadratic: Evas_Real; [[Quadratic attenuation term..]]
234 } 174 }
235 } 175 }
236 176
237 attenuation_get @const { 177 attenuation_get @const {
238 /*@ 178 [[Get the attenuation of the given light.
239 Get the attenuation of the given light.
240 179
241 @see evas_canvas3d_light_attenuation_set() 180 See also @.attenuation_set]]
242
243 @ingroup Evas_Canvas3D_Light
244 */
245 params { 181 params {
246 @out constant: Evas_Real; /*@ Constant attenuation term..*/ 182 @out constant: Evas_Real; [[Constant attenuation term..]]
247 @out linear: Evas_Real; /*@ Linear attenuation term..*/ 183 @out linear: Evas_Real; [[Linear attenuation term..]]
248 @out quadratic: Evas_Real; /*@ Quadratic attenuation term..*/ 184 @out quadratic: Evas_Real; [[Quadratic attenuation term..]]
249 } 185 }
250 } 186 }
251 187
252 projection_matrix_set { 188 projection_matrix_set {
253 /*@ 189 [[Set the projection matrix of the given light source.
254 Set the projection matrix of the given light source.
255
256 @param light The given light source.
257 @param matrix Pointer to the array of 16 Evas_Real values in column major order.
258 190
259 Default projection matrix is identity matrix. 191 Default projection matrix is identity matrix.
260 192
261 @see evas_canvas3d_light_projection_perspective_set() 193 See also @.projection_perspective_set, @.projection_ortho_set and @.projection_frustum_set]]
262 @see evas_canvas3d_light_projection_ortho_set()
263 @see evas_canvas3d_light_projection_frustum_set()
264
265 @ingroup Evas_Canvas3D_Light
266 */
267 params { 194 params {
268 @in matrix: const(Evas_Real) *; /*@ Projection Matrix */ 195 @in matrix: const(Evas_Real) *; [[Projection Matrix. Pointer to the array of 16 Evas_Real values in column major order.]]
269 } 196 }
270 } 197 }
271 198
272 projection_matrix_get @const { 199 projection_matrix_get @const {
273 /*@ 200 [[Get the projection matrix of the given light source.
274 Get the projection matrix of the given light source.
275 201
276 @param light The given light source. 202 See also @.projection_matrix_set]]
277 @param matrix Pointer to receive the 16 Evas_Real values in column major order.
278
279 @see evas_canvas3d_light_projection_matrix_set()
280
281 @ingroup Evas_Canvas3D_Light
282 */
283 params { 203 params {
284 @out matrix: Evas_Real; /*@ Projection Matrix */ 204 @out matrix: Evas_Real; [[Projection Matrix]]
285 } 205 }
286 } 206 }
287 207
288 projection_perspective_set { 208 projection_perspective_set {
289 /*@ 209 [[Set the projection matrix of the given light source with perspective projection.
290 Set the projection matrix of the given light source with perspective projection.
291
292 @param light The given light source.
293 @param fovy Field of view angle in Y direction.
294 @param aspect Aspect ratio.
295 @param dnear Distance to near clipping plane.
296 @param dfar Distance to far clipping plane.
297 210
298 @see evas_canvas3d_light_projection_matrix_set() 211 See also @.projection_matrix_set]]
299
300 @ingroup Evas_Canvas3D_Light
301 */
302 212
303 params { 213 params {
304 fovy: Evas_Real; /*@ Field of view angle in Y direction. */ 214 fovy: Evas_Real; [[Field of view angle in Y direction.]]
305 aspect: Evas_Real; /*@ Aspect ratio.*/ 215 aspect: Evas_Real; [[Aspect ratio.]]
306 dnear: Evas_Real; /*@ Distance to near clipping plane. */ 216 dnear: Evas_Real; [[Distance to near clipping plane.]]
307 dfar: Evas_Real; /*@ Distance to far clipping plane. */ 217 dfar: Evas_Real; [[Distance to far clipping plane.]]
308 } 218 }
309 } 219 }
310 220
311 projection_frustum_set { 221 projection_frustum_set {
312 /*@ 222 [[Set the projection matrix of the given light source with frustum projection.
313 Set the projection matrix of the given light source with frustum projection.
314
315 @see evas_canvas3d_Light_projection_matrix_set()
316 223
317 @ingroup Evas_Canvas3D_Light 224 @Evas.Canvas3D.Light.projection_matrix_set]]
318 */
319 params { 225 params {
320 left: Evas_Real; /*@ Left X coordinate of the near clipping plane. */ 226 left: Evas_Real; [[Left X coordinate of the near clipping plane.]]
321 right: Evas_Real; /*@ Right X coordinate of the near clipping plane..*/ 227 right: Evas_Real; [[Right X coordinate of the near clipping plane.]]
322 bottom: Evas_Real; /*@ Bottom Y coordinate of the near clipping plane. */ 228 bottom: Evas_Real; [[Bottom Y coordinate of the near clipping plane.]]
323 top: Evas_Real; /*@ Top Y coordinate of the near clipping plane */ 229 top: Evas_Real; [[Top Y coordinate of the near clipping plane]]
324 dnear: Evas_Real; /*@ Distance to near clipping plane. */ 230 dnear: Evas_Real; [[Distance to near clipping plane.]]
325 dfar: Evas_Real; /*@ Distance to far clipping plane. */ 231 dfar: Evas_Real; [[Distance to far clipping plane.]]
326 } 232 }
327 } 233 }
328 projection_ortho_set { 234 projection_ortho_set {
329 /*@ 235 [[Set the projection matrix of the given light source with orthogonal projection.
330 Set the projection matrix of the given light source with orthogonal projection.
331
332 @see evas_canvas3d_light_projection_matrix_set()
333 236
334 @ingroup Evas_Canvas3D_Light 237 See also @.projection_matrix_set]]
335 */
336 params { 238 params {
337 left: Evas_Real; /*@ Left X coordinate of the near clipping plane. */ 239 left: Evas_Real; [[Left X coordinate of the near clipping plane.]]
338 right: Evas_Real; /*@ Right X coordinate of the near clipping plane..*/ 240 right: Evas_Real; [[Right X coordinate of the near clipping plane.]]
339 bottom: Evas_Real; /*@ Bottom Y coordinate of the near clipping plane. */ 241 bottom: Evas_Real; [[Bottom Y coordinate of the near clipping plane.]]
340 top: Evas_Real; /*@ Top Y coordinate of the near clipping plane */ 242 top: Evas_Real; [[Top Y coordinate of the near clipping plane]]
341 dnear: Evas_Real; /*@ Distance to near clipping plane. */ 243 dnear: Evas_Real; [[Distance to near clipping plane.]]
342 dfar: Evas_Real; /*@ Distance to far clipping plane. */ 244 dfar: Evas_Real; [[Distance to far clipping plane.]]
343 } 245 }
344 } 246 }
345 } 247 }