Tizen Native API
Functions
Elementary Engine
Elementary Infrastructure

Functions

const char * elm_config_engine_get (void)
 Get Elementary's rendering engine in use.
void elm_config_engine_set (const char *engine)
 Set Elementary's rendering engine for use.
const char * elm_config_preferred_engine_get (void)
 Get Elementary's preferred engine to use.
void elm_config_preferred_engine_set (const char *engine)
 Set Elementary's preferred rendering engine for use.
const char * elm_config_accel_preference_get (void)
 Get Elementary's preferred engine to use.
void elm_config_accel_preference_set (const char *pref)
 Set Elementary's acceleration preferences for new windows.
Eina_Bool elm_config_accel_preference_override_get (void)
 Get the acceleration override preference flag.
void elm_config_accel_preference_override_set (Eina_Bool enabled)
 Set the acceleration override preference flag.

These are functions setting and querying which rendering engine Elementary will use for drawing its windows' pixels.

The following are the available engines:

  • "fb" (Framebuffer)
  • "buffer" (Pixel Memory Buffer)
  • "ews" (Ecore + Evas Single Process Windowing System)
  • NULL - no engine config
Deprecated:
Please use elm_config_accel_preference_override_set() instead

Function Documentation

const char* elm_config_accel_preference_get ( void  )

Get Elementary's preferred engine to use.

Since :
2.3
Returns:
The acceleration preference hint string
Remarks:
there's no need to free the returned string, here.
See elm_config_accel_preference_set() for more information, but this simply returns what was set by this call, nothing more.
See also:
elm_config_accel_preference_set()
Since (EFL) :
1.10
Eina_Bool elm_config_accel_preference_override_get ( void  )

Get the acceleration override preference flag.

Since :
2.3
Remarks:
This gets the acceleration override preference. This is a flag that has the global system acceleration preference configuration forcibly override whatever acceleration preference the application may want.
Returns:
If acceleration override is enabled
Since (EFL) :
1.11
void elm_config_accel_preference_override_set ( Eina_Bool  enabled)

Set the acceleration override preference flag.

Since :
2.3
Remarks:
This sets the acceleration override preference. This is a flag that has the global system acceleration preference configuration forcibly override whatever acceleration preference the application may want.
Parameters:
[in]enabledThis should be EINA_TRUE if enabled, or EINA_FALSE if not.
See also:
elm_config_accel_preference_set()
Since (EFL) :
1.11
void elm_config_accel_preference_set ( const char *  pref)

Set Elementary's acceleration preferences for new windows.

Since :
2.3
Parameters:
[in]prefThe preference desired as a normal C string
Remarks:
Note that it will take effect only to Elementary windows created after this is called. The pref string is a freeform C string that indicates what kind of acceleration is preferred. Here "acceleration" majorly means to rendering and which hardware unit application renders guis with. This may or may not be honored, but a best attempt will be made. Known strings are as follows:
  • "gl", "opengl" - try use opengl.
  • "3d" - try and use a 3d acceleration unit.
  • "hw", "hardware", "accel" - try any acceleration unit (best possible)
  • "none" - use no acceleration. try use software

Accel preference's string has the egl surface configuration as a hw accel, depth, stencil and msaa. The string format is "{HW Accel}:depth{value}:stencil{value}:msaa{msaa string}". Especially, msaa string is related Evas GL MSAA enum value(low, mid, high). so msaa string has four types as msaa, msaa_low, msaa_mid, msaa_high. For instance, "opengl:depth24:stencil8:msaa_high". It means that using hw accelation, window surface depth buffer's size is 24, stencil buffer's size 8 and msaa bits is the highest. The other use-case is "opengl:depth24". It measn that using hw accelation, depth buffer size is 24. stencil and msaa are not used. Default case is "opengl:depth:stencil:msaa". It means that depth, stencil and msaa are setted by default value(depth:24, stencil:8, msaa:low).

Remarks:
This takes precedence over engine preferences set with elm_config_preferred_engine_set().
See also:
elm_win_add()
elm_config_accel_preference_override_set()
elm_glview_mode_set()
Since (EFL) :
1.10
const char* elm_config_engine_get ( void  )

Get Elementary's rendering engine in use.

Since :
2.3
Returns:
The rendering engine's name
Remarks:
there's no need to free the returned string, here.
This gets the global rendering engine that is applied to all Elementary applications.
See also:
elm_config_engine_set()
Deprecated:
use elm_config_accel_preference_get() + elm_config_accel_preference_set() Deprecated since Tizen 2.4
void elm_config_engine_set ( const char *  engine)

Set Elementary's rendering engine for use.

Since :
2.3
Parameters:
[in]engineThe rendering engine's name
Remarks:
Note that it will take effect only to Elementary windows created after this is called.
See also:
elm_win_add()
Deprecated:
use elm_config_accel_preference_get() + elm_config_accel_preference_set() Deprecated since Tizen 2.4
const char* elm_config_preferred_engine_get ( void  )

Get Elementary's preferred engine to use.

Since :
2.3
Returns:
The rendering engine's name
Remarks:
there's no need to free the returned string, here.
This gets the global rendering engine that is applied to all Elementary applications and is PREFERRED by the application. This can (and will) override the engine configured for all applications which.
See also:
elm_config_preferred_engine_set()
void elm_config_preferred_engine_set ( const char *  engine)

Set Elementary's preferred rendering engine for use.

Since :
2.3
Parameters:
[in]engineThe rendering engine's name
Remarks:
Note that it will take effect only to Elementary windows created after this is called. This overrides the engine set by configuration at application startup. Note that it is a hint and may not be honored.
See also:
elm_win_add()
elm_config_accel_preference_set()
elm_config_engine_set()