Functions
void	evas_object_image_load_dpi_set (Evas_Image *obj, double dpi)
	Set the DPI resolution of an image object's source image.
double	evas_object_image_load_dpi_get (const Evas_Image *obj)
	Get the DPI resolution of a loaded image object in the canvas.
void	evas_object_image_source_clip_set (Evas_Image *obj, Eina_Bool source_clip)
	Clip the proxy object with the source object's clipper.
Eina_Bool	evas_object_image_source_clip_get (const Evas_Image *obj)
	Determine whether an object is clipped by source object's clipper.
Eina_Bool	evas_object_image_source_set (Evas_Image obj, Evas_Object src)
	Set the source object on an image object to used as a proxy.
Evas_Object *	evas_object_image_source_get (const Evas_Image *obj)
	Get the current source object of an image object.
void	evas_object_image_filled_set (Evas_Image *obj, Eina_Bool filled)
	Set whether the image object's fill property should track the object's size.
Eina_Bool	evas_object_image_filled_get (const Evas_Image *obj)
	Retrieve whether the image object's fill property should track the object's size.
void	evas_object_image_content_hint_set (Evas_Image *obj, Evas_Image_Content_Hint hint)
	Set the content hint setting of a given image object of the canvas.
Evas_Image_Content_Hint	evas_object_image_content_hint_get (const Evas_Image *obj)
	Get the content hint setting of a given image object of the canvas.
void	evas_object_image_load_region_set (Evas_Image *obj, int x, int y, int w, int h)
	Inform a given image object to load a selective region of its source image.
void	evas_object_image_load_region_get (const Evas_Image obj, int x, int y, int w, int *h)
	Retrieve the coordinates of a given image object's selective (source image) load region.
void	evas_object_image_alpha_set (Evas_Image *obj, Eina_Bool alpha)
	Enable or disable alpha channel usage on the given image object.
Eina_Bool	evas_object_image_alpha_get (const Evas_Image *obj)
	Retrieve whether alpha channel data is being used on the given image object.
void	evas_object_image_border_set (Evas_Image *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.
void	evas_object_image_border_get (const Evas_Image 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.
void	evas_object_image_border_scale_set (Evas_Image *obj, double scale)
	Sets the scaling factor (multiplier) for the borders of an image object.
double	evas_object_image_border_scale_get (const Evas_Image *obj)
	Retrieves the scaling factor (multiplier) for the borders of an image object.
void	evas_object_image_pixels_dirty_set (Evas_Image *obj, Eina_Bool dirty)
	Mark whether the given image object is dirty and needs to request its pixels.
Eina_Bool	evas_object_image_pixels_dirty_get (const Evas_Image *obj)
	Retrieves whether the given image object is dirty (needs to be redrawn).
void	evas_object_image_video_surface_set (Evas_Image obj, Evas_Video_Surface surf)
	Set the video surface linked to a given image of the canvas.
const Evas_Video_Surface *	evas_object_image_video_surface_get (const Evas_Image *obj)
	Get the video surface linekd to a given image of the canvas.
void	evas_object_image_load_orientation_set (Evas_Image *obj, Eina_Bool enable)
	Define if the orientation information in the image file should be honored.
Eina_Bool	evas_object_image_load_orientation_get (const Evas_Image *obj)
	Get if the orientation information in the image file should be honored.
void	evas_object_image_fill_spread_set (Evas_Image *obj, Evas_Fill_Spread spread)
	Sets the tiling mode for the given evas image object's fill.
Evas_Fill_Spread	evas_object_image_fill_spread_get (const Evas_Image *obj)
	Retrieves the spread (tiling mode) for the given image object's fill.
void	evas_object_image_border_center_fill_set (Evas_Image *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.
Evas_Border_Fill_Mode	evas_object_image_border_center_fill_get (const Evas_Image *obj)
	Retrieves how the center part of the given image object (not the borders) is to be drawn when Evas is rendering it.
void	evas_object_image_size_set (Evas_Image *obj, int w, int h)
	Sets the size of the given image object.
void	evas_object_image_size_get (const Evas_Image obj, int w, int *h)
	Retrieves the size of the given image object.
void	evas_object_image_source_visible_set (Evas_Image *obj, Eina_Bool visible)
	Set the source object to be visible or not.
Eina_Bool	evas_object_image_source_visible_get (const Evas_Image *obj)
	Get the state of the source object visibility.
void	evas_object_image_fill_set (Evas_Image *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.
void	evas_object_image_fill_get (const Evas_Image 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.
Evas_Native_Surface *	evas_object_image_native_surface_get (const Evas_Image *obj)
	Get the native surface of a given image of the canvas.
void	evas_object_image_load_scale_down_set (Evas_Image *obj, int scale_down)
	Set the scale down factor of a given image object's source image, when loading it.
int	evas_object_image_load_scale_down_get (const Evas_Image *obj)
	get the scale down factor of a given image object's source image, when loading it.
void	evas_object_image_scale_hint_set (Evas_Image *obj, Evas_Image_Scale_Hint hint)
	Set the scale hint of a given image of the canvas.
Evas_Image_Scale_Hint	evas_object_image_scale_hint_get (const Evas_Image *obj)
	Get the scale hint of a given image of the canvas.
void	evas_object_image_colorspace_set (Evas_Image *obj, Evas_Colorspace cspace)
	Set the colorspace of a given image of the canvas.
Evas_Colorspace	evas_object_image_colorspace_get (const Evas_Image *obj)
	Get the colorspace of a given image of the canvas.
void	evas_object_image_pixels_get_callback_set (Evas_Image obj, Evas_Object_Image_Pixels_Get_Cb func, void data)
	Set the callback function to get pixels from a canvas' image.
void	evas_object_image_data_copy_set (Evas_Image obj, void data)
	Replaces the raw image data of the given image object.
void	evas_object_image_animated_frame_set (Evas_Image *obj, int frame_index)
	Set the frame to current frame of an image object.
Eina_Bool	evas_object_image_region_support_get (const Evas_Image *obj)
	Get the support state of a given image.
Evas_Load_Error	evas_object_image_load_error_get (const Evas_Image *obj)
	Retrieves a number representing any error that occurred during the last loading of the given image object's source image.
int	evas_object_image_animated_frame_count_get (const Evas_Image *obj)
	Get the total number of frames of the image object.
int	evas_object_image_stride_get (const Evas_Image *obj)
	Retrieves the row stride of the given image object.
Evas_Image_Animated_Loop_Hint	evas_object_image_animated_loop_type_get (const Evas_Image *obj)
	Get the kind of looping the image object does.
int	evas_object_image_animated_loop_count_get (const Evas_Image *obj)
	Get the number times the animation of the object loops.
void	evas_object_image_data_update_add (Evas_Image *obj, int x, int y, int w, int h)
	Mark a sub-region of the given image object to be redrawn.
double	evas_object_image_animated_frame_duration_get (const Evas_Image *obj, int start_frame, int frame_num)
	Get the duration of a sequence of frames.
void	evas_object_image_data_set (Evas_Image obj, void data)
	Sets the raw image data of the given image object.
void *	evas_object_image_data_get (const Evas_Image *obj, Eina_Bool for_writing)
	Get a pointer to the raw image data of the given image object.
void *	evas_object_image_data_convert (Evas_Image *obj, Evas_Colorspace to_cspace)
	Converts the raw image data of the given image object to the specified colorspace.
Eina_Bool	evas_object_image_pixels_import (Evas_Image obj, Evas_Pixel_Import_Source pixels)
	Import pixels from given source to a given canvas image object.
void	evas_object_image_reload (Evas_Image *obj)
	Reload an image object's image data.
Eina_Bool	evas_object_image_extension_can_load_get (const char *file)
Eina_Bool	evas_object_image_extension_can_load_fast_get (const char *file)
Typedefs
typedef void(*	Evas_Object_Image_Pixels_Get_Cb )(void data, Evas_Object o)
typedef enum _Evas_Colorspace	Evas_Colorspace
typedef enum _Evas_Pixel_Import_Pixel_Format	Evas_Pixel_Import_Pixel_Format
typedef struct _Evas_Pixel_Import_Source	Evas_Pixel_Import_Source

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

 evas_object_image_filled_set(img, EINA_TRUE);

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:

 prev = evas_object_image_filled_add(canvas);
 evas_object_image_file_set(prev, "/path/to/prev", NULL);
 evas_object_image_preload(prev, EINA_TRUE);

 next = evas_object_image_filled_add(canvas);
 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
 evas_object_image_load_scale_down_set(img, zoom);

 //optional: if you know you'll be showing a sub-set of the image's
 //pixels, you can avoid loading the complementary data
 evas_object_image_load_region_set(img, x, y, w, h);

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:

 evas_object_image_scale_hint_set(wd->img, EVAS_IMAGE_SCALE_HINT_DYNAMIC);

 // resizing takes place in between

 evas_object_image_scale_hint_set(wd->img, EVAS_IMAGE_SCALE_HINT_STATIC);

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_YCBCR422P709_PL: Not implemented yet.

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 Some image object functions examples here.

Typedef Documentation

typedef enum _Evas_Colorspace Evas_Colorspace

Colorspaces for pixel data supported by Evas Colorspaces for pixel data supported by Evas

typedef void(* Evas_Object_Image_Pixels_Get_Cb)(void *data, Evas_Object *o)

Function signature for the evas object pixels get callback function

See also:: evas_object_image_pixels_get()

By data it will be passed the private data. By o it will be passed the Evas_Object image on which the pixels are requested.

Evas_Pixel_Import_Pixel_Format

Pixel format for import call. See evas_object_image_pixels_import()

Evas_Pixel_Import_Source

A source description of pixels for importing pixels

Enumeration Type Documentation

enum _Evas_Colorspace

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.
EVAS_COLORSPACE_AGRY88	AY 8bits Alpha and 8bits Grey, accessed 1 16bits at a time
EVAS_COLORSPACE_ETC1	OpenGL ETC1 encoding of RGB texture (4 bit per pixel) Since (EFL) : 1.10
EVAS_COLORSPACE_RGB8_ETC2	OpenGL GL_COMPRESSED_RGB8_ETC2 texture compression format (4 bit per pixel) Since (EFL) : 1.10
EVAS_COLORSPACE_RGBA8_ETC2_EAC	OpenGL GL_COMPRESSED_RGBA8_ETC2_EAC texture compression format, supports alpha (8 bit per pixel) Since (EFL) : 1.10
EVAS_COLORSPACE_ETC1_ALPHA	ETC1 with alpha support using two planes: ETC1 RGB and ETC1 grey for alpha Since (EFL) : 1.11
EVAS_COLORSPACE_RGB_S3TC_DXT1	OpenGL COMPRESSED_RGB_S3TC_DXT1_EXT format with RGB only. Since (EFL) : 1.11
EVAS_COLORSPACE_RGBA_S3TC_DXT1	OpenGL COMPRESSED_RGBA_S3TC_DXT1_EXT format with RGBA punchthrough. Since (EFL) : 1.11
EVAS_COLORSPACE_RGBA_S3TC_DXT2	DirectDraw DXT2 format with premultiplied RGBA. Not supported by OpenGL itself. Since (EFL) : 1.11
EVAS_COLORSPACE_RGBA_S3TC_DXT3	OpenGL COMPRESSED_RGBA_S3TC_DXT3_EXT format with RGBA. Since (EFL) : 1.11
EVAS_COLORSPACE_RGBA_S3TC_DXT4	DirectDraw DXT4 format with premultiplied RGBA. Not supported by OpenGL itself. Since (EFL) : 1.11
EVAS_COLORSPACE_RGBA_S3TC_DXT5	OpenGL COMPRESSED_RGBA_S3TC_DXT5_EXT format with RGBA. Since (EFL) : 1.11

Function Documentation

Evas_Object* evas_object_image_add ( Evas * e )

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

Since :: 2.3

Parameters:

[in] e The given canvas.

Returns:: The created image object handle.

Remarks:: 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()

Remarks:

Example:

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

Eina_Bool evas_object_image_alpha_get ( const Evas_Image * obj )

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

Since :: 2.3

Returns:: Whether the alpha channel data is being used (EINA_TRUE) or not (EINA_FALSE).

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

Parameters:

[in] obj The image object

void evas_object_image_alpha_mask_set	(	Evas_Object *	obj,
		Eina_Bool	ismask
	)

Enable an image to be used as an alpha mask.

Since :: 2.3

Remarks:: 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:

[in]	obj	Object to use as an alpha mask.
[in]	ismask	Use image as alphamask, must be true.

void evas_object_image_alpha_set	(	Evas_Image *	obj,
		Eina_Bool	alpha
	)

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

Since :: 2.3

Remarks:: 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()

Parameters:

[in]	obj	The image object
[in]	alpha	Whether to use alpha channel (`EINA_TRUE`) data or not (`EINA_FALSE`).

int evas_object_image_animated_frame_count_get ( const Evas_Image * obj )

Get the total number of frames of the image object.

Since :: 2.3

Returns:: The number of frames

Remarks:: 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 (EFL) :: 1.1

Parameters:

[in] obj The image object

double evas_object_image_animated_frame_duration_get	(	const Evas_Image *	obj,
		int	start_frame,
		int	frame_num
	)

Get the duration of a sequence of frames.

Since :: 2.3

Remarks:: 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 (EFL) :: 1.1

Parameters:

[in]	obj	The image object
[in]	start_frame	The first frame
[in]	frame_num	Number of frames in the sequence

void evas_object_image_animated_frame_set	(	Evas_Image *	obj,
		int	frame_index
	)

Set the frame to current frame of an image object.

Since :: 2.3

Remarks:: 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 (EFL) :: 1.1

Parameters:

[in]	obj	The image object
[in]	frame_index	The index of current frame

Eina_Bool evas_object_image_animated_get ( const Eo * obj )

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

Since :: 2.3

Returns:: whether obj support animation

Remarks:

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;

 if (evas_object_image_animated_get(obj))
 {
 int frame_count;
 int loop_count;
 Evas_Image_Animated_Loop_Hint loop_type;
 double duration;

 frame_count = evas_object_image_animated_frame_count_get(obj);
 printf("This image has %d frames\n",frame_count);

 duration = evas_object_image_animated_frame_duration_get(obj,1,0);
 printf("Frame 1's duration is %f. You had better set object's frame to 2 after this duration using timer\n");

 loop_count = evas_object_image_animated_loop_count_get(obj);
 printf("loop count is %d. You had better run loop %d times\n",loop_count,loop_count);

 loop_type = evas_object_image_animated_loop_type_get(obj);
 if (loop_type == EVAS_IMAGE_ANIMATED_HINT_LOOP)
 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");

 evas_object_image_animated_frame_set(obj,1);
 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 (EFL) :: 1.1

int evas_object_image_animated_loop_count_get ( const Evas_Image * obj )

Get the number times the animation of the object loops.

Since :: 2.3

Returns:: The number of loop of an animated image object

Remarks:: 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 (EFL) :: 1.1

Parameters:

[in] obj The image object

Evas_Image_Animated_Loop_Hint evas_object_image_animated_loop_type_get ( const Evas_Image * obj )

Get the kind of looping the image object does.

Since :: 2.3

Returns:: Loop type of the image object

Remarks:: 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 (EFL) :: 1.1

Parameters:

[in] obj The image object

Evas_Border_Fill_Mode evas_object_image_border_center_fill_get ( const Evas_Image * obj )

Retrieves how the center part of the given image object (not the borders) is to be drawn when Evas is rendering it.

Since :: 2.3

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.

Parameters:

[in] obj The image object

void evas_object_image_border_center_fill_set	(	Evas_Image *	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.

Since :: 2.3

Remarks:: 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()

Parameters:

[in]	obj	The image object
[in]	fill	Fill mode of the center region of `obj` (a value in Evas_Border_Fill_Mode).

void evas_object_image_border_get	(	const Evas_Image *	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.

Since :: 2.3

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

Parameters:

[in]	obj	The image object
[out]	l	The border's left width.
[out]	r	The border's right width.
[out]	t	The border's top width.
[out]	b	The border's bottom width.

double evas_object_image_border_scale_get ( const Evas_Image * obj )

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

Since :: 2.3

Returns:: The scale factor set for its borders

See also:: evas_object_image_border_set(); evas_object_image_border_scale_set()

Parameters:

[in] obj The image object

void evas_object_image_border_scale_set	(	Evas_Image *	obj,
		double	scale
	)

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

Since :: 2.3

See also:: evas_object_image_border_set(); evas_object_image_border_scale_get()

Parameters:

[in]	obj	The image object
[in]	scale	The scale factor (default is `1.0` - i.e. no scaling)

void evas_object_image_border_set	(	Evas_Image *	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.

Since :: 2.3

Remarks:: 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.; 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()

Parameters:

[in]	obj	The image object
[in]	l	The border's left width.
[in]	r	The border's right width.
[in]	t	The border's top width.
[in]	b	The border's bottom width.

Evas_Colorspace evas_object_image_colorspace_get ( const Evas_Image * obj )

Get the colorspace of a given image of the canvas.

Since :: 2.3

Returns:: The colorspace of the image.

This function returns the colorspace of given canvas image.

Parameters:

[in] obj The image object

void evas_object_image_colorspace_set	(	Evas_Image *	obj,
		Evas_Colorspace	cspace
	)

Set the colorspace of a given image of the canvas.

Since :: 2.3

This function sets the colorspace of given canvas image.

Parameters:

[in]	obj	The image object
[in]	cspace	The new color space.

Evas_Image_Content_Hint evas_object_image_content_hint_get ( const Evas_Image * obj )

Get the content hint setting of a given image object of the canvas.

Since :: 2.3

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

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

See also:: evas_object_image_content_hint_set()

Parameters:

[in] obj The image object

void evas_object_image_content_hint_set	(	Evas_Image *	obj,
		Evas_Image_Content_Hint	hint
	)

Set the content hint setting of a given image object of the canvas.

Since :: 2.3

Remarks:: 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()

Parameters:

[in]	obj	The image object
[in]	hint	The content hint value, one of the Evas_Image_Content_Hint ones.

void* evas_object_image_data_convert	(	Evas_Image *	obj,
		Evas_Colorspace	to_cspace
	)

Converts the raw image data of the given image object to the specified colorspace.

Since :: 2.3

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

Returns:: data A newly allocated data in the format specified by to_cspace.

Parameters:

[in]	obj	The image object
[in]	to_cspace	The colorspace to which the image raw data will be converted.

void evas_object_image_data_copy_set	(	Evas_Image *	obj,
		void *	data
	)

Replaces the raw image data of the given image object.

Since :: 2.3

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

Parameters:

[in]	obj	The image object
[in]	data	The raw data to replace.

void* evas_object_image_data_get	(	const Evas_Image *	obj,
		Eina_Bool	for_writing
	)

Get a pointer to the raw image data of the given image object.

Since :: 2.3

Returns:: The raw image data.

Remarks:: 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.; 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()

Parameters:

[in]	obj	The image object
[in]	for_writing	Whether the data being retrieved will be modified (`EINA_TRUE`) or not (`EINA_FALSE`).

void evas_object_image_data_set	(	Evas_Image *	obj,
		void *	data
	)

Sets the raw image data of the given image object.

Since :: 2.3

Remarks:: 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()

Parameters:

[in]	obj	The image object
[in]	data	The raw data, or `NULL`.

void evas_object_image_data_update_add	(	Evas_Image *	obj,
		int	x,
		int	y,
		int	w,
		int	h
	)

Mark a sub-region of the given image object to be redrawn.

Since :: 2.3

Remarks:: This function schedules a particular rectangular region of an image object to be updated (redrawn) at the next rendering cycle.

Parameters:

[in]	obj	The image object
[in]	x	X-offset of the region to be updated.
[in]	y	Y-offset of the region to be updated.
[in]	w	Width of the region to be updated.
[in]	h	Height of the region to be updated.

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.

Since :: 2.4

Parameters:

file	The 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 (EFL) :: 1.1

This functions is threadsafe.

Eina_Bool evas_object_image_extension_can_load_get ( const char * file )

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

Since :: 2.4

Parameters:

file	The file to check

Returns:: EINA_TRUE if we may be able to open it, EINA_FALSE if it's unlikely.

Since (EFL) :: 1.1

If file is a Eina_Stringshare, use directly evas_object_image_extension_can_load_fast_get.

This functions is threadsafe.

void evas_object_image_file_get	(	const Eo *	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).

Since :: 2.3

Remarks:: You must not modify the strings on the returned pointers.; Use NULL pointers on the file components you're not interested in: they'll be ignored by the function.

Parameters:

[out]	file	The image file path.
[out]	key	The image key in `file` (if its an Eet one), or `NULL`, otherwise.

void evas_object_image_file_set	(	Eo *	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).

Since :: 2.3

Remarks:

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);
 err = evas_object_image_load_error_get(img);
 if (err != EVAS_LOAD_ERROR_NONE)
 {
 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);
 evas_object_show(img);
 }

Parameters:

[in]	file	The image file path.
[in]	key	The image key in `file` (if its an Eet one), or `NULL`, otherwise.

void evas_object_image_fill_get	(	const Evas_Image *	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.

Since :: 2.3

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

Parameters:

[in]	obj	The image object
[out]	x	The x coordinate (from the top left corner of the bound image) to start drawing from.
[out]	y	The y coordinate (from the top left corner of the bound image) to start drawing from.
[out]	w	The width the bound image will be displayed at.
[out]	h	The height the bound image will be displayed at.

void evas_object_image_fill_set	(	Evas_Image *	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.

Since :: 2.3

Remarks:: 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:

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.

Remarks:: evas_object_image_filled_set() is a helper function which will override the values set here automatically, for you, in a given way.

Parameters:

[in]	obj	The image object
[in]	x	The x coordinate (from the top left corner of the bound image) to start drawing from.
[in]	y	The y coordinate (from the top left corner of the bound image) to start drawing from.
[in]	w	The width the bound image will be displayed at.
[in]	h	The height the bound image will be displayed at.

Evas_Fill_Spread evas_object_image_fill_spread_get ( const Evas_Image * obj )

Retrieves the spread (tiling mode) for the given image object's fill.

Since :: 2.3

Returns:: The current spread mode of the image object.

Parameters:

[in] obj The image object

void evas_object_image_fill_spread_set	(	Evas_Image *	obj,
		Evas_Fill_Spread	spread
	)

Sets the tiling mode for the given evas image object's fill.

Since :: 2.3

EVAS_TEXTURE_RESTRICT, or EVAS_TEXTURE_PAD.

Parameters:

[in]	obj	The image object
[in]	spread	One of EVAS_TEXTURE_REFLECT, EVAS_TEXTURE_REPEAT,

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.

Since :: 2.3

Parameters:

[in] e The given canvas.

Returns:: The created image object handle.

Remarks:: 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.; 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()

Eina_Bool evas_object_image_filled_get ( const Evas_Image * obj )

Retrieve whether the image object's fill property should track the object's size.

Since :: 2.3

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

Parameters:

[in] obj The image object

void evas_object_image_filled_set	(	Evas_Image *	obj,
		Eina_Bool	filled
	)

Set whether the image object's fill property should track the object's size.

Since :: 2.3

Remarks:: 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()

Parameters:

[in]	obj	The image object
[in]	filled	`EINA_TRUE`, to make the fill property follow object size or `EINA_FALSE`, otherwise.

double evas_object_image_load_dpi_get ( const Evas_Image * obj )

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

Since :: 2.3

Returns:: The DPI resolution of the given canvas image.

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

See also:: evas_object_image_load_dpi_set() for more details

Parameters:

[in] obj The image object

void evas_object_image_load_dpi_set	(	Evas_Image *	obj,
		double	dpi
	)

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

Since :: 2.3

Remarks:: 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()

Parameters:

[in]	obj	The image object
[in]	dpi	The new DPI resolution.

Evas_Load_Error evas_object_image_load_error_get ( const Evas_Image * obj )

Retrieves a number representing any error that occurred during the last loading of the given image object's source image.

Since :: 2.3

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.

Parameters:

[in] obj The image object

Eina_Bool evas_object_image_load_orientation_get ( const Evas_Image * obj )

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

Since :: 2.3

Since (EFL) :: 1.1

Parameters:

[in] obj The image object

void evas_object_image_load_orientation_set	(	Evas_Image *	obj,
		Eina_Bool	enable
	)

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

Since :: 2.3

Since (EFL) :: 1.1

Parameters:

[in]	obj	The image object
[in]	enable	`EINA_TRUE` means that it should honor the orientation information

void evas_object_image_load_region_get	(	const Evas_Image *	obj,
		int *	x,
		int *	y,
		int *	w,
		int *	h
	)

Retrieve the coordinates of a given image object's selective (source image) load region.

Since :: 2.3

Remarks:: 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()

Parameters:

[in]	obj	The image object
[out]	x	X-offset of the region to be loaded.
[out]	y	Y-offset of the region to be loaded.
[out]	w	Width of the region to be loaded.
[out]	h	Height of the region to be loaded.

void evas_object_image_load_region_set	(	Evas_Image *	obj,
		int	x,
		int	y,
		int	w,
		int	h
	)

Inform a given image object to load a selective region of its source image.

Since :: 2.3

Remarks:: This function is useful when one is not showing all of an image's area on its image object.; 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()

Parameters:

[in]	obj	The image object
[in]	x	X-offset of the region to be loaded.
[in]	y	Y-offset of the region to be loaded.
[in]	w	Width of the region to be loaded.
[in]	h	Height of the region to be loaded.

int evas_object_image_load_scale_down_get ( const Evas_Image * obj )

get the scale down factor of a given image object's source image, when loading it.

Since :: 2.3

See also:: evas_object_image_load_scale_down_set() for more details

Parameters:

[in] obj The image object

void evas_object_image_load_scale_down_set	(	Evas_Image *	obj,
		int	scale_down
	)

Set the scale down factor of a given image object's source image, when loading it.

Since :: 2.3

Remarks:: This function sets the scale down factor of a given canvas image. 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. Scale down factor can be set to several values. For example, image's content size is 1920X1080, the scale factor is set to 2, loading size is 960X540. Most useful for the SVG image loader, but BMP, JPG, PNG image loader also work.

See also:: evas_object_image_load_scale_down_get(); evas_object_image_load_size_set()

Parameters:

[in]	obj	The image object
[in]	scale_down	The scale down factor.

void evas_object_image_load_size_get	(	const Eo *	obj,
		int *	w,
		int *	h
	)

Get the load size of a given image object's source image.

Since :: 2.3

Remarks:: This function gets the geometry size set manually for the given canvas image.; Use NULL pointers on the size components you're not interested in: they'll be ignored by the function.; w and h will be set with the image's loading size only if the image's load size is set manually: if evas_object_image_load_size_set() has not been called, w and h will be set with 0.

See also:: evas_object_image_load_size_set() for more details

Parameters:

[out]	w	The new width of the image's load size.
[out]	h	The new height of the image's load size.

void evas_object_image_load_size_set	(	Eo *	obj,
		int	w,
		int	h
	)

Set the load size of a given image object's source image.

Since :: 2.3

Remarks:: This function sets a new geometry size for the given canvas image. The image will be loaded into memory as if it was the set size instead of the original size.; The size of a given image object's source image will be less than or equal to the size of w and h.; This function has a similar effect as evas_object_image_load_scale_down_set(). For example, if the image content size is 1920X1080, you can get the same result with the following two calls: e.g., evas_object_image_load_scale_down_set(obj, 2) or evas_object_image_load_size_set(obj, 960, 540). evas_object_image_load_scale_down_set() takes precedence over evas_object_image_load_size_set().

See also:: evas_object_image_load_size_get(); evas_object_image_load_scale_down_set()

Parameters:

[in]	w	The new width of the image's load size.
[in]	h	The new height of the image's load size.

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.

Since :: 2.3

Remarks:: 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:

[in]	obj	The given image object.
[in]	data	The image file data address
[in]	size	The size of the image file data in bytes
[in]	format	The format of the file (optional), or `NULL` if not needed
[in]	key	The image key in file, or `NULL`.

Evas_Native_Surface* evas_object_image_native_surface_get ( const Evas_Image * obj )

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

Since :: 2.3

Returns:: The native surface of the given canvas image.

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

Parameters:

[in] obj The image object

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.

Since :: 2.3

Parameters:

[in]	obj	The given canvas pointer.
[in]	surf	The new native surface.

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

Eina_Bool evas_object_image_pixels_dirty_get ( const Evas_Image * obj )

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

Since :: 2.3

Returns:: Whether the image is dirty.

Parameters:

[in] obj The image object

void evas_object_image_pixels_dirty_set	(	Evas_Image *	obj,
		Eina_Bool	dirty
	)

Mark whether the given image object is dirty and needs to request its pixels.

Since :: 2.3

Remarks:: 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()

Parameters:

[in]	obj	The image object
[in]	dirty	Whether the image is dirty.

void evas_object_image_pixels_get_callback_set	(	Evas_Image *	obj,
		Evas_Object_Image_Pixels_Get_Cb	func,
		void *	data
	)

Set the callback function to get pixels from a canvas' image.

Since :: 2.3

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

Parameters:

[in]	obj	The image object
[in]	func	The callback function.
[in]	data	The data pointer to be passed to func.

Eina_Bool evas_object_image_pixels_import	(	Evas_Image *	obj,
		Evas_Pixel_Import_Source *	pixels
	)

Import pixels from given source to a given canvas image object.

Since :: 2.3

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

Parameters:

[in]	obj	The image object
[in]	pixels	The pixel's source to be imported.

void evas_object_image_preload	(	Evas_Object *	obj,
		Eina_Bool	cancel
	)

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

Since :: 2.3

Parameters:

[in]	obj	The given image object.
[in]	cancel	`EINA_FALSE` will add it the preloading work queue, `EINA_TRUE` will remove it (if it was issued before).

Remarks:: This function requests the preload of the data image in the background asynchronously. The work is queued before being processed (because there might be other pending requests of this type).; In general, the image data will be loaded at render time. But if evas_object_image_preload() is called with EINA_FALSE as param, the image data load will be queued.; 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.; 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.

Eina_Bool evas_object_image_region_support_get ( const Evas_Image * obj )

Get the support state of a given image.

Since :: 2.3

Returns:: The region support state

Since (EFL) :: 1.2

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

Parameters:

[in] obj The image object

void evas_object_image_reload ( Evas_Image * obj )

Reload an image object's image data.

Since :: 2.3

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

Parameters:

[in] obj The image object

Eina_Bool evas_object_image_save	(	const Eo *	obj,
		const char *	file,
		const char *	key,
		const char *	flags
	)

Save the given image object's contents to an (image) file. Proxy object is image object, but it doesn't have contents. So you can't use this function for proxy objects.

Since :: 2.3

Remarks:: 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"; quality is hint for the quality of image,0-100. 0 means low quality and saved image size is small. 100 means high quality and saved image size is big.

compress is hint for the compression modes (Eet ones) or for the compression flags (Png one) (1 == compress, 0 = don't compress).

Parameters:

[in]	file	The filename to be used to save the image (extension obligatory).
[in]	key	The image key in the file (if an Eet one), or `NULL`, otherwise.
[in]	flags	String containing the flags to be used (`NULL` for none).

Evas_Image_Scale_Hint evas_object_image_scale_hint_get ( const Evas_Image * obj )

Get the scale hint of a given image of the canvas.

Since :: 2.3

Returns:: The scale hint value set on obj, a value in #Evas_Image_Scale_Hint.

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

Parameters:

[in] obj The image object

void evas_object_image_scale_hint_set	(	Evas_Image *	obj,
		Evas_Image_Scale_Hint	hint
	)

Set the scale hint of a given image of the canvas.

Since :: 2.3

Remarks:: 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()

Parameters:

[in]	obj	The image object
[in]	hint	The scale hint, a value in #Evas_Image_Scale_Hint.

void evas_object_image_size_get	(	const Evas_Image *	obj,
		int *	w,
		int *	h
	)

Retrieves the size of the given image object.

Since :: 2.3

See evas_object_image_size_set() for more details.

Parameters:

[in]	obj	The image object
[out]	w	The new width of the image.
[out]	h	The new height of the image.

void evas_object_image_size_set	(	Evas_Image *	obj,
		int	w,
		int	h
	)

Sets the size of the given image object.

Since :: 2.3

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

Parameters:

[in]	obj	The image object
[in]	w	The new width of the image.
[in]	h	The new height of the image.

Eina_Bool evas_object_image_smooth_scale_get ( const Eo * obj )

Retrieves whether the given image object is using high-quality image scaling algorithm.

Since :: 2.3

Returns:: Whether smooth scale is being used.

Remarks:: See evas_object_image_smooth_scale_set() for more details.

void evas_object_image_smooth_scale_set	(	Eo *	obj,
		Eina_Bool	smooth_scale
	)

Sets whether to use high-quality image scaling algorithm on the given image object.

Since :: 2.3

Remarks:: 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.; Image objects get created originally with smooth scaling on.

See also:: evas_object_image_smooth_scale_get()

Parameters:

[in] smooth_scale Whether to use smooth scale or not.

Eina_Bool evas_object_image_source_clip_get ( const Evas_Image * obj )

Determine whether an object is clipped by source object's clipper.

Since :: 2.3

Returns:: EINA_TRUE if source clip is enabled, EINA_FALSE otherwise.

See also:: evas_object_clip_set(); evas_object_image_source_set(); evas_object_image_source_clip_set()

Since (EFL) :: 1.8

Parameters:

[in] obj The image object

void evas_object_image_source_clip_set	(	Evas_Image *	obj,
		Eina_Bool	source_clip
	)

Clip the proxy object with the source object's clipper.

Since :: 2.3

See also:: evas_object_clip_set(); evas_object_image_source_set()

Since (EFL) :: 1.8

Parameters:

[in]	obj	The image object
[in]	source_clip	whether `obj` is clipped by the source clipper. (`EINA_TRUE`) or not (`EINA_FALSE`)

Evas_Object* evas_object_image_source_get ( const Evas_Image * obj )

Get the current source object of an image object.

Since :: 2.3

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

Parameters:

[in] obj The image object

Eina_Bool evas_object_image_source_set	(	Evas_Image *	obj,
		Evas_Object *	src
	)

Set the source object on an image object to used as a proxy.

Since :: 2.3

Returns:: EINA_TRUE on success, EINA_FALSE on error.

Remarks:: 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(); evas_object_image_source_visible_set()

Parameters:

[in]	obj	The image object
[in]	src	Source object to use for the proxy.

Eina_Bool evas_object_image_source_unset ( Evas_Object * obj )

Clear the source object on a proxy image object.

Since :: 2.3

Parameters:

[in] obj Image object to clear source of.

Returns:: EINA_TRUE on success, EINA_FALSE on error.

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

Eina_Bool evas_object_image_source_visible_get ( const Evas_Image * obj )

Get the state of the source object visibility.

Since :: 2.3

Returns:: EINA_TRUE if source object is visible, EINA_FALSE otherwise.

See also:: evas_object_image_source_visible_set(); evas_object_image_source_set(); evas_object_show(); evas_object_hide()

Since (EFL) :: 1.8

Parameters:

[in] obj The image object

void evas_object_image_source_visible_set	(	Evas_Image *	obj,
		Eina_Bool	visible
	)

Set the source object to be visible or not.

Since :: 2.3

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

Warning:: If the all of proxies are deleted, then the source visibility of the source object will be cancelled.

See also:: evas_object_image_source_visible_get(); evas_object_image_source_set(); evas_object_show(); evas_object_hide()

Since (EFL) :: 1.8

Parameters:

[in]	obj	The image object
[in]	visible	`EINA_TRUE` is source object to be shown, `EINA_FALSE` otherwise.

int evas_object_image_stride_get ( const Evas_Image * obj )

Retrieves the row stride of the given image object.

Since :: 2.3

Returns:: The stride of the image (in bytes).

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

Parameters:

[in] obj The image object

const Evas_Video_Surface* evas_object_image_video_surface_get ( const Evas_Image * obj )

Get the video surface linekd to a given image of the canvas.

Since :: 2.3

Returns:: The video surface of the given canvas image.

Since (EFL) :: 1.1

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

Parameters:

[in] obj The image object

void evas_object_image_video_surface_set	(	Evas_Image *	obj,
		Evas_Video_Surface *	surf
	)

Set the video surface linked to a given image of the canvas.

Since :: 2.3

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

Parameters:

[in]	obj	The image object
[in]	surf	The new video surface.

Since (EFL) :: 1.1

Functions

Typedefs

Image object basics

Scale and resizing

Performance hints

Load hints

Animation hints

Borders

Manipulating pixels

Color spaces

Typedef Documentation

Enumeration Type Documentation

Function Documentation