Functions |
Evas_Object * | elm_glview_add (Evas_Object *parent) |
| Adds a new GLView to the parent.
|
Evas_Object * | elm_glview_version_add (Evas_Object *parent, Evas_GL_Context_Version version) |
| Adds a new GLView to the parent, given an OpenGL-ES context version number.
|
void | elm_glview_size_set (Evas_Object *obj, Evas_Coord w, Evas_Coord h) |
| Sets the size of the GLView.
|
void | elm_glview_size_get (const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) |
| Gets the size of the GLView.
|
Evas_GL_API * | elm_glview_gl_api_get (const Evas_Object *obj) |
| Gets the GL API struct for GL rendering.
|
Eina_Bool | elm_glview_mode_set (Evas_Object *obj, Elm_GLView_Mode mode) |
| Sets the mode of the GLView. Supports alpha, depth and stencil.
|
Eina_Bool | elm_glview_resize_policy_set (Evas_Object *obj, Elm_GLView_Resize_Policy policy) |
| Sets the resize policy for the GLView object.
|
Eina_Bool | elm_glview_render_policy_set (Evas_Object *obj, Elm_GLView_Render_Policy policy) |
| Sets the render policy for the GLView object.
|
void | elm_glview_init_func_set (Evas_Object *obj, Elm_GLView_Func_Cb func) |
| Sets the init function that runs once in the main loop.
|
void | elm_glview_del_func_set (Evas_Object *obj, Elm_GLView_Func_Cb func) |
| Sets the delete function that runs when the GLView gets deleted.
|
void | elm_glview_resize_func_set (Evas_Object *obj, Elm_GLView_Func_Cb func) |
| Sets the resize function that gets called when resize happens.
|
void | elm_glview_render_func_set (Evas_Object *obj, Elm_GLView_Func_Cb func) |
| Sets the render function that runs in the main loop.
|
void | elm_glview_changed_set (Evas_Object *obj) |
| Notifies that there have been changes in the GLView.
|
Evas_GL * | elm_glview_evas_gl_get (Evas_Object *obj) |
| Get the internal Evas GL attached to this view.
|
Typedefs |
typedef enum _Elm_GLView_Mode | Elm_GLView_Mode |
| Selects the target surface properties.
|
A GLView widget allows for simple GL rendering in the elementary environment.
GLView hides all the complicated evas_gl details so that the user only has to deal with registering a few callback functions for rendering to a surface using OpenGL APIs.
This widget emits the following signals, besides the ones sent from GLView :
"language,changed"
- The program's language is changed
Please refer to the page OpenGL with Elementary for a quick introduction about OpenGL with EFL.
Typedef Documentation
Selects the target surface properties.
An OR combination of Elm_GLView_Mode
values should be passed to elm_glview_mode_set when setting up a GL widget. These flags will specify the properties of the rendering target surface; in particular, the mode can request the surface to support alpha, depth and stencil buffers.
- Note:
ELM_GLVIEW_CLIENT_SIDE_ROTATION
is a special value that indicates to EFL that the application will handle the view rotation when the device is rotated. This is needed only when the application requests direct rendering. Please refer to Rendering GL on Evas for more information about direct rendering.
- See also:
- elm_glview_mode_set
-
OpenGL with Elementary
- Since :
- 2.3
Enumeration Type Documentation
Selects the target surface properties.
An OR combination of Elm_GLView_Mode
values should be passed to elm_glview_mode_set when setting up a GL widget. These flags will specify the properties of the rendering target surface; in particular, the mode can request the surface to support alpha, depth and stencil buffers.
- Note:
ELM_GLVIEW_CLIENT_SIDE_ROTATION
is a special value that indicates to EFL that the application will handle the view rotation when the device is rotated. This is needed only when the application requests direct rendering. Please refer to Rendering GL on Evas for more information about direct rendering.
- See also:
- elm_glview_mode_set
-
OpenGL with Elementary
- Since :
- 2.3
- Enumerator:
ELM_GLVIEW_ALPHA |
Alpha channel enabled rendering mode
|
ELM_GLVIEW_DEPTH |
Depth buffer enabled rendering mode (24 bits by default)
|
ELM_GLVIEW_STENCIL |
Stencil buffer enabled rendering mode (8 bits by default)
|
ELM_GLVIEW_DIRECT |
Request direct rendering, unless there must be a fallback
|
ELM_GLVIEW_CLIENT_SIDE_ROTATION |
Client will handle GL view rotation if direct rendering is enabled
|
ELM_GLVIEW_DEPTH_8 |
Request min. 8 bits for the depth buffer
|
ELM_GLVIEW_DEPTH_16 |
Request min. 16 bits for the depth buffer
|
ELM_GLVIEW_DEPTH_24 |
Request min. 24 bits for the depth buffer (default)
|
ELM_GLVIEW_DEPTH_32 |
Request min. 32 bits for the depth buffer
|
ELM_GLVIEW_STENCIL_1 |
Request min. 1 bits for the stencil buffer
|
ELM_GLVIEW_STENCIL_2 |
Request min. 2 bits for the stencil buffer
|
ELM_GLVIEW_STENCIL_4 |
Request min. 4 bits for the stencil buffer
|
ELM_GLVIEW_STENCIL_8 |
Request min. 8 bits for the stencil buffer (default)
|
ELM_GLVIEW_STENCIL_16 |
Request min. 16 bits for the stencil buffer
|
ELM_GLVIEW_MULTISAMPLE_LOW |
MSAA with minimum number of samples
|
ELM_GLVIEW_MULTISAMPLE_MED |
MSAA with half the number of maximum samples
|
ELM_GLVIEW_MULTISAMPLE_HIGH |
MSAA with maximum number of samples
|
Enumeration that defines a policy for gl rendering.
- Since :
- 2.3
- Enumerator:
ELM_GLVIEW_RENDER_POLICY_ON_DEMAND |
Render only when there is a need for redrawing
|
ELM_GLVIEW_RENDER_POLICY_ALWAYS |
Render always even when it is not visible
|
Enumeration that defines a policy for the GLView resizing.
- Since :
- 2.3
- Enumerator:
ELM_GLVIEW_RESIZE_POLICY_RECREATE |
Resize the internal surface along with the image
|
ELM_GLVIEW_RESIZE_POLICY_SCALE |
Only resize the internal image and not the surface
|
Function Documentation
Adds a new GLView to the parent.
- Since :
- 2.3
- Parameters:
-
[in] | parent | The parent object |
- Returns:
- The new object, otherwise
NULL
if it cannot be created
- See also:
- elm_glview_version_add
Notifies that there have been changes in the GLView.
- Since :
- 2.3
- Parameters:
-
Sets the delete function that runs when the GLView gets deleted.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The GLView object |
[in] | func | The delete function to be registered |
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 :
- 2.3
- Parameters:
-
- Returns:
- The Evas_GL used by this GLView.
Gets the GL API struct for GL rendering.
Elementary GLView uses Evas GL internally to create a rendering context and target surfaces. Please refer to the Evas GL documentation for more information about this GL API structure.
- Note:
- When using an OpenGL-ES 1.1 context,
elm_glview_gl_api_get
will return a GL-ES 1.1 API.
- Since :
- 2.3
- Parameters:
-
- Returns:
- The API object, otherwise
NULL
if it cannot be created
Sets the init function that runs once in the main loop.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The GLView object |
[in] | func | The init function to be registered |
Sets the mode of the GLView. Supports alpha, depth and stencil.
- Since :
- 2.3
- if the object's color is not (255,255,255,255),
- if the object has an evas map,
- if the object size is different from the viewport, (RESIZE_POLICY_SCALE)
- if the window is rotated and CLIENT_SIDE_ROTATION is not set,
- if the GLView policy is set to ALWAYS render.
- Parameters:
-
[in] | obj | The GLView object |
[in] | mode | The mode Options OR'ed enabling Alpha, Depth, Stencil, Direct and Client Side Rotation |
- Returns:
true
if set properly, otherwise false
Sets the render function that runs in the main loop.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The GLView object |
[in] | func | The render function to be registered |
Sets the render policy for the GLView object.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The GLView object |
[in] | policy | The render policy |
- Returns:
- EINA_TRUE if succeed, otherwise EINA_FALSE
Sets the resize function that gets called when resize happens.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The GLView object |
[in] | func | The resize function to be registered |
Sets the resize policy for the GLView object.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The GLView object |
[in] | policy | The scaling policy |
- Returns:
- EINA_TRUE if succeed, otherwise EINA_FALSE
Gets the size of the GLView.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The GLView object |
[out] | w | The width of the GLView object |
[out] | h | The height of the GLView object |
Sets the size of the GLView.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The GLView object |
[in] | w | The width of the GLView object |
[in] | h | The height of the GLView object |
Adds a new GLView to the parent, given an OpenGL-ES context version number.
- Since :
- 2.3
- Parameters:
-
[in] | parent | The parent object |
[in] | version | Requested GL ES version number (default is 2.x, 1.x may also be supported) |
- Returns:
- The new object, otherwise
NULL
if it cannot be created
- See also:
- elm_glview_add