Here are grouped together functions used to create and manipulate image objects. More...
Typedefs | |
typedef enum _Evas_Colorspace | Evas_Colorspace |
Colorspaces for pixel data supported by Evas. More... | |
typedef void(* | Evas_Object_Image_Pixels_Get_Cb) (void *data, Evas_Object *o) |
Enumerations | |
enum | _Evas_Colorspace { EVAS_COLORSPACE_ARGB8888, EVAS_COLORSPACE_YCBCR422P601_PL, EVAS_COLORSPACE_YCBCR422P709_PL, EVAS_COLORSPACE_RGB565_A5P, EVAS_COLORSPACE_GRY8, EVAS_COLORSPACE_YCBCR422601_PL, EVAS_COLORSPACE_YCBCR420NV12601_PL, EVAS_COLORSPACE_YCBCR420TM12601_PL } |
Colorspaces for pixel data supported by Evas. More... | |
Functions | |
Eina_Bool | evas_object_image_extension_can_load_get (const char *file) |
Check if a file extension may be supported by Image Object Functions. More... | |
Eina_Bool | evas_object_image_extension_can_load_fast_get (const char *file) |
Check if a file extension may be supported by Image Object Functions. More... | |
#define | evas_obj_image_file_set(file, key) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_FILE_SET), EO_TYPECHECK(const char *, file), EO_TYPECHECK(const char*, key) |
#define | evas_obj_image_mmap_set(f, key) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_MMAP_SET), EO_TYPECHECK(const Eina_File *, f), EO_TYPECHECK(const char*, key) |
#define | evas_obj_image_file_get(file, key) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_FILE_GET), EO_TYPECHECK(const char **, file), EO_TYPECHECK(const char **, key) |
#define | evas_obj_image_source_set(src, result) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SOURCE_SET), EO_TYPECHECK(Evas_Object *, src), EO_TYPECHECK(Eina_Bool *, result) |
#define | evas_obj_image_source_get(src) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SOURCE_GET), EO_TYPECHECK(Evas_Object **, src) |
#define | evas_obj_image_source_visible_set(visible) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SOURCE_VISIBLE_SET), EO_TYPECHECK(Eina_Bool, visible) |
#define | evas_obj_image_source_visible_get(visible) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SOURCE_VISIBLE_GET), EO_TYPECHECK(Eina_Bool *, visible) |
#define | evas_obj_image_source_events_set(source) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SOURCE_EVENTS_SET), EO_TYPECHECK(Eina_Bool, source) |
#define | evas_obj_image_source_events_get(source) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SOURCE_EVENTS_GET), EO_TYPECHECK(Eina_Bool *, source) |
#define | evas_obj_image_source_clip_set(source_clip) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SOURCE_CLIP_SET), EO_TYPECHECK(Eina_Bool, source_clip) |
#define | evas_obj_image_source_clip_get(source_clip) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SOURCE_CLIP_GET), EO_TYPECHECK(Eina_Bool *, source_clip) |
#define | evas_obj_image_border_set(l, r, t, b) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_BORDER_SET), EO_TYPECHECK(int, l), EO_TYPECHECK(int, r), EO_TYPECHECK(int, t), EO_TYPECHECK(int, b) |
#define | evas_obj_image_border_get(l, r, t, b) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_BORDER_GET), EO_TYPECHECK(int *, l), EO_TYPECHECK(int *, r), EO_TYPECHECK(int *, t), EO_TYPECHECK(int *, b) |
#define | evas_obj_image_border_center_fill_set(fill) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_BORDER_CENTER_FILL_SET), EO_TYPECHECK(Evas_Border_Fill_Mode, fill) |
#define | evas_obj_image_border_center_fill_get(fill) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_BORDER_CENTER_FILL_GET), EO_TYPECHECK(Evas_Border_Fill_Mode *, fill) |
#define | evas_obj_image_filled_set(filled) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_FILLED_SET), EO_TYPECHECK(Eina_Bool, filled) |
#define | evas_obj_image_filled_get(filled) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_FILLED_GET), EO_TYPECHECK(Eina_Bool *, filled) |
#define | evas_obj_image_border_scale_set(scale) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_BORDER_SCALE_SET), EO_TYPECHECK(double, scale) |
#define | evas_obj_image_border_scale_get(scale) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_BORDER_SCALE_GET), EO_TYPECHECK(double *, scale) |
#define | evas_obj_image_fill_set(x, y, w, h) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_FILL_SET), EO_TYPECHECK(Evas_Coord, x), EO_TYPECHECK(Evas_Coord, y), EO_TYPECHECK(Evas_Coord, w), EO_TYPECHECK(Evas_Coord, h) |
#define | evas_obj_image_fill_get(x, y, w, h) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_FILL_GET), EO_TYPECHECK(Evas_Coord *, x), EO_TYPECHECK(Evas_Coord *, y), EO_TYPECHECK(Evas_Coord *, w), EO_TYPECHECK(Evas_Coord *, h) |
#define | evas_obj_image_fill_spread_set(spread) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_FILL_SPREAD_SET), EO_TYPECHECK(Evas_Fill_Spread, spread) |
#define | evas_obj_image_fill_spread_get(spread) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_FILL_SPREAD_GET), EO_TYPECHECK(Evas_Fill_Spread *, spread) |
#define | evas_obj_image_size_set(w, h) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SIZE_SET), EO_TYPECHECK(int, w), EO_TYPECHECK(int, h) |
#define | evas_obj_image_size_get(w, h) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SIZE_GET), EO_TYPECHECK(int *, w), EO_TYPECHECK(int *, h) |
#define | evas_obj_image_stride_get(stride) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_STRIDE_GET), EO_TYPECHECK(int *, stride) |
#define | evas_obj_image_load_error_get(load_error) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_ERROR_GET), EO_TYPECHECK(Evas_Load_Error *, load_error) |
#define | evas_obj_image_data_convert(to_cspace, data) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_DATA_CONVERT), EO_TYPECHECK(Evas_Colorspace, to_cspace), EO_TYPECHECK(void **, data) |
#define | evas_obj_image_data_set(data) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_DATA_SET), EO_TYPECHECK(void *, data) |
#define | evas_obj_image_data_get(for_writing, data) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_DATA_GET), EO_TYPECHECK(Eina_Bool, for_writing), EO_TYPECHECK(void **, data) |
#define | evas_obj_image_data_copy_set(data) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_DATA_COPY_SET), EO_TYPECHECK(void *, data) |
#define | evas_obj_image_data_update_add(x, y, w, h) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_DATA_UPDATE_ADD), EO_TYPECHECK(int, x), EO_TYPECHECK(int, y), EO_TYPECHECK(int, w), EO_TYPECHECK(int, h) |
#define | evas_obj_image_alpha_set(alpha) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_ALPHA_SET), EO_TYPECHECK(Eina_Bool, sw_64) |
#define | evas_obj_image_alpha_get(alpha) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_ALPHA_GET), EO_TYPECHECK(Eina_Bool *, sw_64) |
#define | evas_obj_image_smooth_scale_set(smooth_scale) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SMOOTH_SCALE_SET), EO_TYPECHECK(Eina_Bool, smooth_scale) |
#define | evas_obj_image_smooth_scale_get(smooth_scale) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SMOOTH_SCALE_GET), EO_TYPECHECK(Eina_Bool *, smooth_scale) |
#define | evas_obj_image_preload_begin() EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_PRELOAD_BEGIN) |
#define | evas_obj_image_preload_cancel() EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_PRELOAD_CANCEL) |
#define | evas_obj_image_reload() EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_RELOAD) |
#define | evas_obj_image_save(file, key, flags, result) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SAVE), EO_TYPECHECK(const char *, file), EO_TYPECHECK(const char *, key), EO_TYPECHECK(const char *, flags), EO_TYPECHECK(Eina_Bool *, result) |
#define | evas_obj_image_pixels_import(pixels, result) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_PIXELS_IMPORT), EO_TYPECHECK(Evas_Pixel_Import_Source *, pixels), EO_TYPECHECK(Eina_Bool *, result) |
#define | evas_obj_image_pixels_get_callback_set(func, data) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_PIXELS_GET_CALLBACK_SET), EO_TYPECHECK(Evas_Object_Image_Pixels_Get_Cb, func), EO_TYPECHECK(void *, data) |
#define | evas_obj_image_pixels_dirty_set(dirty) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_PIXELS_DIRTY_SET), EO_TYPECHECK(Eina_Bool, dirty) |
#define | evas_obj_image_pixels_dirty_get(dirty) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_PIXELS_DIRTY_GET), EO_TYPECHECK(Eina_Bool *, dirty) |
#define | evas_obj_image_load_dpi_set(dpi) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_DPI_SET), EO_TYPECHECK(double, dpi) |
#define | evas_obj_image_load_dpi_get(dpi) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_DPI_GET), EO_TYPECHECK(double *, dpi) |
#define | evas_obj_image_load_size_set(w, h) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_SIZE_SET), EO_TYPECHECK(int, w), EO_TYPECHECK(int, h) |
#define | evas_obj_image_load_size_get(w, h) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_SIZE_GET), EO_TYPECHECK(int *, w), EO_TYPECHECK(int *, h) |
#define | evas_obj_image_load_scale_down_set(scale_down) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_SCALE_DOWN_SET), EO_TYPECHECK(int, scale_down) |
#define | evas_obj_image_load_scale_down_get(scale_down) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_SCALE_DOWN_GET), EO_TYPECHECK(int *, scale_down) |
#define | evas_obj_image_load_region_set(x, y, w, h) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_REGION_SET), EO_TYPECHECK(int, x), EO_TYPECHECK(int, y), EO_TYPECHECK(int, w), EO_TYPECHECK(int, h) |
#define | evas_obj_image_load_region_get(x, y, w, h) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_REGION_GET), EO_TYPECHECK(int *, x), EO_TYPECHECK(int *, y), EO_TYPECHECK(int *, w), EO_TYPECHECK(int *, h) |
#define | evas_obj_image_load_orientation_set(enable) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_ORIENTATION_SET), EO_TYPECHECK(Eina_Bool, enable) |
#define | evas_obj_image_load_orientation_get(enable) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_ORIENTATION_GET), EO_TYPECHECK(Eina_Bool *, enable) |
#define | evas_obj_image_colorspace_set(cspace) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_COLORSPACE_SET), EO_TYPECHECK(Evas_Colorspace, cspace) |
#define | evas_obj_image_colorspace_get(cspace) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_COLORSPACE_GET), EO_TYPECHECK(Evas_Colorspace *, cspace) |
#define | evas_obj_image_video_surface_set(surf) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_VIDEO_SURFACE_SET), EO_TYPECHECK(Evas_Video_Surface *, surf) |
#define | evas_obj_image_video_surface_get(surf) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_VIDEO_SURFACE_GET), EO_TYPECHECK(const Evas_Video_Surface **, surf) |
#define | evas_obj_image_video_surface_caps_set(caps) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_VIDEO_SURFACE_CAPS_SET), EO_TYPECHECK(unsigned int, caps) |
#define | evas_obj_image_video_surface_caps_get(caps) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_VIDEO_SURFACE_CAPS_GET), EO_TYPECHECK(unsigned int *, caps) |
#define | evas_obj_image_native_surface_set(surf) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_NATIVE_SURFACE_SET), EO_TYPECHECK(Evas_Native_Surface *, surf) |
#define | evas_obj_image_native_surface_get(surf) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_NATIVE_SURFACE_GET), EO_TYPECHECK(Evas_Native_Surface **, surf) |
#define | evas_obj_image_scale_hint_set(hint) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SCALE_HINT_SET), EO_TYPECHECK(Evas_Image_Scale_Hint, hint) |
#define | evas_obj_image_scale_hint_get(hint) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SCALE_HINT_GET), EO_TYPECHECK(Evas_Image_Scale_Hint *, hint) |
#define | evas_obj_image_content_hint_set(hint) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_CONTENT_HINT_SET), EO_TYPECHECK(Evas_Image_Content_Hint, hint) |
#define | evas_obj_image_content_hint_get(hint) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_CONTENT_HINT_GET), EO_TYPECHECK(Evas_Image_Content_Hint *, hint) |
#define | evas_obj_image_region_support_get(region) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_REGION_SUPPORT_GET), EO_TYPECHECK(Eina_Bool *, region) |
#define | evas_obj_image_animated_get(animated) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_ANIMATED_GET), EO_TYPECHECK(Eina_Bool *, animated) |
#define | evas_obj_image_animated_frame_count_get(frame_count) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_ANIMATED_FRAME_COUNT_GET), EO_TYPECHECK(int *, frame_count) |
#define | evas_obj_image_animated_loop_type_get(hint) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_ANIMATED_LOOP_TYPE_GET), EO_TYPECHECK(Evas_Image_Animated_Loop_Hint *, hint) |
#define | evas_obj_image_animated_loop_count_get(loop_count) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_ANIMATED_LOOP_COUNT_GET), EO_TYPECHECK(int *, loop_count) |
#define | evas_obj_image_animated_frame_duration_get(start_frame, frame_num, frame_duration) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_ANIMATED_FRAME_DURATION_GET), EO_TYPECHECK(int, start_frame), EO_TYPECHECK(int, frame_num), EO_TYPECHECK(double *, frame_duration) |
#define | evas_obj_image_animated_frame_set(frame_index) EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_ANIMATED_FRAME_SET), EO_TYPECHECK(int, frame_index) |
Evas_Object * | evas_object_image_add (Evas *e) |
Creates a new image object on the given Evas e canvas. More... | |
Evas_Object * | evas_object_image_filled_add (Evas *e) |
Creates a new image object that automatically scales its bound image to the object's area, on both axis. More... | |
void | evas_object_image_memfile_set (Evas_Object *obj, void *data, int size, char *format, char *key) |
Sets the data for an image from memory to be loaded. More... | |
void | evas_object_image_file_set (Evas_Object *obj, const char *file, const char *key) |
Set the source file from where an image object must fetch the real image data (it may be an Eet file, besides pure image ones). More... | |
void | evas_object_image_mmap_set (Evas_Object *obj, const Eina_File *f, const char *key) |
Set the source mmaped file from where an image object must fetch the real image data (it must be an Eina_File). More... | |
void | evas_object_image_file_get (const Evas_Object *obj, const char **file, const char **key) |
Retrieve the source file from where an image object is to fetch the real image data (it may be an Eet file, besides pure image ones). More... | |
void | evas_object_image_border_set (Evas_Object *obj, int l, int r, int t, int b) |
Set the dimensions for an image object's border, a region which won't ever be scaled together with its center. More... | |
void | evas_object_image_border_get (const Evas_Object *obj, int *l, int *r, int *t, int *b) |
Retrieve the dimensions for an image object's border, a region which won't ever be scaled together with its center. More... | |
void | evas_object_image_border_center_fill_set (Evas_Object *obj, Evas_Border_Fill_Mode fill) |
Sets how the center part of the given image object (not the borders) should be drawn when Evas is rendering it. More... | |
Evas_Border_Fill_Mode | evas_object_image_border_center_fill_get (const Evas_Object *obj) |
Retrieves how the center part of the given image object (not the borders) is to be drawn when Evas is rendering it. More... | |
void | evas_object_image_filled_set (Evas_Object *obj, Eina_Bool setting) |
Set whether the image object's fill property should track the object's size. More... | |
Eina_Bool | evas_object_image_filled_get (const Evas_Object *obj) |
Retrieve whether the image object's fill property should track the object's size. More... | |
void | evas_object_image_border_scale_set (Evas_Object *obj, double scale) |
Sets the scaling factor (multiplier) for the borders of an image object. More... | |
double | evas_object_image_border_scale_get (const Evas_Object *obj) |
Retrieves the scaling factor (multiplier) for the borders of an image object. More... | |
void | evas_object_image_fill_set (Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h) |
Set how to fill an image object's drawing rectangle given the (real) image bound to it. More... | |
void | evas_object_image_fill_get (const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) |
Retrieve how an image object is to fill its drawing rectangle, given the (real) image bound to it. More... | |
void | evas_object_image_fill_spread_set (Evas_Object *obj, Evas_Fill_Spread spread) |
Sets the tiling mode for the given evas image object's fill. More... | |
Evas_Fill_Spread | evas_object_image_fill_spread_get (const Evas_Object *obj) |
Retrieves the spread (tiling mode) for the given image object's fill. More... | |
void | evas_object_image_size_set (Evas_Object *obj, int w, int h) |
Sets the size of the given image object. More... | |
void | evas_object_image_size_get (const Evas_Object *obj, int *w, int *h) |
Retrieves the size of the given image object. More... | |
int | evas_object_image_stride_get (const Evas_Object *obj) |
Retrieves the row stride of the given image object. More... | |
Evas_Load_Error | evas_object_image_load_error_get (const Evas_Object *obj) |
Retrieves a number representing any error that occurred during the last loading of the given image object's source image. More... | |
void | evas_object_image_data_set (Evas_Object *obj, void *data) |
Sets the raw image data of the given image object. More... | |
void * | evas_object_image_data_get (const Evas_Object *obj, Eina_Bool for_writing) |
Get a pointer to the raw image data of the given image object. More... | |
void * | evas_object_image_data_convert (Evas_Object *obj, Evas_Colorspace to_cspace) |
Converts the raw image data of the given image object to the specified colorspace. More... | |
void | evas_object_image_data_copy_set (Evas_Object *obj, void *data) |
Replaces the raw image data of the given image object. More... | |
void | evas_object_image_data_update_add (Evas_Object *obj, int x, int y, int w, int h) |
Mark a sub-region of the given image object to be redrawn. More... | |
void | evas_object_image_alpha_set (Evas_Object *obj, Eina_Bool has_alpha) |
Enable or disable alpha channel usage on the given image object. More... | |
Eina_Bool | evas_object_image_alpha_get (const Evas_Object *obj) |
Retrieve whether alpha channel data is being used on the given image object. More... | |
void | evas_object_image_smooth_scale_set (Evas_Object *obj, Eina_Bool smooth_scale) |
Sets whether to use high-quality image scaling algorithm on the given image object. More... | |
Eina_Bool | evas_object_image_smooth_scale_get (const Evas_Object *obj) |
Retrieves whether the given image object is using high-quality image scaling algorithm. More... | |
void | evas_object_image_preload (Evas_Object *obj, Eina_Bool cancel) |
Preload an image object's image data in the background. More... | |
void | evas_object_image_reload (Evas_Object *obj) |
Reload an image object's image data. More... | |
Eina_Bool | evas_object_image_save (const Evas_Object *obj, const char *file, const char *key, const char *flags) |
Save the given image object's contents to an (image) file. More... | |
Eina_Bool | evas_object_image_pixels_import (Evas_Object *obj, Evas_Pixel_Import_Source *pixels) |
Import pixels from given source to a given canvas image object. More... | |
void | evas_object_image_pixels_get_callback_set (Evas_Object *obj, Evas_Object_Image_Pixels_Get_Cb func, void *data) |
Set the callback function to get pixels from a canvas' image. More... | |
void | evas_object_image_pixels_dirty_set (Evas_Object *obj, Eina_Bool dirty) |
Mark whether the given image object is dirty and needs to request its pixels. More... | |
Eina_Bool | evas_object_image_pixels_dirty_get (const Evas_Object *obj) |
Retrieves whether the given image object is dirty (needs to be redrawn). More... | |
void | evas_object_image_load_dpi_set (Evas_Object *obj, double dpi) |
Set the DPI resolution of an image object's source image. More... | |
double | evas_object_image_load_dpi_get (const Evas_Object *obj) |
Get the DPI resolution of a loaded image object in the canvas. More... | |
void | evas_object_image_load_size_set (Evas_Object *obj, int w, int h) |
Set the size of a given image object's source image, when loading it. More... | |
void | evas_object_image_load_size_get (const Evas_Object *obj, int *w, int *h) |
Get the size of a given image object's source image, when loading it. More... | |
void | evas_object_image_load_scale_down_set (Evas_Object *obj, int scale_down) |
Set the scale down factor of a given image object's source image, when loading it. More... | |
int | evas_object_image_load_scale_down_get (const Evas_Object *obj) |
get the scale down factor of a given image object's source image, when loading it. More... | |
void | evas_object_image_load_region_set (Evas_Object *obj, int x, int y, int w, int h) |
Inform a given image object to load a selective region of its source image. More... | |
void | evas_object_image_load_region_get (const Evas_Object *obj, int *x, int *y, int *w, int *h) |
Retrieve the coordinates of a given image object's selective (source image) load region. More... | |
void | evas_object_image_load_orientation_set (Evas_Object *obj, Eina_Bool enable) |
Define if the orientation information in the image file should be honored. More... | |
Eina_Bool | evas_object_image_load_orientation_get (const Evas_Object *obj) |
Get if the orientation information in the image file should be honored. More... | |
void | evas_object_image_colorspace_set (Evas_Object *obj, Evas_Colorspace cspace) |
Set the colorspace of a given image of the canvas. More... | |
Evas_Colorspace | evas_object_image_colorspace_get (const Evas_Object *obj) |
Get the colorspace of a given image of the canvas. More... | |
Eina_Bool | evas_object_image_region_support_get (const Evas_Object *obj) |
Get the support state of a given image. More... | |
void | evas_object_image_native_surface_set (Evas_Object *obj, Evas_Native_Surface *surf) |
Set the native surface of a given image of the canvas. More... | |
Evas_Native_Surface * | evas_object_image_native_surface_get (const Evas_Object *obj) |
Get the native surface of a given image of the canvas. More... | |
void | evas_object_image_video_surface_set (Evas_Object *obj, Evas_Video_Surface *surf) |
Set the video surface linked to a given image of the canvas. More... | |
const Evas_Video_Surface * | evas_object_image_video_surface_get (const Evas_Object *obj) |
Get the video surface linekd to a given image of the canvas. More... | |
void | evas_object_image_video_surface_caps_set (Evas_Object *obj, unsigned int caps) |
unsigned int | evas_object_image_video_surface_caps_get (const Evas_Object *obj) |
void | evas_object_image_scale_hint_set (Evas_Object *obj, Evas_Image_Scale_Hint hint) |
Set the scale hint of a given image of the canvas. More... | |
Evas_Image_Scale_Hint | evas_object_image_scale_hint_get (const Evas_Object *obj) |
Get the scale hint of a given image of the canvas. More... | |
void | evas_object_image_content_hint_set (Evas_Object *obj, Evas_Image_Content_Hint hint) |
Set the content hint setting of a given image object of the canvas. More... | |
Evas_Image_Content_Hint | evas_object_image_content_hint_get (const Evas_Object *obj) |
Get the content hint setting of a given image object of the canvas. More... | |
void | evas_object_image_sw_64_mask_set (Evas_Object *obj, Eina_Bool ismask) |
Enable an image to be used as an alpha mask. More... | |
Eina_Bool | evas_object_image_source_set (Evas_Object *obj, Evas_Object *src) |
Set the source object on an image object to used as a proxy. More... | |
Evas_Object * | evas_object_image_source_get (const Evas_Object *obj) |
Get the current source object of an image object. More... | |
Eina_Bool | evas_object_image_source_unset (Evas_Object *obj) |
Clear the source object on a proxy image object. More... | |
void | evas_object_image_source_visible_set (Evas_Object *obj, Eina_Bool visible) |
Set the source object to be visible or not. More... | |
Eina_Bool | evas_object_image_source_visible_get (const Evas_Object *obj) |
Get the state of the source object visibility. More... | |
void | evas_object_image_source_events_set (Evas_Object *obj, Eina_Bool source) |
Set whether an Evas object is to source events. More... | |
Eina_Bool | evas_object_image_source_events_get (const Evas_Object *obj) |
Determine whether an object is set to source events. More... | |
void | evas_object_image_source_clip_set (Evas_Object *obj, Eina_Bool source_clip) |
Clip the proxy object with the source object's clipper. More... | |
Eina_Bool | evas_object_image_source_clip_get (const Evas_Object *obj) |
Determine whether an object is clipped by source object's clipper. More... | |
Eina_Bool | evas_object_image_animated_get (const Evas_Object *obj) |
Check if an image object can be animated (have multiple frames) More... | |
int | evas_object_image_animated_frame_count_get (const Evas_Object *obj) |
Get the total number of frames of the image object. More... | |
Evas_Image_Animated_Loop_Hint | evas_object_image_animated_loop_type_get (const Evas_Object *obj) |
Get the kind of looping the image object does. More... | |
int | evas_object_image_animated_loop_count_get (const Evas_Object *obj) |
Get the number times the animation of the object loops. More... | |
double | evas_object_image_animated_frame_duration_get (const Evas_Object *obj, int start_frame, int fram_num) |
Get the duration of a sequence of frames. More... | |
void | evas_object_image_animated_frame_set (Evas_Object *obj, int frame_num) |
Set the frame to current frame of an image object. More... | |
Here are grouped together functions used to create and manipulate image objects.
They are available to whichever occasion one needs complex imagery on a GUI that could not be achieved by the other Evas' primitive object types, or to make image manipulations.
Evas will support whichever image file types it was compiled with support to (its image loaders) – check your software packager for that information and see evas_object_image_extension_can_load_get().
The most common use of image objects – to display an image on the canvas – is achieved by a common function triplet:
The first function, naturally, is creating the image object. Then, one must set an source file on it, so that it knows where to fetch image data from. Next, one must set how to fill the image object's area with that given pixel data. One could use just a sub-region of the original image or even have it tiled repeatedly on the image object. For the common case of having the whole source image to be displayed on the image object, stretched to the destination's size, there's also a function helper, to be used instead of evas_object_image_fill_set():
See those functions' documentation for more details.
Resizing of image objects will scale their respective source images to their areas, if they are set to "fill" the object's area (evas_object_image_filled_set()). If the user wants any control on the aspect ratio of an image for different sizes, he/she has to take care of that themselves. There are functions to make images to get loaded scaled (up or down) in memory, already, if the user is going to use them at pre-determined sizes and wants to save computations.
Evas has even a scale cache, which will take care of caching scaled versions of images with more often usage/hits. Finally, one can have images being rescaled smoothly by Evas (more computationally expensive) or not.
When dealing with image objects, there are some tricks to boost the performance of your application, if it does intense image loading and/or manipulations, as in animations on a UI.
In image viewer applications, for example, the user will be looking at a given image, at full size, and will desire that the navigation to the adjacent images on his/her album be fluid and fast. Thus, while displaying a given image, the program can be on the background loading the next and previous images already, so that displaying them on the sequence is just a matter of repainting the screen (and not decoding image data).
Evas addresses this issue with image pre-loading. The code for the situation above would be something like the following:
If you're loading images which are too big, consider setting previously it's loading size to something smaller, in case you won't expose them in real size. It may speed up the loading considerably:
Refer to Elementary's Photocam widget for a high level (smart) object which does lots of loading speed-ups for you.
If you want to animate image objects on a UI (what you'd get by concomitant usage of other libraries, like Ecore and Edje), there are also some tips on how to boost the performance of your application. If the animation involves resizing of an image (thus, re-scaling), you'd better turn off smooth scaling on it during the animation, turning it back on afterwards, for less computations. Also, in this case you'd better flag the image object in question not to cache scaled versions of it:
Finally, movement of opaque images through the canvas is less expensive than of translucid ones, because of blending computations.
Evas provides facilities for one to specify an image's region to be treated specially – as "borders". This will make those regions be treated specially on resizing scales, by keeping their aspect. This makes setting frames around other objects on UIs easy. See the following figures for a visual explanation:
Full-size
Full-size
Evas image objects can be used to manipulate raw pixels in many ways. The meaning of the data in the pixel arrays will depend on the image's color space, be warned (see next section). You can set your own data as an image's pixel data, fetch an image's pixel data for saving/altering, convert images between different color spaces and even advanced operations like setting a native surface as image objects' data.
Image objects may return or accept "image data" in multiple formats. This is based on the color space of an object. Here is a rundown on formats:
Some examples on this group of functions can be found here.
#define evas_obj_image_file_set | ( | file, | |
key | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_FILE_SET), EO_TYPECHECK(const char *, file), EO_TYPECHECK(const char*, key) |
Set the source file from where an image object must fetch the real image data (it may be an Eet file, besides pure image ones).
[in] | file | The image file path. |
[in] | key | The image key in file (if its an Eet one), or |
Referenced by evas_object_image_file_set().
#define evas_obj_image_mmap_set | ( | f, | |
key | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_MMAP_SET), EO_TYPECHECK(const Eina_File *, f), EO_TYPECHECK(const char*, key) |
Set the source mmaped file from where an image object must fetch the real image data (it may be any Eina_File).
[in] | f | in |
[in] | key | in |
Referenced by evas_object_image_memfile_set(), and evas_object_image_mmap_set().
#define evas_obj_image_file_get | ( | file, | |
key | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_FILE_GET), EO_TYPECHECK(const char **, file), EO_TYPECHECK(const char **, key) |
Retrieve the source file from where an image object is to fetch the real image data (it may be an Eet file, besides pure image ones).
[out] | file | Location to store the image file path. |
[out] | key | Location to store the image key (if file is an Eet one). |
You must not modify the strings on the returned pointers.
NULL
pointers on the file components you're not interested in: they'll be ignored by the function.Referenced by evas_object_image_file_get().
#define evas_obj_image_source_set | ( | src, | |
result | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SOURCE_SET), EO_TYPECHECK(Evas_Object *, src), EO_TYPECHECK(Eina_Bool *, result) |
Set the source object on an image object to used as a proxy.
[in] | src | in |
[out] | result | out |
Referenced by evas_object_image_source_set(), and evas_object_image_source_unset().
#define evas_obj_image_source_get | ( | src | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SOURCE_GET), EO_TYPECHECK(Evas_Object **, src) |
Get the current source object of an image object.
[out] | src | out |
Referenced by evas_object_image_source_get().
#define evas_obj_image_source_visible_set | ( | visible | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SOURCE_VISIBLE_SET), EO_TYPECHECK(Eina_Bool, visible) |
Set the source object to be shown or hidden.
[in] | visible | in |
Referenced by evas_object_image_source_visible_set().
#define evas_obj_image_source_visible_get | ( | visible | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SOURCE_VISIBLE_GET), EO_TYPECHECK(Eina_Bool *, visible) |
Get the state of the source object visibility.
[out] | visible | out |
Referenced by evas_object_image_source_visible_get().
#define evas_obj_image_source_events_set | ( | source | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SOURCE_EVENTS_SET), EO_TYPECHECK(Eina_Bool, source) |
Set events to be repeated to the source object.
[in] | source | in |
Referenced by evas_object_image_source_events_set().
#define evas_obj_image_source_events_get | ( | source | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SOURCE_EVENTS_GET), EO_TYPECHECK(Eina_Bool *, source) |
Get the state of the source event.
[out] | source | out |
Referenced by evas_object_image_source_events_get().
#define evas_obj_image_source_clip_set | ( | source_clip | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SOURCE_CLIP_SET), EO_TYPECHECK(Eina_Bool, source_clip) |
Apply the source object's clip to the proxy
[in] | source_clip | in |
Referenced by evas_object_image_source_clip_set().
#define evas_obj_image_source_clip_get | ( | source_clip | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SOURCE_CLIP_GET), EO_TYPECHECK(Eina_Bool *, source_clip) |
Get the state of the source clip
[out] | source_clip | out |
Referenced by evas_image_max_size_get(), and evas_object_image_source_clip_get().
#define evas_obj_image_border_set | ( | l, | |
r, | |||
t, | |||
b | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_BORDER_SET), EO_TYPECHECK(int, l), EO_TYPECHECK(int, r), EO_TYPECHECK(int, t), EO_TYPECHECK(int, b) |
Set the dimensions for an image object's border, a region which won't ever be scaled together with its center.
[in] | l | in |
[in] | r | in |
[in] | t | in |
[in] | b | in |
Referenced by evas_object_image_border_set().
#define evas_obj_image_border_get | ( | l, | |
r, | |||
t, | |||
b | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_BORDER_GET), EO_TYPECHECK(int *, l), EO_TYPECHECK(int *, r), EO_TYPECHECK(int *, t), EO_TYPECHECK(int *, b) |
Retrieve the dimensions for an image object's border, a region which won't ever be scaled together with its center.
[out] | l | in |
[out] | r | in |
[out] | t | in |
[out] | b | in |
Referenced by evas_object_image_border_get().
#define evas_obj_image_border_center_fill_set | ( | fill | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_BORDER_CENTER_FILL_SET), EO_TYPECHECK(Evas_Border_Fill_Mode, fill) |
Sets how the center part of the given image object (not the borders) should be drawn when Evas is rendering it.
[in] | fill | in |
Referenced by evas_object_image_border_center_fill_set().
#define evas_obj_image_border_center_fill_get | ( | fill | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_BORDER_CENTER_FILL_GET), EO_TYPECHECK(Evas_Border_Fill_Mode *, fill) |
Retrieves how the center part of the given image object (not the borders) is to be drawn when Evas is rendering it.
[out] | fill | out |
Referenced by evas_object_image_border_center_fill_get().
#define evas_obj_image_filled_set | ( | filled | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_FILLED_SET), EO_TYPECHECK(Eina_Bool, filled) |
Set whether the image object's fill property should track the object's size.
[in] | filled | in |
Referenced by evas_object_image_filled_set().
#define evas_obj_image_filled_get | ( | filled | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_FILLED_GET), EO_TYPECHECK(Eina_Bool *, filled) |
Retrieve whether the image object's fill property should track the object's size.
[out] | filled | out |
Referenced by evas_object_image_filled_get().
#define evas_obj_image_border_scale_set | ( | scale | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_BORDER_SCALE_SET), EO_TYPECHECK(double, scale) |
Sets the scaling factor (multiplier) for the borders of an image object.
[in] | scale | in |
Referenced by evas_object_image_border_scale_set().
#define evas_obj_image_border_scale_get | ( | scale | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_BORDER_SCALE_GET), EO_TYPECHECK(double *, scale) |
Retrieves the scaling factor (multiplier) for the borders of an image object.
[out] | scale | out |
Referenced by evas_object_image_border_scale_get().
#define evas_obj_image_fill_set | ( | x, | |
y, | |||
w, | |||
h | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_FILL_SET), EO_TYPECHECK(Evas_Coord, x), EO_TYPECHECK(Evas_Coord, y), EO_TYPECHECK(Evas_Coord, w), EO_TYPECHECK(Evas_Coord, h) |
Set how to fill an image object's drawing rectangle given the (real) image bound to it.
[in] | x | in |
[in] | y | in |
[in] | w | in |
[in] | h | in |
Referenced by evas_object_image_fill_set().
#define evas_obj_image_fill_get | ( | x, | |
y, | |||
w, | |||
h | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_FILL_GET), EO_TYPECHECK(Evas_Coord *, x), EO_TYPECHECK(Evas_Coord *, y), EO_TYPECHECK(Evas_Coord *, w), EO_TYPECHECK(Evas_Coord *, h) |
Retrieve how an image object is to fill its drawing rectangle, given the (real) image bound to it.
[out] | x | out |
[out] | y | out |
[out] | w | out |
[out] | h | out |
Referenced by evas_object_image_fill_get().
#define evas_obj_image_fill_spread_set | ( | spread | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_FILL_SPREAD_SET), EO_TYPECHECK(Evas_Fill_Spread, spread) |
Sets the tiling mode for the given evas image object's fill.
[in] | spread | in |
Referenced by evas_object_image_fill_spread_set().
#define evas_obj_image_fill_spread_get | ( | spread | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_FILL_SPREAD_GET), EO_TYPECHECK(Evas_Fill_Spread *, spread) |
Retrieves the spread (tiling mode) for the given image object's fill.
[out] | spread | out |
Referenced by evas_object_image_fill_spread_get().
#define evas_obj_image_size_set | ( | w, | |
h | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SIZE_SET), EO_TYPECHECK(int, w), EO_TYPECHECK(int, h) |
Sets the size of the given image object.
[in] | w | in |
[in] | h | in |
Referenced by evas_object_image_size_set().
#define evas_obj_image_size_get | ( | w, | |
h | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SIZE_GET), EO_TYPECHECK(int *, w), EO_TYPECHECK(int *, h) |
Retrieves the size of the given image object.
[out] | w | out |
[out] | h | out |
Referenced by evas_object_image_size_get().
#define evas_obj_image_stride_get | ( | stride | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_STRIDE_GET), EO_TYPECHECK(int *, stride) |
Retrieves the row stride of the given image object.
[out] | stride | out |
Referenced by evas_object_image_stride_get().
#define evas_obj_image_load_error_get | ( | load_error | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_ERROR_GET), EO_TYPECHECK(Evas_Load_Error *, load_error) |
Retrieves a number representing any error that occurred during the last loading of the given image object's source image.
[out] | load_error |
Referenced by evas_object_image_load_error_get(), and evas_object_image_source_events_get().
#define evas_obj_image_data_convert | ( | to_cspace, | |
data | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_DATA_CONVERT), EO_TYPECHECK(Evas_Colorspace, to_cspace), EO_TYPECHECK(void **, data) |
Converts the raw image data of the given image object to the specified colorspace.
[in] | to_cspace | in |
[out] | data | out |
Referenced by evas_object_image_data_convert().
#define evas_obj_image_data_set | ( | data | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_DATA_SET), EO_TYPECHECK(void *, data) |
Sets the raw image data of the given image object.
[in] | data | in |
Referenced by evas_object_image_data_set().
#define evas_obj_image_data_get | ( | for_writing, | |
data | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_DATA_GET), EO_TYPECHECK(Eina_Bool, for_writing), EO_TYPECHECK(void **, data) |
Get a pointer to the raw image data of the given image object.
[in] | for_writing | in |
[out] | data | out |
Referenced by evas_object_image_data_get().
#define evas_obj_image_data_copy_set | ( | data | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_DATA_COPY_SET), EO_TYPECHECK(void *, data) |
Replaces the raw image data of the given image object.
[in] | data | in |
Referenced by evas_object_image_data_copy_set().
#define evas_obj_image_data_update_add | ( | x, | |
y, | |||
w, | |||
h | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_DATA_UPDATE_ADD), EO_TYPECHECK(int, x), EO_TYPECHECK(int, y), EO_TYPECHECK(int, w), EO_TYPECHECK(int, h) |
Mark a sub-region of the given image object to be redrawn.
[in] | x | in |
[in] | y | in |
[in] | w | in |
[in] | h | in |
Referenced by evas_object_image_data_update_add().
#define evas_obj_image_alpha_set | ( | alpha | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_ALPHA_SET), EO_TYPECHECK(Eina_Bool, sw_64) |
Enable or disable alpha channel usage on the given image object.
[in] | alpha | in |
Referenced by evas_object_image_alpha_set().
#define evas_obj_image_alpha_get | ( | alpha | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_ALPHA_GET), EO_TYPECHECK(Eina_Bool *, sw_64) |
Retrieve whether alpha channel data is being used on the given image object.
[out] | alpha | out |
Referenced by evas_object_image_alpha_get().
#define evas_obj_image_smooth_scale_set | ( | smooth_scale | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SMOOTH_SCALE_SET), EO_TYPECHECK(Eina_Bool, smooth_scale) |
Sets whether to use high-quality image scaling algorithm on the given image object.
[in] | smooth_scale | in |
Referenced by evas_object_image_smooth_scale_set().
#define evas_obj_image_smooth_scale_get | ( | smooth_scale | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SMOOTH_SCALE_GET), EO_TYPECHECK(Eina_Bool *, smooth_scale) |
Retrieves whether the given image object is using high-quality image scaling algorithm.
[out] | smooth_scale | out |
Referenced by evas_object_image_smooth_scale_get().
#define evas_obj_image_preload_begin | ( | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_PRELOAD_BEGIN) |
Begin preloading an image object's image data in the background
Referenced by evas_object_image_preload().
#define evas_obj_image_preload_cancel | ( | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_PRELOAD_CANCEL) |
Cancel preloading an image object's image data in the background
Referenced by evas_object_image_preload().
#define evas_obj_image_reload | ( | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_RELOAD) |
Reload an image object's image data.
Referenced by evas_object_image_reload().
#define evas_obj_image_save | ( | file, | |
key, | |||
flags, | |||
result | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SAVE), EO_TYPECHECK(const char *, file), EO_TYPECHECK(const char *, key), EO_TYPECHECK(const char *, flags), EO_TYPECHECK(Eina_Bool *, result) |
Save the given image object's contents to an (image) file.
[in] | file | in |
[in] | key | in |
[in] | flags | in |
[out] | result | out |
Referenced by evas_object_image_save().
#define evas_obj_image_pixels_import | ( | pixels, | |
result | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_PIXELS_IMPORT), EO_TYPECHECK(Evas_Pixel_Import_Source *, pixels), EO_TYPECHECK(Eina_Bool *, result) |
Import pixels from given source to a given canvas image object.
[in] | pixels | in |
[out] | result | out |
Referenced by evas_object_image_pixels_import().
#define evas_obj_image_pixels_get_callback_set | ( | func, | |
data | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_PIXELS_GET_CALLBACK_SET), EO_TYPECHECK(Evas_Object_Image_Pixels_Get_Cb, func), EO_TYPECHECK(void *, data) |
Set the callback function to get pixels from a canvas' image.
[in] | func | in |
[in] | data | in |
Referenced by evas_object_image_pixels_get_callback_set().
#define evas_obj_image_pixels_dirty_set | ( | dirty | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_PIXELS_DIRTY_SET), EO_TYPECHECK(Eina_Bool, dirty) |
Mark whether the given image object is dirty (needs to be redrawn).
[in] | dirty | in |
Referenced by evas_object_image_pixels_dirty_set().
#define evas_obj_image_pixels_dirty_get | ( | dirty | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_PIXELS_DIRTY_GET), EO_TYPECHECK(Eina_Bool *, dirty) |
Retrieves whether the given image object is dirty (needs to be redrawn).
[out] | dirty | out |
Referenced by evas_object_image_pixels_dirty_get().
#define evas_obj_image_load_dpi_set | ( | dpi | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_DPI_SET), EO_TYPECHECK(double, dpi) |
Set the DPI resolution of an image object's source image.
[in] | dpi | in |
Referenced by evas_object_image_load_dpi_set().
#define evas_obj_image_load_dpi_get | ( | dpi | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_DPI_GET), EO_TYPECHECK(double *, dpi) |
Get the DPI resolution of a loaded image object in the canvas.
[out] | dpi | out |
Referenced by evas_object_image_load_dpi_get().
#define evas_obj_image_load_size_set | ( | w, | |
h | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_SIZE_SET), EO_TYPECHECK(int, w), EO_TYPECHECK(int, h) |
Set the size of a given image object's source image, when loading it.
[in] | w | in |
[in] | h | in |
Referenced by evas_object_image_load_size_set().
#define evas_obj_image_load_size_get | ( | w, | |
h | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_SIZE_GET), EO_TYPECHECK(int *, w), EO_TYPECHECK(int *, h) |
Get the size of a given image object's source image, when loading it.
[out] | w | out |
[out] | h | out |
Referenced by evas_object_image_load_size_get().
#define evas_obj_image_load_scale_down_set | ( | scale_down | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_SCALE_DOWN_SET), EO_TYPECHECK(int, scale_down) |
Set the scale down factor of a given image object's source image, when loading it.
[in] | scale_down | in |
Referenced by evas_object_image_load_scale_down_set().
#define evas_obj_image_load_scale_down_get | ( | scale_down | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_SCALE_DOWN_GET), EO_TYPECHECK(int *, scale_down) |
Get the scale down factor of a given image object's source image, when loading it.
[out] | scale_down | out |
Referenced by evas_object_image_load_scale_down_get().
#define evas_obj_image_load_region_set | ( | x, | |
y, | |||
w, | |||
h | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_REGION_SET), EO_TYPECHECK(int, x), EO_TYPECHECK(int, y), EO_TYPECHECK(int, w), EO_TYPECHECK(int, h) |
Inform a given image object to load a selective region of its source image.
[in] | x | in |
[in] | y | in |
[in] | w | in |
[in] | h | in |
Referenced by evas_object_image_load_region_set().
#define evas_obj_image_load_region_get | ( | x, | |
y, | |||
w, | |||
h | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_REGION_GET), EO_TYPECHECK(int *, x), EO_TYPECHECK(int *, y), EO_TYPECHECK(int *, w), EO_TYPECHECK(int *, h) |
Retrieve the coordinates of a given image object's selective (source image) load region.
[out] | x | out |
[out] | y | out |
[out] | w | out |
[out] | h | out |
Referenced by evas_object_image_load_region_get().
#define evas_obj_image_load_orientation_set | ( | enable | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_ORIENTATION_SET), EO_TYPECHECK(Eina_Bool, enable) |
Define if the orientation information in the image file should be honored.
[in] | enable | in |
Referenced by evas_object_image_load_orientation_set().
#define evas_obj_image_load_orientation_get | ( | enable | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_LOAD_ORIENTATION_GET), EO_TYPECHECK(Eina_Bool *, enable) |
Get if the orientation information in the image file should be honored.
[out] | enable | out |
Referenced by evas_object_image_load_orientation_get().
#define evas_obj_image_colorspace_set | ( | cspace | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_COLORSPACE_SET), EO_TYPECHECK(Evas_Colorspace, cspace) |
Set the colorspace of a given image of the canvas.
[in] | cspace | in |
Referenced by evas_object_image_colorspace_set().
#define evas_obj_image_colorspace_get | ( | cspace | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_COLORSPACE_GET), EO_TYPECHECK(Evas_Colorspace *, cspace) |
Get the colorspace of a given image of the canvas.
[out] | cspace | out |
Referenced by evas_object_image_colorspace_get().
#define evas_obj_image_video_surface_set | ( | surf | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_VIDEO_SURFACE_SET), EO_TYPECHECK(Evas_Video_Surface *, surf) |
Set the video surface linked to a given image of the canvas
[in] | surf | in |
Referenced by evas_object_image_video_surface_set().
#define evas_obj_image_video_surface_get | ( | surf | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_VIDEO_SURFACE_GET), EO_TYPECHECK(const Evas_Video_Surface **, surf) |
Get the video surface linked to a given image of the canvas
[out] | surf | out |
Referenced by evas_object_image_video_surface_get().
#define evas_obj_image_video_surface_caps_set | ( | caps | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_VIDEO_SURFACE_CAPS_SET), EO_TYPECHECK(unsigned int, caps) |
Set the video surface capabilities to a given image of the canvas
[in] | caps | in |
Referenced by evas_object_image_video_surface_get().
#define evas_obj_image_video_surface_caps_get | ( | caps | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_VIDEO_SURFACE_CAPS_GET), EO_TYPECHECK(unsigned int *, caps) |
Get the video surface capabilities to a given image of the canvas
[out] | caps | out |
Referenced by evas_object_image_video_surface_get().
#define evas_obj_image_native_surface_set | ( | surf | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_NATIVE_SURFACE_SET), EO_TYPECHECK(Evas_Native_Surface *, surf) |
Set the native surface of a given image of the canvas
[in] | surf | in |
Referenced by evas_object_image_native_surface_set().
#define evas_obj_image_native_surface_get | ( | surf | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_NATIVE_SURFACE_GET), EO_TYPECHECK(Evas_Native_Surface **, surf) |
Get the native surface of a given image of the canvas
[out] | surf | out |
Referenced by evas_object_image_native_surface_get().
#define evas_obj_image_scale_hint_set | ( | hint | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SCALE_HINT_SET), EO_TYPECHECK(Evas_Image_Scale_Hint, hint) |
Set the scale hint of a given image of the canvas.
[in] | hint | in |
Referenced by evas_object_image_scale_hint_set().
#define evas_obj_image_scale_hint_get | ( | hint | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_SCALE_HINT_GET), EO_TYPECHECK(Evas_Image_Scale_Hint *, hint) |
Get the scale hint of a given image of the canvas.
[out] | hint | out |
Referenced by evas_object_image_scale_hint_get().
#define evas_obj_image_content_hint_set | ( | hint | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_CONTENT_HINT_SET), EO_TYPECHECK(Evas_Image_Content_Hint, hint) |
Set the content hint setting of a given image object of the canvas.
[in] | hint | in |
Referenced by evas_object_image_content_hint_set().
#define evas_obj_image_content_hint_get | ( | hint | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_CONTENT_HINT_GET), EO_TYPECHECK(Evas_Image_Content_Hint *, hint) |
Get the content hint setting of a given image object of the canvas.
[out] | hint | out |
Referenced by evas_object_image_content_hint_get().
#define evas_obj_image_region_support_get | ( | region | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_REGION_SUPPORT_GET), EO_TYPECHECK(Eina_Bool *, region) |
Get the support state of a given image
[out] | region | out |
Referenced by evas_object_image_region_support_get().
#define evas_obj_image_animated_get | ( | animated | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_ANIMATED_GET), EO_TYPECHECK(Eina_Bool *, animated) |
Check if an image object can be animated (have multiple frames)
[out] | animated | out |
Referenced by evas_object_image_animated_get().
#define evas_obj_image_animated_frame_count_get | ( | frame_count | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_ANIMATED_FRAME_COUNT_GET), EO_TYPECHECK(int *, frame_count) |
Get the total number of frames of the image object.
[out] | frame_count | out |
Referenced by evas_object_image_animated_frame_count_get().
#define evas_obj_image_animated_loop_type_get | ( | hint | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_ANIMATED_LOOP_TYPE_GET), EO_TYPECHECK(Evas_Image_Animated_Loop_Hint *, hint) |
Get the kind of looping the image object does.
[out] | hint | out |
Referenced by evas_object_image_animated_loop_type_get().
#define evas_obj_image_animated_loop_count_get | ( | loop_count | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_ANIMATED_LOOP_COUNT_GET), EO_TYPECHECK(int *, loop_count) |
Get the number times the animation of the object loops.
[out] | loop_count | out |
Referenced by evas_object_image_animated_loop_count_get().
#define evas_obj_image_animated_frame_duration_get | ( | start_frame, | |
frame_num, | |||
frame_duration | |||
) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_ANIMATED_FRAME_DURATION_GET), EO_TYPECHECK(int, start_frame), EO_TYPECHECK(int, frame_num), EO_TYPECHECK(double *, frame_duration) |
Get the duration of a sequence of frames.
[in] | start_frame | in |
[in] | frame_num | in |
[out] | frame_duration | out |
Referenced by evas_object_image_animated_frame_duration_get().
#define evas_obj_image_animated_frame_set | ( | frame_index | ) | EVAS_OBJ_IMAGE_ID(EVAS_OBJ_IMAGE_SUB_ID_ANIMATED_FRAME_SET), EO_TYPECHECK(int, frame_index) |
Set the frame to current frame of an image object
[in] | frame_index | in |
Referenced by evas_object_image_animated_frame_set().
typedef enum _Evas_Colorspace Evas_Colorspace |
Colorspaces for pixel data supported by Evas.
Colorspaces for pixel data supported by Evas
enum _Evas_Colorspace |
Colorspaces for pixel data supported by Evas.
Eina_Bool evas_object_image_extension_can_load_get | ( | const char * | file | ) |
Check if a file extension may be supported by Image Object Functions.
file | The file to check |
EINA_TRUE
if we may be able to open it, EINA_FALSE
if it's unlikely. If file is a Eina_Stringshare, use directly evas_object_image_extension_can_load_fast_get.
This functions is threadsafe.
References EAPI, eina_stringshare_add(), and eina_stringshare_del().
Eina_Bool evas_object_image_extension_can_load_fast_get | ( | const char * | file | ) |
Check if a file extension may be supported by Image Object Functions.
file | The file to check, it should be an Eina_Stringshare. |
EINA_TRUE
if we may be able to open it, EINA_FALSE
if it's unlikely. This functions is threadsafe.
References EAPI.
Evas_Object* evas_object_image_add | ( | Evas * | e | ) |
Creates a new image object on the given Evas e
canvas.
e | The given canvas. |
Example:
References EAPI.
Referenced by ecore_evas_cursor_set(), ecore_evas_ews_new(), ecore_evas_object_image_new(), edje_edit_object_add(), edje_edit_part_name_set(), edje_file_data_get(), emotion_object_suspend_get(), and evas_object_image_filled_add().
Evas_Object* evas_object_image_filled_add | ( | Evas * | e | ) |
Creates a new image object that automatically scales its bound image to the object's area, on both axis.
e | The given canvas. |
This is a helper function around evas_object_image_add() and evas_object_image_filled_set(). It has the same effect of applying those functions in sequence, which is a very common use case.
References EAPI, evas_object_image_add(), and evas_object_image_filled_set().
void evas_object_image_memfile_set | ( | Evas_Object * | obj, |
void * | data, | ||
int | size, | ||
char * | format, | ||
char * | key | ||
) |
Sets the data for an image from memory to be loaded.
This is the same as evas_object_image_file_set() but the file to be loaded may exist at an address in memory (the data for the file, not the filename itself). The data
at the address is copied and stored for future use, so no data
needs to be kept after this call is made. It will be managed and freed for you when no longer needed. The size
is limited to 2 gigabytes in size, and must be greater than 0. A NULL
data
pointer is also invalid. Set the filename to NULL
to reset to empty state and have the image file data freed from memory using evas_object_image_file_set().
The format
is optional (pass NULL
if you don't need/use it). It is used to help Evas guess better which loader to use for the data. It may simply be the "extension" of the file as it would normally be on disk such as "jpg" or "png" or "gif" etc.
obj | The given image object. |
data | The image file data address |
size | The size of the image file data in bytes |
format | The format of the file (optional), or NULL if not needed |
key | The image key in file, or NULL . |
References EAPI, EINA_COW_WRITE_BEGIN, EINA_COW_WRITE_END, EINA_FALSE, eina_file_close(), eina_file_dup(), eina_file_virtualize(), eina_stringshare_add(), eina_stringshare_del(), EINA_TRUE, EVAS_COLORSPACE_ARGB8888, and evas_obj_image_mmap_set.
void evas_object_image_file_set | ( | Evas_Object * | obj, |
const char * | file, | ||
const char * | key | ||
) |
Set the source file from where an image object must fetch the real image data (it may be an Eet file, besides pure image ones).
obj | The given image object. |
file | The image file path. |
key | The image key in file (if its an Eet one), or NULL , otherwise. |
If the file supports multiple data stored in it (as Eet files do), you can specify the key to be used as the index of the image in this file.
Example:
References EAPI, and evas_obj_image_file_set.
Referenced by ecore_evas_cursor_set(), edje_edit_object_add(), evas_image_max_size_get(), and evas_object_image_source_set().
void evas_object_image_mmap_set | ( | Evas_Object * | obj, |
const Eina_File * | f, | ||
const char * | key | ||
) |
Set the source mmaped file from where an image object must fetch the real image data (it must be an Eina_File).
obj | The given image object. |
f | The mmaped file |
key | The image key in file (if its an Eet one), or NULL , otherwise. |
If the file supports multiple data stored in it (as Eet files do), you can specify the key to be used as the index of the image in this file.
References EAPI, and evas_obj_image_mmap_set.
void evas_object_image_file_get | ( | const Evas_Object * | obj, |
const char ** | file, | ||
const char ** | key | ||
) |
Retrieve the source file from where an image object is to fetch the real image data (it may be an Eet file, besides pure image ones).
obj | The given image object. |
file | Location to store the image file path. |
key | Location to store the image key (if file is an Eet one). |
You must not modify the strings on the returned pointers.
NULL
pointers on the file components you're not interested in: they'll be ignored by the function. References EAPI, and evas_obj_image_file_get.
Referenced by edje_object_preload().
void evas_object_image_border_set | ( | Evas_Object * | obj, |
int | l, | ||
int | r, | ||
int | t, | ||
int | b | ||
) |
Set the dimensions for an image object's border, a region which won't ever be scaled together with its center.
obj | The given image object. |
l | The border's left width. |
r | The border's right width. |
t | The border's top width. |
b | The border's bottom width. |
When Evas is rendering, an image source may be scaled to fit the size of its image object. This function sets an area from the borders of the image inwards which is not to be scaled. This function is useful for making frames and for widget theming, where, for example, buttons may be of varying sizes, but their border size must remain constant.
The units used for l
, r
, t
and b
are canvas units.
l
, r
, t
and b
start as 0
.See the following figures for visual explanation:
Full-size
Full-size
References EAPI, EINA_TRUE, and evas_obj_image_border_set.
void evas_object_image_border_get | ( | const Evas_Object * | obj, |
int * | l, | ||
int * | r, | ||
int * | t, | ||
int * | b | ||
) |
Retrieve the dimensions for an image object's border, a region which won't ever be scaled together with its center.
obj | The given image object. |
l | Location to store the border's left width in. |
r | Location to store the border's right width in. |
t | Location to store the border's top width in. |
b | Location to store the border's bottom width in. |
NULL
pointers on the border components you're not interested in: they'll be ignored by the function.See evas_object_image_border_set() for more details.
References EAPI, and evas_obj_image_border_get.
void evas_object_image_border_center_fill_set | ( | Evas_Object * | obj, |
Evas_Border_Fill_Mode | fill | ||
) |
Sets how the center part of the given image object (not the borders) should be drawn when Evas is rendering it.
obj | The given image object. |
fill | Fill mode of the center region of obj (a value in Evas_Border_Fill_Mode). |
This function sets how the center part of the image object's source image is to be drawn, which must be one of the values in Evas_Border_Fill_Mode. By center we mean the complementary part of that defined by evas_object_image_border_set(). This one is very useful for making frames and decorations. You would most probably also be using a filled image (as in evas_object_image_filled_set()) to use as a frame.
References EAPI, EINA_TRUE, and evas_obj_image_border_center_fill_set.
Evas_Border_Fill_Mode evas_object_image_border_center_fill_get | ( | const Evas_Object * | obj | ) |
Retrieves how the center part of the given image object (not the borders) is to be drawn when Evas is rendering it.
obj | The given image object. |
obj
(a value in Evas_Border_Fill_Mode).See evas_object_image_fill_set() for more details.
References EAPI, and evas_obj_image_border_center_fill_get.
void evas_object_image_filled_set | ( | Evas_Object * | obj, |
Eina_Bool | setting | ||
) |
Set whether the image object's fill property should track the object's size.
obj | The given image object. |
setting | EINA_TRUE , to make the fill property follow object size or EINA_FALSE , otherwise. |
If setting
is EINA_TRUE
, then every evas_object_resize() will automatically trigger a call to evas_object_image_fill_set() with the that new size (and 0
, 0
as source image's origin), so the bound image will fill the whole object's area.
References EAPI, EVAS_CALLBACK_RESIZE, evas_obj_image_filled_set, evas_object_event_callback_add(), evas_object_event_callback_del(), evas_object_geometry_get(), and evas_object_image_fill_set().
Referenced by evas_object_image_filled_add().
Eina_Bool evas_object_image_filled_get | ( | const Evas_Object * | obj | ) |
Retrieve whether the image object's fill property should track the object's size.
obj | The given image object. |
EINA_TRUE
if it is tracking, EINA_FALSE
, if not (and evas_object_fill_set() must be called manually).References EAPI, EINA_FALSE, and evas_obj_image_filled_get.
void evas_object_image_border_scale_set | ( | Evas_Object * | obj, |
double | scale | ||
) |
Sets the scaling factor (multiplier) for the borders of an image object.
obj | The given image object. |
scale | The scale factor (default is 1.0 - i.e. no scaling) |
References EAPI, EINA_TRUE, and evas_obj_image_border_scale_set.
double evas_object_image_border_scale_get | ( | const Evas_Object * | obj | ) |
Retrieves the scaling factor (multiplier) for the borders of an image object.
obj | The given image object. |
References EAPI, and evas_obj_image_border_scale_get.
void evas_object_image_fill_set | ( | Evas_Object * | obj, |
Evas_Coord | x, | ||
Evas_Coord | y, | ||
Evas_Coord | w, | ||
Evas_Coord | h | ||
) |
Set how to fill an image object's drawing rectangle given the (real) image bound to it.
obj | The given image object to operate on. |
x | The x coordinate (from the top left corner of the bound image) to start drawing from. |
y | The y coordinate (from the top left corner of the bound image) to start drawing from. |
w | The width the bound image will be displayed at. |
h | The height the bound image will be displayed at. |
Note that if w
or h
are smaller than the dimensions of obj
, the displayed image will be tiled around the object's area. To have only one copy of the bound image drawn, x
and y
must be 0 and w
and h
need to be the exact width and height of the image object itself, respectively.
See the following image to better understand the effects of this call. On this diagram, both image object and original image source have a
x a
dimensions and the image itself is a circle, with empty space around it:
x
= 0, y
= 0, w
= 0 and h
= 0. Thus, if you're not using the evas_object_image_filled_add() helper and want your image displayed, you'll have to set valid values with this function on your object.References EAPI, EINA_TRUE, and evas_obj_image_fill_set.
Referenced by ecore_evas_cursor_set(), ecore_evas_ews_new(), emotion_object_suspend_get(), evas_image_max_size_get(), and evas_object_image_filled_set().
void evas_object_image_fill_get | ( | const Evas_Object * | obj, |
Evas_Coord * | x, | ||
Evas_Coord * | y, | ||
Evas_Coord * | w, | ||
Evas_Coord * | h | ||
) |
Retrieve how an image object is to fill its drawing rectangle, given the (real) image bound to it.
obj | The given image object. |
x | Location to store the x coordinate (from the top left corner of the bound image) to start drawing from. |
y | Location to store the y coordinate (from the top left corner of the bound image) to start drawing from. |
w | Location to store the width the bound image is to be displayed at. |
h | Location to store the height the bound image is to be displayed at. |
NULL
pointers on the fill components you're not interested in: they'll be ignored by the function.See evas_object_image_fill_set() for more details.
References EAPI, and evas_obj_image_fill_get.
void evas_object_image_fill_spread_set | ( | Evas_Object * | obj, |
Evas_Fill_Spread | spread | ||
) |
Sets the tiling mode for the given evas image object's fill.
obj | The given evas image object. |
spread | One of EVAS_TEXTURE_REFLECT, EVAS_TEXTURE_REPEAT, EVAS_TEXTURE_RESTRICT, or EVAS_TEXTURE_PAD. |
References EAPI, EINA_TRUE, and evas_obj_image_fill_spread_set.
Evas_Fill_Spread evas_object_image_fill_spread_get | ( | const Evas_Object * | obj | ) |
Retrieves the spread (tiling mode) for the given image object's fill.
obj | The given evas image object. |
References EAPI, evas_obj_image_fill_spread_get, and EVAS_TEXTURE_REPEAT.
void evas_object_image_size_set | ( | Evas_Object * | obj, |
int | w, | ||
int | h | ||
) |
Sets the size of the given image object.
obj | The given image object. |
w | The new width of the image. |
h | The new height of the image. |
This function will scale down or crop the image so that it is treated as if it were at the given size. If the size given is smaller than the image, it will be cropped. If the size given is larger, then the image will be treated as if it were in the upper left hand corner of a larger image that is otherwise transparent.
References EAPI, EINA_COW_WRITE_BEGIN, EINA_COW_WRITE_END, EINA_TRUE, and evas_obj_image_size_set.
Referenced by ecore_evas_ews_new(), ecore_evas_object_image_new(), emotion_object_file_set(), and emotion_object_suspend_get().
void evas_object_image_size_get | ( | const Evas_Object * | obj, |
int * | w, | ||
int * | h | ||
) |
Retrieves the size of the given image object.
obj | The given image object. |
w | Location to store the width of the image in, or NULL . |
h | Location to store the height of the image in, or NULL . |
See evas_object_image_size_set() for more details.
References EAPI, and evas_obj_image_size_get.
Referenced by ecore_evas_cursor_set(), edje_edit_object_add(), edje_object_update_hints_get(), emotion_object_suspend_get(), and evas_obscured_clear().
int evas_object_image_stride_get | ( | const Evas_Object * | obj | ) |
Retrieves the row stride of the given image object.
obj | The given image object. |
The row stride is the number of bytes between the start of a row and the start of the next row for image data.
References EAPI, and evas_obj_image_stride_get.
Referenced by ecore_evas_ews_new(), and ecore_evas_object_image_new().
Evas_Load_Error evas_object_image_load_error_get | ( | const Evas_Object * | obj | ) |
Retrieves a number representing any error that occurred during the last loading of the given image object's source image.
obj | The given image object. |
References EAPI, and evas_obj_image_load_error_get.
Referenced by edje_edit_object_add(), and evas_object_image_source_events_get().
void evas_object_image_data_set | ( | Evas_Object * | obj, |
void * | data | ||
) |
Sets the raw image data of the given image object.
obj | The given image object. |
data | The raw data, or NULL . |
Note that the raw data must be of the same size (see evas_object_image_size_set(), which has to be called before this one) and colorspace (see evas_object_image_colorspace_set()) of the image. If data is NULL
, the current image data will be freed. Naturally, if one does not set an image object's data manually, it will still have one, allocated by Evas.
References EAPI, EINA_FALSE, EINA_TRUE, and evas_obj_image_data_set.
Referenced by ecore_evas_ews_new(), ecore_evas_object_image_new(), emotion_object_file_set(), and emotion_object_suspend_get().
void* evas_object_image_data_get | ( | const Evas_Object * | obj, |
Eina_Bool | for_writing | ||
) |
Get a pointer to the raw image data of the given image object.
obj | The given image object. |
for_writing | Whether the data being retrieved will be modified (EINA_TRUE ) or not (EINA_FALSE ). |
This function returns a pointer to an image object's internal pixel buffer, for reading only or read/write. If you request it for writing, the image will be marked dirty so that it gets redrawn at the next update.
Each time you call this function on an image object, its data buffer will have an internal reference counter incremented. Decrement it back by using evas_object_image_data_set().
This is best suited for when you want to modify an existing image, without changing its dimensions.
References EAPI, EINA_TRUE, and evas_obj_image_data_get.
Referenced by ecore_evas_ews_new(), ecore_evas_object_image_new(), edje_edit_object_add(), and emotion_object_suspend_get().
void* evas_object_image_data_convert | ( | Evas_Object * | obj, |
Evas_Colorspace | to_cspace | ||
) |
Converts the raw image data of the given image object to the specified colorspace.
Note that this function does not modify the raw image data. If the requested colorspace is the same as the image colorspace nothing is done and NULL
is returned. You should use evas_object_image_colorspace_get() to check the current image colorspace.
See evas_object_image_colorspace_get.
obj | The given image object. |
to_cspace | The colorspace to which the image raw data will be converted. |
References EAPI, EINA_FALSE, and evas_obj_image_data_convert.
void evas_object_image_data_copy_set | ( | Evas_Object * | obj, |
void * | data | ||
) |
Replaces the raw image data of the given image object.
obj | The given image object. |
data | The raw data to replace. |
This function lets the application replace an image object's internal pixel buffer with an user-allocated one. For best results, you should generally first call evas_object_image_size_set() with the width and height for the new buffer.
This call is best suited for when you will be using image data with different dimensions than the existing image data, if any. If you only need to modify the existing image in some fashion, then using evas_object_image_data_get() is probably what you are after.
Note that the caller is responsible for freeing the buffer when finished with it, as user-set image data will not be automatically freed when the image object is deleted.
See evas_object_image_data_get() for more details.
References EAPI, EINA_TRUE, and evas_obj_image_data_copy_set.
void evas_object_image_data_update_add | ( | Evas_Object * | obj, |
int | x, | ||
int | y, | ||
int | w, | ||
int | h | ||
) |
Mark a sub-region of the given image object to be redrawn.
obj | The given image object. |
x | X-offset of the region to be updated. |
y | Y-offset of the region to be updated. |
w | Width of the region to be updated. |
h | Height of the region to be updated. |
This function schedules a particular rectangular region of an image object to be updated (redrawn) at the next rendering cycle.
References EAPI, eina_list_append(), eina_list_count(), EINA_LIST_FREE, eina_rectangle_free(), EINA_TRUE, evas_obj_image_data_update_add, _Eina_Rectangle::h, _Eina_Rectangle::w, _Eina_Rectangle::x, and _Eina_Rectangle::y.
Referenced by emotion_object_suspend_get(), and evas_object_image_alpha_set().
void evas_object_image_alpha_set | ( | Evas_Object * | obj, |
Eina_Bool | has_alpha | ||
) |
Enable or disable alpha channel usage on the given image object.
obj | The given image object. |
has_alpha | Whether to use alpha channel (EINA_TRUE ) data or not (EINA_FALSE ). |
This function sets a flag on an image object indicating whether or not to use alpha channel data. A value of EINA_TRUE
makes it use alpha channel data, and EINA_FALSE
makes it ignore that data. Note that this has nothing to do with an object's color as manipulated by evas_object_color_set().
References EAPI, EINA_FALSE, EINA_TRUE, evas_obj_image_alpha_set, and evas_object_image_data_update_add().
Referenced by ecore_evas_ews_new(), ecore_evas_object_image_new(), and emotion_object_suspend_get().
Eina_Bool evas_object_image_alpha_get | ( | const Evas_Object * | obj | ) |
Retrieve whether alpha channel data is being used on the given image object.
obj | The given image object. |
EINA_TRUE
) or not (EINA_FALSE
).This function returns EINA_TRUE
if the image object's alpha channel is being used, or EINA_FALSE
otherwise.
See evas_object_image_alpha_set() for more details.
References EAPI, EINA_FALSE, and evas_obj_image_alpha_get.
Referenced by edje_edit_object_add().
void evas_object_image_smooth_scale_set | ( | Evas_Object * | obj, |
Eina_Bool | smooth_scale | ||
) |
Sets whether to use high-quality image scaling algorithm on the given image object.
obj | The given image object. |
smooth_scale | Whether to use smooth scale or not. |
When enabled, a higher quality image scaling algorithm is used when scaling images to sizes other than the source image's original one. This gives better results but is more computationally expensive.
References EAPI, EINA_TRUE, and evas_obj_image_smooth_scale_set.
Referenced by emotion_object_smooth_scale_set().
Eina_Bool evas_object_image_smooth_scale_get | ( | const Evas_Object * | obj | ) |
Retrieves whether the given image object is using high-quality image scaling algorithm.
obj | The given image object. |
See evas_object_image_smooth_scale_set() for more details.
References EAPI, EINA_FALSE, and evas_obj_image_smooth_scale_get.
Referenced by emotion_object_smooth_scale_get().
void evas_object_image_preload | ( | Evas_Object * | obj, |
Eina_Bool | cancel | ||
) |
Preload an image object's image data in the background.
obj | The given image object. |
cancel | EINA_FALSE will add it the preloading work queue, EINA_TRUE will remove it (if it was issued before). |
This function requests the preload of the data image in the background. The work is queued before being processed (because there might be other pending requests of this type).
Whenever the image data gets loaded, Evas will call EVAS_CALLBACK_IMAGE_PRELOADED registered callbacks on obj
(what may be immediately, if the data was already preloaded before).
Use EINA_TRUE
for cancel
on scenarios where you don't need the image data preloaded anymore.
References EAPI, EINA_FALSE, EINA_TRUE, evas_obj_image_preload_begin, and evas_obj_image_preload_cancel.
Referenced by edje_object_preload().
void evas_object_image_reload | ( | Evas_Object * | obj | ) |
Reload an image object's image data.
obj | The given image object pointer. |
This function reloads the image data bound to image object obj
.
References EAPI, EINA_COW_WRITE_BEGIN, EINA_COW_WRITE_END, EINA_FALSE, EINA_TRUE, and evas_obj_image_reload.
Eina_Bool evas_object_image_save | ( | const Evas_Object * | obj, |
const char * | file, | ||
const char * | key, | ||
const char * | flags | ||
) |
Save the given image object's contents to an (image) file.
obj | The given image object. |
file | The filename to be used to save the image (extension obligatory). |
key | The image key in the file (if an Eet one), or NULL , otherwise. |
flags | String containing the flags to be used (NULL for none). |
The extension suffix on file
will determine which saver module Evas is to use when saving, thus the final file's format. If the file supports multiple data stored in it (Eet ones), you can specify the key to be used as the index of the image in it.
You can specify some flags when saving the image. Currently acceptable flags are quality
and compress
. Eg.: "quality=100 compress=9"
References EAPI, EINA_FALSE, EVAS_COLORSPACE_ARGB8888, and evas_obj_image_save.
Eina_Bool evas_object_image_pixels_import | ( | Evas_Object * | obj, |
Evas_Pixel_Import_Source * | pixels | ||
) |
Import pixels from given source to a given canvas image object.
obj | The given canvas object. |
pixels | The pixel's source to be imported. |
This function imports pixels from a given source to a given canvas image.
References EAPI, EINA_FALSE, EINA_TRUE, evas_obj_image_pixels_import, EVAS_PIXEL_FORMAT_ARGB32, EVAS_PIXEL_FORMAT_YUV420P_601, _Evas_Pixel_Import_Source::format, _Evas_Pixel_Import_Source::h, and _Evas_Pixel_Import_Source::rows.
void evas_object_image_pixels_get_callback_set | ( | Evas_Object * | obj, |
Evas_Object_Image_Pixels_Get_Cb | func, | ||
void * | data | ||
) |
Set the callback function to get pixels from a canvas' image.
obj | The given canvas pointer. |
func | The callback function. |
data | The data pointer to be passed to func. |
This functions sets a function to be the callback function that get pixels from a image of the canvas.
References EAPI, and evas_obj_image_pixels_get_callback_set.
Referenced by emotion_object_suspend_get().
void evas_object_image_pixels_dirty_set | ( | Evas_Object * | obj, |
Eina_Bool | dirty | ||
) |
Mark whether the given image object is dirty and needs to request its pixels.
obj | The given image object. |
dirty | Whether the image is dirty. |
This function will only properly work if a pixels get callback has been set.
References EAPI, EINA_FALSE, EINA_TRUE, and evas_obj_image_pixels_dirty_set.
Referenced by emotion_object_suspend_get().
Eina_Bool evas_object_image_pixels_dirty_get | ( | const Evas_Object * | obj | ) |
Retrieves whether the given image object is dirty (needs to be redrawn).
obj | The given image object. |
References EAPI, EINA_FALSE, and evas_obj_image_pixels_dirty_get.
void evas_object_image_load_dpi_set | ( | Evas_Object * | obj, |
double | dpi | ||
) |
Set the DPI resolution of an image object's source image.
obj | The given canvas pointer. |
dpi | The new DPI resolution. |
This function sets the DPI resolution of a given loaded canvas image. Most useful for the SVG image loader.
References EAPI, EINA_TRUE, and evas_obj_image_load_dpi_set.
double evas_object_image_load_dpi_get | ( | const Evas_Object * | obj | ) |
Get the DPI resolution of a loaded image object in the canvas.
obj | The given canvas pointer. |
This function returns the DPI resolution of the given canvas image.
References EAPI, and evas_obj_image_load_dpi_get.
void evas_object_image_load_size_set | ( | Evas_Object * | obj, |
int | w, | ||
int | h | ||
) |
Set the size of a given image object's source image, when loading it.
obj | The given canvas object. |
w | The new width of the image's load size. |
h | The new height of the image's load size. |
This function sets a new (loading) size for the given canvas image.
References EAPI, EINA_TRUE, and evas_obj_image_load_size_set.
void evas_object_image_load_size_get | ( | const Evas_Object * | obj, |
int * | w, | ||
int * | h | ||
) |
Get the size of a given image object's source image, when loading it.
obj | The given image object. |
w | Where to store the new width of the image's load size. |
h | Where to store the new height of the image's load size. |
NULL
pointers on the size components you're not interested in: they'll be ignored by the function.References EAPI, and evas_obj_image_load_size_get.
void evas_object_image_load_scale_down_set | ( | Evas_Object * | obj, |
int | scale_down | ||
) |
Set the scale down factor of a given image object's source image, when loading it.
obj | The given image object pointer. |
scale_down | The scale down factor. |
This function sets the scale down factor of a given canvas image. Most useful for the SVG image loader.
References EAPI, EINA_TRUE, and evas_obj_image_load_scale_down_set.
int evas_object_image_load_scale_down_get | ( | const Evas_Object * | obj | ) |
get the scale down factor of a given image object's source image, when loading it.
obj | The given image object pointer. |
References EAPI, and evas_obj_image_load_scale_down_get.
void evas_object_image_load_region_set | ( | Evas_Object * | obj, |
int | x, | ||
int | y, | ||
int | w, | ||
int | h | ||
) |
Inform a given image object to load a selective region of its source image.
obj | The given image object pointer. |
x | X-offset of the region to be loaded. |
y | Y-offset of the region to be loaded. |
w | Width of the region to be loaded. |
h | Height of the region to be loaded. |
This function is useful when one is not showing all of an image's area on its image object.
References EAPI, EINA_TRUE, and evas_obj_image_load_region_set.
void evas_object_image_load_region_get | ( | const Evas_Object * | obj, |
int * | x, | ||
int * | y, | ||
int * | w, | ||
int * | h | ||
) |
Retrieve the coordinates of a given image object's selective (source image) load region.
obj | The given image object pointer. |
x | Where to store the X-offset of the region to be loaded. |
y | Where to store the Y-offset of the region to be loaded. |
w | Where to store the width of the region to be loaded. |
h | Where to store the height of the region to be loaded. |
NULL
pointers on the coordinates you're not interested in: they'll be ignored by the function.References EAPI, and evas_obj_image_load_region_get.
void evas_object_image_load_orientation_set | ( | Evas_Object * | obj, |
Eina_Bool | enable | ||
) |
Define if the orientation information in the image file should be honored.
obj | The given image object pointer. |
enable | EINA_TRUE means that it should honor the orientation information |
References EAPI, and evas_obj_image_load_orientation_set.
Eina_Bool evas_object_image_load_orientation_get | ( | const Evas_Object * | obj | ) |
Get if the orientation information in the image file should be honored.
obj | The given image object pointer. |
References EAPI, EINA_FALSE, and evas_obj_image_load_orientation_get.
void evas_object_image_colorspace_set | ( | Evas_Object * | obj, |
Evas_Colorspace | cspace | ||
) |
Set the colorspace of a given image of the canvas.
obj | The given image object pointer. |
cspace | The new color space. |
This function sets the colorspace of given canvas image.
References EAPI, and evas_obj_image_colorspace_set.
Referenced by ecore_evas_ews_new(), ecore_evas_object_image_new(), and emotion_object_suspend_get().
Evas_Colorspace evas_object_image_colorspace_get | ( | const Evas_Object * | obj | ) |
Get the colorspace of a given image of the canvas.
obj | The given image object pointer. |
This function returns the colorspace of given canvas image.
References EAPI, EVAS_COLORSPACE_ARGB8888, and evas_obj_image_colorspace_get.
Eina_Bool evas_object_image_region_support_get | ( | const Evas_Object * | obj | ) |
Get the support state of a given image.
obj | The given image object pointer |
This function returns the state of the region support of given image
References EAPI, EINA_FALSE, and evas_obj_image_region_support_get.
void evas_object_image_native_surface_set | ( | Evas_Object * | obj, |
Evas_Native_Surface * | surf | ||
) |
Set the native surface of a given image of the canvas.
obj | The given canvas pointer. |
surf | The new native surface. |
This function sets a native surface of a given canvas image.
References EAPI, EVAS_CALLBACK_DEL, evas_obj_image_native_surface_set, evas_object_event_callback_add(), and evas_object_event_callback_del_full().
Referenced by evas_object_image_video_surface_get().
Evas_Native_Surface* evas_object_image_native_surface_get | ( | const Evas_Object * | obj | ) |
Get the native surface of a given image of the canvas.
obj | The given canvas pointer. |
This function returns the native surface of a given canvas image.
References EAPI, and evas_obj_image_native_surface_get.
void evas_object_image_video_surface_set | ( | Evas_Object * | obj, |
Evas_Video_Surface * | surf | ||
) |
Set the video surface linked to a given image of the canvas.
obj | The given canvas pointer. |
surf | The new video surface. |
This function links a video surface to a given canvas image.
References EAPI, EINA_FALSE, eina_list_append(), eina_list_remove(), EINA_TRUE, evas_obj_image_video_surface_set, EVAS_VIDEO_SURFACE_VERSION, _Evas_Video_Surface::hide, _Evas_Video_Surface::move, _Evas_Video_Surface::resize, _Evas_Video_Surface::show, and _Evas_Video_Surface::update_pixels.
Referenced by evas_image_max_size_get().
const Evas_Video_Surface* evas_object_image_video_surface_get | ( | const Evas_Object * | obj | ) |
Get the video surface linekd to a given image of the canvas.
obj | The given canvas pointer. |
This function returns the video surface linked to a given canvas image.
References EAPI, evas_obj_image_video_surface_caps_get, evas_obj_image_video_surface_caps_set, evas_obj_image_video_surface_get, and evas_object_image_native_surface_set().
void evas_object_image_scale_hint_set | ( | Evas_Object * | obj, |
Evas_Image_Scale_Hint | hint | ||
) |
Set the scale hint of a given image of the canvas.
obj | The given image object pointer. |
hint | The scale hint, a value in #Evas_Image_Scale_Hint. |
This function sets the scale hint value of the given image object in the canvas, which will affect how Evas is to cache scaled versions of its original source image.
References EAPI, and evas_obj_image_scale_hint_set.
Evas_Image_Scale_Hint evas_object_image_scale_hint_get | ( | const Evas_Object * | obj | ) |
Get the scale hint of a given image of the canvas.
obj | The given image object pointer. |
obj
, a value in #Evas_Image_Scale_Hint.This function returns the scale hint value of the given image object of the canvas.
References EAPI, and evas_obj_image_scale_hint_get.
void evas_object_image_content_hint_set | ( | Evas_Object * | obj, |
Evas_Image_Content_Hint | hint | ||
) |
Set the content hint setting of a given image object of the canvas.
obj | The given canvas pointer. |
hint | The content hint value, one of the Evas_Image_Content_Hint ones. |
This function sets the content hint value of the given image of the canvas. For example, if you're on the GL engine and your driver implementation supports it, setting this hint to EVAS_IMAGE_CONTENT_HINT_DYNAMIC will make it need zero copies at texture upload time, which is an "expensive" operation.
References EAPI, and evas_obj_image_content_hint_set.
Referenced by ecore_evas_ews_new(), and ecore_evas_object_image_new().
Evas_Image_Content_Hint evas_object_image_content_hint_get | ( | const Evas_Object * | obj | ) |
Get the content hint setting of a given image object of the canvas.
obj | The given canvas pointer. |
This function returns the content hint value of the given image of the canvas.
References EAPI, EVAS_IMAGE_CONTENT_HINT_NONE, and evas_obj_image_content_hint_get.
void evas_object_image_sw_64_mask_set | ( | Evas_Object * | obj, |
Eina_Bool | ismask | ||
) |
Enable an image to be used as an alpha mask.
This will set any flags, and discard any excess image data not used as an alpha mask.
Note there is little point in using a image as alpha mask unless it has an alpha channel.
obj | Object to use as an alpha mask. |
ismask | Use image as alphamask, must be true. |
References EAPI.
Eina_Bool evas_object_image_source_set | ( | Evas_Object * | obj, |
Evas_Object * | src | ||
) |
Set the source object on an image object to used as a proxy.
obj | Proxy (image) object. |
src | Source object to use for the proxy. |
EINA_TRUE
on success, EINA_FALSE
on error.If an image object is set to behave as a proxy, it will mirror the rendering contents of a given source object in its drawing region, without affecting that source in any way. The source must be another valid Evas object. Other effects may be applied to the proxy, such as a map (see evas_object_map_set()) to create a reflection of the original object (for example).
Any existing source object on obj
will be removed after this call. Setting src
to NULL
clears the proxy object (not in "proxy state" anymore).
References EAPI, EINA_FALSE, EINA_TRUE, evas_obj_image_source_set, and evas_object_image_file_set().
Evas_Object* evas_object_image_source_get | ( | const Evas_Object * | obj | ) |
Get the current source object of an image object.
obj | Image object |
NULL
, if not in "proxy mode" (or on errors).References EAPI, and evas_obj_image_source_get.
Referenced by edje_object_update_hints_get(), and evas_object_image_source_events_get().
Eina_Bool evas_object_image_source_unset | ( | Evas_Object * | obj | ) |
Clear the source object on a proxy image object.
obj | Image object to clear source of. |
EINA_TRUE
on success, EINA_FALSE
on error.This is equivalent to calling evas_object_image_source_set() with a NULL
source.
References EAPI, EINA_FALSE, and evas_obj_image_source_set.
Referenced by evas_object_del().
void evas_object_image_source_visible_set | ( | Evas_Object * | obj, |
Eina_Bool | visible | ||
) |
Set the source object to be visible or not.
obj | Proxy (image) object. |
visible | EINA_TRUE is source object to be shown, EINA_FALSE otherwise. |
If the visible
set to EINA_FALSE
, the source object of the proxy(obj
) will be invisible.
This API works differently to evas_object_show() and evas_object_hide(). Once source object is hidden by evas_object_hide() then the proxy object will be hidden as well. Actually in this case both objects are excluded from the Evas internal update circle.
By this API, instead, one can toggle the visibility of a proxy's source object remaining the proxy visibility untouched.
References EAPI, EINA_COW_WRITE_BEGIN, EINA_COW_WRITE_END, EINA_FALSE, EINA_TRUE, and evas_obj_image_source_visible_set.
Eina_Bool evas_object_image_source_visible_get | ( | const Evas_Object * | obj | ) |
Get the state of the source object visibility.
obj | Proxy (image) object. |
EINA_TRUE
if source object is visible, EINA_FALSE
otherwise.References EAPI, EINA_FALSE, and evas_obj_image_source_visible_get.
void evas_object_image_source_events_set | ( | Evas_Object * | obj, |
Eina_Bool | source | ||
) |
Set whether an Evas object is to source events.
obj | Proxy (image) object. |
source | whether obj is to pass events (EINA_TRUE ) or not (EINA_FALSE ) |
Set whether an Evas object is to repeat events to source.
If source
is EINA_TRUE
, it will make events on obj
to also be repeated for the source object (see evas_object_image_source_set()). Even the obj
and source geometries are different, the event position will be transformed to the source object's space.
If source
is EINA_FALSE
, events occurring on obj
will be processed only on it.
References EAPI, EINA_COW_WRITE_BEGIN, EINA_COW_WRITE_END, and evas_obj_image_source_events_set.
Eina_Bool evas_object_image_source_events_get | ( | const Evas_Object * | obj | ) |
Determine whether an object is set to source events.
obj | Proxy (image) object. |
EINA_TRUE
if source object has events, EINA_FALSE
otherwise.References EAPI, EINA_FALSE, eina_file_filename_get(), EINA_VALUE_TYPE_STRING, EINA_VALUE_TYPE_UINT64, evas_load_error_str(), evas_obj_image_load_error_get, evas_obj_image_source_events_get, evas_object_image_load_error_get(), and evas_object_image_source_get().
void evas_object_image_source_clip_set | ( | Evas_Object * | obj, |
Eina_Bool | source_clip | ||
) |
Clip the proxy object with the source object's clipper.
obj | Proxy (image) object. |
source_clip | whether obj is clipped by the source clipper. (EINA_TRUE ) or not (EINA_FALSE ) |
References EAPI, and evas_obj_image_source_clip_set.
Eina_Bool evas_object_image_source_clip_get | ( | const Evas_Object * | obj | ) |
Determine whether an object is clipped by source object's clipper.
obj | Proxy (image) object. |
EINA_TRUE
if source clip is enabled, EINA_FALSE
otherwise.References EAPI, EINA_FALSE, and evas_obj_image_source_clip_get.
Eina_Bool evas_object_image_animated_get | ( | const Evas_Object * | obj | ) |
Check if an image object can be animated (have multiple frames)
obj | Image object |
This returns if the image file of an image object is capable of animation such as an animated gif file might. This is only useful to be called once the image object file has been set.
Example:
References EAPI, EINA_FALSE, and evas_obj_image_animated_get.
Referenced by evas_object_image_animated_frame_count_get(), evas_object_image_animated_frame_set(), evas_object_image_animated_loop_count_get(), and evas_object_image_animated_loop_type_get().
int evas_object_image_animated_frame_count_get | ( | const Evas_Object * | obj | ) |
Get the total number of frames of the image object.
obj | Image object |
This returns total number of frames the image object supports (if animated)
References EAPI, evas_obj_image_animated_frame_count_get, and evas_object_image_animated_get().
Referenced by evas_object_image_animated_frame_set().
Evas_Image_Animated_Loop_Hint evas_object_image_animated_loop_type_get | ( | const Evas_Object * | obj | ) |
Get the kind of looping the image object does.
obj | Image object |
This returns the kind of looping the image object wants to do.
If it returns EVAS_IMAGE_ANIMATED_HINT_LOOP, you should display frames in a sequence like: 1->2->3->1->2->3->1... If it returns EVAS_IMAGE_ANIMATED_HINT_PINGPONG, it is better to display frames in a sequence like: 1->2->3->2->1->2->3->1...
The default type is EVAS_IMAGE_ANIMATED_HINT_LOOP.
References EAPI, evas_obj_image_animated_loop_type_get, and evas_object_image_animated_get().
int evas_object_image_animated_loop_count_get | ( | const Evas_Object * | obj | ) |
Get the number times the animation of the object loops.
obj | Image object |
This returns loop count of image. The loop count is the number of times the animation will play fully from first to last frame until the animation should stop (at the final frame).
If 0 is returned, then looping should happen indefinitely (no limit to the number of times it loops).
References EAPI, evas_obj_image_animated_loop_count_get, and evas_object_image_animated_get().
double evas_object_image_animated_frame_duration_get | ( | const Evas_Object * | obj, |
int | start_frame, | ||
int | fram_num | ||
) |
Get the duration of a sequence of frames.
obj | Image object |
start_frame | The first frame |
fram_num | Number of frames in the sequence |
This returns total duration that the specified sequence of frames should take in seconds.
If you set start_frame to 1 and frame_num 0, you get frame 1's duration If you set start_frame to 1 and frame_num 1, you get frame 1's duration + frame2's duration
References EAPI, and evas_obj_image_animated_frame_duration_get.
void evas_object_image_animated_frame_set | ( | Evas_Object * | obj, |
int | frame_num | ||
) |
Set the frame to current frame of an image object.
obj | The given image object. |
frame_num | The index of current frame |
This set image object's current frame to frame_num with 1 being the first frame.
References EAPI, EINA_COW_WRITE_BEGIN, EINA_COW_WRITE_END, EINA_TRUE, evas_obj_image_animated_frame_set, evas_object_image_animated_frame_count_get(), and evas_object_image_animated_get().