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.

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.

Typedef Documentation

typedef enum _Elm_GLView_Mode Elm_GLView_Mode

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

Enumeration Type Documentation

enum _Elm_GLView_Mode

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

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

enum Elm_GLView_Render_Policy

Enumeration that defines a policy for gl rendering.

Remarks:: 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.; Default is ELM_GLVIEW_RENDER_POLICY_ON_DEMAND

Since :: 2.3.1

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

enum Elm_GLView_Resize_Policy

Enumeration that defines a policy for the GLView resizing.

Remarks:: The resizing policy tells GLView what to do with the underlying surface when resize happens. ELM_GLVIEW_RESIZE_POLICY_RECREATE destroys the current surface and recreates the surface to the new size. ELM_GLVIEW_RESIZE_POLICY_SCALE instead keeps the current surface but only displays the result at the desired size scaled.; Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE

Since :: 2.3.1

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

Evas_Object* elm_glview_add ( Evas_Object * parent )

Adds a new GLView to the parent.

Since :: 2.3.1

Remarks:: By default, GLView creates an OpenGL-ES 2.0 context, so only OpenGL-ES 2.0 APIs can be used (and supported extensions). Please use elm_glview_version_add instead to create OpenGL-ES 1.1 contexts.

Parameters:

[in] parent The parent object

Returns:: The new object, otherwise NULL if it cannot be created

See also:: elm_glview_version_add

void elm_glview_changed_set ( Evas_Object * obj )

Notifies that there have been changes in the GLView.

Since :: 2.3.1

Parameters:

[in] obj The GLView object

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.

Since :: 2.3.1

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 the GL calls that they desire when delete happens. Called from the main loop.

Parameters:

[in]	obj	The GLView object
[in]	func	The delete function to be registered

Evas_GL* elm_glview_evas_gl_get ( Evas_Object * obj )

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

Parameters:

[in] obj The GLView object

Returns:: The Evas_GL used by this GLView.

Evas_GL_API* elm_glview_gl_api_get ( const Evas_Object * obj )

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

Parameters:

[in] obj The GLView object

Returns:: The API object, otherwise NULL if it cannot be created

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.

Since :: 2.3.1

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 the GL calls that they desire for initialization GL calls.

Parameters:

[in]	obj	The GLView object
[in]	func	The init function to be registered

Eina_Bool elm_glview_mode_set	(	Evas_Object *	obj,
		Elm_GLView_Mode	mode
	)

Sets the mode of the GLView. Supports alpha, depth and stencil.

Since :: 2.3.1

Remarks:: If direct rendering is enabled, Evas GL will render directly to the back buffer of the window, unless the window has been rotated. If the window is rotated and the flag DIRECT is set, the flag CLIENT_SIDE_ROTATION can be used to avoid falling back to a framebuffer.; Here are some conditions that will disable direct rendering and force a fallback to indirect rendering in a framebuffer:

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

void elm_glview_render_func_set	(	Evas_Object *	obj,
		Elm_GLView_Func_Cb	func
	)

Sets the render function that runs in the main loop.

Since :: 2.3.1

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]	obj	The GLView object
[in]	func	The render function to be registered

Eina_Bool elm_glview_render_policy_set	(	Evas_Object *	obj,
		Elm_GLView_Render_Policy	policy
	)

Sets the render policy for the GLView object.

Since :: 2.3.1

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]	obj	The GLView object
[in]	policy	The render policy

Returns:: EINA_TRUE if succeed, otherwise EINA_FALSE

void elm_glview_resize_func_set	(	Evas_Object *	obj,
		Elm_GLView_Func_Cb	func
	)

Sets the resize function that gets called when resize happens.

Since :: 2.3.1

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 the GL calls that they desire when resize happens.

Parameters:

[in]	obj	The GLView object
[in]	func	The resize function to be registered

Eina_Bool elm_glview_resize_policy_set	(	Evas_Object *	obj,
		Elm_GLView_Resize_Policy	policy
	)

Sets the resize policy for the GLView object.

Since :: 2.3.1

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]	obj	The GLView object
[in]	policy	The scaling policy

Returns:: EINA_TRUE if succeed, otherwise EINA_FALSE

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

Gets the size of the GLView.

Since :: 2.3.1

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 returns the non-scaled size.

Parameters:

[in]	obj	The GLView object
[out]	w	The width of the GLView object
[out]	h	The height of the GLView object

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

Sets the size of the GLView.

Since :: 2.3.1

Parameters:

[in]	obj	The GLView object
[in]	w	The width of the GLView object
[in]	h	The height of the GLView object

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.

Since :: 2.3.1

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

Functions

Typedefs

Typedef Documentation

Enumeration Type Documentation

Function Documentation