Efl.Canvas.Image (class)


Low-level Image object.

This replaces the legacy Evas Object Image, with only image-related interfaces: file and data images only. This object does not implement any special features such as proxy, snapshot or GL.


Efl.Canvas.Image.Internal (class)Efl.Canvas.Object (class)Efl.Object (class)

Full hierarchy


animated (get) [Overridden from Efl.Image.Animated]

Check if an image can be animated (has multiple frames).
Eina_Bool efl_image_animated_get(const Eo *obj);

animated_frame (get, set) [Overridden from Efl.Image.Animated]

Index of the current frame of an animated image.
int efl_image_animated_frame_get(const Eo *obj);
Eina_Bool efl_image_animated_frame_set(Eo *obj, int frame_index);

animated_frame_count (get) [Overridden from Efl.Image.Animated]

Get the total number of frames of the image, if animated.
int efl_image_animated_frame_count_get(const Eo *obj);

animated_frame_duration (get) [Overridden from Efl.Image.Animated]

Get the duration of a sequence of frames.
double efl_image_animated_frame_duration_get(const Eo *obj, int start_frame, int frame_num);

animated_loop_count (get) [Overridden from Efl.Image.Animated]

Get the number times the animation of the object loops.
int efl_image_animated_loop_count_get(const Eo *obj);

animated_loop_type (get) [Overridden from Efl.Image.Animated]

Get the kind of looping the image object does.
Efl_Image_Animated_Loop_Hint efl_image_animated_loop_type_get(const Eo *obj);

buffer_copy_set [Overridden from Efl.Gfx.Buffer]

Set the pixels for this buffer by copying them, or allocate a new memory region.
Eina_Bool efl_gfx_buffer_copy_set(Eo *obj, const Eina_Slice *slice, Eina_Size2D size, int stride, Efl_Gfx_Colorspace cspace, int plane);

buffer_managed_get [Overridden from Efl.Gfx.Buffer]

Get a direct pointer to the internal pixel data, if available.
Eina_Slice efl_gfx_buffer_managed_get(Eo *obj, int plane);

buffer_managed_set [Overridden from Efl.Gfx.Buffer]

Set the pixels for this buffer, managed externally by the client.
Eina_Bool efl_gfx_buffer_managed_set(Eo *obj, const Eina_Slice *slice, Eina_Size2D size, int stride, Efl_Gfx_Colorspace cspace, int plane);

buffer_map [Overridden from Efl.Gfx.Buffer]

Map a region of this buffer for read or write access by the CPU.
Eina_Rw_Slice efl_gfx_buffer_map(Eo *obj, Efl_Gfx_Buffer_Access_Mode mode, const Eina_Rect *region, Efl_Gfx_Colorspace cspace, int plane, int *stride);

buffer_size (get, set) [Overridden from Efl.Gfx.Buffer]

Rectangular size of the pixel buffer as allocated in memory.
Eina_Size2D efl_gfx_buffer_size_get(const Eo *obj);
void efl_gfx_buffer_size_set(Eo *obj, Eina_Size2D sz);

buffer_unmap [Overridden from Efl.Gfx.Buffer]

Unmap a region of this buffer, and update the internal data if needed.
Eina_Bool efl_gfx_buffer_unmap(Eo *obj, Eina_Rw_Slice slice);

load_async_cancel [Overridden from Efl.Image.Load]

Cancel preloading an image object's image data in the background.
void efl_image_load_async_cancel(Eo *obj);

load_async_start [Overridden from Efl.Image.Load]

Begin preloading an image object's image data in the background.
void efl_image_load_async_start(Eo *obj);

load_dpi (get, set) [Overridden from Efl.Image.Load]

double efl_image_load_dpi_get(const Eo *obj);
void efl_image_load_dpi_set(Eo *obj, double dpi);

load_error (get) [Overridden from Efl.File]

Gets the (last) file loading error for a given object.
Efl_Image_Load_Error efl_file_load_error_get(const Eo *obj);

load_orientation (get, set) [Overridden from Efl.Image.Load]

Defines whether the orientation information in the image file should be honored.
Eina_Bool efl_image_load_orientation_get(const Eo *obj);
void efl_image_load_orientation_set(Eo *obj, Eina_Bool enable);

load_region (get, set) [Overridden from Efl.Image.Load]

Eina_Rect efl_image_load_region_get(const Eo *obj);
void efl_image_load_region_set(Eo *obj, Eina_Rect region);

load_region_support (get) [Overridden from Efl.Image.Load]

Indicates whether the Efl.Image.Load.load_region property is supported for the current file.
Eina_Bool efl_image_load_region_support_get(const Eo *obj);

load_scale_down (get, set) [Overridden from Efl.Image.Load]

The scale down factor is a divider on the original image size.
int efl_image_load_scale_down_get(const Eo *obj);
void efl_image_load_scale_down_set(Eo *obj, int div);

load_size (get, set) [Overridden from Efl.Image.Load]

The load size of an image.
Eina_Size2D efl_image_load_size_get(const Eo *obj);
void efl_image_load_size_set(Eo *obj, Eina_Size2D size);

load_skip_header (get, set) [Overridden from Efl.Image.Load]

Initial load should skip header check and leave it all to data load
Eina_Bool efl_image_load_skip_header_get(const Eo *obj);
void efl_image_load_skip_header_set(Eo *obj, Eina_Bool skip);

mmap (get, set) [Overridden from Efl.File]

void efl_file_mmap_get(const Eo *obj, const Eina_File **f, const char **key);
Eina_Bool efl_file_mmap_set(Eo *obj, const Eina_File *f, const char *key);


filter_data (get, set) Extra data used by the filter program.
filter_padding (get) Required padding to apply this filter without cropping.
filter_source (get, set) Bind an object to use as a mask or texture in a filter program.
filter_state (get, set) Set the current state of the filter.
protected filter_changed (set) Marks this filter as changed.
protected filter_invalid (set) Marks this filter as invalid.
protected filter_output_buffer (get) Retrieve cached output buffer, if any.
alpha (get, set) Indicates whether the alpha channel should be used.
border (get, set) Dimensions of this image's border, a region that does not scale with the center area.
border_center_fill (get, set) Specifies how the center part of the object (not the borders) should be drawn when EFL is rendering it.
border_scale (get, set) Scaling factor applied to the image borders.
buffer_update_add Mark a sub-region of the given image object to be redrawn.
colorspace (get) The colorspace defines how pixels are encoded in the image in memory.
constructor Call the object's constructor.
content_hint (get, set)
debug_name_override Build a read-only name for this object used for debugging.
destructor Call the object's destructor.
fill (get, set) Specifies how to tile an image to fill its rectangle geometry.
fill_auto (get, set) Binds the object's Efl.Gfx.Fill.fill property to its actual geometry.
filter_program (get, set)
finalize Called at the end of efl_add. Should not be called, just overridden.
flip (get, set) Control the flip of the given image
image_size (get) This represents the size of the original image in pixels.
orientation (get, set) Control the orientation of a given object.
ratio (get) The native width/height ratio of the image.
save Save the given image object's contents to an (image) file.
scale_hint (get, set)
smooth_scale (get, set) Whether to use high-quality image scaling algorithm for this image.
view_size (get, set) The dimensions of this object's viewport.
protected filter_dirty Called when filter changes must trigger a redraw of the object.
protected filter_input_alpha Called by Efl.Canvas.Filter.Internal to determine whether the input is alpha or rgba.
protected filter_input_render Called by Efl.Canvas.Filter.Internal when the parent class must render the input.
protected filter_state_prepare Called by Efl.Canvas.Filter.Internal to request the parent class for state information (color, etc...).
above (get) Get the Evas object stacked right above obj
anti_alias (get, set)
below (get) Get the Evas object stacked right below obj
clip (get, set)
clipees (get) Return a list of objects currently clipped by obj.
clipees_has Test if any object is clipped by obj.
color (get, set)
coords_inside (get) Returns whether the coords are logically inside the object.
del Unrefs the object and reparents it to NULL.
event_animation (get, set) Set the animation which starts when the given event_name happens to the object.
freeze_events (get, set)
geometry (get, set) Rectangular geometry that combines both position and size.
hint_align (get, set) Hints for an object's alignment.
hint_aspect (get, set) Defines the aspect ratio to respect when scaling this object.
hint_combined_min (get) Read-only minimum size combining both Efl.Gfx.Size.Hint.hint_restricted_min and Efl.Gfx.Size.Hint.hint_min size hints.
hint_margin (get, set) Hints for an object's margin or padding space.
hint_max (get, set) Hints on the object's maximum size.
hint_min (get, set) Hints on the object's minimum size.
protected set hint_restricted_min (get, set) Internal hints for an object's minimum size.
hint_weight (get, set) Hints for an object's weight.
is_frame_object (get, set) If true the object belongs to the window border decorations.
key_focus (get, set) Indicates that this object is the keyboard event receiver on its canvas.
key_grab Requests keyname key events be directed to obj.
key_ungrab Removes the grab on keyname key events by obj.
layer (get, set)
loop (get) The loop to which this object belongs to.
lower Lower obj to the bottom of its layer.
no_render (get, set)
paragraph_direction (get, set) This handles text paragraph direction of the given object. Even if the given object is not textblock or text, its smart child objects can inherit the paragraph direction from the given object. The default paragraph direction is inherit.
pass_events (get, set)
pointer_inside (get) Returns whether the mouse pointer is logically inside the canvas.
pointer_mode (get, set) Low-level pointer behaviour.
pointer_mode_by_device (get, set) Low-level pointer behaviour by device. See Efl.Canvas.Object.pointer_mode.get and Efl.Canvas.Object.pointer_mode.set for more explanation.
position (get, set) The 2D position of a canvas object.
precise_is_inside (get, set)
propagate_events (get, set)
provider_find Searches upwards in the object tree for a provider which knows the given class/interface.
raise Raise obj to the top of its layer.
render_op (get, set) Render mode to be used for compositing the Evas object.
repeat_events (get, set)
scale (get, set) The scaling factor of an object.
seat_event_filter (get, set)
seat_focus (get) Check if this object is focused.
seat_focus_add Add a seat to the focus list.
seat_focus_check Check if this object is focused by a given seat
seat_focus_del Remove a seat from the focus list.
size (get, set) The 2D size of a canvas object.
stack_above Stack obj immediately above
stack_below Stack obj immediately below
visible (get, set) The visibility of a canvas object.
protected render_parent (get) Gets the parent smart object of a given Evas object, if it has one.
file (get, set)
buffer_borders (get) Duplicated pixel borders inside this buffer.
stride (get) Length in bytes of one row of pixels in memory.
color_class_code (get, set)
color_code (get, set)
lightning_3d Apply a lighting effect on the object.
lightning_3d_absolute Apply a lighting effect to the object.
map_alpha (get, set) Alpha flag for map rendering.
map_clockwise (get) Clockwise state of a map (read-only).
map_color (get, set) Color of a vertex in the map.
map_coord_absolute (get, set) A point's absolute coordinate on the canvas.
map_has Read-only property indicating whether an object is mapped.
map_point_count (get, set) Number of points of a map.
map_reset Resets the map transformation to its default state.
map_smooth (get, set) Smoothing state for map rendering.
map_uv (get, set) Map point's U and V texture source point.
perspective_3d Apply a perspective transform to the map
perspective_3d_absolute Apply a perspective transform to the map
rotate Apply a rotation to the object.
rotate_3d Rotate the object around 3 axes in 3D.
rotate_3d_absolute Rotate the object around 3 axes in 3D, using absolute coordinates.
rotate_absolute Apply a rotation to the object, using absolute coordinates.
rotate_quat Rotate the object in 3D using a unit quaternion.
rotate_quat_absolute Rotate the object in 3D using a unit quaternion, using absolute coordinates.
translate Apply a translation to the object using map.
zoom Apply a zoom to the object.
zoom_absolute Apply a zoom to the object, using absolute coordinates.
hint_base (get, set) Base size for objects with sizing restrictions.
hint_step (get, set) Step size for objects with sizing restrictions.
scale_type (get, set) Control how the image is scaled.
allow_parent_unref (get, set) Allow an object to be deleted by unref even if it has a parent.
children_iterator_new Get an iterator on all childrens
comment (get, set) A human readable comment for the object
composite_attach Make an object a composite object of another.
composite_detach Detach a composite object from another object.
composite_part_is Check if an object is part of a composite object.
event_callback_forwarder_add Add an event callback forwarder for an event and an object.
event_callback_forwarder_del Remove an event callback forwarder for an event and an object.
event_callback_stop Stop the current callback call.
event_freeze Freeze events of object.
event_freeze_count (get) Return freeze events of object.
class event_global_freeze Freeze events of object.
class event_global_freeze_count (get) Return freeze events of object.
class event_global_thaw Thaw events of object.
event_thaw Thaw events of object.
finalized (get) True if the object is already finalized, otherwise false.
name (get, set) The name of the object.
name_find Find a child object with the given name and return it.
parent (get, set) The parent of an object.
language (get, set) The (human) language for this object.
mirrored (get, set) Whether this object should be mirrored.
mirrored_automatic (get, set) Whether the property Efl.Ui.Base.mirrored should be set automatically.



animator,tick Animator tick synchronized with screen vsync if possible.
hide Object just became invisible.
move Object was moved, its position during the event is the new one.
resize Object was resized, its size during the event is the new one.
show Object just became visible.
change,size,hints Object size hints changed.
restack Object stacking was changed.
preload Image data has been preloaded.
unload Image data has been unloaded (by some mechanism in EFL that threw out the original image data).
load,cancelled Called when the image loading was cancelled
load,done Called when he image was loaded
load,error Called when an error happened during image loading
finger,down Finger pressed (finger id is known).
finger,move Finger moved (current and previous positions are known).
finger,up Finger released (finger id is known).
focus,in A focus in event.
focus,out A focus out event.
hold All input events are on hold or resumed.
key,down Keyboard key press.
key,up Keyboard key release.
pointer,axis Pen or other axis event update.
pointer,cancel Main pointer button press was cancelled (button id is known). This can happen in rare cases when the window manager passes the focus to a more urgent window, for instance. You probably don't need to listen to this event, as it will be accompanied by an up event.
pointer,down Main pointer button pressed (button id is known).
pointer,in Pointer entered a window or a widget.
pointer,move Main pointer move (current and previous positions are known).
pointer,out Pointer left a window or a widget.
pointer,up Main pointer button released (button id is known).
pointer,wheel Mouse wheel event.
callback,add A callback was added.
callback,del A callback was deleted.
del Object is being deleted.
destruct Object has been fully destroyed. It can not be used beyond this point. This event should only serve to clean up any dangling pointer.