GLView

Functions

Evas_Object * elm_glview_add (Evas_Object *parent)
 Add a new glview to the parent.
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)
 Set the mode of the GLView.
Eina_Bool elm_glview_resize_policy_set (Evas_Object *obj, Elm_GLView_Resize_Policy policy)
 Set the resize policy for the glview object.
Eina_Bool elm_glview_render_policy_set (Evas_Object *obj, Elm_GLView_Render_Policy policy)
 Set the render policy for the glview object.
void elm_glview_init_func_set (Evas_Object *obj, Elm_GLView_Func_Cb func)
 Set the init function that runs once in the main loop.
void elm_glview_del_func_set (Evas_Object *obj, Elm_GLView_Func_Cb func)
 Set the render function that runs in the main loop.
void elm_glview_resize_func_set (Evas_Object *obj, Elm_GLView_Func_Cb func)
 Set the resize function that gets called when resize happens.
void elm_glview_render_func_set (Evas_Object *obj, Elm_GLView_Func_Cb func)
 Set the render function that runs in the main loop.
void elm_glview_changed_set (Evas_Object *obj)
 Notifies that there has been changes in the GLView.

Detailed Description

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.

Below is an illustrative example of how to use GLView and and OpenGL to render in elementary environment.


Function Documentation

Evas_Object* elm_glview_add ( Evas_Object *  parent)

Add a new glview to the parent.

Parameters:
parentThe parent object
Returns:
The new object or NULL if it cannot be created
void elm_glview_changed_set ( Evas_Object *  obj)

Notifies that there has been changes in the GLView.

Parameters:
objThe glview object.

References ELM_WIDGET_DATA.

Referenced by elm_glview_mode_set(), and elm_glview_resize_policy_set().

void elm_glview_del_func_set ( Evas_Object *  obj,
Elm_GLView_Func_Cb  func 
)

Set the render function that runs in the main loop.

Parameters:
objThe glview object.
funcThe delete function to be registered.

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.

Evas_GL_API* elm_glview_gl_api_get ( const Evas_Object *  obj)

Gets the gl api struct for gl rendering.

Parameters:
objThe glview object
Returns:
The api object or NULL if it cannot be created
void elm_glview_init_func_set ( Evas_Object *  obj,
Elm_GLView_Func_Cb  func 
)

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

Parameters:
objThe glview object.
funcThe init function to be registered.

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.

Eina_Bool elm_glview_mode_set ( Evas_Object *  obj,
Elm_GLView_Mode  mode 
)

Set the mode of the GLView.

Supports alpha, depth, stencil.

Parameters:
objThe glview object
modeThe mode Options OR'ed enabling Alpha, Depth, Stencil, Direct.
Returns:
True if set properly.

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.

References elm_glview_changed_set(), and ELM_WIDGET_DATA.

void elm_glview_render_func_set ( Evas_Object *  obj,
Elm_GLView_Func_Cb  func 
)

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 elm_glview_changed_set() gets called.

Parameters:
objThe glview object.
funcThe render function to be registered.
Eina_Bool elm_glview_render_policy_set ( Evas_Object *  obj,
Elm_GLView_Render_Policy  policy 
)

Set the render policy for the glview object.

Parameters:
objThe glview object.
policyThe render policy.

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.

void elm_glview_resize_func_set ( Evas_Object *  obj,
Elm_GLView_Func_Cb  func 
)

Set the resize function that gets called when resize happens.

Parameters:
objThe glview object.
funcThe resize function to be registered.

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.

Eina_Bool elm_glview_resize_policy_set ( Evas_Object *  obj,
Elm_GLView_Resize_Policy  policy 
)

Set the resize policy for the glview object.

Parameters:
objThe glview object.
policyThe scaling policy.

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.

References elm_glview_changed_set().

void elm_glview_size_get ( const Evas_Object *  obj,
Evas_Coord *  w,
Evas_Coord *  h 
)

Gets the size of the glview.

Parameters:
objThe glview object
wwidth of the glview object
hheight of the glview object

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.

void elm_glview_size_set ( Evas_Object *  obj,
Evas_Coord  w,
Evas_Coord  h 
)

Sets the size of the glview.

Parameters:
objThe glview object
wwidth of the glview object
hheight of the glview object