This option causes updates of the Ecore_Evas to be done on a pixmap, and then copied to the window, or the pixmap used directly on the window, depending on the setting.

Enumerator:

ECORE_EVAS_AVOID_DAMAGE_NONE	every expose event triggers a new damage and consequently render of the affected area. The rendering of things happens directly on the window
ECORE_EVAS_AVOID_DAMAGE_EXPOSE	there's a pixmap where everything is rendered into, and then copied to the window. On expose events, there's no need to render things again, just to copy the exposed region to the window
ECORE_EVAS_AVOID_DAMAGE_BUILT_IN	there's the same pixmap as the previous one, but it is set as a "background pixmap" of the window. The rendered things appear directly on the window, with no need to copy anything, but would stay stored on the pixmap, so there's no need to render things again on expose events. This option can be faster than the previous one, but may lead to artifacts during resize of the window

Activates (set focus to, via the window manager) an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas to activate.

This functions activates the Ecore_Evas.

Since :

3.0

Queries whether an Ecore_Evas has an alpha channel.

Parameters:

ee	The Ecore_Evas to query.

Returns:

EINA_TRUE if ee has an alpha channel, EINA_FALSE if it does not.

See also:

ecore_evas_alpha_set()

Since :

3.0

Sets whether an Ecore_Evas has an alpha channel or not.

Parameters:

ee	The Ecore_Evas to shape
alpha	EINA_TRUE to enable the alpha channel, EINA_FALSE to disable it

This function allows you to make an Ecore_Evas translucent using an alpha channel. See ecore_evas_shaped_set() for details. The difference between a shaped window and a window with an alpha channel is that an alpha channel supports multiple levels of transparency, as opposed to the 1 bit transparency of a shaped window (a pixel is either opaque, or it's transparent).

Warning:

Support for this depends on the underlying windowing system.

Since :

3.0

Get the compositing synchronization state.

Returns:

True if app comp sync is enabled.

Note:

This is an experimental functionality and is likely to be removed.

Since :

3.0

Sets application compositor synchronization on/off.

Turns on client+server synchronized rendering in X11. App comp sync is disabled by default, but can be turned on optionally.

Note:

This is an experimental functionality and is likely to be removed.

Parameters:

do_sync

True to enable comp syncing, False to disable

Since :

3.0

Gets the aspect ratio of a canvas window.

This returns the value set by ecore_evas_aspect_set().

Parameters:

ee	The Ecore_Evas to set

Returns:

The aspect ratio

See also:

ecore_evas_aspect_set()

Since (EFL) :

1.2

Since :

3.0

Sets the aspect ratio of a canvas window.

Parameters:

ee	The Ecore_Evas
aspect	The aspect ratio (width divided by height), or 0 to disable

This sets the desired aspect ratio of a canvas window

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.2

Since :

3.0

Creates an auxiliary hint of the Ecore_Evas.

Parameters:

ee	The Ecore_Evas
hint	The auxiliary hint string.
val	The value string.

Returns:

The ID of created auxiliary hint, or -1 on failure.

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.10.0

Since :

4.0

Deletes an auxiliary hint of the Ecore_Evas.

Parameters:

ee	The Ecore_Evas
id	The ID of the auxiliary hint.

Returns:

EINA_TRUE if no error occurred, EINA_FALSE otherwise.

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.10.0

Since :

3.0

Gets a ID of the auxiliary hint string.

Parameters:

ee	The Ecore_Evas
hint	The auxiliary hint string.

Returns:

The ID of the auxiliary hint string, or -1 if none exists

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.15

Since :

3.0

Gets a value of the auxiliary hint.

Parameters:

ee	The Ecore_Evas
id	The auxiliary hint ID.

Returns:

The string value of the auxiliary hint ID, or NULL if none exists

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.15

Since :

3.0

Changes a value of the auxiliary hint.

Parameters:

ee	The Ecore_Evas
id	The auxiliary hint ID.
val	The value string to be set.

Returns:

EINA_TRUE if no error occurred, EINA_FALSE otherwise.

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.10.0

Since :

3.0

Gets the list of allowed auxiliary hint IDs.

Parameters:

ee	The Ecore_Evas

Returns:

List of allowed auxiliary hint IDs.

Note:

This function is low level. Instead of using it directly, consider using the callback mechanism in Elementary such as "aux,hint,allowed".

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.10.0

Since :

3.0

Gets the list of supported auxiliary hint strings.

Parameters:

ee	The Ecore_Evas

Returns:

List of supported auxiliary hint strings.

Note:

Do not change the returned list of its contents. Auxiliary hint strings are internal and should be considered constants, do not free or modify them.

Warning:

Support for this depends on the underlying windowing system.

The window auxiliary hint is the value which is used to decide which actions should be made available to the user by the window manager. If you want to set a specific hint on your window, then you should check whether it exists in the supported auxiliary hints that are registered in the root window by the window manager. Once you've added an auxiliary hint, you can get a new ID which is used to change value and delete hint. The window manager sends the response message to the application on receiving auxiliary hint change event. A list of auxiliary hints within the Ecore_Evas has this format: ID:HINT:VALUE,ID:HINT:VALUE,...

Since (EFL) :

1.10.0

Since :

3.0

Queries whether an Ecore_Evas' window avoids damage or not.

Parameters:

ee	The Ecore_Evas to set

Returns:

The type of the damage management

Sets whether or not an Ecore_Evas' window should avoid damage.

Parameters:

ee	The Ecore_Evas
on	The type of the damage management

This option causes updates of the Ecore_Evas to be done on a pixmap, and then copied to the window, or the pixmap used directly on the window, depending on the setting. Possible options are:

• ECORE_EVAS_AVOID_DAMAGE_NONE - every expose event triggers a new damage and consequently render of the affected area. The rendering of things happens directly on the window;

• ECORE_EVAS_AVOID_DAMAGE_EXPOSE - there's a pixmap where everything is rendered into, and then copied to the window. On expose events, there's no need to render things again, just copy the exposed region to the window;

• ECORE_EVAS_AVOID_DAMAGE_BUILT_IN - there's the same pixmap as the previous one, but it is set as a "background pixmap" of the window. The rendered things appear directly on the window, with no need to copy anything, but would stay stored on the pixmap, so there's no need to render things again on expose events. This option can be faster than the previous one, but may lead to artifacts during resize of the window.

Queries whether an Ecore_Evas' window is borderless or not.

Parameters:

ee	The Ecore_Evas to set

Returns:

EINA_TRUE if ee is borderless, EINA_FALSE if not.

See also:

ecore_evas_borderless_set()

Since :

3.0

Sets whether an Ecore_Evas' window is borderless or not.

Parameters:

ee	The Ecore_Evas
on	EINA_TRUE for borderless, EINA_FALSE for bordered.

This function makes ee borderless if on is EINA_TRUE, or bordered if on is EINA_FALSE.

Warning:

Support for this depends on the underlying windowing system.

Since :

3.0

Creates a new Ecore_Evas canvas bound to the Evas buffer engine, giving custom allocation and freeing functions for the canvas memory region.

Parameters:

w	The width of the canvas, in canvas units
h	The height of the canvas, in canvas units
alloc_func	Function to be called to allocate the memory needed for the new buffer canvas. data will be passed the same value as the data of this function, while size will be passed w times h times sizeof(int).
free_func	Function to be called to free the memory used by the new buffer canvas. data will be passed the same value as the data of this function, while pix will be passed the canvas memory pointer.
data	Custom data to be passed to the allocation and freeing functions

Returns:

A new Ecore_Evas instance or NULL, on failure

This creates a new buffer canvas wrapper, with image data array bound to the ARGB format, 8 bits per pixel.

This function is useful when one wants an Ecore_Evas buffer canvas with a custom allocation function, like one getting memory chunks from a memory pool, for example.

On any resizing of this Ecore_Evas buffer canvas, its image data will be freed, to be allocated again with the new size.

Note:

w and h sizes have to greater or equal to 1. Otherwise, they'll be interpreted as 1, exactly.

See also:

ecore_evas_buffer_new()

Since :

3.0

Returns a pointer to the Ecore_Evas parent of the given Ecore_Evas.

Parameters:

ee	An Ecore_Evas handle

Returns:

A pointer to the Ecore_Evas parent.

A use case for the function is to determine if the buffer is used inside X11 or Wayland. Since the buffer engine doesn't give any indication on it, we need to retrieve information from the Ecore_Evas parent.

Since (EFL) :

1.13

Since :

3.0

Creates a new Ecore_Evas canvas bound to the Evas buffer engine.

Since (EFL) :

1.12

Parameters:

w	The width of the canvas, in pixels
h	The height of the canvas, in pixels

Returns:

A new Ecore_Evas instance or NULL, on failure

This creates a new buffer canvas wrapper, with image data array bound to the ARGB format, 8 bits per pixel.

This function will allocate the needed pixels array with canonical malloc(). If you wish a custom function to allocate it, consider using ecore_evas_buffer_allocfunc_new(), instead.

Note:

This function actually is a wrapper on ecore_evas_buffer_allocfunc_new(), using the same w and h arguments and canonical malloc() and free() to the memory allocation and freeing functions. See that function's documentation for more details.

Since :

3.0

Examples:

ecore_evas_buffer_example_01.c.

Grabs a pointer to the actual pixels array of a given Ecore_Evas buffer canvas/window.

Parameters:

ee	An Ecore_Evas handle

Returns:

A pointer to the internal pixels array of ee

Besides returning a pointer to the actual pixel array of the given canvas, this call will force a rendering update on ee, first.

A common use case for this call is to create an image object, from another canvas, to have as data ee's contents, thus snapshoting the canvas. For that case, one can also use the ecore_evas_object_image_new() helper function.

Since :

3.0

Examples:

ecore_evas_buffer_example_01.c.

Sets a callback for Ecore_Evas delete request events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee gets a delete request.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_basics_example.c, ecore_evas_buffer_example_02.c, ecore_evas_callbacks.c, ecore_evas_window_sizes_example.c, edje-basic.c, edje-signals-messages.c, edje-swallow.c, edje-table.c, edje-text.c, and evas-box.c.

Sets a callback for Ecore_Evas destroy events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee is destroyed.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c, edje-box.c, edje-box2.c, edje-color-class.c, edje-drag.c, edje-perspective.c, evas-hints.c, evas-images.c, evas-images2.c, evas-smart-interface.c, evas-smart-object.c, evas-stacking.c, evas-table.c, and evas-text.c.

Sets a callback for Ecore_Evas mouse in events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever the mouse enters ee.

Warning:

If and when this function is called depends on the underlying windowing system.

Since (EFL) :

1.19

Sets a callback for Ecore_Evas mouse out events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever the mouse leaves ee.

Warning:

If and when this function is called depends on the underlying windowing system.

Since (EFL) :

1.19

Sets a callback for Ecore_Evas focus in events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee gets focus.

Warning:

If and when this function is called depends on the underlying windowing system.

See also:

ecore_evas_callback_focus_device_out_set()

Since (EFL) :

1.19

Sets a callback for Ecore_Evas focus out events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee loses focus.

Warning:

If and when this function is called depends on the underlying windowing system.

See also:

ecore_evas_callback_focus_device_in_set()

Since (EFL) :

1.19

Sets a callback for Ecore_Evas focus in events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee gets focus.

Warning:

If and when this function is called depends on the underlying windowing system.

Note:

This function only reports focus in events for the default seat!

See also:

ecore_evas_callback_focus_device_in_set()

Since :

3.0

Examples:

ecore_evas_callbacks.c.

Sets a callback for Ecore_Evas focus out events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee loses focus.

Warning:

If and when this function is called depends on the underlying windowing system.

Note:

This function only reports focus in events for the default seat!

See also:

ecore_evas_callback_focus_device_out_set()

Since :

3.0

Examples:

ecore_evas_callbacks.c.

Sets a callback for Ecore_Evas hide events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee is hidden.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c.

Sets a callback for Ecore_Evas mouse in events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever the mouse enters ee.

Note:

the func will only report events for the default mouse.

Warning:

If and when this function is called depends on the underlying windowing system.

See also:

ecore_evas_callback_device_mouse_in_set

Since :

3.0

Examples:

ecore_evas_callbacks.c.

Sets a callback for Ecore_Evas mouse out events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever the mouse leaves ee.

Note:

the func will only report events for the default mouse.

Warning:

If and when this function is called depends on the underlying windowing system.

See also:

ecore_evas_callback_device_mouse_out_set

Since :

3.0

Examples:

ecore_evas_callbacks.c.

Sets a callback for Ecore_Evas move events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee is moved.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c.

Sets a callback for child Ecore_Evas message.

Parameters:

ee	The Ecore_Evas to set callbacks on
func_handle	The handle to be called when message arrive

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.8.0

See also:

ecore_evas_msg_parent_send()

ecore_evas_msg_send()

ecore_evas_callback_msg_parent_handle_set()

Since :

3.0

Sets a callback for parent Ecore_Evas message.

Parameters:

ee	The Ecore_Evas to set callbacks on
func_parent_handle	The handle to be called when message arrive.

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.8.0

See also:

ecore_evas_msg_parent_send()

ecore_evas_msg_send()

eecore_evas_callback_msg_handle_set()

Since :

3.0

Sets a callback for building new Evas.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever a new Ecore_Evas is created.

Warning:

If and when this function is called depends on the underlying windowing system.

Sets a callback for Ecore_Evas mouse post-render events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called just after the evas in ee is rendered.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c.

Sets a callback for Ecore_Evas pre-free event.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called just before the instance ee is freed.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c.

Sets a callback for Ecore_Evas pre-render events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called just before the evas in ee is rendered.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c.

Sets a callback for Ecore_Evas resize events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee is resized.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c, ecore_evas_window_sizes_example.c, edje-box.c, edje-box2.c, edje-color-class.c, edje-drag.c, edje-perspective.c, edje-swallow.c, edje-table.c, evas-aspect-hints.c, evas-box.c, evas-events.c, evas-hints.c, evas-images.c, evas-images2.c, evas-object-manipulation.c, evas-smart-interface.c, evas-smart-object.c, evas-stacking.c, evas-table.c, and evas-text.c.

Sets a callback for Ecore_Evas show events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee is shown.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c.

Sets a callback for Ecore_Evas state changes.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee changes state.

Warning:

If and when this function is called depends on the underlying windowing system.

Since (EFL) :

1.2

Since :

3.0

Sets a callback for Ecore_Evas sticky events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee becomes sticky.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Sets a callback for Ecore_Evas un-sticky events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee becomes un-sticky.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Creates a new Ecore_Evas canvas bound to the Evas Cocoa engine.

Parameters:

parent	ID of the parent window this Ecore_Evas window belongs to, or 0 if this is a top-level window.
x	Horizontal position of window, in pixels
y	Vertical position of window, in pixels
w	Width of the canvas, in pixels.
h	Height of the canvas, in pixels.

The cocoa backend is used for MacOS based systems.

Gets the window from Ecore_Evas using the opengl_cocoa backend.

Parameters:

ee	The Ecore_Evas from which to get the window.

Returns:

The window of type Ecore_X_Window.

Note:

If ecore is not compiled with support for opengl_cocoa or if ee was not created with ecore_evas_cocoa_new() then nothing is done and NULL is returned.

Since (EFL) :

1.17

Gets the comp sync state.

Parameters:

ee	An Ecore_Evas handle

Returns:

True if composition synchronization is enabled, False otherwise

Note:

This is an experimental functionality and is likely to be removed in future versions of EFL.

Since :

3.0

Sets comp syncing to enabled/disabled.

Parameters:

ee	An Ecore_Evas handle
do_sync	True to enable comp syncing, False to disable

Turns on client+server synchronized rendering in X11. Comp sync is disabled by default, but can be turned on optionally. Can also be set via the ECORE_EVAS_COMP_NOSYNC / ECORE_EVAS_COMP_SYNC environmental variables.

Note:

This is an experimental functionality and is likely to be removed in future versions of EFL.

Since :

3.0

Gets information about an Ecore_Evas' specified pointer device.

Parameters:

ee	The Ecore_Evas
pointer	A pointer device to set the cursor. Use NULL for the default.
obj	A pointer to an Evas_Object to place the cursor Evas_Object.
layer	A pointer to an int to place the cursor's layer in.
hot_x	A pointer to an int to place the cursor's hot_x coordinate in.
hot_y	A pointer to an int to place the cursor's hot_y coordinate in.

This function queries information about an Ecore_Evas' cursor.

See also:

ecore_evas_cursor_device_set()

Since (EFL) :

1.19

Unsets the cursor of the specified pointer device.

Parameters:

ee	The Ecore_Evas to unset the cursor.
pointer	A pointer device to set the cursor. Use NULL for the default.

This function unsets the cursor from the Ecore_Evas, and returns the cursor object. If the cursor was set from ecore_evas_cursor_set(), this function returns the image. In this case, the image should be deleted when it is no longer needed.

See also:

ecore_evas_cursor_device_set()

ecore_evas_object_cursor_device_set()

Since (EFL) :

1.20

Gets information about an Ecore_Evas' default pointer device.

Parameters:

ee	The Ecore_Evas to get
obj	A pointer to an Evas_Object to place the cursor Evas_Object.
layer	A pointer to an int to place the cursor's layer in.
hot_x	A pointer to an int to place the cursor's hot_x coordinate in.
hot_y	A pointer to an int to place the cursor's hot_y coordinate in.

This function queries information about an Ecore_Evas' cursor.

See also:

ecore_evas_cursor_set()

ecore_evas_object_cursor_set()

ecore_evas_cursor_unset()

Since :

3.0

Examples:

ecore_evas_object_example.c.

Sets the cursor for the default pointer device.

Parameters:

ee	The Ecore_Evas
file	The path to an image file for the cursor.
layer	The layer in which the cursor will appear.
hot_x	The x coordinate of the cursor's hot spot.
hot_y	The y coordinate of the cursor's hot spot.

This function makes the mouse cursor over ee be the image specified by file. The actual point within the image that the mouse is at is specified by hot_x and hot_y, which are coordinates with respect to the top left corner of the cursor image. Cursor object will be deleted with Ecore_Evas.

Note:

This function creates an object from the image and uses ecore_evas_object_cursor_set().

Warning:

Previously set cursor will be deleted.

See also:

ecore_evas_object_cursor_set()

ecore_evas_cursor_unset()

Since :

3.0

Unsets the cursor of the default pointer device.

Parameters:

ee	The Ecore_Evas to unset the cursor.

This function unsets the cursor from the Ecore_Evas, and returns the cursor object. If the cursor was set from ecore_evas_cursor_set(), this function returns the image. In this case, the image should be deleted when it is no longer needed.

See also:

ecore_evas_cursor_set()

ecore_evas_object_cursor_set()

Since (EFL) :

1.11

Since :

3.0

Examples:

ecore_evas_object_example.c.

Retrieves user data associated with an Ecore_Evas.

Parameters:

ee	The Ecore_Evas to retrieve the user data from.
key	The key which the user data to be retrieved is associated with.

Returns:

NULL on error or no data found, A pointer to the user data on success.

This function retrieves user specific data that has been stored within an Ecore_Evas structure with ecore_evas_data_set().

See also:

ecore_evas_data_set()

Since :

3.0

Examples:

ecore_evas_basics_example.c, edje-box.c, edje-box2.c, edje-drag.c, edje-perspective.c, edje-swallow.c, and edje-table.c.

Stores user data in an Ecore_Evas structure.

Parameters:

ee	The Ecore_Evas to store the user data in.
key	A unique string to associate the user data against. Cannot be NULL.
data	A pointer to the user data to store.

This function associates the data with a key which is stored by the Ecore_Evas ee. Be aware that a call to ecore_evas_free() will not free any memory for the associated user data, this is the responsibility of the caller.

See also:

ecore_evas_callback_pre_free_set()

ecore_evas_free()

ecore_evas_data_get()

Since :

3.0

Examples:

ecore_evas_basics_example.c, edje-box.c, edje-box2.c, edje-drag.c, edje-perspective.c, edje-swallow.c, and edje-table.c.

Gets the "i demand attention" flag.

This returns the value set by ecore_evas_demand_attention_set().

Parameters:

ee	The Ecore_Evas to set

Returns:

The "i demand attention" flag

See also:

ecore_evas_demand_attention_set()

Since (EFL) :

1.2

Sets the "i demand attention" flag on a canvas window.

Parameters:

ee	The Ecore_Evas
demand	The flag state to set

A window may demand attention now (eg you must enter a password before continuing), and so it may flag a window with this.

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.2

Since :

3.0

Since :

3.0

Create an Ecore_Evas window using the drm engine.

Parameters:

disp_name	Name of the Wayland display to connect to.
parent	(Unused)
x	Horizontal position of the Ecore_Evas window.
y	Vertical position of the Ecore_Evas window.
w	Width of the Ecore_Evas window to be created.
h	Height of the Ecore_Evas window to be created.

Returns:

Ecore_Evas instance or NULL if creation failed.

Creates an Ecore_Evas window using the Direct Rendering Manager (DRM) backend. DRM is a kernel-level module providing direct graphic hardware access, bypassing the GL stack entirely.

See also:

ecore_evas_new()

ecore_evas_gl_drm_new()

Returns the Ecore_Evas for this Evas.

Parameters:

e	The Evas to get the Ecore_Evas from

Returns:

The Ecore_Evas that holds this Evas, or NULL if not held by one.

Warning:

Only use on Evas' created with ecore evas!

Since :

3.0

Examples:

ecore_evas_basics_example.c.

Gets a list of all the ecore_evases.

Returns:

A list of ecore_evases.

The returned list of ecore evases is only valid until the canvases are destroyed (and should not be cached for instance). The list can be freed by just deleting the list.

Examples:

ecore_evas_basics_example.c.

Gets the engine name used by this Ecore_Evas(window).

Parameters:

ee	Ecore_Evas whose engine's name is desired

Returns:

A string that can(usually) be used in ecore_evas_new()

See also:

ecore_evas_free()

Examples:

ecore_evas_basics_example.c.

Free list returned by ecore_evas_engines_get()

Parameters:

engines

List with engine names

Examples:

ecore_evas_basics_example.c.

Returns a list of supported engine names.

Returns:

Newly allocated list with engine names. Engine names strings are internal and should be considered constants, do not free or modify them, to free the list use ecore_evas_engines_free().

Examples:

ecore_evas_basics_example.c.

Returns the backing store image object that represents the given window in EWS.

Parameters:

ee	The Ecore_Evas from which to get the backing store.

Returns:

The evas object of EWS backing store.

Note:

This should not be modified anyhow, but may be helpful to determine stacking and geometry of it for window managers that decorate windows.

See also:

ecore_evas_ews_manager_set()

ecore_evas_ews_evas_get()

Since (EFL) :

1.1

Calls the window to be deleted (freed), but can let user decide to forbid it by using ecore_evas_callback_delete_request_set().

Parameters:

ee	The Ecore_Evas for which window will be deleted.

Since (EFL) :

1.1

Creates a new Ecore_Evas canvas bound to the Evas ews (Ecore + Evas Single Process Windowing System) engine.

EWS is a simple single process windowing system. The backing store is also an Ecore_Evas that can be setup with ecore_evas_ews_setup() and retrieved with ecore_evas_ews_ecore_evas_get(). It will allow window management using events prefixed with ECORE_EVAS_EVENT_EWS_.

The EWS windows (returned by this function or ecore_evas_new("ews"...)) will all be software buffer windows automatic rendered to the backing store.

Parameters:

x	Horizontal position of window, in pixels
y	Vertical position of window, in pixels
w	The width of the canvas, in pixels
h	The height of the canvas, in pixels

Returns:

A new Ecore_Evas instance or NULL, on failure

See also:

ecore_evas_ews_setup()

ecore_evas_ews_ecore_evas_get()

Since (EFL) :

1.1

Creates Ecore_Evas using fb backend.

Parameters:

disp_name	The name of the display to be used.
rotation	The rotation to be used.
w	The width of the Ecore_Evas to be created.
h	The height of the Ecore_Evas to be created.

Returns:

The new Ecore_Evas.

Queries whether an Ecore_Evas' window is focused or not.

Parameters:

ee	The Ecore_Evas to set
seat	An Efl_Input_Device that represents the seat or NULL for the default seat.

Returns:

EINA_TRUE if ee if focused, EINA_FALSE if not.

See also:

ecore_evas_focus_device_set()

Since (EFL) :

1.19

Sets the Ecore_Evas windows focus for a given seat.

Parameters:

ee	The Ecore_Evas
seat	An Efl_Input_Device that represents the seat or NULL for the default seat.
on	EINA_TRUE for focus, EINA_FALSE to defocus.

This function focuses ee if on is EINA_TRUE, or unfocuses ee if on is EINA_FALSE.

Warning:

Support for this depends on the underlying windowing system.

See also:

ecore_evas_focus_device_get()

Since (EFL) :

1.19

Queries whether the default seat has the Ecore_Evas focus.

Parameters:

ee	The Ecore_Evas to set

Returns:

EINA_TRUE if ee if focused, EINA_FALSE if not.

See also:

ecore_evas_focus_set()

ecore_evas_focus_device_get()

Since :

3.0

Sets the Ecore_Evas window focus for the default seat.

Parameters:

ee	The Ecore_Evas
on	EINA_TRUE for focus, EINA_FALSE to defocus.

This function focuses ee if on is EINA_TRUE, or unfocuses ee if on is EINA_FALSE.

Warning:

Support for this depends on the underlying windowing system.

See also:

ecore_evas_focus_device_set()

Since :

3.0

Gets the "focus skip" flag.

This returns the value set by ecore_evas_focus_skip_set().

Parameters:

ee	The Ecore_Evas to set

Returns:

The "focus skip" flag

See also:

ecore_evas_focus_skip_set()

Since (EFL) :

1.2

Since :

3.0

Sets the "focus skip" flag.

Parameters:

ee	The Ecore_Evas
skip	The "focus skip" state to set.

A window may not want to accept focus, be in the taskbar, pager etc. sometimes (example for a small notification window that hovers around a taskbar or panel, or hovers around a window until some activity dismisses it).

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.2

Since :

3.0

Frees an Ecore_Evas.

Parameters:

ee	The Ecore_Evas to free

This frees up any memory used by the Ecore_Evas.

Since :

3.0

Examples:

ecore_animator_example.c, ecore_evas_basics_example.c, ecore_evas_buffer_example_01.c, ecore_evas_buffer_example_02.c, ecore_evas_callbacks.c, ecore_evas_object_example.c, ecore_evas_window_sizes_example.c, ecore_imf_example.c, edje-basic.c, edje-box.c, edje-box2.c, edje-color-class.c, edje-drag.c, edje-perspective.c, edje-signals-messages.c, edje-swallow.c, edje-table.c, edje-text.c, eina_tiler_01.c, evas-aspect-hints.c, evas-events.c, evas-images.c, evas-images2.c, evas-object-manipulation.c, evas-smart-interface.c, evas-smart-object.c, evas-table.c, and evas-text.c.

Queries whether an Ecore_Evas' window is fullscreen or not.

Parameters:

ee	The Ecore_Evas to set

Returns:

EINA_TRUE if ee is fullscreen, EINA_FALSE if not.

See also:

ecore_evas_fullscreen_set()

Since :

3.0

Sets whether or not an Ecore_Evas' window is fullscreen.

Parameters:

ee	The Ecore_Evas
on	EINA_TRUE fullscreen, EINA_FALSE not.

This function causes ee to be fullscreen if on is EINA_TRUE, or not if on is EINA_FALSE.

Warning:

Support for this depends on the underlying windowing system.

Since :

3.0

Gets the geometry of an Ecore_Evas.

Parameters:

ee	The Ecore_Evas whose geometry y
x	A pointer to an int to place the x coordinate in
y	A pointer to an int to place the y coordinate in
w	A pointer to an int to place the w size in
h	A pointer to an int to place the h size in

This function takes four pointers to (already allocated) ints, and places the geometry of ee in them. If any of the parameters are not desired you may pass NULL for them.

 int x, y, w, h;
 ecore_evas_geometry_get(ee, &x, &y, &w, &h);

See also:

ecore_evas_new()

ecore_evas_resize()

ecore_evas_move()

ecore_evas_move_resize()

Since :

3.0

Examples:

ecore_evas_window_sizes_example.c, edje-box.c, edje-box2.c, edje-color-class.c, edje-drag.c, edje-perspective.c, edje-swallow.c, edje-table.c, evas-aspect-hints.c, evas-box.c, evas-events.c, evas-hints.c, evas-images.c, evas-images2.c, evas-object-manipulation.c, evas-smart-interface.c, evas-smart-object.c, evas-stacking.c, evas-table.c, and evas-text.c.

Gets an Ecore_Evas's Evas.

Parameters:

ee	The Ecore_Evas whose Evas you wish to get

Returns:

The Evas contained within ee.

Since :

3.0

Examples:

ecore_animator_example.c, ecore_evas_basics_example.c, ecore_evas_buffer_example_01.c, ecore_evas_buffer_example_02.c, ecore_evas_callbacks.c, ecore_evas_object_example.c, ecore_evas_window_sizes_example.c, ecore_imf_example.c, edje-basic.c, edje-box.c, edje-box2.c, edje-color-class.c, edje-drag.c, edje-perspective.c, edje-signals-messages.c, edje-swallow.c, edje-table.c, edje-text.c, eina_tiler_01.c, evas-aspect-hints.c, evas-box.c, evas-events.c, evas-hints.c, evas-images.c, evas-images2.c, evas-map-utils.c, evas-object-manipulation.c, evas-smart-interface.c, evas-smart-object.c, evas-stacking.c, evas-table.c, and evas-text.c.

Create an Ecore_Evas window using the drm engine with GL support.

Parameters:

disp_name	Name of the Wayland display to connect to.
parent	(Unused)
x	Horizontal position of the Ecore_Evas window.
y	Vertical position of the Ecore_Evas window.
w	Width of the Ecore_Evas window to be created.
h	Height of the Ecore_Evas window to be created.

Returns:

Ecore_Evas instance or NULL if creation failed.

This creates a drm backend backed Ecore_Evas window, that also includes gl support using libglapi.

See also:

ecore_evas_new()

ecore_evas_drm_new()

Creates a new Ecore_Evas canvas bound to the Evas SDL + gl engine.

Parameters:

name	Device target name, defaults to "EFL SDL" if NULL.
w	Width of the canvas, in pixels.
h	Height of the canvas, in pixels.
fullscreen	Set the fullscreen property for the window.
noframe	Set the noframe flag on the einfo.

Returns:

A new Ecore_Evas instance or NULL on failure

Gets if the Ecore_Evas is being directly resized using opengl x11.

Parameters:

ee	The Ecore_Evas from which to get direct resize.

Note:

If ecore is not compiled with support for x11 then nothing is done and EINA_FALSE is returned.

Returns:

EINA_TRUE if the resize was managed directly, otherwise return EINA_FALSE.

Sets direct_resize for Ecore_Evas using opengl x11.

Parameters:

ee	The Ecore_Evas in which to set direct resize.
on	Enables the resize of Ecore_Evas if equals EINA_TRUE, disables if equals EINA_FALSE.

Note:

If ecore is not compiled with support for x11 then nothing is done.

Adds extra window on Ecore_Evas using opengl x11.

Parameters:

ee	The Ecore_Evas for which to add the window.
win	The window to be added to the Ecore_Evas.

Note:

If ecore is not compiled with support for x11 then nothing is done.

Creates Ecore_Evas using opengl x11.

Parameters:

disp_name	The name of the display of the Ecore_Evas to be created.
parent	The parent of the Ecore_Evas to be created.
x	The X coordinate to be used.
y	The Y coordinate to be used.
w	The width of the Ecore_Evas to be created.
h	The height of the Ecore_Evas to be created.

Returns:

The new Ecore_Evas.

Note:

If ecore is not compiled with support for x11 then nothing is done and NULL is returned.

Create Ecore_Evas using OpenGL X11, with options.

Parameters:

disp_name	The name of the display of the Ecore_Evas to be created.
parent	The parent of the Ecore_Evas to be created.
x	The X coordinate to be used.
y	The Y coordinate to be used.
w	The width of the Ecore_Evas to be created.
h	The height of the Ecore_Evas to be created.
opt	The options array (see above)

Returns:

The new Ecore_Evas.

Allows creation of an Ecore_Evas, similar to ecore_evas_gl_x11_new, except it permits passing in opt, a NULL-terminated C array of key/value pairs for various settings, as follows:

ECORE_EVAS_GL_X11_OPT_INDIRECT: Use indirect rendering [0,1] ECORE_EVAS_GL_X11_OPT_VSYNC: Use vsync [0,1] ECORE_EVAS_GL_X11_OPT_SWAP_MODE: Swap mode to assume (see Evas_Engine_Info_Gl_Swap_Mode) ECORE_EVAS_GL_X11_OPT_GL_DEPTH: depth_bits ECORE_EVAS_GL_X11_OPT_GL_STENCIL: stencil_bits ECORE_EVAS_GL_X11_OPT_GL_MSAA: msaa_bits

Note:

If ecore is not compiled with support for x11 then nothing is done and NULL is returned.

Returns the underlying Ecore_X_Pixmap used in the Ecore_Evas.

Parameters:

ee	The Ecore_Evas whose pixmap is desired.

Returns:

The underlying Ecore_X_Pixmap

Warning:

Support for this depends on the underlying windowing system.

The XPixmap ID can change with every frame after it is rendered, so you should ALWAYS call ecore_evas_software_x11_pixmap_get when you need the current pixmap id.

Since (EFL) :

1.8

Creates a new Ecore_Evas which does not contain an XWindow. It will only contain an XPixmap to render to.

Warning:

The XPixmap ID can change with every frame after it is rendered, so you should ALWAYS call ecore_evas_software_x11_pixmap_get when you need the current pixmap id.

Since (EFL) :

1.8

Sets the functions to be used before and after the swap callback.

Parameters:

ee	The Ecore_Evas for which to set the swap callback.
data	The data for which to set the swap callback.
pre_cb	The function to be called before the callback.
post_cb	The function to be called after the callback.

Note:

If ecore is not compiled with support for x11 then nothing is done and the function is returned.

Gets the window from Ecore_Evas using opengl x11.

Parameters:

ee	The Ecore_Evas from which to get the window.

Returns:

The window of type Ecore_X_Window of Ecore_Evas.

Note:

If ecore is not compiled with support for x11 or if ee was not created with ecore_evas_gl_x11_new() then nothing is done and 0 is returned.

Hides an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas to hide.

This function makes ee hidden(not visible).

Since :

3.0

Examples:

ecore_evas_basics_example.c.

Queries whether an Ecore_Evas' window is iconified or not.

Parameters:

ee	The Ecore_Evas to set

Returns:

EINA_TRUE if ee is iconified, EINA_FALSE if not.

Note:

Iconify and minimize are synonyms.

See also:

ecore_evas_iconified_set()

Since :

3.0

Iconifies or uniconifies an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas
on	EINA_TRUE to iconify, EINA_FALSE to uniconify.

This function iconifies ee if on is EINA_TRUE, or uniconifies ee if on is EINA_FALSE.

Note:

Iconify and minimize are synonyms.

Warning:

Support for this depends on the underlying windowing system.

Since :

3.0

Returns the ignore state of an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas whose window's ignore events state is returned.

Returns:

The Ecore_Evas window's ignore state.

See also:

ecore_evas_ignore_events_set()

Since :

3.0

Sets if this evas should ignore all events.

Parameters:

ee	The Ecore_Evas whose window's to ignore events.
ignore	The Ecore_Evas new ignore state.

Warning:

Support for this depends on the underlying windowing system.

Since :

3.0

Inits the Ecore_Evas system.

Returns:

How many times the lib has been initialized, 0 indicates failure.

Set up the Evas wrapper system. Init Evas and Ecore libraries.

See also:

ecore_evas_shutdown()

Since :

3.0

Examples:

ecore_animator_example.c, ecore_evas_basics_example.c, ecore_evas_buffer_example_01.c, ecore_evas_buffer_example_02.c, ecore_evas_callbacks.c, ecore_evas_object_example.c, ecore_evas_window_sizes_example.c, ecore_imf_example.c, edje-basic.c, edje-box.c, edje-box2.c, edje-color-class.c, edje-drag.c, edje-perspective.c, edje-signals-messages.c, edje-swallow.c, edje-table.c, edje-text.c, eina_tiler_01.c, evas-aspect-hints.c, evas-box.c, evas-events.c, evas-hints.c, evas-images.c, evas-images2.c, evas-map-utils.c, evas-object-manipulation.c, evas-smart-interface.c, evas-smart-object.c, evas-stacking.c, evas-table.c, and evas-text.c.

Registers an Ecore_Evas to receive events through ecore_input_evas.

Parameters:

ee	The Ecore_Evas handle.

This function calls ecore_event_window_register() with the ee as its id argument, window argument, and uses its Evas too. It is useful when no window information is available on a given Ecore_Evas backend.

See also:

ecore_evas_input_event_unregister()

Since (EFL) :

1.1

Since :

3.0

Registers an Ecore_Evas to receive events through ecore_input_evas.

Parameters:

ee	The Ecore_Evas handle.

This function calls ecore_event_window_register_with_multi() with the ee as its id argument, window argument, and uses its Evas too. It is useful when no window information is available on a given Ecore_Evas backend.

See also:

ecore_evas_input_event_unregister()

Since (EFL) :

1.1

Registers an Ecore_Evas to receive events through ecore_input_evas.

Parameters:

ee	The Ecore_Evas handle.

This function calls ecore_event_window_register_with_multi() with the ee as its id argument, window argument, and uses its Evas too. It is useful when no window information is available on a given Ecore_Evas backend.

See also:

ecore_evas_input_event_unregister()

Since (EFL) :

1.1

Unregisters an Ecore_Evas receiving events through ecore_input_evas.

Parameters:

ee	The Ecore_Evas handle.

See also:

ecore_evas_input_event_register()

Since (EFL) :

1.1

Since :

3.0

Gets the layer of an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas to set

Returns:

The layer ee's window is on

See also:

ecore_evas_layer_set()

ecore_evas_lower()

ecore_evas_raise()

Since :

3.0

Sets the layer of an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas
layer	The layer to put ee on.

This function moves ee to the layer layer.

Warning:

Support for this depends on the underlying windowing system.

See also:

ecore_evas_lower()

ecore_evas_raise()

Since :

3.0

Lowers an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas to raise.

This functions lowers the Ecore_Evas to the back.

Warning:

Support for this depends on the underlying windowing system.

See also:

ecore_evas_raise()

ecore_evas_layer_set()

Since :

3.0

Provides Managed move co-ordinates for an Ecore_Evas.

Parameters:

ee	The Ecore_Evas to move
x	The x coordinate to set as the managed location
y	The y coordinate to set as the managed location

This sets the managed geometry position of the ee to (x, y)

Forces immediate rendering on a given Ecore_Evas window.

Parameters:

ee	An Ecore_Evas handle

Use this call to forcefully flush the ee's canvas rendering pipeline, thus bring its window to an up to date state.

Since :

3.0

Examples:

ecore_evas_buffer_example_01.c.

Gets enable/disable status of manual render.

Parameters:

ee	An Ecore_Evas handle

Returns:

EINA_TRUE if manual render is enabled, EINA_FALSE if manual render is disabled

See also:

ecore_evas_manual_render_set()

ecore_evas_manual_render()

Since :

3.0

Enables/disables manual render.

Parameters:

ee	An Ecore_Evas handle
manual_render	Enable/disable manual render. EINA_TRUE to enable manual render, EINA_FALSE to disable manual render. EINA_FALSE by default

If manual_render is true, default ecore_evas render routine would be disabled and rendering will be done only manually. If manual_render is false, rendering will be done by default ecore_evas rendering routine, but still manual rendering is available. Call ecore_evas_manual_render() to force immediate render.

See also:

ecore_evas_manual_render_get()

ecore_evas_manual_render()

Since :

3.0

Queries whether an Ecore_Evas' window is maximized or not.

Parameters:

ee	The Ecore_Evas to set

Returns:

EINA_TRUE if ee is maximized, EINA_FALSE if not.

See also:

ecore_evas_maximized_set()

Since :

3.0

Maximizes (or unmaximizes) an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas
on	EINA_TRUE to maximize, EINA_FALSE to unmaximize

This function maximizes ee if on is EINA_TRUE, or unmaximizes ee if on is EINA_FALSE.

Warning:

Support for this depends on the underlying windowing system.

Since :

3.0

Gets The modal flag.

This returns the value set by ecore_evas_modal_set().

Parameters:

ee	The Ecore_Evas to set

Returns:

The modal flag

See also:

ecore_evas_modal_set()

Since (EFL) :

1.2