summaryrefslogtreecommitdiff
path: root/src/lib/evas/canvas/evas_3d_material.eo
blob: 5e6c9a054efb45f2b5cf8eaccdfa6afd3640dd9c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
class Evas_3D_Material (Evas_3D_Object, Evas.Common_Interface)
{
   legacy_prefix: null;
   data: Evas_3D_Material_Data;
   methods {
      color_set {
         /*
           Set the material attribute color of the given material.

           Material color is used also when texture map is enabled. The colors will be
           modulated (multiplied). To controll the color contribution of a material
           attribute, use gray color. Setting color value for normal attribute has no
           effect.

           Default color is as follows.

           Ambient  : (0.2, 0.2, 0.2, 1.0)
           Diffuse  : (0.8, 0.8, 0.8, 1.0)
           Specular : (1.0, 1.0, 1.0, 1.0)
           Emission : (0.0, 0.0, 0.0, 1.0)
           Normal   : Not used

           @ingroup Evas_3D_Material
          */

         params {
            @in Evas_3D_Material_Attrib attrib; /*@ Material attribute ID. */
            @in Evas_Real r; /*@ Red component of the color. */
            @in Evas_Real g; /*@ Green component of the color. */
            @in Evas_Real b; /*@ Blue component of the color. */
            @in Evas_Real a; /*@ Alpha component of the color. */
         }
      }

      color_get @const {
         /*
           Get the material attribute color of the given material.

           @see evas_3d_material_color_set()

           @ingroup Evas_3D_Material
          */
         params {
            @in Evas_3D_Material_Attrib attrib; /*@ Material attribute ID. */
            @out Evas_Real r; /*@ Pointer to receive red component of the color. */
            @out Evas_Real g; /*@ Pointer to receive green component of the color. */
            @out Evas_Real b; /*@ Pointer to receive blue component of the color. */
            @out Evas_Real a; /*@ Pointer to receive alpha component of the color. */
         }
      }
   }

   properties {
      enable {
         set {
            /*
              Set the material attribute enable flag of the given material.

              You might want to disable some material reflection contribution. For
              example,Emission attribute is rarely used. Disabling unused attributes
              might help the shading less complex so that can get speed up.

              By default, diffuse and specular is enabled.

              @ingroup Evas_3D_Material
             */
         }
         get {
            /*
              Get the material attribute enable flag of the given material.

              @see evas_3d_material_enable_set()

              @return              @c EINA_TRUE if enabled, or @c EINA_FALSE if not.
              @ingroup Evas_3D_Material
            */
         }
         keys {
            Evas_3D_Material_Attrib attrib;  /*@ Material attribute ID. */
         }
         values {
            bool enable; /*@ Whether to enable the attribute (@c EINA_TRUE), or not (@c EINA_FALSE). */
         }
      }

      shininess {
         set {
            /*
              Set the shininess of the given material.

              Shininess is only used when specular attribute is enabled. Higher shininess
              value will make the object more shiny.

              Default shininess value is 150.0.

              @see evas_3d_material_enable_set()

              @ingroup Evas_3D_Material
             */
         }
         get {
            /*
              Get the shininess of the given material.

              @see evas_3d_material_shininess_set()

              @return              The shininess value.
              @ingroup Evas_3D_Material
             */
         }
         values {
            Evas_Real shininess; /*@ Shininess value. */
         }
      }

      texture {
         set {
            /*@
              Set the texture of the given material.

              You have to enable the desired attribute first.

              @see evas_3d_material_enable_set()

              @ingroup Evas_3D_Material
             */
         }
         get {
            /*
              Get the texture of the given material.

              @see evas_3d_material_texture_set()

              @return              The texture that is set to the given material attribute.

              @ingroup Evas_3D_Material
             */
         }

         keys {
            Evas_3D_Material_Attrib attrib; /*@ Material attribute ID. */
         }
         values {
            Evas_3D_Texture *texture;
         }
      }
   }
   implements {
      Eo.Base.constructor;
      Eo.Base.destructor;
      Evas_3D_Object.update_notify;
      Evas_3D_Object.change_notify;
   }

}