Modules | Typedefs | Functions
Canvas Functions

Low level Evas canvas functions. More...

Modules

 Render Engine Functions
 Functions that are used to set the render engine for a given function, and then get that engine working.
 
 Coordinate Mapping Functions
 Functions that are used to map coordinates from the canvas to the screen or the screen to the canvas.
 
 Output and Viewport Resizing Functions
 Functions that set and retrieve the output and viewport size of an evas.
 
 Canvas Events
 Functions relating to canvas events, which are mainly reports on its internal states changing (an object got focused, the rendering is updated, etc).
 
 Image Functions
 Functions that deals with images at canvas level.
 
 Font Functions
 Functions that deals with fonts.
 
 Key Input Functions
 Functions which feed key events to the canvas.
 
 Touch Point List Functions
 Functions to get information of touched points in the Evas.
 
 Rendering GL on Evas
 This group discusses the functions that are used to do OpenGL rendering on Evas.
 

Typedefs

typedef Eo Evas
 An opaque handle to an Evas canvas. More...
 
typedef struct _Evas_Public_Data Evas_Public_Data
 Public data for an Evas.
 

Functions

EOAPI void evas_canvas_image_cache_set (Eo *obj, int size)
 Set the image cache. More...
 
EOAPI int evas_canvas_image_cache_get (const Eo *obj)
 Get the image cache. More...
 
EOAPI void evas_canvas_event_default_flags_set (Eo *obj, Efl_Event_Flags flags)
 Set the default set of flags an event begins with. More...
 
EOAPI Efl_Event_Flags evas_canvas_event_default_flags_get (const Eo *obj)
 Get the default set of flags an event begins with. More...
 
EOAPI void evas_canvas_font_cache_set (Eo *obj, int size)
 Changes the size of font cache of the given evas. More...
 
EOAPI int evas_canvas_font_cache_get (const Eo *obj)
 Get the size of font cache of the given evas in bytes. More...
 
EOAPI void evas_canvas_data_attach_set (Eo *obj, void *data)
 Attaches a specific pointer to the evas for fetching later. More...
 
EOAPI void * evas_canvas_data_attach_get (const Eo *obj)
 Returns the pointer attached by evas_canvas_data_attach_set. More...
 
EOAPI void evas_canvas_font_hinting_set (Eo *obj, Evas_Font_Hinting_Flags hinting)
 Changes the font hinting for the given evas. More...
 
EOAPI Evas_Font_Hinting_Flags evas_canvas_font_hinting_get (const Eo *obj)
 Retrieves the font hinting used by the given evas. More...
 
EOAPI Eina_Bool evas_canvas_engine_info_set (Eo *obj, Evas_Engine_Info *info)
 Applies the engine settings for the given evas from the given Evas_Engine_Info structure. More...
 
EOAPI Evas_Engine_Infoevas_canvas_engine_info_get (const Eo *obj)
 Retrieves the current render engine info struct from the given evas. More...
 
EOAPI Efl_Canvas_Object * evas_canvas_focus_get (const Eo *obj)
 Retrieve the object that currently has focus. More...
 
EOAPI Efl_Canvas_Object * evas_canvas_object_top_get (const Eo *obj)
 Get the highest (stacked) Evas object on the canvas e. More...
 
EOAPI const Evas_Lockevas_canvas_key_lock_get (const Eo *obj)
 Returns a handle to the list of lock keys registered in the canvas e. More...
 
EOAPI void evas_canvas_pointer_canvas_xy_get (const Eo *obj, Evas_Coord *x, Evas_Coord *y)
 This function returns the current known pointer coordinates. More...
 
EOAPI int evas_canvas_event_down_count_get (const Eo *obj)
 Get the number of mouse or multi presses currently active. More...
 
EOAPI int evas_canvas_smart_objects_calculate_count_get (const Eo *obj)
 This gets the internal counter that counts the number of smart calculations. More...
 
EOAPI Eina_Bool evas_canvas_focus_state_get (const Eo *obj)
 Get the focus state known by the given evas.
 
EOAPI Eina_Bool evas_canvas_changed_get (const Eo *obj)
 Get the changed marker for the canvas. More...
 
EOAPI void evas_canvas_pointer_output_xy_get (const Eo *obj, int *x, int *y)
 This function returns the current known pointer coordinates. More...
 
EOAPI Eina_Bool evas_canvas_pointer_inside_get (const Eo *obj)
 Returns whether the mouse pointer is logically inside the canvas. More...
 
EOAPI Eina_Bool evas_canvas_image_max_size_get (const Eo *obj, int *maxw, int *maxh)
 Get the maximum image size evas can possibly handle. More...
 
EOAPI Efl_Canvas_Object * evas_canvas_object_bottom_get (const Eo *obj)
 Get the lowest (stacked) Evas object on the canvas e. More...
 
EOAPI const Evas_Modifierevas_canvas_key_modifier_get (const Eo *obj)
 Returns a handle to the list of modifier keys registered in the canvas e. More...
 
EOAPI unsigned int evas_canvas_pointer_button_down_mask_get (const Eo *obj)
 Returns a bitmask with the mouse buttons currently pressed, set to 1. More...
 
EOAPI Eina_Listevas_canvas_tree_objects_at_xy_get (Eo *obj, Efl_Canvas_Object *stop, int x, int y)
 Retrieve a list of Evas objects lying over a given position in a canvas. More...
 
EOAPI void evas_canvas_key_lock_on (Eo *obj, const char *keyname)
 Enables or turns on programmatically the lock key with name keyname. More...
 
EOAPI Evas_Modifier_Mask evas_canvas_key_modifier_mask_get (const Eo *obj, const char *keyname)
 Creates a bit mask from the keyname modifier key. More...
 
EOAPI void evas_canvas_key_modifier_add (Eo *obj, const char *keyname)
 Adds the keyname key to the current list of modifier keys. More...
 
EOAPI void evas_canvas_key_modifier_off (Eo *obj, const char *keyname)
 Disables or turns off programmatically the modifier key with name keyname. More...
 
EOAPI Eina_Listevas_canvas_objects_at_xy_get (const Eo *obj, Evas_Coord x, Evas_Coord y, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects)
 Retrieve a list of Evas objects lying over a given position in a canvas. More...
 
EOAPI Eina_Bool evas_canvas_render_async (Eo *obj)
 Render the given Evas canvas asynchronously. More...
 
EOAPI Eina_Bool evas_canvas_render2 (Eo *obj)
 Render the given Evas canvas using the new rendering infra. More...
 
EOAPI Eina_Listevas_canvas_render2_updates (Eo *obj)
 Render the given Evas canvas using the new rendering infra. More...
 
EOAPI void evas_canvas_focus_out (Eo *obj)
 Inform to the evas that it lost the focus.
 
EOAPI void evas_canvas_norender (Eo *obj)
 Update the canvas internal objects but not triggering immediate renderization. More...
 
EOAPI unsigned int evas_canvas_touch_point_list_count (Eo *obj)
 Get the number of touched point in the evas. More...
 
EOAPI void evas_canvas_nochange_pop (Eo *obj)
 Pop the nochange flag down 1. More...
 
EOAPI void evas_canvas_key_lock_off (Eo *obj, const char *keyname)
 Disables or turns off programmatically the lock key with name keyname. More...
 
EOAPI void evas_canvas_nochange_push (Eo *obj)
 Push the nochange flag up 1. More...
 
EOAPI void evas_canvas_font_cache_flush (Eo *obj)
 Force the given evas and associated engine to flush its font cache.
 
EOAPI Eina_Bool evas_canvas_font_hinting_can_hint (const Eo *obj, Evas_Font_Hinting_Flags hinting)
 Checks if the font hinting is supported by the given evas. More...
 
EOAPI Efl_Canvas_Object * evas_canvas_object_top_at_xy_get (const Eo *obj, Evas_Coord x, Evas_Coord y, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects)
 Retrieve the Evas object stacked at the top of a given position in a canvas. More...
 
EOAPI void evas_canvas_key_modifier_on (Eo *obj, const char *keyname)
 Enables or turns on programmatically the modifier key with name keyname. More...
 
EOAPI Eina_Listevas_canvas_font_available_list (const Eo *obj)
 List of available font descriptions known or found by this evas. More...
 
EOAPI Efl_Canvas_Object * evas_canvas_object_name_find (const Eo *obj, const char *name)
 Retrieves the object on the given evas with the given name. More...
 
EOAPI void evas_canvas_font_path_append (Eo *obj, const char *path)
 Appends a font path to the list of font paths used by the given evas. More...
 
EOAPI int evas_canvas_touch_point_list_nth_id_get (Eo *obj, unsigned int n)
 This function returns the id of nth touch point. More...
 
EOAPI void evas_canvas_font_path_clear (Eo *obj)
 Removes all font paths loaded into memory for the given evas.
 
EOAPI void evas_canvas_smart_objects_calculate (Eo *obj)
 Call user-provided calculate smart functions and unset the flag signalling that the object needs to get recalculated to all smart objects in the canvas.
 
EOAPI void evas_canvas_touch_point_list_nth_xy_get (Eo *obj, unsigned int n, Evas_Coord *x, Evas_Coord *y)
 This function returns the nth touch point's coordinates. More...
 
EOAPI void evas_canvas_key_lock_del (Eo *obj, const char *keyname)
 Removes the keyname key from the current list of lock keys on canvas e. More...
 
EOAPI void evas_canvas_damage_rectangle_add (Eo *obj, int x, int y, int w, int h)
 Add a damage rectangle. More...
 
EOAPI const Eina_Listevas_canvas_font_path_list (const Eo *obj)
 Retrieves the list of font paths used by the given evas. More...
 
EOAPI void evas_canvas_image_cache_reload (Eo *obj)
 Reload the image cache. More...
 
EOAPI int evas_canvas_coord_world_x_to_screen (const Eo *obj, Evas_Coord x)
 Convert/scale a canvas coordinate into output screen coordinates. More...
 
EOAPI Eina_Listevas_canvas_render_updates (Eo *obj)
 Force immediate renderization of the given Evas canvas. More...
 
EOAPI void evas_canvas_image_cache_flush (Eo *obj)
 Flush the image cache of the canvas. More...
 
EOAPI Evas_Coord evas_canvas_coord_screen_y_to_world (const Eo *obj, int y)
 Convert/scale an output screen coordinate into canvas coordinates. More...
 
EOAPI void evas_canvas_key_modifier_del (Eo *obj, const char *keyname)
 Removes the keyname key from the current list of modifier keys on canvas e. More...
 
EOAPI Evas_Touch_Point_State evas_canvas_touch_point_list_nth_state_get (Eo *obj, unsigned int n)
 This function returns the state of nth touch point. More...
 
EOAPI void evas_canvas_focus_in (Eo *obj)
 Inform to the evas that it got the focus.
 
EOAPI void evas_canvas_obscured_rectangle_add (Eo *obj, int x, int y, int w, int h)
 Add an "obscured region" to an Evas canvas. More...
 
EOAPI void evas_canvas_render_dump (Eo *obj)
 Make the canvas discard as much data as possible used by the engine at runtime. More...
 
EOAPI Efl_Canvas_Object * evas_canvas_object_top_in_rectangle_get (const Eo *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects)
 Retrieve the Evas object stacked at the top of a given rectangular region in a canvas. More...
 
EOAPI void evas_canvas_render (Eo *obj)
 Force renderization of the given canvas.
 
EOAPI void evas_canvas_font_path_prepend (Eo *obj, const char *path)
 Prepends a font path to the list of font paths used by the given evas. More...
 
EOAPI void evas_canvas_obscured_clear (Eo *obj)
 Remove all "obscured regions" from an Evas canvas. More...
 
EOAPI Evas_Coord evas_canvas_coord_screen_x_to_world (const Eo *obj, int x)
 Convert/scale an output screen coordinate into canvas coordinates. More...
 
EOAPI void evas_canvas_key_lock_add (Eo *obj, const char *keyname)
 Adds the keyname key to the current list of lock keys. More...
 
EOAPI void evas_canvas_render_idle_flush (Eo *obj)
 Make the canvas discard internally cached data used for rendering. More...
 
EOAPI int evas_canvas_coord_world_y_to_screen (const Eo *obj, Evas_Coord y)
 Convert/scale a canvas coordinate into output screen coordinates. More...
 
void evas_image_cache_set (Evas_Canvas *obj, int size)
 Set the image cache. More...
 
int evas_image_cache_get (const Evas_Canvas *obj)
 Get the image cache. More...
 
void evas_event_default_flags_set (Evas_Canvas *obj, Efl_Event_Flags flags)
 Set the default set of flags an event begins with. More...
 
Efl_Event_Flags evas_event_default_flags_get (const Evas_Canvas *obj)
 Get the default set of flags an event begins with. More...
 
void evas_font_cache_set (Evas_Canvas *obj, int size)
 Changes the size of font cache of the given evas. More...
 
int evas_font_cache_get (const Evas_Canvas *obj)
 Get the size of font cache of the given evas in bytes. More...
 
void evas_data_attach_set (Evas_Canvas *obj, void *data)
 Attaches a specific pointer to the evas for fetching later. More...
 
void * evas_data_attach_get (const Evas_Canvas *obj)
 Returns the pointer attached by evas_data_attach_set. More...
 
void evas_font_hinting_set (Evas_Canvas *obj, Evas_Font_Hinting_Flags hinting)
 Changes the font hinting for the given evas. More...
 
Evas_Font_Hinting_Flags evas_font_hinting_get (const Evas_Canvas *obj)
 Retrieves the font hinting used by the given evas. More...
 
Eina_Bool evas_engine_info_set (Evas_Canvas *obj, Evas_Engine_Info *info)
 Applies the engine settings for the given evas from the given Evas_Engine_Info structure. More...
 
Evas_Engine_Infoevas_engine_info_get (const Evas_Canvas *obj)
 Retrieves the current render engine info struct from the given evas. More...
 
Efl_Canvas_Object * evas_focus_get (const Evas_Canvas *obj)
 Retrieve the object that currently has focus. More...
 
Efl_Canvas_Object * evas_object_top_get (const Evas_Canvas *obj)
 Get the highest (stacked) Evas object on the canvas e. More...
 
const Evas_Lockevas_key_lock_get (const Evas_Canvas *obj)
 Returns a handle to the list of lock keys registered in the canvas e. More...
 
void evas_pointer_canvas_xy_get (const Evas_Canvas *obj, Evas_Coord *x, Evas_Coord *y)
 This function returns the current known pointer coordinates. More...
 
int evas_event_down_count_get (const Evas_Canvas *obj)
 Get the number of mouse or multi presses currently active. More...
 
int evas_smart_objects_calculate_count_get (const Evas_Canvas *obj)
 This gets the internal counter that counts the number of smart calculations. More...
 
Eina_Bool evas_focus_state_get (const Evas_Canvas *obj)
 Get the focus state known by the given evas.
 
Eina_Bool evas_changed_get (const Evas_Canvas *obj)
 Get the changed marker for the canvas. More...
 
void evas_pointer_output_xy_get (const Evas_Canvas *obj, int *x, int *y)
 This function returns the current known pointer coordinates. More...
 
Eina_Bool evas_pointer_inside_get (const Evas_Canvas *obj)
 Returns whether the mouse pointer is logically inside the canvas. More...
 
Eina_Bool evas_image_max_size_get (const Evas_Canvas *obj, int *maxw, int *maxh)
 Get the maximum image size evas can possibly handle. More...
 
Efl_Canvas_Object * evas_object_bottom_get (const Evas_Canvas *obj)
 Get the lowest (stacked) Evas object on the canvas e. More...
 
const Evas_Modifierevas_key_modifier_get (const Evas_Canvas *obj)
 Returns a handle to the list of modifier keys registered in the canvas e. More...
 
unsigned int evas_pointer_button_down_mask_get (const Evas_Canvas *obj)
 Returns a bitmask with the mouse buttons currently pressed, set to 1. More...
 
Eina_Listevas_tree_objects_at_xy_get (Evas_Canvas *obj, Efl_Canvas_Object *stop, int x, int y)
 Retrieve a list of Evas objects lying over a given position in a canvas. More...
 
void evas_key_lock_on (Evas_Canvas *obj, const char *keyname)
 Enables or turns on programmatically the lock key with name keyname. More...
 
Evas_Modifier_Mask evas_key_modifier_mask_get (const Evas_Canvas *obj, const char *keyname)
 Creates a bit mask from the keyname modifier key. More...
 
void evas_key_modifier_add (Evas_Canvas *obj, const char *keyname)
 Adds the keyname key to the current list of modifier keys. More...
 
void evas_key_modifier_off (Evas_Canvas *obj, const char *keyname)
 Disables or turns off programmatically the modifier key with name keyname. More...
 
Eina_Listevas_objects_at_xy_get (const Evas_Canvas *obj, Evas_Coord x, Evas_Coord y, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects)
 Retrieve a list of Evas objects lying over a given position in a canvas. More...
 
Eina_Bool evas_render_async (Evas_Canvas *obj)
 Render the given Evas canvas asynchronously. More...
 
Eina_Bool evas_render2 (Evas_Canvas *obj)
 Render the given Evas canvas using the new rendering infra. More...
 
Eina_Listevas_render2_updates (Evas_Canvas *obj)
 Render the given Evas canvas using the new rendering infra. More...
 
void evas_focus_out (Evas_Canvas *obj)
 Inform to the evas that it lost the focus.
 
void evas_norender (Evas_Canvas *obj)
 Update the canvas internal objects but not triggering immediate renderization. More...
 
unsigned int evas_touch_point_list_count (Evas_Canvas *obj)
 Get the number of touched point in the evas. More...
 
void evas_nochange_pop (Evas_Canvas *obj)
 Pop the nochange flag down 1. More...
 
void evas_key_lock_off (Evas_Canvas *obj, const char *keyname)
 Disables or turns off programmatically the lock key with name keyname. More...
 
void evas_nochange_push (Evas_Canvas *obj)
 Push the nochange flag up 1. More...
 
void evas_font_cache_flush (Evas_Canvas *obj)
 Force the given evas and associated engine to flush its font cache.
 
Eina_Bool evas_font_hinting_can_hint (const Evas_Canvas *obj, Evas_Font_Hinting_Flags hinting)
 Checks if the font hinting is supported by the given evas. More...
 
Efl_Canvas_Object * evas_object_top_at_xy_get (const Evas_Canvas *obj, Evas_Coord x, Evas_Coord y, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects)
 Retrieve the Evas object stacked at the top of a given position in a canvas. More...
 
void evas_key_modifier_on (Evas_Canvas *obj, const char *keyname)
 Enables or turns on programmatically the modifier key with name keyname. More...
 
Eina_Listevas_font_available_list (const Evas_Canvas *obj)
 List of available font descriptions known or found by this evas. More...
 
Efl_Canvas_Object * evas_object_name_find (const Evas_Canvas *obj, const char *name)
 Retrieves the object on the given evas with the given name. More...
 
void evas_font_path_append (Evas_Canvas *obj, const char *path)
 Appends a font path to the list of font paths used by the given evas. More...
 
int evas_touch_point_list_nth_id_get (Evas_Canvas *obj, unsigned int n)
 This function returns the id of nth touch point. More...
 
void evas_font_path_clear (Evas_Canvas *obj)
 Removes all font paths loaded into memory for the given evas.
 
void evas_smart_objects_calculate (Evas_Canvas *obj)
 Call user-provided calculate smart functions and unset the flag signalling that the object needs to get recalculated to all smart objects in the canvas.
 
void evas_touch_point_list_nth_xy_get (Evas_Canvas *obj, unsigned int n, Evas_Coord *x, Evas_Coord *y)
 This function returns the nth touch point's coordinates. More...
 
void evas_key_lock_del (Evas_Canvas *obj, const char *keyname)
 Removes the keyname key from the current list of lock keys on canvas e. More...
 
void evas_damage_rectangle_add (Evas_Canvas *obj, int x, int y, int w, int h)
 Add a damage rectangle. More...
 
const Eina_Listevas_font_path_list (const Evas_Canvas *obj)
 Retrieves the list of font paths used by the given evas. More...
 
void evas_image_cache_reload (Evas_Canvas *obj)
 Reload the image cache. More...
 
int evas_coord_world_x_to_screen (const Evas_Canvas *obj, Evas_Coord x)
 Convert/scale a canvas coordinate into output screen coordinates. More...
 
Eina_Listevas_render_updates (Evas_Canvas *obj)
 Force immediate renderization of the given Evas canvas. More...
 
void evas_image_cache_flush (Evas_Canvas *obj)
 Flush the image cache of the canvas. More...
 
Evas_Coord evas_coord_screen_y_to_world (const Evas_Canvas *obj, int y)
 Convert/scale an output screen coordinate into canvas coordinates. More...
 
void evas_key_modifier_del (Evas_Canvas *obj, const char *keyname)
 Removes the keyname key from the current list of modifier keys on canvas e. More...
 
Evas_Touch_Point_State evas_touch_point_list_nth_state_get (Evas_Canvas *obj, unsigned int n)
 This function returns the state of nth touch point. More...
 
void evas_focus_in (Evas_Canvas *obj)
 Inform to the evas that it got the focus.
 
void evas_obscured_rectangle_add (Evas_Canvas *obj, int x, int y, int w, int h)
 Add an "obscured region" to an Evas canvas. More...
 
void evas_render_dump (Evas_Canvas *obj)
 Make the canvas discard as much data as possible used by the engine at runtime. More...
 
Efl_Canvas_Object * evas_object_top_in_rectangle_get (const Evas_Canvas *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects)
 Retrieve the Evas object stacked at the top of a given rectangular region in a canvas. More...
 
void evas_render (Evas_Canvas *obj)
 Force renderization of the given canvas.
 
void evas_font_path_prepend (Evas_Canvas *obj, const char *path)
 Prepends a font path to the list of font paths used by the given evas. More...
 
void evas_obscured_clear (Evas_Canvas *obj)
 Remove all "obscured regions" from an Evas canvas. More...
 
Evas_Coord evas_coord_screen_x_to_world (const Evas_Canvas *obj, int x)
 Convert/scale an output screen coordinate into canvas coordinates. More...
 
void evas_key_lock_add (Evas_Canvas *obj, const char *keyname)
 Adds the keyname key to the current list of lock keys. More...
 
void evas_render_idle_flush (Evas_Canvas *obj)
 Make the canvas discard internally cached data used for rendering. More...
 
int evas_coord_world_y_to_screen (const Evas_Canvas *obj, Evas_Coord y)
 Convert/scale a canvas coordinate into output screen coordinates. More...
 
void evas_render_updates_free (Eina_List *updates)
 Free the rectangles returned by evas_render_updates(). More...
 
void evas_output_framespace_set (Evas *e, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h)
 Sets the output framespace size of the render engine of the given evas. More...
 
void evas_output_framespace_get (const Evas *e, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
 Get the render engine's output framespace coordinates in canvas units. More...
 
void evas_output_viewport_set (Evas *e, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h)
 Sets the output viewport of the given evas in evas units. More...
 
void evas_output_viewport_get (const Evas *e, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
 Get the render engine's output viewport coordinates in canvas units. More...
 
void evas_output_method_set (Evas *e, int render_method)
 Sets the output engine for the given evas. More...
 
int evas_output_method_get (const Evas *e)
 Retrieves the number of the output engine used for the given evas. More...
 
void evas_output_size_set (Evas *e, int w, int h)
 Sets the output size of the render engine of the given evas. More...
 
void evas_output_size_get (const Evas *e, int *w, int *h)
 Retrieve the output size of the render engine of the given evas. More...
 
Evasevas_new (void)
 Creates a new empty evas. More...
 
void evas_free (Evas *e)
 Frees the given evas and any objects created on it. More...
 

Detailed Description

Low level Evas canvas functions.

Sub groups will present more high level ones, though.

Most of these functions deal with low level Evas actions, like:

Most users will be using Evas by means of the Ecore_Evas wrapper, which deals with all the above mentioned issues automatically for them. Thus, you'll be looking at this section only if you're building low level stuff.

The groups within present you functions that deal with the canvas directly, too, and not yet with its objects. They are the functions you need to use at a minimum to get a working canvas.

Some of the functions in this group are exemplified here.

Typedef Documentation

◆ Evas

An opaque handle to an Evas canvas.

See also
evas_new()
evas_free()

Function Documentation

◆ evas_canvas_image_cache_set()

EOAPI void evas_canvas_image_cache_set ( Eo obj,
int  size 
)

Set the image cache.

This function sets the image cache of canvas in bytes.

Parameters
[in]sizeThe cache size.

Referenced by evas_image_cache_set().

◆ evas_canvas_image_cache_get()

EOAPI int evas_canvas_image_cache_get ( const Eo obj)

Get the image cache.

This function returns the image cache size of canvas in bytes.

Returns
The cache size.

Referenced by evas_image_cache_get().

◆ evas_canvas_event_default_flags_set()

EOAPI void evas_canvas_event_default_flags_set ( Eo obj,
Efl_Event_Flags  flags 
)

Set the default set of flags an event begins with.

Events in evas can have an event_flags member. This starts out with and initial value (no flags). This lets you set the default flags that an event begins with to be flags.

Parameters
[in]flagsThe default flags to use.
Since
1.2

Referenced by evas_event_default_flags_set().

◆ evas_canvas_event_default_flags_get()

EOAPI Efl_Event_Flags evas_canvas_event_default_flags_get ( const Eo obj)

Get the default set of flags an event begins with.

This gets the default event flags events are produced with when fed in.

Returns
The default flags to use.
Since
1.2

Referenced by evas_event_default_flags_get().

◆ evas_canvas_font_cache_set()

EOAPI void evas_canvas_font_cache_set ( Eo obj,
int  size 
)

Changes the size of font cache of the given evas.

Parameters
[in]sizeThe size in bytes.

Referenced by evas_font_cache_set().

◆ evas_canvas_font_cache_get()

EOAPI int evas_canvas_font_cache_get ( const Eo obj)

Get the size of font cache of the given evas in bytes.

Returns
The size in bytes.

Referenced by evas_font_cache_get().

◆ evas_canvas_data_attach_set()

EOAPI void evas_canvas_data_attach_set ( Eo obj,
void *  data 
)

Attaches a specific pointer to the evas for fetching later.

Parameters
[in]dataThe attached pointer.

Referenced by evas_data_attach_set().

◆ evas_canvas_data_attach_get()

EOAPI void* evas_canvas_data_attach_get ( const Eo obj)

Returns the pointer attached by evas_canvas_data_attach_set.

Returns
The attached pointer.

Referenced by evas_data_attach_get().

◆ evas_canvas_font_hinting_set()

EOAPI void evas_canvas_font_hinting_set ( Eo obj,
Evas_Font_Hinting_Flags  hinting 
)

Changes the font hinting for the given evas.

#EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.

Parameters
[in]hintingThe used hinting, one of #EVAS_FONT_HINTING_NONE, #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.

Referenced by evas_font_hinting_set().

◆ evas_canvas_font_hinting_get()

EOAPI Evas_Font_Hinting_Flags evas_canvas_font_hinting_get ( const Eo obj)

Retrieves the font hinting used by the given evas.

Returns
The used hinting, one of #EVAS_FONT_HINTING_NONE, #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.

Referenced by evas_font_hinting_get().

◆ evas_canvas_engine_info_set()

EOAPI Eina_Bool evas_canvas_engine_info_set ( Eo obj,
Evas_Engine_Info info 
)

Applies the engine settings for the given evas from the given Evas_Engine_Info structure.

To get the Evas_Engine_Info structure to use, call evas_canvas_engine_info_get. Do not try to obtain a pointer to an Evas_Engine_Info structure in any other way.

You will need to call this function at least once before you can create objects on an evas or render that evas. Some engines allow their settings to be changed more than once.

Once called, the info pointer should be considered invalid.

Parameters
[in]infoThe pointer to the engine info to use.
Returns
true if no error occurred, false otherwise.

Referenced by evas_engine_info_set().

◆ evas_canvas_engine_info_get()

EOAPI Evas_Engine_Info* evas_canvas_engine_info_get ( const Eo obj)

Retrieves the current render engine info struct from the given evas.

The returned structure is publicly modifiable. The contents are valid until either evas_canvas_engine_info_set or evas_canvas_render are called.

This structure does not need to be freed by the caller.

Returns
The pointer to the engine info to use.

Referenced by evas_engine_info_get().

◆ evas_canvas_focus_get()

EOAPI Efl_Canvas_Object* evas_canvas_focus_get ( const Eo obj)

Retrieve the object that currently has focus.

Evas can have (at most) one of its objects focused at a time. Focused objects will be the ones having key events delivered to, which the programmer can act upon by means of evas_object_event_callback_add usage.

Note
Most users wouldn't be dealing directly with Evas' focused objects. Instead, they would be using a higher level library for that (like a toolkit, as Elementary) to handle focus and who's receiving input for them.

This call returns the object that currently has focus on the canvas e or null, if none.

See also evas_object_focus_set, evas_object_focus_get, evas_object_key_grab, evas_object_key_ungrab.

Returns
The object that has focus or null if there is not one.

Referenced by evas_focus_get().

◆ evas_canvas_object_top_get()

EOAPI Efl_Canvas_Object* evas_canvas_object_top_get ( const Eo obj)

Get the highest (stacked) Evas object on the canvas e.

This function will take all populated layers in the canvas into account, getting the highest object for the highest layer, naturally.

Warning
This function will skip objects parented by smart objects, acting only on the ones at the "top level", with regard to object parenting.

See also evas_object_layer_get, evas_object_layer_set, evas_object_below_get, evas_object_above_get.

Returns
A pointer to the highest object on it (if any) or null otherwise.

Referenced by evas_object_top_get().

◆ evas_canvas_key_lock_get()

EOAPI const Evas_Lock* evas_canvas_key_lock_get ( const Eo obj)

Returns a handle to the list of lock keys registered in the canvas e.

This is required to check for which locks are set at a given time with the evas_key_lock_is_set function.

Returns
An Evas_Lock handle to query Evas' keys subsystem with evas_key_lock_is_set, or null on error.

Referenced by evas_key_lock_get().

◆ evas_canvas_pointer_canvas_xy_get()

EOAPI void evas_canvas_pointer_canvas_xy_get ( const Eo obj,
Evas_Coord x,
Evas_Coord y 
)

This function returns the current known pointer coordinates.

This function returns the current known canvas unit coordinates of the mouse pointer and sets the contents of the Evas_Coords pointed to by x and y to contain these coordinates. If e is not a valid canvas the results of this function are undefined.

Parameters
[out]xThe pointer to a Evas_Coord to be filled in.
[out]yThe pointer to a Evas_Coord to be filled in.

Referenced by evas_pointer_canvas_xy_get().

◆ evas_canvas_event_down_count_get()

EOAPI int evas_canvas_event_down_count_get ( const Eo obj)

Get the number of mouse or multi presses currently active.

Since
1.2

Referenced by evas_event_down_count_get().

◆ evas_canvas_smart_objects_calculate_count_get()

EOAPI int evas_canvas_smart_objects_calculate_count_get ( const Eo obj)

This gets the internal counter that counts the number of smart calculations.

Whenever evas performs smart object calculations on the whole canvas it increments a counter by 1. This is the smart object calculate counter that this function returns the value of. It starts at the value of 0 and will increase (and eventually wrap around to negative values and so on) by 1 every time objects are calculated. You can use this counter to ensure you don't re-do calculations withint the same calculation generation/run if the calculations maybe cause self-feeding effects.

Since
1.1

Referenced by evas_smart_objects_calculate_count_get().

◆ evas_canvas_changed_get()

EOAPI Eina_Bool evas_canvas_changed_get ( const Eo obj)

Get the changed marker for the canvas.

Since
1.11

Referenced by evas_changed_get().

◆ evas_canvas_pointer_output_xy_get()

EOAPI void evas_canvas_pointer_output_xy_get ( const Eo obj,
int *  x,
int *  y 
)

This function returns the current known pointer coordinates.

This function returns the current known screen/output coordinates of the mouse pointer and sets the contents of the integers pointed to by x and y to contain these coordinates. If e is not a valid canvas the results of this function are undefined.

Parameters
[out]xThe pointer to an integer to be filled in.
[out]yThe pointer to an integer to be filled in.

Referenced by evas_pointer_output_xy_get().

◆ evas_canvas_pointer_inside_get()

EOAPI Eina_Bool evas_canvas_pointer_inside_get ( const Eo obj)

Returns whether the mouse pointer is logically inside the canvas.

When this function is called it will return a value of either false or true, depending on if event_feed_mouse_in or event_feed_mouse_out have been called to feed in a mouse enter event into the canvas.

A return value of true indicates the mouse is logically inside the canvas, and false implies it is logically outside the canvas.

A canvas begins with the mouse being assumed outside ($false).

If e is not a valid canvas, the return value is undefined.

Referenced by evas_pointer_inside_get().

◆ evas_canvas_image_max_size_get()

EOAPI Eina_Bool evas_canvas_image_max_size_get ( const Eo obj,
int *  maxw,
int *  maxh 
)

Get the maximum image size evas can possibly handle.

This function returns the largest image or surface size that evas can handle in pixels, and if there is one, returns true. It returns false if no extra constraint on maximum image size exists. You still should check the return values of maxw and maxh as there may still be a limit, just a much higher one.

Parameters
[out]maxwPointer to hold the return value in pixels of the maximum width.
[out]maxhPointer to hold the return value in pixels of the maximum height.
Since
1.1

Referenced by evas_image_max_size_get().

◆ evas_canvas_object_bottom_get()

EOAPI Efl_Canvas_Object* evas_canvas_object_bottom_get ( const Eo obj)

Get the lowest (stacked) Evas object on the canvas e.

This function will take all populated layers in the canvas into account, getting the lowest object for the lowest layer, naturally.

Warning
This function will skip objects parented by smart objects, acting only on the ones at the "top level", with regard to object parenting.

See also evas_object_layer_get, evas_object_layer_set, evas_object_below_get, evas_object_below_set.

Returns
A pointer to the lowest object on it, if any, or null otherwise.

Referenced by evas_object_bottom_get().

◆ evas_canvas_key_modifier_get()

EOAPI const Evas_Modifier* evas_canvas_key_modifier_get ( const Eo obj)

Returns a handle to the list of modifier keys registered in the canvas e.

This is required to check for which modifiers are set at a given time with the evas_key_modifier_is_set function.

See also evas_canvas_key_modifier_add, evas_canvas_key_modifier_del, evas_canvas_key_modifier_on, evas_canvas_key_modifier_off.

Returns
An Evas_Modifier handle to query Evas' keys subsystem with evas_key_modifier_is_set, or null on error.

Referenced by evas_key_modifier_get().

◆ evas_canvas_pointer_button_down_mask_get()

EOAPI unsigned int evas_canvas_pointer_button_down_mask_get ( const Eo obj)

Returns a bitmask with the mouse buttons currently pressed, set to 1.

Calling this function will return a 32-bit integer with the appropriate bits set to 1 that correspond to a mouse button being depressed. This limits Evas to a mouse devices with a maximum of 32 buttons, but that is generally in excess of any host system's pointing device abilities.

A canvas by default begins with no mouse buttons being pressed and only pointer move events can alter that.

The least significant bit corresponds to the first mouse button (button 1) and the most significant bit corresponds to the last mouse button (button 32).

If e is not a valid canvas, the return value is undefined.

Returns
A bitmask of the currently depressed buttons on the canvas.

Referenced by evas_pointer_button_down_mask_get().

◆ evas_canvas_tree_objects_at_xy_get()

EOAPI Eina_List* evas_canvas_tree_objects_at_xy_get ( Eo obj,
Efl_Canvas_Object *  stop,
int  x,
int  y 
)

Retrieve a list of Evas objects lying over a given position in a canvas.

This function will traverse all the layers of the given canvas, from top to bottom, querying for objects with areas covering the given position. It will enter the smart objects. It will not append to the list pass events as hidden objects. Call eina_list_free on the returned list after usage.

Parameters
[in]stopAn Evas Object where to stop searching.
[in]xThe horizontal coordinate of the position.
[in]yThe vertical coordinate of the position.

Referenced by evas_tree_objects_at_xy_get().

◆ evas_canvas_key_lock_on()

EOAPI void evas_canvas_key_lock_on ( Eo obj,
const char *  keyname 
)

Enables or turns on programmatically the lock key with name keyname.

The effect will be as if the key was put on its active state after this call.

See also evas_canvas_key_lock_add, evas_canvas_key_lock_del, evas_canvas_key_lock_del, evas_canvas_key_lock_off.

Parameters
[in]keynameThe name of the lock to enable.

Referenced by evas_key_lock_on().

◆ evas_canvas_key_modifier_mask_get()

EOAPI Evas_Modifier_Mask evas_canvas_key_modifier_mask_get ( const Eo obj,
const char *  keyname 
)

Creates a bit mask from the keyname modifier key.

Values returned from different calls to it may be ORed together, naturally.

This function is meant to be using in conjunction with evas_object_key_grab/@ref evas_object_key_ungrab. Go check their documentation for more information.

See also evas_canvas_key_modifier_add, evas_key_modifier_get, evas_canvas_key_modifier_on, evas_canvas_key_modifier_off, evas_key_modifier_is_set.

Parameters
[in]keynameThe name of the modifier key to create the mask for.
Returns
The bit mask or 0 if the keyname key wasn't registered as a modifier for canvas e.

Referenced by evas_key_modifier_mask_get().

◆ evas_canvas_key_modifier_add()

EOAPI void evas_canvas_key_modifier_add ( Eo obj,
const char *  keyname 
)

Adds the keyname key to the current list of modifier keys.

Modifiers are keys like shift, alt and ctrl, i.e., keys which are meant to be pressed together with others, altering the behavior of the secondly pressed keys somehow. Evas is so that these keys can be user defined.

This call allows custom modifiers to be added to the Evas system at run time. It is then possible to set and unset modifier keys programmatically for other parts of the program to check and act on. Programmers using Evas would check for modifier keys on key event callbacks using evas_key_modifier_is_set.

Note
If the programmer instantiates the canvas by means of the ecore_evas_new family of helper functions, Ecore will take care of registering on it all standard modifiers: "Shift", "Control", "Alt", "Meta", "Hyper", "Super".
Parameters
[in]keynameThe name of the modifier key to add to the list of Evas modifiers.

Referenced by evas_key_modifier_add().

◆ evas_canvas_key_modifier_off()

EOAPI void evas_canvas_key_modifier_off ( Eo obj,
const char *  keyname 
)

Disables or turns off programmatically the modifier key with name keyname.

See also evas_canvas_key_modifier_add, evas_key_modifier_get, evas_canvas_key_modifier_on, evas_canvas_key_modifier_mask_get, evas_key_modifier_is_set.

Parameters
[in]keynameThe name of the modifier to disable.

Referenced by evas_key_modifier_off().

◆ evas_canvas_objects_at_xy_get()

EOAPI Eina_List* evas_canvas_objects_at_xy_get ( const Eo obj,
Evas_Coord  x,
Evas_Coord  y,
Eina_Bool  include_pass_events_objects,
Eina_Bool  include_hidden_objects 
)

Retrieve a list of Evas objects lying over a given position in a canvas.

This function will traverse all the layers of the given canvas, from top to bottom, querying for objects with areas covering the given position. The user can remove from query objects which are hidden and/or which are set to pass events.

Warning
This function will skip objects parented by smart objects, acting only on the ones at the "top level", with regard to object parenting.
Parameters
[in]xThe horizontal coordinate of the position.
[in]yThe vertical coordinate of the position.
[in]include_pass_events_objectsBoolean flag to include or not objects which pass events in this calculation.
[in]include_hidden_objectsBoolean flag to include or not hidden objects in this calculation.
Returns
The list of Evas objects that are over the given position in e.

Referenced by evas_objects_at_xy_get().

◆ evas_canvas_render_async()

EOAPI Eina_Bool evas_canvas_render_async ( Eo obj)

Render the given Evas canvas asynchronously.

This function only returns true when a frame will be rendered. If the previous frame is still rendering, false will be returned so the users know not to wait for the updates callback and just return to their main loop.

If a func callback is given, a list of updated areas will be generated and the function will be called from the main thread after the rendered frame is flushed to the screen. The resulting list should be freed with evas_render_updates_free.

The list is given in the event_info parameter of the callback function.

Returns
true if the canvas will render, false otherwise.
Since
1.8

Referenced by evas_render_async().

◆ evas_canvas_render2()

EOAPI Eina_Bool evas_canvas_render2 ( Eo obj)

Render the given Evas canvas using the new rendering infra.

This is experimental and will change over time until noted here.

This function only returns true when a frame will be rendered. If the previous frame is still rendering, false will be returned so the users know not to wait for the updates callback and just return to their main loop.

Returns
true if the canvas will render, false otherwise.
Since
1.14

Referenced by evas_render2().

◆ evas_canvas_render2_updates()

EOAPI Eina_List* evas_canvas_render2_updates ( Eo obj)

Render the given Evas canvas using the new rendering infra.

This is experimental and will change over time until noted here.

Returns
A newly allocated list of updated rectangles of the canvas ($Eina.Rectangle structs). Free this list with evas_render_updates_free.
Since
1.15

Referenced by evas_render2_updates().

◆ evas_canvas_norender()

EOAPI void evas_canvas_norender ( Eo obj)

Update the canvas internal objects but not triggering immediate renderization.

This function updates the canvas internal objects not triggering renderization. To force renderization function evas_canvas_render should be used.

Referenced by evas_norender().

◆ evas_canvas_touch_point_list_count()

EOAPI unsigned int evas_canvas_touch_point_list_count ( Eo obj)

Get the number of touched point in the evas.

New touched point is added to the list whenever touching the evas and point is removed whenever removing touched point from the evas.

Returns
The number of touched point on the evas.

Referenced by evas_touch_point_list_count().

◆ evas_canvas_nochange_pop()

EOAPI void evas_canvas_nochange_pop ( Eo obj)

Pop the nochange flag down 1.

This tells evas, that while the nochange flag is greater than 0, do not mark objects as "changed" when making changes.

Warning
Do not use this function unless you know what Evas exactly works with "changed" state.

Referenced by evas_nochange_pop().

◆ evas_canvas_key_lock_off()

EOAPI void evas_canvas_key_lock_off ( Eo obj,
const char *  keyname 
)

Disables or turns off programmatically the lock key with name keyname.

The effect will be as if the key was put on its inactive state after this call.

See also evas_canvas_key_lock_on.

Parameters
[in]keynameThe name of the lock to disable.

Referenced by evas_key_lock_off().

◆ evas_canvas_nochange_push()

EOAPI void evas_canvas_nochange_push ( Eo obj)

Push the nochange flag up 1.

This tells evas, that while the nochange flag is greater than 0, do not mark objects as "changed" when making changes.

Warning
Do not use this function unless you know what Evas exactly works with "changed" state.

Referenced by evas_nochange_push().

◆ evas_canvas_font_hinting_can_hint()

EOAPI Eina_Bool evas_canvas_font_hinting_can_hint ( const Eo obj,
Evas_Font_Hinting_Flags  hinting 
)

Checks if the font hinting is supported by the given evas.

One of #EVAS_FONT_HINTING_NONE, #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.

Parameters
[in]hintingThe hinting to use.
Returns
true if it is supported, false otherwise.

Referenced by evas_font_hinting_can_hint().

◆ evas_canvas_object_top_at_xy_get()

EOAPI Efl_Canvas_Object* evas_canvas_object_top_at_xy_get ( const Eo obj,
Evas_Coord  x,
Evas_Coord  y,
Eina_Bool  include_pass_events_objects,
Eina_Bool  include_hidden_objects 
)

Retrieve the Evas object stacked at the top of a given position in a canvas.

This function will traverse all the layers of the given canvas, from top to bottom, querying for objects with areas covering the given position. The user can remove from the query objects which are hidden and/or which are set to pass events.

Warning
This function will skip objects parented by smart objects, acting only on the ones at the "top level", with regard to object parenting.
Parameters
[in]xThe horizontal coordinate of the position.
[in]yThe vertical coordinate of the position.
[in]include_pass_events_objectsBoolean flag to include or not objects which pass events in this calculation.
[in]include_hidden_objectsBoolean flag to include or not hidden objects in this calculation.
Returns
The Evas object that is over all other objects at the given position.

Referenced by evas_object_top_at_pointer_get(), and evas_object_top_at_xy_get().

◆ evas_canvas_key_modifier_on()

EOAPI void evas_canvas_key_modifier_on ( Eo obj,
const char *  keyname 
)

Enables or turns on programmatically the modifier key with name keyname.

The effect will be as if the key was pressed for the whole time between this call and a matching evas_key_modifier_off().

See also evas_canvas_key_modifier_off.

Parameters
[in]keynameThe name of the modifier to enable.

Referenced by evas_key_modifier_on().

◆ evas_canvas_font_available_list()

EOAPI Eina_List* evas_canvas_font_available_list ( const Eo obj)

List of available font descriptions known or found by this evas.

The list depends on Evas compile time configuration, such as fontconfig support, and the paths provided at runtime as explained in Font Path Functions.

Returns
A newly allocated list of strings. Do not change the strings. Be sure to call evas_font_available_list_free after you're done.

Referenced by evas_font_available_list().

◆ evas_canvas_object_name_find()

EOAPI Efl_Canvas_Object* evas_canvas_object_name_find ( const Eo obj,
const char *  name 
)

Retrieves the object on the given evas with the given name.

This looks for the evas object given a name by evas_object_name_set. If the name is not unique canvas-wide, then which one of the many objects with that name is returned is undefined, so only use this if you can ensure the object name is unique.

Parameters
[in]nameThe given name.
Returns
If successful, the Evas object with the given name. Otherwise, null.

Referenced by evas_object_name_find().

◆ evas_canvas_font_path_append()

EOAPI void evas_canvas_font_path_append ( Eo obj,
const char *  path 
)

Appends a font path to the list of font paths used by the given evas.

Parameters
[in]pathThe new font path.

Referenced by evas_font_path_append().

◆ evas_canvas_touch_point_list_nth_id_get()

EOAPI int evas_canvas_touch_point_list_nth_id_get ( Eo obj,
unsigned int  n 
)

This function returns the id of nth touch point.

The point which comes from Mouse Event has id 0 and The point which comes from Multi Event has id that is same as Multi Event's device id.

Parameters
[in]nThe number of the touched point (0 being the first).
Returns
id of nth touch point, if the call succeeded, -1 otherwise.

Referenced by evas_touch_point_list_nth_id_get().

◆ evas_canvas_touch_point_list_nth_xy_get()

EOAPI void evas_canvas_touch_point_list_nth_xy_get ( Eo obj,
unsigned int  n,
Evas_Coord x,
Evas_Coord y 
)

This function returns the nth touch point's coordinates.

Touch point's coordinates is updated whenever moving that point on the canvas.

Parameters
[in]nThe number of the touched point (0 being the first).
[out]xThe pointer to a Evas_Coord to be filled in.
[out]yThe pointer to a Evas_Coord to be filled in.

Referenced by evas_touch_point_list_nth_xy_get().

◆ evas_canvas_key_lock_del()

EOAPI void evas_canvas_key_lock_del ( Eo obj,
const char *  keyname 
)

Removes the keyname key from the current list of lock keys on canvas e.

Parameters
[in]keynameThe name of the key to remove from the locks list.

Referenced by evas_key_lock_del().

◆ evas_canvas_damage_rectangle_add()

EOAPI void evas_canvas_damage_rectangle_add ( Eo obj,
int  x,
int  y,
int  w,
int  h 
)

Add a damage rectangle.

This is the function by which one tells evas that a part of the canvas has to be repainted.

Note
All newly created Evas rectangles get the default color values of 255 255 255 255 (opaque white).
Parameters
[in]xThe rectangle's left position.
[in]yThe rectangle's top position.
[in]wThe rectangle's width.
[in]hThe rectangle's height.

Referenced by evas_damage_rectangle_add().

◆ evas_canvas_font_path_list()

EOAPI const Eina_List* evas_canvas_font_path_list ( const Eo obj)

Retrieves the list of font paths used by the given evas.

Returns
The list of font paths used.

Referenced by evas_font_path_list().

◆ evas_canvas_image_cache_reload()

EOAPI void evas_canvas_image_cache_reload ( Eo obj)

Reload the image cache.

This function reloads the image cache of canvas.

Referenced by evas_image_cache_reload().

◆ evas_canvas_coord_world_x_to_screen()

EOAPI int evas_canvas_coord_world_x_to_screen ( const Eo obj,
Evas_Coord  x 
)

Convert/scale a canvas coordinate into output screen coordinates.

This function takes in a horizontal coordinate as the x parameter and converts it into output units, accounting for output size, viewport size and location, returning it as the function return value. If e is invalid, the results are undefined.

Parameters
[in]xThe canvas x coordinate.
Returns
The output/screen coordinate translated to output coordinates.

Referenced by evas_coord_world_x_to_screen().

◆ evas_canvas_render_updates()

EOAPI Eina_List* evas_canvas_render_updates ( Eo obj)

Force immediate renderization of the given Evas canvas.

This function forces an immediate renderization update of the given canvas e.

Note
This is a very low level function, which most of Evas' users wouldn't care about. One would use it, for example, to grab an Evas' canvas update regions and paint them back, using the canvas' pixmap, on a displaying system working below Evas.
Evas is a stateful canvas. If no operations changing its state took place since the last rendering action, you won't see no changes and this call will be a no-op.
Returns
A newly allocated list of updated rectangles of the canvas ($Eina.Rectangle structs). Free this list with evas_render_updates_free.

Referenced by evas_render_updates().

◆ evas_canvas_image_cache_flush()

EOAPI void evas_canvas_image_cache_flush ( Eo obj)

Flush the image cache of the canvas.

This function flushes image cache of canvas.

Referenced by evas_image_cache_flush().

◆ evas_canvas_coord_screen_y_to_world()

EOAPI Evas_Coord evas_canvas_coord_screen_y_to_world ( const Eo obj,
int  y 
)

Convert/scale an output screen coordinate into canvas coordinates.

This function takes in a vertical coordinate as the y parameter and converts it into canvas units, accounting for output size, viewport size and location, returning it as the function return value. If e is invalid, the results are undefined.

Parameters
[in]yThe screen/output y coordinate.
Returns
The screen coordinate translated to canvas unit coordinates.

Referenced by evas_coord_screen_y_to_world().

◆ evas_canvas_key_modifier_del()

EOAPI void evas_canvas_key_modifier_del ( Eo obj,
const char *  keyname 
)

Removes the keyname key from the current list of modifier keys on canvas e.

See also evas_canvas_key_modifier_add.

Parameters
[in]keynameThe name of the key to remove from the modifiers list.

Referenced by evas_key_modifier_del().

◆ evas_canvas_touch_point_list_nth_state_get()

EOAPI Evas_Touch_Point_State evas_canvas_touch_point_list_nth_state_get ( Eo obj,
unsigned int  n 
)

This function returns the state of nth touch point.

The point's state is EVAS_TOUCH_POINT_DOWN when pressed, EVAS_TOUCH_POINT_STILL when the point is not moved after pressed, EVAS_TOUCH_POINT_MOVE when moved at least once after pressed and EVAS_TOUCH_POINT_UP when released.

Parameters
[in]nThe number of the touched point (0 being the first).
Returns
state of nth touch point, if the call succeeded, EVAS_TOUCH_POINT_CANCEL otherwise.

Referenced by evas_touch_point_list_nth_state_get().

◆ evas_canvas_obscured_rectangle_add()

EOAPI void evas_canvas_obscured_rectangle_add ( Eo obj,
int  x,
int  y,
int  w,
int  h 
)

Add an "obscured region" to an Evas canvas.

This is the function by which one tells an Evas canvas that a part of it must not be repainted. The region must be rectangular and its coordinates inside the canvas viewport are passed in the call. After this call, the region specified won't participate in any form in Evas' calculations and actions during its rendering updates, having its displaying content frozen as it was just after this function took place.

We call it "obscured region" because the most common use case for this rendering (partial) freeze is something else (most probably other canvas) being on top of the specified rectangular region, thus shading it completely from the user's final scene in a display. To avoid unnecessary processing, one should indicate to the obscured canvas not to bother about the non-important area.

The majority of users won't have to worry about this function, as they'll be using just one canvas in their applications, with nothing inset or on top of it in any form.

To make this region one that has to be repainted again, call the function evas_obscured_clear.

Note
This is a very low level function, which most of Evas' users wouldn't care about.
This function does not flag the canvas as having its state changed. If you want to re-render it afterwards expecting new contents, you have to add "damage" regions yourself (see evas_damage_rectangle_add).
Parameters
[in]xThe rectangle's top left corner's horizontal coordinate.
[in]yThe rectangle's top left corner's vertical coordinate.
[in]wThe rectangle's width.
[in]hThe rectangle's height.

Referenced by evas_obscured_rectangle_add().

◆ evas_canvas_render_dump()

EOAPI void evas_canvas_render_dump ( Eo obj)

Make the canvas discard as much data as possible used by the engine at runtime.

This function will unload images, delete textures and much more, where possible. You may also want to call evas_canvas_render_idle_flush immediately prior to this to perhaps discard a little more, though this function should implicitly delete most of what evas_canvas_render_idle_flush might discard too.

Referenced by evas_render_dump().

◆ evas_canvas_object_top_in_rectangle_get()

EOAPI Efl_Canvas_Object* evas_canvas_object_top_in_rectangle_get ( const Eo obj,
Evas_Coord  x,
Evas_Coord  y,
Evas_Coord  w,
Evas_Coord  h,
Eina_Bool  include_pass_events_objects,
Eina_Bool  include_hidden_objects 
)

Retrieve the Evas object stacked at the top of a given rectangular region in a canvas.

This function will traverse all the layers of the given canvas, from top to bottom, querying for objects with areas overlapping with the given rectangular region inside e. The user can remove from the query objects which are hidden and/or which are set to pass events.

Warning
This function will skip objects parented by smart objects, acting only on the ones at the "top level", with regard to object parenting.
Parameters
[in]xThe top left corner's horizontal coordinate for the rectangular region.
[in]yThe top left corner's vertical coordinate for the rectangular region.
[in]wThe width of the rectangular region.
[in]hThe height of the rectangular region.
[in]include_pass_events_objectsBoolean flag to include or not objects which pass events in this calculation.
[in]include_hidden_objectsBoolean flag to include or not hidden objects in this calculation.
Returns
The Evas object that is over all other objects at the given rectangular region.

Referenced by evas_object_top_in_rectangle_get().

◆ evas_canvas_font_path_prepend()

EOAPI void evas_canvas_font_path_prepend ( Eo obj,
const char *  path 
)

Prepends a font path to the list of font paths used by the given evas.

Parameters
[in]pathThe new font path.

Referenced by evas_font_path_prepend().

◆ evas_canvas_obscured_clear()

EOAPI void evas_canvas_obscured_clear ( Eo obj)

Remove all "obscured regions" from an Evas canvas.

This function removes all the rectangles from the obscured regions list of the canvas e. It takes obscured areas added with evas_canvas_obscured_rectangle_add and make them again a regions that have to be repainted on rendering updates.

Note
This is a very low level function, which most of Evas' users wouldn't care about.
This function does not flag the canvas as having its state changed. If you want to re-render it afterwards expecting new contents, you have to add "damage" regions yourself (see evas_canvas_damage_rectangle_add).

Referenced by evas_obscured_clear().

◆ evas_canvas_coord_screen_x_to_world()

EOAPI Evas_Coord evas_canvas_coord_screen_x_to_world ( const Eo obj,
int  x 
)

Convert/scale an output screen coordinate into canvas coordinates.

This function takes in a horizontal coordinate as the x parameter and converts it into canvas units, accounting for output size, viewport size and location, returning it as the function return value. If e is invalid, the results are undefined.

Parameters
[in]xThe screen/output x coordinate.
Returns
The screen coordinate translated to canvas unit coordinates.

Referenced by evas_coord_screen_x_to_world().

◆ evas_canvas_key_lock_add()

EOAPI void evas_canvas_key_lock_add ( Eo obj,
const char *  keyname 
)

Adds the keyname key to the current list of lock keys.

Locks are keys like caps lock, num lock or scroll lock, i.e., keys which are meant to be pressed once – toggling a binary state which is bound to it – and thus altering the behavior of all subsequently pressed keys somehow, depending on its state. Evas is so that these keys can be defined by the user.

This allows custom locks to be added to the evas system at run time. It is then possible to set and unset lock keys programmatically for other parts of the program to check and act on. Programmers using Evas would check for lock keys on key event callbacks using evas_key_lock_is_set.

Note
If the programmer instantiates the canvas by means of the ecore_evas_new() family of helper functions, Ecore will take care of registering on it all standard lock keys: "Caps_Lock", "Num_Lock", "Scroll_Lock".
Parameters
[in]keynameThe name of the key to add to the locks list.

Referenced by evas_key_lock_add().

◆ evas_canvas_render_idle_flush()

EOAPI void evas_canvas_render_idle_flush ( Eo obj)

Make the canvas discard internally cached data used for rendering.

This function flushes the arrays of delete, active and render objects. Other things it may also discard are: shared memory segments, temporary scratch buffers, cached data to avoid re-compute of that data etc.

Referenced by evas_render_idle_flush().

◆ evas_canvas_coord_world_y_to_screen()

EOAPI int evas_canvas_coord_world_y_to_screen ( const Eo obj,
Evas_Coord  y 
)

Convert/scale a canvas coordinate into output screen coordinates.

This function takes in a vertical coordinate as the x parameter and converts it into output units, accounting for output size, viewport size and location, returning it as the function return value. If e is invalid, the results are undefined.

Parameters
[in]yThe canvas y coordinate.
Returns
The output/screen coordinate translated to output coordinates.

Referenced by evas_coord_world_y_to_screen().

◆ evas_image_cache_set()

void evas_image_cache_set ( Evas_Canvas *  obj,
int  size 
)

Set the image cache.

This function sets the image cache of canvas in bytes.

Parameters
[in]sizeThe cache size.

References evas_canvas_image_cache_set().

Referenced by ethumb_dup().

◆ evas_image_cache_get()

int evas_image_cache_get ( const Evas_Canvas *  obj)

Get the image cache.

This function returns the image cache size of canvas in bytes.

Returns
The cache size.

References evas_canvas_image_cache_get().

◆ evas_event_default_flags_set()

void evas_event_default_flags_set ( Evas_Canvas *  obj,
Efl_Event_Flags  flags 
)

Set the default set of flags an event begins with.

Events in evas can have an event_flags member. This starts out with and initial value (no flags). This lets you set the default flags that an event begins with to be flags.

Parameters
[in]flagsThe default flags to use.
Since
1.2

References evas_canvas_event_default_flags_set().

Referenced by evas_event_feed_mouse_up().

◆ evas_event_default_flags_get()

Efl_Event_Flags evas_event_default_flags_get ( const Evas_Canvas *  obj)

Get the default set of flags an event begins with.

This gets the default event flags events are produced with when fed in.

Returns
The default flags to use.
Since
1.2

References evas_canvas_event_default_flags_get().

Referenced by evas_event_feed_mouse_up().

◆ evas_font_cache_set()

void evas_font_cache_set ( Evas_Canvas *  obj,
int  size 
)

Changes the size of font cache of the given evas.

Parameters
[in]sizeThe size in bytes.

References evas_canvas_font_cache_set().

Referenced by ethumb_dup().

◆ evas_font_cache_get()

int evas_font_cache_get ( const Evas_Canvas *  obj)

Get the size of font cache of the given evas in bytes.

Returns
The size in bytes.

References evas_canvas_font_cache_get().

◆ evas_data_attach_set()

void evas_data_attach_set ( Evas_Canvas *  obj,
void *  data 
)

Attaches a specific pointer to the evas for fetching later.

Parameters
[in]dataThe attached pointer.

References evas_canvas_data_attach_set().

◆ evas_data_attach_get()

void* evas_data_attach_get ( const Evas_Canvas *  obj)

Returns the pointer attached by evas_data_attach_set.

Returns
The attached pointer.

References evas_canvas_data_attach_get().

Referenced by ecore_evas_ecore_evas_get().

◆ evas_font_hinting_set()

void evas_font_hinting_set ( Evas_Canvas *  obj,
Evas_Font_Hinting_Flags  hinting 
)

Changes the font hinting for the given evas.

#EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.

Parameters
[in]hintingThe used hinting, one of #EVAS_FONT_HINTING_NONE, #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.

References evas_canvas_font_hinting_set().

Referenced by elm_config_font_hint_type_set().

◆ evas_font_hinting_get()

Evas_Font_Hinting_Flags evas_font_hinting_get ( const Evas_Canvas *  obj)

Retrieves the font hinting used by the given evas.

Returns
The used hinting, one of #EVAS_FONT_HINTING_NONE, #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.

References evas_canvas_font_hinting_get().

◆ evas_engine_info_set()

Eina_Bool evas_engine_info_set ( Evas_Canvas *  obj,
Evas_Engine_Info info 
)

Applies the engine settings for the given evas from the given Evas_Engine_Info structure.

To get the Evas_Engine_Info structure to use, call evas_engine_info_get. Do not try to obtain a pointer to an Evas_Engine_Info structure in any other way.

You will need to call this function at least once before you can create objects on an evas or render that evas. Some engines allow their settings to be changed more than once.

Once called, the info pointer should be considered invalid.

Parameters
[in]infoThe pointer to the engine info to use.
Returns
true if no error occurred, false otherwise.

References evas_canvas_engine_info_set().

◆ evas_engine_info_get()

Evas_Engine_Info* evas_engine_info_get ( const Evas_Canvas *  obj)

Retrieves the current render engine info struct from the given evas.

The returned structure is publicly modifiable. The contents are valid until either evas_engine_info_set or evas_render are called.

This structure does not need to be freed by the caller.

Returns
The pointer to the engine info to use.

References evas_canvas_engine_info_get().

◆ evas_focus_get()

Efl_Canvas_Object* evas_focus_get ( const Evas_Canvas *  obj)

Retrieve the object that currently has focus.

Evas can have (at most) one of its objects focused at a time. Focused objects will be the ones having key events delivered to, which the programmer can act upon by means of evas_object_event_callback_add usage.

Note
Most users wouldn't be dealing directly with Evas' focused objects. Instead, they would be using a higher level library for that (like a toolkit, as Elementary) to handle focus and who's receiving input for them.

This call returns the object that currently has focus on the canvas e or null, if none.

See also evas_object_focus_set, evas_object_focus_get, evas_object_key_grab, evas_object_key_ungrab.

Returns
The object that has focus or null if there is not one.

References evas_canvas_focus_get().

◆ evas_object_top_get()

Efl_Canvas_Object* evas_object_top_get ( const Evas_Canvas *  obj)

Get the highest (stacked) Evas object on the canvas e.

This function will take all populated layers in the canvas into account, getting the highest object for the highest layer, naturally.

Warning
This function will skip objects parented by smart objects, acting only on the ones at the "top level", with regard to object parenting.

See also evas_object_layer_get, evas_object_layer_set, evas_object_below_get, evas_object_above_get.

Returns
A pointer to the highest object on it (if any) or null otherwise.

References evas_canvas_object_top_get().

◆ evas_key_lock_get()

const Evas_Lock* evas_key_lock_get ( const Evas_Canvas *  obj)

Returns a handle to the list of lock keys registered in the canvas e.

This is required to check for which locks are set at a given time with the evas_key_lock_is_set function.

Returns
An Evas_Lock handle to query Evas' keys subsystem with evas_key_lock_is_set, or null on error.

References evas_canvas_key_lock_get().

◆ evas_pointer_canvas_xy_get()

void evas_pointer_canvas_xy_get ( const Evas_Canvas *  obj,
Evas_Coord x,
Evas_Coord y 
)

This function returns the current known pointer coordinates.

This function returns the current known canvas unit coordinates of the mouse pointer and sets the contents of the Evas_Coords pointed to by x and y to contain these coordinates. If e is not a valid canvas the results of this function are undefined.

Parameters
[out]xThe pointer to a Evas_Coord to be filled in.
[out]yThe pointer to a Evas_Coord to be filled in.

References evas_canvas_pointer_canvas_xy_get().

Referenced by elm_drop_item_container_add().

◆ evas_event_down_count_get()

int evas_event_down_count_get ( const Evas_Canvas *  obj)

Get the number of mouse or multi presses currently active.

Since
1.2

References evas_canvas_event_down_count_get().

◆ evas_smart_objects_calculate_count_get()

int evas_smart_objects_calculate_count_get ( const Evas_Canvas *  obj)

This gets the internal counter that counts the number of smart calculations.

Whenever evas performs smart object calculations on the whole canvas it increments a counter by 1. This is the smart object calculate counter that this function returns the value of. It starts at the value of 0 and will increase (and eventually wrap around to negative values and so on) by 1 every time objects are calculated. You can use this counter to ensure you don't re-do calculations withint the same calculation generation/run if the calculations maybe cause self-feeding effects.

Since
1.1

References evas_canvas_smart_objects_calculate_count_get().

◆ evas_changed_get()

Eina_Bool evas_changed_get ( const Evas_Canvas *  obj)

Get the changed marker for the canvas.

Since
1.11

References evas_canvas_changed_get().

◆ evas_pointer_output_xy_get()

void evas_pointer_output_xy_get ( const Evas_Canvas *  obj,
int *  x,
int *  y 
)

This function returns the current known pointer coordinates.

This function returns the current known screen/output coordinates of the mouse pointer and sets the contents of the integers pointed to by x and y to contain these coordinates. If e is not a valid canvas the results of this function are undefined.

Parameters
[out]xThe pointer to an integer to be filled in.
[out]yThe pointer to an integer to be filled in.

References evas_canvas_pointer_output_xy_get().

◆ evas_pointer_inside_get()

Eina_Bool evas_pointer_inside_get ( const Evas_Canvas *  obj)

Returns whether the mouse pointer is logically inside the canvas.

When this function is called it will return a value of either false or true, depending on if event_feed_mouse_in or event_feed_mouse_out have been called to feed in a mouse enter event into the canvas.

A return value of true indicates the mouse is logically inside the canvas, and false implies it is logically outside the canvas.

A canvas begins with the mouse being assumed outside ($false).

If e is not a valid canvas, the return value is undefined.

References evas_canvas_pointer_inside_get().

◆ evas_image_max_size_get()

Eina_Bool evas_image_max_size_get ( const Evas_Canvas *  obj,
int *  maxw,
int *  maxh 
)

Get the maximum image size evas can possibly handle.

This function returns the largest image or surface size that evas can handle in pixels, and if there is one, returns true. It returns false if no extra constraint on maximum image size exists. You still should check the return values of maxw and maxh as there may still be a limit, just a much higher one.

Parameters
[out]maxwPointer to hold the return value in pixels of the maximum width.
[out]maxhPointer to hold the return value in pixels of the maximum height.
Since
1.1

References evas_canvas_image_max_size_get().

◆ evas_object_bottom_get()

Efl_Canvas_Object* evas_object_bottom_get ( const Evas_Canvas *  obj)

Get the lowest (stacked) Evas object on the canvas e.

This function will take all populated layers in the canvas into account, getting the lowest object for the lowest layer, naturally.

Warning
This function will skip objects parented by smart objects, acting only on the ones at the "top level", with regard to object parenting.

See also evas_object_layer_get, evas_object_layer_set, evas_object_below_get, evas_object_below_set.

Returns
A pointer to the lowest object on it, if any, or null otherwise.

References evas_canvas_object_bottom_get().

◆ evas_key_modifier_get()

const Evas_Modifier* evas_key_modifier_get ( const Evas_Canvas *  obj)

Returns a handle to the list of modifier keys registered in the canvas e.

This is required to check for which modifiers are set at a given time with the evas_key_modifier_is_set function.

See also evas_key_modifier_add, evas_key_modifier_del, evas_key_modifier_on, evas_key_modifier_off.

Returns
An Evas_Modifier handle to query Evas' keys subsystem with evas_key_modifier_is_set, or null on error.

References evas_canvas_key_modifier_get().

◆ evas_pointer_button_down_mask_get()

unsigned int evas_pointer_button_down_mask_get ( const Evas_Canvas *  obj)

Returns a bitmask with the mouse buttons currently pressed, set to 1.

Calling this function will return a 32-bit integer with the appropriate bits set to 1 that correspond to a mouse button being depressed. This limits Evas to a mouse devices with a maximum of 32 buttons, but that is generally in excess of any host system's pointing device abilities.

A canvas by default begins with no mouse buttons being pressed and only pointer move events can alter that.

The least significant bit corresponds to the first mouse button (button 1) and the most significant bit corresponds to the last mouse button (button 32).

If e is not a valid canvas, the return value is undefined.

Returns
A bitmask of the currently depressed buttons on the canvas.

References evas_canvas_pointer_button_down_mask_get().

◆ evas_tree_objects_at_xy_get()

Eina_List* evas_tree_objects_at_xy_get ( Evas_Canvas *  obj,
Efl_Canvas_Object *  stop,
int  x,
int  y 
)

Retrieve a list of Evas objects lying over a given position in a canvas.

This function will traverse all the layers of the given canvas, from top to bottom, querying for objects with areas covering the given position. It will enter the smart objects. It will not append to the list pass events as hidden objects. Call eina_list_free on the returned list after usage.

Parameters
[in]stopAn Evas Object where to stop searching.
[in]xThe horizontal coordinate of the position.
[in]yThe vertical coordinate of the position.

References evas_canvas_tree_objects_at_xy_get().

◆ evas_key_lock_on()

void evas_key_lock_on ( Evas_Canvas *  obj,
const char *  keyname 
)

Enables or turns on programmatically the lock key with name keyname.

The effect will be as if the key was put on its active state after this call.

See also evas_key_lock_add, evas_key_lock_del, evas_key_lock_del, evas_key_lock_off.

Parameters
[in]keynameThe name of the lock to enable.

References evas_canvas_key_lock_on().

◆ evas_key_modifier_mask_get()

Evas_Modifier_Mask evas_key_modifier_mask_get ( const Evas_Canvas *  obj,
const char *  keyname 
)

Creates a bit mask from the keyname modifier key.

Values returned from different calls to it may be ORed together, naturally.

This function is meant to be using in conjunction with evas_object_key_grab/@ref evas_object_key_ungrab. Go check their documentation for more information.

See also evas_key_modifier_add, evas_key_modifier_get, evas_key_modifier_on, evas_key_modifier_off, evas_key_modifier_is_set.

Parameters
[in]keynameThe name of the modifier key to create the mask for.
Returns
The bit mask or 0 if the keyname key wasn't registered as a modifier for canvas e.

References evas_canvas_key_modifier_mask_get().

◆ evas_key_modifier_add()

void evas_key_modifier_add ( Evas_Canvas *  obj,
const char *  keyname 
)

Adds the keyname key to the current list of modifier keys.

Modifiers are keys like shift, alt and ctrl, i.e., keys which are meant to be pressed together with others, altering the behavior of the secondly pressed keys somehow. Evas is so that these keys can be user defined.

This call allows custom modifiers to be added to the Evas system at run time. It is then possible to set and unset modifier keys programmatically for other parts of the program to check and act on. Programmers using Evas would check for modifier keys on key event callbacks using evas_key_modifier_is_set.

Note
If the programmer instantiates the canvas by means of the ecore_evas_new family of helper functions, Ecore will take care of registering on it all standard modifiers: "Shift", "Control", "Alt", "Meta", "Hyper", "Super".
Parameters
[in]keynameThe name of the modifier key to add to the list of Evas modifiers.

References evas_canvas_key_modifier_add().

◆ evas_key_modifier_off()

void evas_key_modifier_off ( Evas_Canvas *  obj,
const char *  keyname 
)

Disables or turns off programmatically the modifier key with name keyname.

See also evas_key_modifier_add, evas_key_modifier_get, evas_key_modifier_on, evas_key_modifier_mask_get, evas_key_modifier_is_set.

Parameters
[in]keynameThe name of the modifier to disable.

References evas_canvas_key_modifier_off().

◆ evas_objects_at_xy_get()

Eina_List* evas_objects_at_xy_get ( const Evas_Canvas *  obj,
Evas_Coord  x,
Evas_Coord  y,
Eina_Bool  include_pass_events_objects,
Eina_Bool  include_hidden_objects 
)

Retrieve a list of Evas objects lying over a given position in a canvas.

This function will traverse all the layers of the given canvas, from top to bottom, querying for objects with areas covering the given position. The user can remove from query objects which are hidden and/or which are set to pass events.

Warning
This function will skip objects parented by smart objects, acting only on the ones at the "top level", with regard to object parenting.
Parameters
[in]xThe horizontal coordinate of the position.
[in]yThe vertical coordinate of the position.
[in]include_pass_events_objectsBoolean flag to include or not objects which pass events in this calculation.
[in]include_hidden_objectsBoolean flag to include or not hidden objects in this calculation.
Returns
The list of Evas objects that are over the given position in e.

References evas_canvas_objects_at_xy_get().

◆ evas_render_async()

Eina_Bool evas_render_async ( Evas_Canvas *  obj)

Render the given Evas canvas asynchronously.

This function only returns true when a frame will be rendered. If the previous frame is still rendering, false will be returned so the users know not to wait for the updates callback and just return to their main loop.

If a func callback is given, a list of updated areas will be generated and the function will be called from the main thread after the rendered frame is flushed to the screen. The resulting list should be freed with evas_render_updates_free.

The list is given in the event_info parameter of the callback function.

Returns
true if the canvas will render, false otherwise.
Since
1.8

References evas_canvas_render_async().

◆ evas_render2()

Eina_Bool evas_render2 ( Evas_Canvas *  obj)

Render the given Evas canvas using the new rendering infra.

This is experimental and will change over time until noted here.

This function only returns true when a frame will be rendered. If the previous frame is still rendering, false will be returned so the users know not to wait for the updates callback and just return to their main loop.

Returns
true if the canvas will render, false otherwise.
Since
1.14

References evas_canvas_render2().

◆ evas_render2_updates()

Eina_List* evas_render2_updates ( Evas_Canvas *  obj)

Render the given Evas canvas using the new rendering infra.

This is experimental and will change over time until noted here.

Returns
A newly allocated list of updated rectangles of the canvas ($Eina.Rectangle structs). Free this list with evas_render_updates_free.
Since
1.15

References evas_canvas_render2_updates().

◆ evas_norender()

void evas_norender ( Evas_Canvas *  obj)

Update the canvas internal objects but not triggering immediate renderization.

This function updates the canvas internal objects not triggering renderization. To force renderization function evas_render should be used.

References evas_canvas_norender().

◆ evas_touch_point_list_count()

unsigned int evas_touch_point_list_count ( Evas_Canvas *  obj)

Get the number of touched point in the evas.

New touched point is added to the list whenever touching the evas and point is removed whenever removing touched point from the evas.

Returns
The number of touched point on the evas.

References evas_canvas_touch_point_list_count().

◆ evas_nochange_pop()

void evas_nochange_pop ( Evas_Canvas *  obj)

Pop the nochange flag down 1.

This tells evas, that while the nochange flag is greater than 0, do not mark objects as "changed" when making changes.

Warning
Do not use this function unless you know what Evas exactly works with "changed" state.

References evas_canvas_nochange_pop().

◆ evas_key_lock_off()

void evas_key_lock_off ( Evas_Canvas *  obj,
const char *  keyname 
)

Disables or turns off programmatically the lock key with name keyname.

The effect will be as if the key was put on its inactive state after this call.

See also evas_key_lock_on.

Parameters
[in]keynameThe name of the lock to disable.

References evas_canvas_key_lock_off().

◆ evas_nochange_push()

void evas_nochange_push ( Evas_Canvas *  obj)

Push the nochange flag up 1.

This tells evas, that while the nochange flag is greater than 0, do not mark objects as "changed" when making changes.

Warning
Do not use this function unless you know what Evas exactly works with "changed" state.

References evas_canvas_nochange_push().

◆ evas_font_hinting_can_hint()

Eina_Bool evas_font_hinting_can_hint ( const Evas_Canvas *  obj,
Evas_Font_Hinting_Flags  hinting 
)

Checks if the font hinting is supported by the given evas.

One of #EVAS_FONT_HINTING_NONE, #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.

Parameters
[in]hintingThe hinting to use.
Returns
true if it is supported, false otherwise.

References evas_canvas_font_hinting_can_hint().

◆ evas_object_top_at_xy_get()

Efl_Canvas_Object* evas_object_top_at_xy_get ( const Evas_Canvas *  obj,
Evas_Coord  x,
Evas_Coord  y,
Eina_Bool  include_pass_events_objects,
Eina_Bool  include_hidden_objects 
)

Retrieve the Evas object stacked at the top of a given position in a canvas.

This function will traverse all the layers of the given canvas, from top to bottom, querying for objects with areas covering the given position. The user can remove from the query objects which are hidden and/or which are set to pass events.

Warning
This function will skip objects parented by smart objects, acting only on the ones at the "top level", with regard to object parenting.
Parameters
[in]xThe horizontal coordinate of the position.
[in]yThe vertical coordinate of the position.
[in]include_pass_events_objectsBoolean flag to include or not objects which pass events in this calculation.
[in]include_hidden_objectsBoolean flag to include or not hidden objects in this calculation.
Returns
The Evas object that is over all other objects at the given position.

References evas_canvas_object_top_at_xy_get().

◆ evas_key_modifier_on()

void evas_key_modifier_on ( Evas_Canvas *  obj,
const char *  keyname 
)

Enables or turns on programmatically the modifier key with name keyname.

The effect will be as if the key was pressed for the whole time between this call and a matching evas_key_modifier_off().

See also evas_key_modifier_off.

Parameters
[in]keynameThe name of the modifier to enable.

References evas_canvas_key_modifier_on().

◆ evas_font_available_list()

Eina_List* evas_font_available_list ( const Evas_Canvas *  obj)

List of available font descriptions known or found by this evas.

The list depends on Evas compile time configuration, such as fontconfig support, and the paths provided at runtime as explained in Font Path Functions.

Returns
A newly allocated list of strings. Do not change the strings. Be sure to call evas_font_available_list_free after you're done.

References evas_canvas_font_available_list().

◆ evas_object_name_find()

Efl_Canvas_Object* evas_object_name_find ( const Evas_Canvas *  obj,
const char *  name 
)

Retrieves the object on the given evas with the given name.

This looks for the evas object given a name by evas_object_name_set. If the name is not unique canvas-wide, then which one of the many objects with that name is returned is undefined, so only use this if you can ensure the object name is unique.

Parameters
[in]nameThe given name.
Returns
If successful, the Evas object with the given name. Otherwise, null.

References evas_canvas_object_name_find().

Referenced by edje_evas_global_perspective_get(), and edje_perspective_global_set().

◆ evas_font_path_append()

void evas_font_path_append ( Evas_Canvas *  obj,
const char *  path 
)

Appends a font path to the list of font paths used by the given evas.

Parameters
[in]pathThe new font path.

References evas_canvas_font_path_append().

◆ evas_touch_point_list_nth_id_get()

int evas_touch_point_list_nth_id_get ( Evas_Canvas *  obj,
unsigned int  n 
)

This function returns the id of nth touch point.

The point which comes from Mouse Event has id 0 and The point which comes from Multi Event has id that is same as Multi Event's device id.

Parameters
[in]nThe number of the touched point (0 being the first).
Returns
id of nth touch point, if the call succeeded, -1 otherwise.

References evas_canvas_touch_point_list_nth_id_get().

◆ evas_touch_point_list_nth_xy_get()

void evas_touch_point_list_nth_xy_get ( Evas_Canvas *  obj,
unsigned int  n,
Evas_Coord x,
Evas_Coord y 
)

This function returns the nth touch point's coordinates.

Touch point's coordinates is updated whenever moving that point on the canvas.

Parameters
[in]nThe number of the touched point (0 being the first).
[out]xThe pointer to a Evas_Coord to be filled in.
[out]yThe pointer to a Evas_Coord to be filled in.

References evas_canvas_touch_point_list_nth_xy_get().

◆ evas_key_lock_del()

void evas_key_lock_del ( Evas_Canvas *  obj,
const char *  keyname 
)

Removes the keyname key from the current list of lock keys on canvas e.

Parameters
[in]keynameThe name of the key to remove from the locks list.

References evas_canvas_key_lock_del().

Referenced by evas_key_lock_is_set().

◆ evas_damage_rectangle_add()

void evas_damage_rectangle_add ( Evas_Canvas *  obj,
int  x,
int  y,
int  w,
int  h 
)

Add a damage rectangle.

This is the function by which one tells evas that a part of the canvas has to be repainted.

Note
All newly created Evas rectangles get the default color values of 255 255 255 255 (opaque white).
Parameters
[in]xThe rectangle's left position.
[in]yThe rectangle's top position.
[in]wThe rectangle's width.
[in]hThe rectangle's height.

References evas_canvas_damage_rectangle_add().

Referenced by ecore_evas_rotation_set(), and ecore_evas_rotation_with_resize_set().

◆ evas_font_path_list()

const Eina_List* evas_font_path_list ( const Evas_Canvas *  obj)

Retrieves the list of font paths used by the given evas.

Returns
The list of font paths used.

References evas_canvas_font_path_list().

◆ evas_image_cache_reload()

void evas_image_cache_reload ( Evas_Canvas *  obj)

Reload the image cache.

This function reloads the image cache of canvas.

References evas_canvas_image_cache_reload().

◆ evas_coord_world_x_to_screen()

int evas_coord_world_x_to_screen ( const Evas_Canvas *  obj,
Evas_Coord  x 
)

Convert/scale a canvas coordinate into output screen coordinates.

This function takes in a horizontal coordinate as the x parameter and converts it into output units, accounting for output size, viewport size and location, returning it as the function return value. If e is invalid, the results are undefined.

Parameters
[in]xThe canvas x coordinate.
Returns
The output/screen coordinate translated to output coordinates.

References evas_canvas_coord_world_x_to_screen().

◆ evas_render_updates()

Eina_List* evas_render_updates ( Evas_Canvas *  obj)

Force immediate renderization of the given Evas canvas.

This function forces an immediate renderization update of the given canvas e.

Note
This is a very low level function, which most of Evas' users wouldn't care about. One would use it, for example, to grab an Evas' canvas update regions and paint them back, using the canvas' pixmap, on a displaying system working below Evas.
Evas is a stateful canvas. If no operations changing its state took place since the last rendering action, you won't see no changes and this call will be a no-op.
Returns
A newly allocated list of updated rectangles of the canvas ($Eina.Rectangle structs). Free this list with evas_render_updates_free.

References evas_canvas_render_updates().

◆ evas_image_cache_flush()

void evas_image_cache_flush ( Evas_Canvas *  obj)

Flush the image cache of the canvas.

This function flushes image cache of canvas.

References evas_canvas_image_cache_flush().

Referenced by elm_cache_all_flush().

◆ evas_coord_screen_y_to_world()

Evas_Coord evas_coord_screen_y_to_world ( const Evas_Canvas *  obj,
int  y 
)

Convert/scale an output screen coordinate into canvas coordinates.

This function takes in a vertical coordinate as the y parameter and converts it into canvas units, accounting for output size, viewport size and location, returning it as the function return value. If e is invalid, the results are undefined.

Parameters
[in]yThe screen/output y coordinate.
Returns
The screen coordinate translated to canvas unit coordinates.

References evas_canvas_coord_screen_y_to_world().

◆ evas_key_modifier_del()

void evas_key_modifier_del ( Evas_Canvas *  obj,
const char *  keyname 
)

Removes the keyname key from the current list of modifier keys on canvas e.

See also evas_key_modifier_add.

Parameters
[in]keynameThe name of the key to remove from the modifiers list.

References evas_canvas_key_modifier_del().

Referenced by evas_key_lock_is_set().

◆ evas_touch_point_list_nth_state_get()

Evas_Touch_Point_State evas_touch_point_list_nth_state_get ( Evas_Canvas *  obj,
unsigned int  n 
)

This function returns the state of nth touch point.

The point's state is EVAS_TOUCH_POINT_DOWN when pressed, EVAS_TOUCH_POINT_STILL when the point is not moved after pressed, EVAS_TOUCH_POINT_MOVE when moved at least once after pressed and EVAS_TOUCH_POINT_UP when released.

Parameters
[in]nThe number of the touched point (0 being the first).
Returns
state of nth touch point, if the call succeeded, EVAS_TOUCH_POINT_CANCEL otherwise.

References evas_canvas_touch_point_list_nth_state_get().

◆ evas_obscured_rectangle_add()

void evas_obscured_rectangle_add ( Evas_Canvas *  obj,
int  x,
int  y,
int  w,
int  h 
)

Add an "obscured region" to an Evas canvas.

This is the function by which one tells an Evas canvas that a part of it must not be repainted. The region must be rectangular and its coordinates inside the canvas viewport are passed in the call. After this call, the region specified won't participate in any form in Evas' calculations and actions during its rendering updates, having its displaying content frozen as it was just after this function took place.

We call it "obscured region" because the most common use case for this rendering (partial) freeze is something else (most probably other canvas) being on top of the specified rectangular region, thus shading it completely from the user's final scene in a display. To avoid unnecessary processing, one should indicate to the obscured canvas not to bother about the non-important area.

The majority of users won't have to worry about this function, as they'll be using just one canvas in their applications, with nothing inset or on top of it in any form.

To make this region one that has to be repainted again, call the function evas_obscured_clear.

Note
This is a very low level function, which most of Evas' users wouldn't care about.
This function does not flag the canvas as having its state changed. If you want to re-render it afterwards expecting new contents, you have to add "damage" regions yourself (see evas_damage_rectangle_add).
Parameters
[in]xThe rectangle's top left corner's horizontal coordinate.
[in]yThe rectangle's top left corner's vertical coordinate.
[in]wThe rectangle's width.
[in]hThe rectangle's height.

References evas_canvas_obscured_rectangle_add().

◆ evas_render_dump()

void evas_render_dump ( Evas_Canvas *  obj)

Make the canvas discard as much data as possible used by the engine at runtime.

This function will unload images, delete textures and much more, where possible. You may also want to call evas_render_idle_flush immediately prior to this to perhaps discard a little more, though this function should implicitly delete most of what evas_render_idle_flush might discard too.

References evas_canvas_render_dump().

Referenced by elm_cache_all_flush().

◆ evas_object_top_in_rectangle_get()

Efl_Canvas_Object* evas_object_top_in_rectangle_get ( const Evas_Canvas *  obj,
Evas_Coord  x,
Evas_Coord  y,
Evas_Coord  w,
Evas_Coord  h,
Eina_Bool  include_pass_events_objects,
Eina_Bool  include_hidden_objects 
)

Retrieve the Evas object stacked at the top of a given rectangular region in a canvas.

This function will traverse all the layers of the given canvas, from top to bottom, querying for objects with areas overlapping with the given rectangular region inside e. The user can remove from the query objects which are hidden and/or which are set to pass events.

Warning
This function will skip objects parented by smart objects, acting only on the ones at the "top level", with regard to object parenting.
Parameters
[in]xThe top left corner's horizontal coordinate for the rectangular region.
[in]yThe top left corner's vertical coordinate for the rectangular region.
[in]wThe width of the rectangular region.
[in]hThe height of the rectangular region.
[in]include_pass_events_objectsBoolean flag to include or not objects which pass events in this calculation.
[in]include_hidden_objectsBoolean flag to include or not hidden objects in this calculation.
Returns
The Evas object that is over all other objects at the given rectangular region.

References evas_canvas_object_top_in_rectangle_get().

◆ evas_font_path_prepend()

void evas_font_path_prepend ( Evas_Canvas *  obj,
const char *  path 
)

Prepends a font path to the list of font paths used by the given evas.

Parameters
[in]pathThe new font path.

References evas_canvas_font_path_prepend().

◆ evas_obscured_clear()

void evas_obscured_clear ( Evas_Canvas *  obj)

Remove all "obscured regions" from an Evas canvas.

This function removes all the rectangles from the obscured regions list of the canvas e. It takes obscured areas added with evas_obscured_rectangle_add and make them again a regions that have to be repainted on rendering updates.

Note
This is a very low level function, which most of Evas' users wouldn't care about.
This function does not flag the canvas as having its state changed. If you want to re-render it afterwards expecting new contents, you have to add "damage" regions yourself (see evas_damage_rectangle_add).

References evas_canvas_obscured_clear().

◆ evas_coord_screen_x_to_world()

Evas_Coord evas_coord_screen_x_to_world ( const Evas_Canvas *  obj,
int  x 
)

Convert/scale an output screen coordinate into canvas coordinates.

This function takes in a horizontal coordinate as the x parameter and converts it into canvas units, accounting for output size, viewport size and location, returning it as the function return value. If e is invalid, the results are undefined.

Parameters
[in]xThe screen/output x coordinate.
Returns
The screen coordinate translated to canvas unit coordinates.

References evas_canvas_coord_screen_x_to_world().

◆ evas_key_lock_add()

void evas_key_lock_add ( Evas_Canvas *  obj,
const char *  keyname 
)

Adds the keyname key to the current list of lock keys.

Locks are keys like caps lock, num lock or scroll lock, i.e., keys which are meant to be pressed once – toggling a binary state which is bound to it – and thus altering the behavior of all subsequently pressed keys somehow, depending on its state. Evas is so that these keys can be defined by the user.

This allows custom locks to be added to the evas system at run time. It is then possible to set and unset lock keys programmatically for other parts of the program to check and act on. Programmers using Evas would check for lock keys on key event callbacks using evas_key_lock_is_set.

Note
If the programmer instantiates the canvas by means of the ecore_evas_new() family of helper functions, Ecore will take care of registering on it all standard lock keys: "Caps_Lock", "Num_Lock", "Scroll_Lock".
Parameters
[in]keynameThe name of the key to add to the locks list.

References evas_canvas_key_lock_add().

◆ evas_render_idle_flush()

void evas_render_idle_flush ( Evas_Canvas *  obj)

Make the canvas discard internally cached data used for rendering.

This function flushes the arrays of delete, active and render objects. Other things it may also discard are: shared memory segments, temporary scratch buffers, cached data to avoid re-compute of that data etc.

References evas_canvas_render_idle_flush().

Referenced by evas_free().

◆ evas_coord_world_y_to_screen()

int evas_coord_world_y_to_screen ( const Evas_Canvas *  obj,
Evas_Coord  y 
)

Convert/scale a canvas coordinate into output screen coordinates.

This function takes in a vertical coordinate as the x parameter and converts it into output units, accounting for output size, viewport size and location, returning it as the function return value. If e is invalid, the results are undefined.

Parameters
[in]yThe canvas y coordinate.
Returns
The output/screen coordinate translated to output coordinates.

References evas_canvas_coord_world_y_to_screen().

◆ evas_render_updates_free()

void evas_render_updates_free ( Eina_List updates)

Free the rectangles returned by evas_render_updates().

Parameters
updatesThe list of updated rectangles of the canvas.

This function removes the region from the render updates list. It makes the region doesn't be render updated anymore.

See also
evas_render_updates() for an example

References eina_array_clean(), eina_array_foreach(), eina_array_push(), EINA_COW_WRITE_BEGIN, EINA_COW_WRITE_END, eina_evlog(), EINA_FALSE, EINA_INLIST_FOREACH, eina_list_append(), EINA_LIST_FREE, eina_rectangle_free(), eina_spinlock_release(), eina_spinlock_take(), EINA_TRUE, and eo_data_scope_get().

◆ evas_new()

Evas* evas_new ( void  )

Creates a new empty evas.

Note that before you can use the evas, you will to at a minimum:

This function should only fail if the memory allocation fails

Note
this function is very low level. Instead of using it directly, consider using the high level functions in Ecore_Evas wrapper/helper set of functions such as ecore_evas_new(). See Ecore.
Attention
it is recommended that one calls evas_init() before creating new canvas.
Returns
A new uninitialised Evas canvas on success. Otherwise, NULL.

References eo_add.

◆ evas_free()

void evas_free ( Evas e)

Frees the given evas and any objects created on it.

Any objects with 'free' callbacks will have those callbacks called in this function.

Parameters
eThe given evas.

References eina_array_flush(), EINA_FALSE, eina_hash_free(), EINA_INLIST_FOREACH, eina_list_append(), eina_list_free(), EINA_LIST_FREE, eina_lock_free(), eina_rectangle_free(), eina_spinlock_free(), EINA_TRUE, eo_ref(), eo_ref_get(), eo_unref(), ERR, evas_font_path_clear(), and evas_render_idle_flush().

Referenced by evas_object_image_extension_can_load_fast_get().

◆ evas_output_framespace_set()

void evas_output_framespace_set ( Evas e,
Evas_Coord  x,
Evas_Coord  y,
Evas_Coord  w,
Evas_Coord  h 
)

Sets the output framespace size of the render engine of the given evas.

The framespace size is used in the Wayland engines to denote space in the viewport which is occupied by the window frame. This is mainly used in ecore_evas to draw borders.

The units used for w and h depend on the engine used by the evas.

Parameters
[in]xThe left coordinate in output units, usually pixels.
[in]yThe top coordinate in output units, usually pixels.
[in]wThe width in output units, usually pixels.
[in]hThe height in output units, usually pixels.
Since
1.1

References eo_data_scope_get().

◆ evas_output_framespace_get()

void evas_output_framespace_get ( const Evas e,
Evas_Coord x,
Evas_Coord y,
Evas_Coord w,
Evas_Coord h 
)

Get the render engine's output framespace coordinates in canvas units.

Parameters
[out]xThe left coordinate in output units, usually pixels.
[out]yThe top coordinate in output units, usually pixels.
[out]wThe width in output units, usually pixels.
[out]hThe height in output units, usually pixels.
Since
1.1

References eo_data_scope_get().

Referenced by ecore_evas_ews_background_set().

◆ evas_output_viewport_set()

void evas_output_viewport_set ( Evas e,
Evas_Coord  x,
Evas_Coord  y,
Evas_Coord  w,
Evas_Coord  h 
)

Sets the output viewport of the given evas in evas units.

The output viewport is the area of the evas that will be visible to the viewer. The viewport will be stretched to fit the output target of the evas when rendering is performed.

Note
The coordinate values do not have to map 1-to-1 with the output target. However, it is generally advised that it is done for ease of use.
Parameters
[in]xThe top-left corner x value of the viewport.
[in]yThe top-left corner y value of the viewport.
[in]wThe width of the viewport. Must be greater than 0.
[in]hThe height of the viewport. Must be greater than 0.

References eo_data_scope_get(), ERR, and EVAS_CALLBACK_CANVAS_VIEWPORT_RESIZE.

◆ evas_output_viewport_get()

void evas_output_viewport_get ( const Evas e,
Evas_Coord x,
Evas_Coord y,
Evas_Coord w,
Evas_Coord h 
)

Get the render engine's output viewport coordinates in canvas units.

Calling this function writes the current canvas output viewport size and location values into the variables pointed to by x, y, w and h. On success the variables have the output location and size values written to them in canvas units. Any of x, y, w or h that are null will not be written to. If e is invalid, the results are undefined.

Parameters
[out]xThe top-left corner x value of the viewport.
[out]yThe top-left corner y value of the viewport.
[out]wThe width of the viewport. Must be greater than 0.
[out]hThe height of the viewport. Must be greater than 0.

References eo_data_scope_get().

Referenced by ecore_evas_ews_background_set(), and edje_perspective_new().

◆ evas_output_method_set()

void evas_output_method_set ( Evas e,
int  render_method 
)

Sets the output engine for the given evas.

Once the output engine for an evas is set, any attempt to change it will be ignored. The value for render_method can be found using evas_render_method_lookup.

Note
it is mandatory that one calls evas_init before setting the output method.
Parameters
[in]render_methodThe numeric engine value to use.

References eo_data_scope_get().

◆ evas_output_method_get()

int evas_output_method_get ( const Evas e)

Retrieves the number of the output engine used for the given evas.

Returns
The numeric engine value to use.

References eo_data_scope_get().

◆ evas_output_size_set()

void evas_output_size_set ( Evas e,
int  w,
int  h 
)

Sets the output size of the render engine of the given evas.

The evas will render to a rectangle of the given size once this function is called. The output size is independent of the viewport size. The viewport will be stretched to fill the given rectangle.

The units used for w and h depend on the engine used by the evas.

Parameters
[in]wThe width in output units, usually pixels.
[in]hThe height in output units, usually pixels.

References eo_data_scope_get().

◆ evas_output_size_get()

void evas_output_size_get ( const Evas e,
int *  w,
int *  h 
)

Retrieve the output size of the render engine of the given evas.

The output size is given in whatever the output units are for the engine.

If either w or h is null, then it is ignored. If e is invalid, the returned results are undefined.

Parameters
[out]wThe width in output units, usually pixels.
[out]hThe height in output units, usually pixels.

References eo_data_scope_get().