Efl.Canvas.Proxy (class)


Low-level proxy image object.

A proxy is a special kind of image containing the pixels from a source object attached to it. It can be used to apply some sort of image transformation to any object (eg. filters, map or zoom).


Efl.Canvas.Image_Internal (class)Efl.Canvas.Object (class)Efl.Loop_Consumer (class)Efl.Object (class)

Full hierarchy


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_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);

source (get, set)

The source object for this proxy.
Efl_Canvas_Object *efl_canvas_proxy_source_get(const Eo *obj);
Eina_Bool efl_canvas_proxy_source_set(Eo *obj, Efl_Canvas_Object *src);

source_clip (get, set)

Clip this proxy object with the source object's clipper.
Eina_Bool efl_canvas_proxy_source_clip_get(const Eo *obj);
void efl_canvas_proxy_source_clip_set(Eo *obj, Eina_Bool source_clip);

source_events (get, set)

Defines whether the events on this object are repeated to the source.
Eina_Bool efl_canvas_proxy_source_events_get(const Eo *obj);
void efl_canvas_proxy_source_events_set(Eo *obj, Eina_Bool repeat);


filter_data (get, set) Extra data used by the filter program.
filter_padding (get)
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)
protected filter_invalid (set)
protected filter_output_buffer (get)
alpha (get, set) Indicates whether the alpha channel should be used.
border_insets (get, set) Dimensions of this image's border, a region that does not scale with the center area.
border_insets_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.
center_fill_mode (get, set) Specifies how the center part of the object (not the borders) should be drawn when EFL is rendering it.
colorspace (get) Returns the current encoding of this buffer's pixels.
constructor Implement this method to provide optional initialization code for your object.
content_hint (get, set) Content hint setting for the image. These hints might be used by EFL to enable optimizations.
content_region (get)
debug_name_override Build a read-only name for this object used for debugging.
destructor Implement this method to provide deinitialization code for your object if you need it.
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) A graphical filter program on this object.
finalize Implement this method to finish the initialization of your object after all (if any) user-provided configuration methods have been executed.
image_load_error (get)
image_orientation (get, set) Control the orientation (rotation and flipping) of a visual object.
image_size (get)
ratio (get)
save Save the given image object's contents to an (image) file.
scale_hint (get, set) The scale hint of a given image of the canvas.
smooth_scale (get, set) Whether to use high-quality image scaling algorithm for this image.
stretch_region (get, set) This property defines the stretchable pixels region of an 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)
anti_alias (get, set) Whether or not the given Evas object is to be drawn anti-aliased.
below (get)
clipped_objects (get)
clipped_objects_count Returns the number of objects clipped by obj
clipper (get, set) Clip one object to another.
color (get, set) The general/main color of the given Evas object.
coords_inside (get)
event_freeze Freeze events of this object.
event_thaw Thaw events of object.
geometry (get, set) Rectangular geometry that combines both position and size.
gesture_manager_get Returns current canvas's gesture manager
has_fixed_size (get, set) A hint for an object that its size will not change.
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_fill (get, set) Hints for an object's fill property that used to specify "justify" or "fill" by some users. Efl.Gfx.Hint.hint_fill specify whether to fill the space inside the boundaries of a container/manager.
hint_margin (get, set) Hints for an object's margin or padding space.
hint_size_combined_max (get)
hint_size_combined_min (get)
hint_size_max (get, set) Hints on the object's maximum size.
hint_size_min (get, set) Hints on the object's minimum size.
protected set hint_size_restricted_max (get, set) Internal hints for an object's maximum size.
protected set hint_size_restricted_min (get, set) Internal hints for an object's minimum size.
hint_weight (get, set) Hints for an object's weight.
invalidate Implement this method to perform special actions when your object loses its parent, if you need to.
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) The layer of its canvas that the given object will be part of.
loop (get)
lower_to_bottom Lower obj to the bottom of its layer.
no_render (get, set) Disables all rendering on the canvas.
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) Whether an Evas object is to pass (ignore) events.
pointer_inside (get)
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) Whether to use precise (usually expensive) point collision detection for a given Evas object.
propagate_events (get, set) Whether events on a smart object's member should be propagated up to its parent.
provider_find Searches upwards in the object tree for a provider which knows the given class/interface.
raise_to_top 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) Whether an Evas object is to repeat events to objects below it.
scale (get, set) The scaling factor of an object.
seat_event_filter (get, set) Whether input events from a given seat are enabled. If the filter list is empty (no seat is disabled) this object will report mouse, keyboard and focus events from any seat, otherwise those events will only be reported if the event comes from a seat that is not in the list.
seat_focus (get)
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)
buffer_borders (get)
buffer_copy_set Set the pixels for this buffer by copying them, or allocate a new memory region.
buffer_managed_get Get a direct pointer to the internal pixel data, if available.
buffer_managed_set Set the pixels for this buffer, managed externally by the client.
buffer_size (get, set) Rectangular size of the pixel buffer as allocated in memory.
stride (get)
color_code (get, set) Hexadecimal color code of given Evas object (#RRGGBBAA).
can_downscale (get, set) If true, the image may be scaled to a smaller size. If false, the image will never be resized smaller than its native size.
can_upscale (get, set) If true, the image may be scaled to a larger size. If false, the image will never be resized larger than its native size.
scale_method (get, set) Determine how the image is scaled at render time.
lighting_3d Apply a lighting effect on the object.
lighting_3d_absolute Apply a lighting effect to the object.
mapping_alpha (get, set) Alpha flag for map rendering.
mapping_clockwise (get)
mapping_color (get, set) Color of a vertex in the map.
mapping_coord_absolute (get, set) A point's absolute coordinate on the canvas.
mapping_has Read-only property indicating whether an object is mapped.
mapping_point_count (get, set) Number of points of a map.
mapping_reset Resets the map transformation to its default state.
mapping_smooth (get, set) Smoothing state for map rendering.
mapping_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.
future_rejected Creates a new future that is already rejected to a specified error using the Efl.Loop_Consumer.loop.get.
future_resolved Creates a new future that is already resolved to a value.
parent (get, set) The parent of an object.
promise_new Create a new promise with the scheduler coming from the loop provided by this object.
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 children.
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_del Remove an event callback forwarder for a specified event and object.
event_callback_forwarder_priority_add Add an event callback forwarder that will make this object emit an event whenever another object (source) emits it. The event is said to be forwarded from source to this object.
event_callback_stop Stop the current callback call.
event_freeze_count (get)
static event_global_freeze Globally freeze events for ALL EFL OBJECTS.
static event_global_freeze_count (get)
static event_global_thaw Globally thaw events for ALL EFL OBJECTS.
finalized (get)
invalidated (get)
invalidating (get)
name (get, set) The name of the object.
name_find Find a child object with the given name and return it.
provider_register Will register a manager of a specific class to be answered by Efl.Object.provider_find.
provider_unregister Will unregister a manager of a specific class that was previously registered and answered by Efl.Object.provider_find.



animator,tick Animator tick synchronized with screen vsync if possible.
gesture,double_tap Emitted when a Double-tap gesture has been detected. A Double-tap gesture consists of two taps on the screen (or clicks of the mouse) in quick succession. If the second one is delayed for too long they will be detected as two independent Efl.Gesture.Events.gesture,tap events.
gesture,flick Emitted when a Flick gesture has been detected.
gesture,long_tap Emitted when a Long-tap gesture has been detected. A Long-tap gesture consists of a touch of the screen (or click of the mouse) followed by a release after some time. If the release happens too quickly a Efl.Gesture.Events.gesture,tap event will be emitted instead.
gesture,momentum Emitted when a Momentum gesture has been detected. A Momentum gesture consists of a quick displacement of the finger while touching the screen (or while holding down a mouse button).
gesture,tap Emitted when a Tap gesture has been detected. A Tap gesture consists of a touch of the screen (or click of the mouse) quickly followed by a release. If the release happens too late a Efl.Gesture.Events.gesture,long_tap event will be emitted instead.
gesture,triple_tap Emitted when a Triple-tap gesture has been detected. A Triple-tap gesture consists of three taps on the screen (or clicks of the mouse) in quick succession. If any of them is delayed for too long they will be detected as independent Efl.Gesture.Events.gesture,tap or Efl.Gesture.Events.gesture,double_tap events.
gesture,zoom Emitted when a Zoom gesture has been detected. A Zoom gesture consists of two fingers touching the screen and separating ("zoom in") or getting closer ("zoom out" or "pinch"). This gesture cannot be performed with a mouse as it requires more than one pointer.
position,changed Object was moved, its position during the event is the new one.
size,changed Object was resized, its size during the event is the new one.
visibility,changed Object's visibility state changed, the event value is the new state.
hints,changed Object hints changed.
image,preload_state,changed If true, image data has been preloaded and can be displayed. If false, the image data has been unloaded and can no longer be displayed.
image,resized Image was resized (its pixel data). The event data is the image's new size.
stacking,changed Object stacking was changed.
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.
del Object is being deleted. See Efl.Object.destructor.
destruct Object has been fully destroyed. It can not be used beyond this point. This event should only serve to clean up any reference you keep to the object.
invalidate Object is being invalidated and losing its parent. See Efl.Object.invalidate.
noref Object has lost its last reference, only parent relationship is keeping it alive. Advanced usage.
ownership,shared Object has acquired a second reference. It has multiple owners now. Triggered whenever increasing the refcount from one to two, it will not trigger by further increasing the refcount beyond two.
ownership,unique Object has lost a reference and only one is left. It has just one owner now. Triggered whenever the refcount goes from two to one.