summaryrefslogtreecommitdiff
path: root/src/lib/evas/canvas/evas_canvas3d_material.eo
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-06-26 14:35:39 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-06-26 14:35:39 +0100
commitefc91df01abacd6fb605fdea105b089f35f98631 (patch)
tree1072ca6280023f8d9856933145d1fc074f8885a2 /src/lib/evas/canvas/evas_canvas3d_material.eo
parentb067b02b238a94f538675e3c7bd67dfc27420fff (diff)
evas_canvas3d_material: convert docs
Diffstat (limited to 'src/lib/evas/canvas/evas_canvas3d_material.eo')
-rw-r--r--src/lib/evas/canvas/evas_canvas3d_material.eo117
1 files changed, 45 insertions, 72 deletions
diff --git a/src/lib/evas/canvas/evas_canvas3d_material.eo b/src/lib/evas/canvas/evas_canvas3d_material.eo
index c79205c..831d16e 100644
--- a/src/lib/evas/canvas/evas_canvas3d_material.eo
+++ b/src/lib/evas/canvas/evas_canvas3d_material.eo
@@ -4,13 +4,12 @@ class Evas.Canvas3D.Material (Evas.Canvas3D.Object, Evas.Common_Interface)
4 data: Evas_Canvas3D_Material_Data; 4 data: Evas_Canvas3D_Material_Data;
5 methods { 5 methods {
6 color_set { 6 color_set {
7 /*@ 7 [[Set the material attribute color of the given material.
8 Set the material attribute color of the given material.
9 8
10 Material color is used also when texture map is enabled. The colors will be 9 Material color is used also when texture map is enabled. The colors
11 modulated (multiplied). To controll the color contribution of a material 10 will be modulated (multiplied). To controll the color contribution
12 attribute, use gray color. Setting color value for normal attribute has no 11 of a material attribute, use gray color. Setting color value for
13 effect. 12 normal attribute has no effect.
14 13
15 Default color is as follows. 14 Default color is as follows.
16 15
@@ -19,127 +18,101 @@ class Evas.Canvas3D.Material (Evas.Canvas3D.Object, Evas.Common_Interface)
19 Specular : (1.0, 1.0, 1.0, 1.0) 18 Specular : (1.0, 1.0, 1.0, 1.0)
20 Emission : (0.0, 0.0, 0.0, 1.0) 19 Emission : (0.0, 0.0, 0.0, 1.0)
21 Normal : Not used 20 Normal : Not used
22 21 ]]
23 @ingroup Evas_Canvas3D_Material
24 */
25 22
26 params { 23 params {
27 @in attrib: Evas.Canvas3D.Material_Attrib; /*@ Material attribute ID. */ 24 @in attrib: Evas.Canvas3D.Material_Attrib; [[Material attribute ID.]]
28 @in r: Evas_Real; /*@ Red component of the color. */ 25 @in r: Evas_Real; [[Red component of the color.]]
29 @in g: Evas_Real; /*@ Green component of the color. */ 26 @in g: Evas_Real; [[Green component of the color.]]
30 @in b: Evas_Real; /*@ Blue component of the color. */ 27 @in b: Evas_Real; [[Blue component of the color.]]
31 @in a: Evas_Real; /*@ Alpha component of the color. */ 28 @in a: Evas_Real; [[Alpha component of the color.]]
32 } 29 }
33 } 30 }
34 31
35 color_get @const { 32 color_get @const {
36 /*@ 33 [[Get the material attribute color of the given material.
37 Get the material attribute color of the given material.
38
39 @see evas_canvas3d_material_color_set()
40 34
41 @ingroup Evas_Canvas3D_Material 35 See also @evas_canvas3d_material_color_set.
42 */ 36 ]]
43 params { 37 params {
44 @in attrib: Evas.Canvas3D.Material_Attrib; /*@ Material attribute ID. */ 38 @in attrib: Evas.Canvas3D.Material_Attrib; [[Material attribute ID.]]
45 @out r: Evas_Real; /*@ Pointer to receive red component of the color. */ 39 @out r: Evas_Real; [[Pointer to receive red component of the color.]]
46 @out g: Evas_Real; /*@ Pointer to receive green component of the color. */ 40 @out g: Evas_Real; [[Pointer to receive green component of the color.]]
47 @out b: Evas_Real; /*@ Pointer to receive blue component of the color. */ 41 @out b: Evas_Real; [[Pointer to receive blue component of the color.]]
48 @out a: Evas_Real; /*@ Pointer to receive alpha component of the color. */ 42 @out a: Evas_Real; [[Pointer to receive alpha component of the color.]]
49 } 43 }
50 } 44 }
51 45
52 @property enable { 46 @property enable {
53 set { 47 set {
54 /*@ 48 [[Set the material attribute enable flag of the given material.
55 Set the material attribute enable flag of the given material.
56 49
57 You might want to disable some material reflection contribution. For 50 You might want to disable some material reflection contribution.
58 example,Emission attribute is rarely used. Disabling unused attributes 51 For example, Emission attribute is rarely used. Disabling unused
59 might help the shading less complex so that can get speed up. 52 attributes might help the shading less complex so that can get
53 speed up.
60 54
61 By default, diffuse and specular is enabled. 55 By default, diffuse and specular is enabled.
62 56 ]]
63 @ingroup Evas_Canvas3D_Material
64 */
65 } 57 }
66 get { 58 get {
67 /*@ 59 [[Get the material attribute enable flag of the given material.
68 Get the material attribute enable flag of the given material.
69 60
70 @see evas_canvas3d_material_enable_set() 61 See also @evas_canvas3d_material_enable_set.
71 62 ]]
72 @return @c EINA_TRUE if enabled, or @c EINA_FALSE if not.
73 @ingroup Evas_Canvas3D_Material
74 */
75 } 63 }
76 keys { 64 keys {
77 attrib: Evas.Canvas3D.Material_Attrib; /*@ Material attribute ID. */ 65 attrib: Evas.Canvas3D.Material_Attrib; [[Material attribute ID.]]
78 } 66 }
79 values { 67 values {
80 enable: bool; /*@ Whether to enable the attribute (@c EINA_TRUE), or not (@c EINA_FALSE). */ 68 enable: bool; [[Whether to enable the attribute or not.]]
81 } 69 }
82 } 70 }
83 71
84 @property shininess { 72 @property shininess {
85 set { 73 set {
86 /*@ 74 [[Set the shininess of the given material.
87 Set the shininess of the given material.
88 75
89 Shininess is only used when specular attribute is enabled. Higher shininess 76 Shininess is only used when specular attribute is enabled. Higher shininess
90 value will make the object more shiny. 77 value will make the object more shiny.
91 78
92 Default shininess value is 150.0. 79 Default shininess value is 150.0.
93 80
94 @see evas_canvas3d_material_enable_set() 81 See also @evas_canvas3d_material_enable_set.
95 82 ]]
96 @ingroup Evas_Canvas3D_Material
97 */
98 } 83 }
99 get { 84 get {
100 /*@ 85 [[Get the shininess of the given material.
101 Get the shininess of the given material.
102 86
103 @see evas_canvas3d_material_shininess_set() 87 See also @evas_canvas3d_material_shininess_set.
104 88 ]]
105 @return The shininess value.
106 @ingroup Evas_Canvas3D_Material
107 */
108 } 89 }
109 values { 90 values {
110 shininess: Evas_Real; /*@ Shininess value. */ 91 shininess: Evas_Real; [[Shininess value.]]
111 } 92 }
112 } 93 }
113 94
114 @property texture { 95 @property texture {
115 set { 96 set {
116 /*@ 97 [[Set the texture of the given material.
117 Set the texture of the given material.
118 98
119 You have to enable the desired attribute first. 99 You have to enable the desired attribute first.
120 100
121 @see evas_canvas3d_material_enable_set() 101 See also @evas_canvas3d_material_enable_set.
122 102 ]]
123 @ingroup Evas_Canvas3D_Material
124 */
125 } 103 }
126 get { 104 get {
127 /*@ 105 [[Get the texture of the given material.
128 Get the texture of the given material.
129
130 @see evas_canvas3d_material_texture_set()
131
132 @return The texture that is set to the given material attribute.
133 106
134 @ingroup Evas_Canvas3D_Material 107 See also @evas_canvas3d_material_texture_set.
135 */ 108 ]]
136 } 109 }
137 110
138 keys { 111 keys {
139 attrib: Evas.Canvas3D.Material_Attrib; /*@ Material attribute ID. */ 112 attrib: Evas.Canvas3D.Material_Attrib; [[Material attribute ID.]]
140 } 113 }
141 values { 114 values {
142 texture: Evas.Canvas3D.Texture *; 115 texture: Evas.Canvas3D.Texture *; [[The texture set to the attribute.]]
143 } 116 }
144 } 117 }
145 } 118 }