summaryrefslogtreecommitdiff
path: root/src/lib/elm_glview.eo
blob: feb684c649ad5a896c4ff0675afff2d5edc26638 (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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
class Elm.Glview (Elm.Widget)
{
   eo_prefix: elm_obj_glview;
   methods {
      version_constructor {
         [[Constructor with context version number.]]
         legacy: null;
         params {
            @in version: Evas_GL_Context_Version;
         }
      }
      @property size {
         set {
            [[Sets the size of the glview.]]
         }
         get {
            [[Get the size of the glview.

              Note: This function returns the actual image size of the
              glview. This means that when the scale policy is set to
              #ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
              size.
            ]]
         }
         values {
            w: int; [[Width of the glview object.]]
            h: int; [[Height of the glview object.]]
         }
      }
      @property resize_policy {
         set {
            [[Set the resize policy for the glview object.

              By default, the resize policy is set to
              #ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called
              it destroys the previous surface and recreates the newly
              specified size. If the policy is set to
              #ELM_GLVIEW_RESIZE_POLICY_SCALE, however, glview only
              scales the image object and not the underlying GL Surface.
            ]]
            return: bool;
         }
         values {
            policy: Elm_GLView_Resize_Policy; [[The scaling policy.]]
         }
      }
      @property changed {
         set {
            [[Notifies that there has been changes in the GLView.]]
         }
      }
      @property resize_func {
         set {
            [[Set the resize function that gets called when resize happens.

              The resize function gets called during the render loop.
              This function allows glview to hide all the rendering
              context/surface details and have the user just call GL 
              alls that they desire when resize happens.
            ]]
         }
         values {
            func: Elm_GLView_Func_Cb; [[The resize function to be registered.]]
         }
      }
      @property del_func {
         set {
            [[Set the render function that runs in the main loop.

              The registered del function gets called when GLView object
              is deleted. This function allows glview to hide all the
              rendering context/surface  details and have the user just
              call GL calls that they desire  when delete happens.
            ]]
         }
         values {
            func: Elm_GLView_Func_Cb @nullable; [[The delete function to be registered.]]
         }
      }
      @property init_func {
         set {
            [[Set the init function that runs once in the main loop.

              The registered init function gets called once during the
              render loop. This function allows glview to hide all the
              rendering context/surface details and have the user just
              call GL calls that they desire for initialization GL calls.
            ]]
         }
         values {
            func: Elm_GLView_Func_Cb @nullable; [[The init function to be registered.]]
         }
      }
      @property render_policy {
         set {
            [[Set the render policy for the glview object.

              By default, the render policy is set to
              #ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set
              such that during the render loop, glview is only redrawn
              if it needs to be redrawn. (i.e. when it is visible) If the
              policy is set to #ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it
              redraws regardless of whether it is visible or needs
              redrawing.
            ]]
            return: bool;
         }
         values {
            policy: Elm_GLView_Render_Policy; [[The render policy.]]
         }
      }
      @property mode {
         set {
            [[Set the mode of the GLView. Supports alpha, depth, stencil.

              Direct is a hint for the elm_glview to render directly to
              the window given that the right conditions are met. Otherwise
              it falls back to rendering to an offscreen buffer before it
              gets composited to the window.
            ]]
            return: bool;
         }
         values {
            mode: Elm_GLView_Mode; [[The mode Options OR'ed enabling Alpha, Depth, Stencil, Direct.]]
         }
      }
      @property render_func {
         set {
            [[Set the render function that runs in the main loop.

              The render function gets called in the main loop but whether
              it runs depends on the rendering policy and whether
              @.changed.set gets called.
            ]]
         }
         values {
            func: Elm_GLView_Func_Cb @nullable; [[The render function to be registered.]]
         }
      }
      @property gl_api {
         get {
            [[Get the gl api struct for gl rendering.]]
            return: Evas_GL_API *;
         }
      }
      @property evas_gl {
         get {
            [[Get the internal Evas GL attached to this view.

              Note: The returned Evas_GL must not be destroyed as it is
              still owned by the view. But this pointer can be used then
              to call all the evas_gl_ functions.

              @since 1.12
            ]]
            return: Evas_GL *;
         }
      }
      @property rotation {
         get {
            [[Get the current GL view's rotation when using direct rendering

              Note: This rotation can be different from the device
              orientation. This rotation value must be used in case of
              direct rendering and should be taken into account by the
              application when setting the internal rotation matrix for
              the view.

              @since 1.12
            ]]
            return: int; [[A window rotation in degrees (0, 90, 180 or 270).]]
         }
      }
   }
   implements {
      class.constructor;
      Eo.Base.finalize;
      Evas.Object_Smart.add;
      Evas.Object_Smart.del;
      Evas.Object_Smart.resize;
      Elm.Widget.on_focus;
   }
   events {
      language,changed;
      access,changed;
   }
   constructors {
      .version_constructor;
   }
}