Tizen Native API

Functions

void elm_glview_size_set (Elm_Glview *obj, int w, int h)
 Sets the size of the glview.
void elm_glview_size_get (const Elm_Glview *obj, int *w, int *h)
 Get the size of the glview.
Eina_Bool elm_glview_resize_policy_set (Elm_Glview *obj, Elm_GLView_Resize_Policy policy)
 Set the resize policy for the glview object.
void elm_glview_changed_set (Elm_Glview *obj)
 Notifies that there has been changes in the GLView.
void elm_glview_resize_func_set (Elm_Glview *obj, Elm_GLView_Func_Cb func)
 Set the resize function that gets called when resize happens.
void elm_glview_del_func_set (Elm_Glview *obj, Elm_GLView_Func_Cb func)
 Set the render function that runs in the main loop.
void elm_glview_init_func_set (Elm_Glview *obj, Elm_GLView_Func_Cb func)
 Set the init function that runs once in the main loop.
Eina_Bool elm_glview_render_policy_set (Elm_Glview *obj, Elm_GLView_Render_Policy policy)
 Set the render policy for the glview object.
Eina_Bool elm_glview_mode_set (Elm_Glview *obj, Elm_GLView_Mode mode)
 Set the mode of the GLView. Supports alpha, depth, stencil.
void elm_glview_render_func_set (Elm_Glview *obj, Elm_GLView_Func_Cb func)
 Set the render function that runs in the main loop.
Evas_GL_APIelm_glview_gl_api_get (const Elm_Glview *obj)
 Get the gl api struct for gl rendering.
Evas_GLelm_glview_evas_gl_get (const Elm_Glview *obj)
 Get the internal Evas GL attached to this view.
int elm_glview_rotation_get (const Elm_Glview *obj)
 Get the current GL view's rotation when using direct rendering.
Evas_Objectelm_glview_add (Evas_Object *parent)
 Add a new glview to the parent.
Evas_Objectelm_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.

glview_inheritance_tree.png

A GLView widget allows for simple GL rendering in 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:

  • "focused" - when glview has received focus.
  • "unfocused" - when glview has lost focus.
  • "language,changed" - the program's language changed

Related Features

This API is related with the following feature:

It is recommended to design feature related codes in your application for reliability.

You can check if a device supports the related features for this API by using System Information, thereby controlling the procedure of your application.

To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.

More details on featuring your application can be found from Feature List.


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
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

Defines a policy for gl rendering.

The rendering policy tells glview where to run the gl rendering code. ELM_GLVIEW_RENDER_POLICY_ON_DEMAND tells glview to call the rendering calls on demand, which means that the rendering code gets called only when it is visible.

Note:
Default is ELM_GLVIEW_RENDER_POLICY_ON_DEMAND
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

Defines a policy for the glview resizing.

The resizing policy tells glview what to do with the underlying surface when resize happens. ELM_GLVIEW_RESIZE_POLICY_RECREATE will destroy the current surface and recreate the surface to the new size. ELM_GLVIEW_RESIZE_POLICY_SCALE will instead keep the current surface but only display the result at the desired size scaled.

Note:
Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
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

Add a new glview to the parent.

Since :
2.3
Parameters:
[in]parentThe parent object
Returns:
The new object or NULL if it cannot be created
void elm_glview_changed_set ( Elm_Glview *  obj)

Notifies that there has been changes in the GLView.

Since :
2.3
Parameters:
[in]objThe elm glview object
void elm_glview_del_func_set ( Elm_Glview *  obj,
Elm_GLView_Func_Cb  func 
)

Set the render function that runs in the main loop.

Since :
2.3
Remarks:
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.
Parameters:
[in]objThe elm glview object
[in]funcThe delete function to be registered.
Evas_GL* elm_glview_evas_gl_get ( const Elm_Glview *  obj)

Get the internal Evas GL attached to this view.

Since :
2.3
Remarks:
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 (EFL) :
1.12
Returns:
The Evas_GL used by this GLView.
Parameters:
[in]objThe elm glview object
Evas_GL_API* elm_glview_gl_api_get ( const Elm_Glview *  obj)

Get the gl api struct for gl rendering.

Since :
2.3
Returns:
The api object or NULL if it cannot be created
Parameters:
[in]objThe elm glview object
void elm_glview_init_func_set ( Elm_Glview *  obj,
Elm_GLView_Func_Cb  func 
)

Set the init function that runs once in the main loop.

Since :
2.3
Remarks:
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.
Parameters:
[in]objThe elm glview object
[in]funcThe init function to be registered.
Eina_Bool elm_glview_mode_set ( Elm_Glview *  obj,
Elm_GLView_Mode  mode 
)

Set the mode of the GLView. Supports alpha, depth, stencil.

Since :
2.3
Returns:
True if set properly.
Remarks:
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.
Parameters:
[in]objThe elm glview object
[in]modeThe mode Options OR'ed enabling Alpha, Depth, Stencil, Direct.
void elm_glview_render_func_set ( Elm_Glview *  obj,
Elm_GLView_Func_Cb  func 
)

Set the render function that runs in the main loop.

Since :
2.3
Remarks:
The render function gets called in the main loop but whether it runs depends on the rendering policy and whether elm_glview_changed_set() gets called.
Parameters:
[in]objThe elm glview object
[in]funcThe render function to be registered.

Set the render policy for the glview object.

Since :
2.3
Remarks:
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.
Parameters:
[in]objThe elm glview object
[in]policyThe render policy.
void elm_glview_resize_func_set ( Elm_Glview *  obj,
Elm_GLView_Func_Cb  func 
)

Set the resize function that gets called when resize happens.

Since :
2.3
Remarks:
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 calls that they desire when resize happens.
Parameters:
[in]objThe elm glview object
[in]funcThe resize function to be registered.

Set the resize policy for the glview object.

Since :
2.3
Remarks:
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.
Parameters:
[in]objThe elm glview object
[in]policyThe scaling policy.
int elm_glview_rotation_get ( const Elm_Glview *  obj)

Get the current GL view's rotation when using direct rendering.

Since :
2.4
Returns:
A window rotation in degrees (0, 90, 180 or 270)
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.
See also:
ELM_GLVIEW_CLIENT_SIDE_ROTATION
Since (EFL) :
1.12
Parameters:
[in]objThe elm glview object
void elm_glview_size_get ( const Elm_Glview *  obj,
int *  w,
int *  h 
)

Get the size of the glview.

Since :
2.3
Remarks:
Note that 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.
Parameters:
[in]objThe elm glview object
[out]wwidth of the glview object
[out]hheight of the glview object
void elm_glview_size_set ( Elm_Glview *  obj,
int  w,
int  h 
)

Sets the size of the glview.

Since :
2.3
Parameters:
[in]objThe elm glview object
[in]wwidth of the glview object
[in]hheight of the glview object

Adds a new GLView to the parent, given an OpenGL-ES context version number.

Since :
2.3
Parameters:
[in]parentThe parent object
[in]versionRequested GL ES version number (default is 2.x, 1.x may also be supported)
Returns:
The new object or NULL if it cannot be created
Since (EFL) :
1.12