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...
 

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

EAPI Evas_Objectevas_object_image_add (Evas *e)
 Creates a new image object on the given Evas e canvas. More...
 
EAPI Evas_Objectevas_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...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI double evas_object_image_border_scale_get (const Evas_Object *obj)
 Retrieves the scaling factor (multiplier) for the borders of an image object. More...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI void evas_object_image_size_set (Evas_Object *obj, int w, int h)
 Sets the size of the given image object. More...
 
EAPI void evas_object_image_size_get (const Evas_Object *obj, int *w, int *h)
 Retrieves the size of the given image object. More...
 
EAPI int evas_object_image_stride_get (const Evas_Object *obj)
 Retrieves the row stride of the given image object. More...
 
EAPI 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...
 
EAPI void evas_object_image_data_set (Evas_Object *obj, void *data)
 Sets the raw image data of the given image object. More...
 
EAPI 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...
 
EAPI 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...
 
EAPI void evas_object_image_data_copy_set (Evas_Object *obj, void *data)
 Replaces the raw image data of the given image object. More...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI void evas_object_image_preload (Evas_Object *obj, Eina_Bool cancel)
 Preload an image object's image data in the background. More...
 
EAPI void evas_object_image_reload (Evas_Object *obj)
 Reload an image object's image data. More...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI void evas_object_image_load_dpi_set (Evas_Object *obj, double dpi)
 Set the DPI resolution of an image object's source image. More...
 
EAPI double evas_object_image_load_dpi_get (const Evas_Object *obj)
 Get the DPI resolution of a loaded image object in the canvas. More...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI void evas_object_image_colorspace_set (Evas_Object *obj, Evas_Colorspace cspace)
 Set the colorspace of a given image of the canvas. More...
 
EAPI Evas_Colorspace evas_object_image_colorspace_get (const Evas_Object *obj)
 Get the colorspace of a given image of the canvas. More...
 
EAPI Eina_Bool evas_object_image_region_support_get (const Evas_Object *obj)
 Get the support state of a given image. More...
 
EAPI 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...
 
EAPI Evas_Native_Surfaceevas_object_image_native_surface_get (const Evas_Object *obj)
 Get the native surface of a given image of the canvas. More...
 
EAPI 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...
 
EAPI const Evas_Video_Surfaceevas_object_image_video_surface_get (const Evas_Object *obj)
 Get the video surface linekd to a given image of the canvas. More...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI 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...
 
EAPI void evas_object_image_alpha_mask_set (Evas_Object *obj, Eina_Bool ismask)
 Enable an image to be used as an alpha mask. More...
 
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. More...
 
EAPI Evas_Objectevas_object_image_source_get (const Evas_Object *obj)
 Get the current source object of an image object. More...
 
EAPI Eina_Bool evas_object_image_source_unset (Evas_Object *obj)
 Clear the source object on a proxy image object. More...
 
EAPI 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...
 
EAPI 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...
 
EAPI Eina_Bool evas_object_image_animated_get (const Evas_Object *obj)
 Check if an image object can be animated (have multiple frames) More...
 
EAPI int evas_object_image_animated_frame_count_get (const Evas_Object *obj)
 Get the total number of frames of the image object. More...
 
EAPI 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...
 
EAPI int evas_object_image_animated_loop_count_get (const Evas_Object *obj)
 Get the number times the animation of the object loops. More...
 
EAPI 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...
 
EAPI void evas_object_image_animated_frame_set (Evas_Object *obj, int frame_num)
 Set the frame to current frame of an image object. More...
 

Detailed Description

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().

Image object basics

The most common use of image objects – to display an image on the canvas – is achieved by a common function triplet:

img = evas_object_image_add(canvas);
evas_object_image_file_set(img, "path/to/img", NULL);
evas_object_image_fill_set(img, 0, 0, w, h);

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.

Scale and resizing

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.

Performance hints

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.

Load hints

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:

evas_object_image_file_set(prev, "/path/to/prev", NULL);
evas_object_image_preload(prev, EINA_TRUE);
evas_object_image_file_set(next, "/path/to/next", NULL);
evas_object_image_preload(next, EINA_TRUE);

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:

//to load a scaled down version of the image in memory, if that's
//the size you'll be displaying it anyway
//optional: if you know you'll be showing a sub-set of the image's
//pixels, you can avoid loading the complementary data

Refer to Elementary's Photocam widget for a high level (smart) object which does lots of loading speed-ups for you.

Animation hints

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.

Borders

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

Manipulating pixels

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.

Color spaces

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:

  • EVAS_COLORSPACE_ARGB8888: This pixel format is a linear block of pixels, starting at the top-left row by row until the bottom right of the image or pixel region. All pixels are 32-bit unsigned int's with the high-byte being alpha and the low byte being blue in the format ARGB. Alpha may or may not be used by evas depending on the alpha flag of the image, but if not used, should be set to 0xff anyway.

    This colorspace uses premultiplied alpha. That means that R, G and B cannot exceed A in value. The conversion from non-premultiplied colorspace is:

    R = (r * a) / 255; G = (g * a) / 255; B = (b * a) / 255;

    So 50% transparent blue will be: 0x80000080. This will not be "dark" - just 50% transparent. Values are 0 == black, 255 == solid or full red, green or blue.
  • EVAS_COLORSPACE_YCBCR422P601_PL: This is a pointer-list indirected set of YUV (YCbCr) pixel data. This means that the data returned or set is not actual pixel data, but pointers TO lines of pixel data. The list of pointers will first be N rows of pointers to the Y plane - pointing to the first pixel at the start of each row in the Y plane. N is the height of the image data in pixels. Each pixel in the Y, U and V planes is 1 byte exactly, packed. The next N / 2 pointers will point to rows in the U plane, and the next N / 2 pointers will point to the V plane rows. U and V planes are half the horizontal and vertical resolution of the Y plane.

    Row order is top to bottom and row pixels are stored left to right.

    There is a limitation that these images MUST be a multiple of 2 pixels in size horizontally or vertically. This is due to the U and V planes being half resolution. Also note that this assumes the itu601 YUV colorspace specification. This is defined for standard television and mpeg streams. HDTV may use the itu709 specification.

    Values are 0 to 255, indicating full or no signal in that plane respectively.
  • EVAS_COLORSPACE_RGB565_A5P: In the process of being implemented in 1 engine only. This may change.

    This is a pointer to image data for 16-bit half-word pixel data in 16bpp RGB 565 format (5 bits red, 6 bits green, 5 bits blue), with the high-byte containing red and the low byte containing blue, per pixel. This data is packed row by row from the top-left to the bottom right.

    If the image has an alpha channel enabled there will be an extra alpha plane after the color pixel plane. If not, then this data will not exist and should not be accessed in any way. This plane is a set of pixels with 1 byte per pixel defining the alpha values of all pixels in the image from the top-left to the bottom right of the image, row by row. Even though the values of the alpha pixels can be 0 to 255, only values 0 through to 32 are used, 32 being solid and 0 being transparent.

    RGB values can be 0 to 31 for red and blue and 0 to 63 for green, with 0 being black and 31 or 63 being full red, green or blue respectively. This colorspace is also pre-multiplied like EVAS_COLORSPACE_ARGB8888 so:

    R = (r * a) / 32; G = (g * a) / 32; B = (b * a) / 32;
  • EVAS_COLORSPACE_GRY8: The image is just a alpha mask (8 bit's per pixel). This is used for alpha masking.
Warning
We don't guarantee any proper results if you create a Image object without setting the evas engine.

Some examples on this group of functions can be found here.

Typedef Documentation

Colorspaces for pixel data supported by Evas.

Colorspaces for pixel data supported by Evas

Enumeration Type Documentation

Colorspaces for pixel data supported by Evas.

Enumerator
EVAS_COLORSPACE_ARGB8888 

ARGB 32 bits per pixel, high-byte is Alpha, accessed 1 32bit word at a time.

EVAS_COLORSPACE_YCBCR422P601_PL 

YCbCr 4:2:2 Planar, ITU.BT-601 specifications.

The data pointed to is just an array of row pointer, pointing to the Y rows, then the Cb, then Cr rows

EVAS_COLORSPACE_YCBCR422P709_PL 

YCbCr 4:2:2 Planar, ITU.BT-709 specifications.

The data pointed to is just an array of row pointer, pointing to the Y rows, then the Cb, then Cr rows

EVAS_COLORSPACE_RGB565_A5P 

16bit rgb565 + Alpha plane at end - 5 bits of the 8 being used per alpha byte

EVAS_COLORSPACE_GRY8 

8bit grayscale

EVAS_COLORSPACE_YCBCR422601_PL 

YCbCr 4:2:2, ITU.BT-601 specifications.

The data pointed to is just an array of row pointer, pointing to line of Y,Cb,Y,Cr bytes

EVAS_COLORSPACE_YCBCR420NV12601_PL 

YCbCr 4:2:0, ITU.BT-601 specification.

The data pointed to is just an array of row pointer, pointing to the Y rows, then the Cb,Cr rows.

EVAS_COLORSPACE_YCBCR420TM12601_PL 

YCbCr 4:2:0, ITU.BT-601 specification.

The data pointed to is just an array of tiled row pointer, pointing to the Y rows, then the Cb,Cr rows.

Function Documentation

EAPI Evas_Object* evas_object_image_add ( Evas e)

Creates a new image object on the given Evas e canvas.

Parameters
eThe given canvas.
Returns
The created image object handle.
Note
If you intend to display an image somehow in a GUI, besides binding it to a real image file/source (with evas_object_image_file_set(), for example), you'll have to tell this image object how to fill its space with the pixels it can get from the source. See evas_object_image_filled_add(), for a helper on the common case of scaling up an image source to the whole area of the image object.
See Also
evas_object_image_fill_set()

Example:

img = evas_object_image_add(canvas);
evas_object_image_file_set(img, "/path/to/img", NULL);

Referenced by evas_object_image_filled_add().

EAPI Eina_Bool evas_object_image_alpha_get ( const Evas_Object obj)

Retrieve whether alpha channel data is being used on the given image object.

Parameters
objThe given image object.
Returns
Whether the alpha channel data is being used (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.

EAPI void evas_object_image_alpha_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.

Parameters
objObject to use as an alpha mask.
ismaskUse image as alphamask, must be true.
EAPI void evas_object_image_alpha_set ( Evas_Object obj,
Eina_Bool  has_alpha 
)

Enable or disable alpha channel usage on the given image object.

Parameters
objThe given image object.
has_alphaWhether 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().

See Also
evas_object_image_alpha_get()

References evas_object_image_data_update_add().

Referenced by evas_object_image_memfile_set().

EAPI int evas_object_image_animated_frame_count_get ( const Evas_Object obj)

Get the total number of frames of the image object.

Parameters
objImage object
Returns
The number of frames

This returns total number of frames the image object supports (if animated)

See Also
evas_object_image_animated_get()
evas_object_image_animated_frame_count_get()
evas_object_image_animated_loop_type_get()
evas_object_image_animated_loop_count_get()
evas_object_image_animated_frame_duration_get()
evas_object_image_animated_frame_set()
Since
1.1

References evas_object_image_animated_get().

Referenced by evas_object_image_animated_frame_set().

EAPI 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.

Parameters
objImage object
start_frameThe first frame
fram_numNumber 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

See Also
evas_object_image_animated_get()
evas_object_image_animated_frame_count_get()
evas_object_image_animated_loop_type_get()
evas_object_image_animated_loop_count_get()
evas_object_image_animated_frame_duration_get()
evas_object_image_animated_frame_set()
Since
1.1

References evas_object_image_animated_get().

EAPI void evas_object_image_animated_frame_set ( Evas_Object obj,
int  frame_num 
)

Set the frame to current frame of an image object.

Parameters
objThe given image object.
frame_numThe index of current frame

This set image object's current frame to frame_num with 1 being the first frame.

See Also
evas_object_image_animated_get()
evas_object_image_animated_frame_count_get()
evas_object_image_animated_loop_type_get()
evas_object_image_animated_loop_count_get()
evas_object_image_animated_frame_duration_get()
evas_object_image_animated_frame_set()
Since
1.1

References evas_object_image_animated_frame_count_get(), and evas_object_image_animated_get().

EAPI Eina_Bool evas_object_image_animated_get ( const Evas_Object obj)

Check if an image object can be animated (have multiple frames)

Parameters
objImage object
Returns
whether obj support animation

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:

extern Evas_Object *obj;
{
int frame_count;
int loop_count;
Evas_Image_Animated_Loop_Hint loop_type;
double duration;
printf("This image has %d frames\n",frame_count);
printf("Frame 1's duration is %f. You had better set object's frame to 2 after this duration using timer\n");
printf("loop count is %d. You had better run loop %d times\n",loop_count,loop_count);
printf("You had better set frame like 1->2->3->1->2->3...\n");
else if (loop_type == EVAS_IMAGE_ANIMATED_HINT_PINGPONG)
printf("You had better set frame like 1->2->3->2->1->2...\n");
else
printf("Unknown loop type\n");
printf("You set image object's frame to 1. You can see frame 1\n");
}
See Also
evas_object_image_animated_get()
evas_object_image_animated_frame_count_get()
evas_object_image_animated_loop_type_get()
evas_object_image_animated_loop_count_get()
evas_object_image_animated_frame_duration_get()
evas_object_image_animated_frame_set()
Since
1.1

Referenced by evas_object_image_animated_frame_count_get(), evas_object_image_animated_frame_duration_get(), evas_object_image_animated_frame_set(), evas_object_image_animated_loop_count_get(), and evas_object_image_animated_loop_type_get().

EAPI int evas_object_image_animated_loop_count_get ( const Evas_Object obj)

Get the number times the animation of the object loops.

Parameters
objImage object
Returns
The number of loop of an animated 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).

See Also
evas_object_image_animated_get()
evas_object_image_animated_frame_count_get()
evas_object_image_animated_loop_type_get()
evas_object_image_animated_loop_count_get()
evas_object_image_animated_frame_duration_get()
evas_object_image_animated_frame_set()
Since
1.1

References evas_object_image_animated_get().

EAPI 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.

Parameters
objImage object
Returns
Loop type of the 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.

See Also
evas_object_image_animated_get()
evas_object_image_animated_frame_count_get()
evas_object_image_animated_loop_type_get()
evas_object_image_animated_loop_count_get()
evas_object_image_animated_frame_duration_get()
evas_object_image_animated_frame_set()
Since
1.1

References evas_object_image_animated_get().

EAPI 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.

Parameters
objThe given image object.
Returns
fill Fill mode of the center region of obj (a value in Evas_Border_Fill_Mode).

See evas_object_image_fill_set() for more details.

EAPI 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.

Parameters
objThe given image object.
fillFill 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.

See Also
evas_object_image_border_center_fill_get()
EAPI 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.

Parameters
objThe given image object.
lLocation to store the border's left width in.
rLocation to store the border's right width in.
tLocation to store the border's top width in.
bLocation to store the border's bottom width in.
Note
Use 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.

EAPI double evas_object_image_border_scale_get ( const Evas_Object obj)

Retrieves the scaling factor (multiplier) for the borders of an image object.

Parameters
objThe given image object.
Returns
The scale factor set for its borders
See Also
evas_object_image_border_set()
evas_object_image_border_scale_set()
EAPI void evas_object_image_border_scale_set ( Evas_Object obj,
double  scale 
)

Sets the scaling factor (multiplier) for the borders of an image object.

Parameters
objThe given image object.
scaleThe scale factor (default is 1.0 - i.e. no scaling)
See Also
evas_object_image_border_set()
evas_object_image_border_scale_get()
EAPI 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.

Parameters
objThe given image object.
lThe border's left width.
rThe border's right width.
tThe border's top width.
bThe 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.

Note
The border region itself may be scaled by the evas_object_image_border_scale_set() function.
By default, image objects have no borders set, i. e. l, r, t and b start as 0.

See the following figures for visual explanation:
Full-size Full-size

See Also
evas_object_image_border_get()
evas_object_image_border_center_fill_set()
EAPI Evas_Colorspace evas_object_image_colorspace_get ( const Evas_Object obj)

Get the colorspace of a given image of the canvas.

Parameters
objThe given image object pointer.
Returns
The colorspace of the image.

This function returns the colorspace of given canvas image.

References EVAS_COLORSPACE_ARGB8888.

EAPI void evas_object_image_colorspace_set ( Evas_Object obj,
Evas_Colorspace  cspace 
)

Set the colorspace of a given image of the canvas.

Parameters
objThe given image object pointer.
cspaceThe new color space.

This function sets the colorspace of given canvas image.

EAPI 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.

Parameters
objThe given canvas pointer.
Returns
hint The content hint value set on it, one of the Evas_Image_Content_Hint ones (EVAS_IMAGE_CONTENT_HINT_NONE means an error).

This function returns the content hint value of the given image of the canvas.

See Also
evas_object_image_content_hint_set()

References EVAS_IMAGE_CONTENT_HINT_NONE.

EAPI 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.

Parameters
objThe given canvas pointer.
hintThe 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.

See Also
evas_object_image_content_hint_get()
EAPI 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.

Parameters
objThe given image object.
to_cspaceThe colorspace to which the image raw data will be converted.
Returns
data A newly allocated data in the format specified by to_cspace.
EAPI void evas_object_image_data_copy_set ( Evas_Object obj,
void *  data 
)

Replaces the raw image data of the given image object.

Parameters
objThe given image object.
dataThe 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.

EAPI 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.

Parameters
objThe given image object.
for_writingWhether the data being retrieved will be modified (EINA_TRUE) or not (EINA_FALSE).
Returns
The raw image data.

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 specially important for the directfb Evas engine.

This is best suited for when you want to modify an existing image, without changing its dimensions.

Note
The contents' format returned by it depend on the color space of the given image object.
You may want to use evas_object_image_data_update_add() to inform data changes, if you did any.
See Also
evas_object_image_data_set()
EAPI void evas_object_image_data_set ( Evas_Object obj,
void *  data 
)

Sets the raw image data of the given image object.

Parameters
objThe given image object.
dataThe 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.

See Also
evas_object_image_data_get()

References EVAS_LOAD_ERROR_NONE.

EAPI 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.

Parameters
objThe given image object.
xX-offset of the region to be updated.
yY-offset of the region to be updated.
wWidth of the region to be updated.
hHeight 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.

Referenced by evas_object_image_alpha_set().

EAPI 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.

Parameters
fileThe file to check, it should be an Eina_Stringshare.
Returns
EINA_TRUE if we may be able to open it, EINA_FALSE if it's unlikely.
Since
1.1

This functions is threadsafe.

EAPI Eina_Bool evas_object_image_extension_can_load_get ( const char *  file)

Check if a file extension may be supported by Image Object Functions.

Parameters
fileThe file to check
Returns
EINA_TRUE if we may be able to open it, EINA_FALSE if it's unlikely.
Since
1.1

If file is a Eina_Stringshare, use directly evas_object_image_extension_can_load_fast_get.

This functions is threadsafe.

EAPI 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).

Parameters
objThe given image object.
fileLocation to store the image file path.
keyLocation to store the image key (if file is an Eet one).

You must not modify the strings on the returned pointers.

Note
Use NULL pointers on the file components you're not interested in: they'll be ignored by the function.
EAPI 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).

Parameters
objThe given image object.
fileThe image file path.
keyThe 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:

img = evas_object_image_add(canvas);
evas_object_image_file_set(img, "/path/to/img", NULL);
{
fprintf(stderr, "could not load image '%s'. error string is \"%s\"\n",
valid_path, evas_load_error_str(err));
}
else
{
evas_object_image_fill_set(img, 0, 0, w, h);
evas_object_resize(img, w, h);
}

References EVAS_COLORSPACE_ARGB8888, EVAS_LOAD_ERROR_GENERIC, and EVAS_LOAD_ERROR_NONE.

Referenced by evas_object_image_memfile_set(), and evas_object_image_source_set().

EAPI 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.

Parameters
objThe given image object.
xLocation to store the x coordinate (from the top left corner of the bound image) to start drawing from.
yLocation to store the y coordinate (from the top left corner of the bound image) to start drawing from.
wLocation to store the width the bound image is to be displayed at.
hLocation to store the height the bound image is to be displayed at.
Note
Use 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.

EAPI 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.

Parameters
objThe given image object to operate on.
xThe x coordinate (from the top left corner of the bound image) to start drawing from.
yThe y coordinate (from the top left corner of the bound image) to start drawing from.
wThe width the bound image will be displayed at.
hThe 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:

image-fill.png
Warning
The default values for the fill parameters are 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.
Note
evas_object_image_filled_set() is a helper function which will override the values set here automatically, for you, in a given way.

Referenced by evas_object_image_filled_set().

EAPI 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.

Parameters
objThe given evas image object.
Returns
The current spread mode of the image object.

References EVAS_TEXTURE_REPEAT.

EAPI 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.

Parameters
objThe given evas image object.
spreadOne of EVAS_TEXTURE_REFLECT, EVAS_TEXTURE_REPEAT, EVAS_TEXTURE_RESTRICT, or EVAS_TEXTURE_PAD.
EAPI 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.

Parameters
eThe given canvas.
Returns
The created image object handle.

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.

Note
Whenever this object gets resized, the bound image will be rescaled, too.
See Also
evas_object_image_add()
evas_object_image_filled_set()
evas_object_image_fill_set()

References evas_object_image_add(), and evas_object_image_filled_set().

EAPI 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.

Parameters
objThe given image object.
Returns
EINA_TRUE if it is tracking, EINA_FALSE, if not (and evas_object_fill_set() must be called manually).
See Also
evas_object_image_filled_set() for more information
EAPI 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.

Parameters
objThe given image object.
settingEINA_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.

See Also
evas_object_image_filled_add()
evas_object_image_fill_get()

References EVAS_CALLBACK_RESIZE, 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().

EAPI double evas_object_image_load_dpi_get ( const Evas_Object obj)

Get the DPI resolution of a loaded image object in the canvas.

Parameters
objThe given canvas pointer.
Returns
The DPI resolution of the given canvas image.

This function returns the DPI resolution of the given canvas image.

See Also
evas_object_image_load_dpi_set() for more details
EAPI void evas_object_image_load_dpi_set ( Evas_Object obj,
double  dpi 
)

Set the DPI resolution of an image object's source image.

Parameters
objThe given canvas pointer.
dpiThe new DPI resolution.

This function sets the DPI resolution of a given loaded canvas image. Most useful for the SVG image loader.

See Also
evas_object_image_load_dpi_get()
EAPI 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.

Parameters
objThe given image object.
Returns
A value giving the last error that occurred. It should be one of the Evas_Load_Error values. EVAS_LOAD_ERROR_NONE is returned if there was no error.
EAPI Eina_Bool evas_object_image_load_orientation_get ( const Evas_Object obj)

Get if the orientation information in the image file should be honored.

Parameters
objThe given image object pointer.
Since
1.1
EAPI 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.

Parameters
objThe given image object pointer.
enableEINA_TRUE means that it should honor the orientation information
Since
1.1
EAPI 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.

Parameters
objThe given image object pointer.
xWhere to store the X-offset of the region to be loaded.
yWhere to store the Y-offset of the region to be loaded.
wWhere to store the width of the region to be loaded.
hWhere to store the height of the region to be loaded.
Note
Use NULL pointers on the coordinates you're not interested in: they'll be ignored by the function.
See Also
evas_object_image_load_region_get()
EAPI 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.

Parameters
objThe given image object pointer.
xX-offset of the region to be loaded.
yY-offset of the region to be loaded.
wWidth of the region to be loaded.
hHeight 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.

Note
The image loader for the image format in question has to support selective region loading in order to this function to take effect.
See Also
evas_object_image_load_region_get()
EAPI 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.

Parameters
objThe given image object pointer.
See Also
evas_object_image_load_scale_down_set() for more details
EAPI 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.

Parameters
objThe given image object pointer.
scale_downThe scale down factor.

This function sets the scale down factor of a given canvas image. Most useful for the SVG image loader.

See Also
evas_object_image_load_scale_down_get()
EAPI 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.

Parameters
objThe given image object.
wWhere to store the new width of the image's load size.
hWhere to store the new height of the image's load size.
Note
Use NULL pointers on the size components you're not interested in: they'll be ignored by the function.
See Also
evas_object_image_load_size_set() for more details
EAPI 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.

Parameters
objThe given canvas object.
wThe new width of the image's load size.
hThe new height of the image's load size.

This function sets a new (loading) size for the given canvas image.

See Also
evas_object_image_load_size_get()
EAPI 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.

Parameters
objThe given image object.
dataThe image file data address
sizeThe size of the image file data in bytes
formatThe format of the file (optional), or NULL if not needed
keyThe image key in file, or NULL.

References evas_object_image_alpha_set(), and evas_object_image_file_set().

EAPI Evas_Native_Surface* evas_object_image_native_surface_get ( const Evas_Object obj)

Get the native surface of a given image of the canvas.

Parameters
objThe given canvas pointer.
Returns
The native surface of the given canvas image.

This function returns the native surface of a given canvas image.

EAPI 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.

Parameters
objThe given canvas pointer.
surfThe new native surface.

This function sets a native surface of a given canvas image.

EAPI Eina_Bool evas_object_image_pixels_dirty_get ( const Evas_Object obj)

Retrieves whether the given image object is dirty (needs to be redrawn).

Parameters
objThe given image object.
Returns
Whether the image is dirty.
EAPI 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.

Parameters
objThe given image object.
dirtyWhether the image is dirty.

This function will only properly work if a pixels get callback has been set.

Warning
use this function if you really know what you are doing.
See Also
evas_object_image_pixels_get_callback_set()
EAPI 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.

Parameters
objThe given canvas pointer.
funcThe callback function.
dataThe data pointer to be passed to func.

This functions sets a function to be the callback function that get pixes from a image of the canvas.

EAPI 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.

Parameters
objThe given canvas object.
pixelsThe pixel's source to be imported.

This function imports pixels from a given source to a given canvas image.

References EVAS_PIXEL_FORMAT_ARGB32, and EVAS_PIXEL_FORMAT_YUV420P_601.

EAPI void evas_object_image_preload ( Evas_Object obj,
Eina_Bool  cancel 
)

Preload an image object's image data in the background.

Parameters
objThe given image object.
cancelEINA_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.

Note
Any evas_object_show() call after evas_object_image_preload() will make the latter to be cancelled, with the loading process now taking place synchronously (and, thus, blocking the return of the former until the image is loaded). It is highly advisable, then, that the user preload an image with it being hidden, just to be shown on the EVAS_CALLBACK_IMAGE_PRELOADED event's callback.
EAPI Eina_Bool evas_object_image_region_support_get ( const Evas_Object obj)

Get the support state of a given image.

Parameters
objThe given image object pointer
Returns
The region support state
Since
1.2

This function returns the state of the region support of given image

EAPI void evas_object_image_reload ( Evas_Object obj)

Reload an image object's image data.

Parameters
objThe given image object pointer.

This function reloads the image data bound to image object obj.

EAPI 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.

Parameters
objThe given image object.
fileThe filename to be used to save the image (extension obligatory).
keyThe image key in the file (if an Eet one), or NULL, otherwise.
flagsString 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 EVAS_COLORSPACE_ARGB8888.

EAPI 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.

Parameters
objThe given image object pointer.
Returns
The scale hint value set on obj, a value in Evas_Image_Scale_Hint.

This function returns the scale hint value of the given image object of the canvas.

See Also
evas_object_image_scale_hint_set() for more details.

References EVAS_IMAGE_SCALE_HINT_NONE.

EAPI 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.

Parameters
objThe given image object pointer.
hintThe 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.

See Also
evas_object_image_scale_hint_get()
EAPI void evas_object_image_size_get ( const Evas_Object obj,
int *  w,
int *  h 
)

Retrieves the size of the given image object.

Parameters
objThe given image object.
wLocation to store the width of the image in, or NULL.
hLocation to store the height of the image in, or NULL.

See evas_object_image_size_set() for more details.

EAPI void evas_object_image_size_set ( Evas_Object obj,
int  w,
int  h 
)

Sets the size of the given image object.

Parameters
objThe given image object.
wThe new width of the image.
hThe 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.

EAPI 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.

Parameters
objThe given image object.
Returns
Whether smooth scale is being used.

See evas_object_image_smooth_scale_set() for more details.

EAPI 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.

Parameters
objThe given image object.
smooth_scaleWhether 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.

Note
Image objects get created originally with smooth scaling on.
See Also
evas_object_image_smooth_scale_get()
EAPI Evas_Object* evas_object_image_source_get ( const Evas_Object obj)

Get the current source object of an image object.

Parameters
objImage object
Returns
Source object (if any), or NULL, if not in "proxy mode" (or on errors).
See Also
evas_object_image_source_set() for more details
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.

Parameters
objProxy (image) object.
srcSource object to use for the proxy.
Returns
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).

Warning
You cannot set a proxy as another proxy's source.
See Also
evas_object_image_source_get()
evas_object_image_source_unset()

References evas_object_image_file_set().

Referenced by evas_object_image_source_unset().

EAPI Eina_Bool evas_object_image_source_unset ( Evas_Object obj)

Clear the source object on a proxy image object.

Parameters
objImage object to clear source of.
Returns
EINA_TRUE on success, EINA_FALSE on error.

This is equivalent to calling evas_object_image_source_set() with a NULL source.

References evas_object_image_source_set().

Referenced by evas_object_del().

EAPI int evas_object_image_stride_get ( const Evas_Object obj)

Retrieves the row stride of the given image object.

Parameters
objThe given image object.
Returns
The stride of the image (in bytes).

The row stride is the number of bytes between the start of a row and the start of the next row for image data.

EAPI 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.

Parameters
objThe given canvas pointer.
Returns
The video surface of the given canvas image.
Since
1.1

This function returns the video surface linked to a given canvas image.

EAPI 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.

Parameters
objThe given canvas pointer.
surfThe new video surface.
Since
1.1

This function link a video surface to a given canvas image.

References EVAS_VIDEO_SURFACE_VERSION.