src/lib/elm_engine.h

   1 /**
   2  * @defgroup Engine Elementary Engine
   3  *
   4  * These are functions setting and querying which rendering engine
   5  * Elementary will use for drawing its windows' pixels.
   6  *
   7  * The following are the available engines:
   8  * @li "software_x11"
   9  * @li "fb"
  10  * @li "directfb"
  11  * @li "software_16_x11"
  12  * @li "software_8_x11"
  13  * @li "xrender_x11"
  14  * @li "opengl_x11"
  15  * @li "software_gdi"
  16  * @li "software_16_wince_gdi"
  17  * @li "sdl"
  18  * @li "software_16_sdl"
  19  * @li "opengl_sdl"
  20  * @li "buffer"
  21  * @li "ews"
  22  * @li "opengl_cocoa"
  23  * @li "psl1ght"
  24  *
  25  * @{
  26  */
  27
  28 /**
  29  * @brief Get Elementary's rendering engine in use.
  30  *
  31  * @return The rendering engine's name
  32  * @note there's no need to free the returned string, here.
  33  *
  34  * This gets the global rendering engine that is applied to all Elementary
  35  * applications.
  36  *
  37  * @see elm_engine_set()
  38  */
  39 // XXX: rename to elm_engine_get()
  40 EAPI const char *elm_engine_current_get(void);
  41
  42 /**
  43  * @brief Set Elementary's rendering engine for use.
  44  *
  45  * @param engine The rendering engine's name
  46  *
  47  * This sets global rendering engine that is applied to all Elementary
  48  * applications. Note that it will take effect only to Elementary windows
  49  * created after this is called.
  50  *
  51  * @see elm_win_add()
  52  */
  53 EAPI void        elm_engine_set(const char *engine);
  54
  55 /**
  56  * @}
  57  */