Data Structures
struct	address_const_of

struct	address_of

Public Member Functions
void	preload_begin () const
	Begin preloading an image object's image data in the background.

void	data_update_add (int x_, int y_, int w_, int h_) const
	Mark a sub-region of the given image object to be redrawn. More...

double	animated_frame_duration_get (int start_frame_, int frame_num_) const
	Get the duration of a sequence of frames. More...

void	data_set (void *data_) const
	Sets the raw image data of the given image object. More...

void *	data_get (bool for_writing_) const
	Get a pointer to the raw image data of the given image object. More...

void	preload_cancel () const
	Cancel preloading an image object's image data in the background.

void *	data_convert (Evas_Colorspace to_cspace_) const
	Converts the raw image data of the given image object to the specified colorspace. More...

bool	pixels_import (Evas_Pixel_Import_Source *pixels_) const
	Import pixels from given source to a given canvas image object. More...

void	reload () const
	Reload an image object's image data. More...

double	load_dpi_get () const
	Get the DPI resolution of a loaded image object in the canvas. More...

void	load_dpi_set (double dpi_) const
	Set the DPI resolution of an image object's source image. More...

bool	source_clip_get () const
	Determine whether an object is clipped by source object's clipper. More...

void	source_clip_set (bool source_clip_) const
	Clip the proxy object with the source object's clipper. More...

::efl::eina::optional< ::evas::object >	source_get () const
	Get the current source object of an image object. More...

bool	source_set (::efl::eina::optional< ::evas::object > src_) const
	Set the source object on an image object to used as a proxy. More...

bool	filled_get () const
	Retrieve whether the image object's fill property should track the object's size. More...

void	filled_set (bool filled_) const
	Set whether the image object's fill property should track the object's size. More...

Evas_Image_Content_Hint	content_hint_get () const
	Get the content hint setting of a given image object of the canvas. More...

void	content_hint_set (Evas_Image_Content_Hint hint_) const
	Set the content hint setting of a given image object of the canvas. More...

void	load_region_get (int x_, int y_, int w_, int h_) const
	Retrieve the coordinates of a given image object's selective (source image) load region. More...

void	load_region_set (int x_, int y_, int w_, int h_) const
	Inform a given image object to load a selective region of its source image. More...

bool	alpha_get () const
	Retrieve whether alpha channel data is being used on the given image object. More...

void	alpha_set (bool alpha_) const
	Enable or disable alpha channel usage on the given image object. More...

void	border_get (int l_, int r_, int t_, int b_) const
	Retrieve the dimensions for an image object's border, a region which won't ever be scaled together with its center. More...

void	border_set (int l_, int r_, int t_, int b_) const
	Set the dimensions for an image object's border, a region which won't ever be scaled together with its center. More...

double	border_scale_get () const
	Retrieves the scaling factor (multiplier) for the borders of an image object. More...

void	border_scale_set (double scale_) const
	Sets the scaling factor (multiplier) for the borders of an image object. More...

bool	pixels_dirty_get () const
	Retrieves whether the given image object is dirty (needs to be redrawn). More...

void	pixels_dirty_set (bool dirty_) const
	Mark whether the given image object is dirty and needs to request its pixels. More...

const Evas_Video_Surface *	video_surface_get () const
	Get the video surface linekd to a given image of the canvas. More...

void	video_surface_set (Evas_Video_Surface *surf_) const
	Set the video surface linked to a given image of the canvas. More...

unsigned int	video_surface_caps_get () const
	Get the video surface capabilities to a given image of the canvas. More...

void	video_surface_caps_set (unsigned int caps_) const
	Set the video surface capabilities to a given image of the canvas. More...

bool	load_orientation_get () const
	Get if the orientation information in the image file should be honored. More...

void	load_orientation_set (bool enable_) const
	Define if the orientation information in the image file should be honored. More...

Evas_Fill_Spread	fill_spread_get () const
	Retrieves the spread (tiling mode) for the given image object's fill. More...

void	fill_spread_set (Evas_Fill_Spread spread_) const
	Sets the tiling mode for the given evas image object's fill. More...

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

void	border_center_fill_set (Evas_Border_Fill_Mode fill_) const
	Sets how the center part of the given image object (not the borders) should be drawn when Evas is rendering it. More...

void	size_get (int w_, int h_) const
	Retrieves the size of the given image object. More...

void	size_set (int w_, int h_) const
	Sets the size of the given image object. More...

bool	source_visible_get () const
	Get the state of the source object visibility. More...

void	source_visible_set (bool visible_) const
	Set the source object to be visible or not. More...

void	fill_get (Evas_Coord x_, Evas_Coord y_, Evas_Coord w_, Evas_Coord h_) const
	Retrieve how an image object is to fill its drawing rectangle, given the (real) image bound to it. More...

void	fill_set (Evas_Coord x_, Evas_Coord y_, Evas_Coord w_, Evas_Coord h_) const
	Set how to fill an image object's drawing rectangle given the (real) image bound to it. More...

Evas_Native_Surface *	native_surface_get () const
	Get the native surface of a given image of the canvas. More...

void	native_surface_set (Evas_Native_Surface *surf_) const
	Set the native surface of a given image of the canvas. More...

int	load_scale_down_get () const
	get the scale down factor of a given image object's source image, when loading it. More...

void	load_scale_down_set (int scale_down_) const
	Set the scale down factor of a given image object's source image, when loading it. More...

Evas_Image_Scale_Hint	scale_hint_get () const
	Get the scale hint of a given image of the canvas. More...

void	scale_hint_set (Evas_Image_Scale_Hint hint_) const
	Set the scale hint of a given image of the canvas. More...

bool	source_events_get () const
	Determine whether an object is set to source events. More...

void	source_events_set (bool source_) const
	Set whether an Evas object is to source events. More...

Evas_Colorspace	colorspace_get () const
	Get the colorspace of a given image of the canvas. More...

void	colorspace_set (Evas_Colorspace cspace_) const
	Set the colorspace of a given image of the canvas. More...

void	pixels_get_callback_set (Evas_Object_Image_Pixels_Get_Cb func_, void *data_) const
	Set the callback function to get pixels from a canvas' image. More...

void	mmap_get (const Eina_File f_, const char key_) const
	Get the source mmaped file from where an image object must fetch the real image data (it must be an Eina_File). More...

void	mmap_set (const Eina_File *f_,::efl::eina::optional< std::string > key_) const
	Set the source mmaped file from where an image object must fetch the real image data (it must be an Eina_File). More...

void	data_copy_set (void *data_) const
	Replaces the raw image data of the given image object. More...

void	animated_frame_set (int frame_index_) const
	Set the frame to current frame of an image object. More...

bool	region_support_get () const
	Get the support state of a given image. More...

Evas_Load_Error	load_error_get () const
	Retrieves a number representing any error that occurred during the last loading of the given image object's source image. More...

int	animated_frame_count_get () const
	Get the total number of frames of the image object. More...

int	stride_get () const
	Retrieves the row stride of the given image object. More...

Evas_Image_Animated_Loop_Hint	animated_loop_type_get () const
	Get the kind of looping the image object does. More...

int	animated_loop_count_get () const
	Get the number times the animation of the object loops. More...

Evas_3D_Scene *	scene_get () const
	Get the 3D scene of a given image of the canvas. More...

void	scene_set (Evas_3D_Scene *scene_) const
	Set the 3D scene of a given image of the canvas. More...

void	filter_program_set (::efl::eina::optional< std::string > program_) const
	Set an Evas filter program on this Text Object. More...

void	filter_source_set (::efl::eina::optional< std::string > name_,::efl::eina::optional< ::efl::eo::concrete > eobj_) const
	Bind an object to use as a mask or texture with Evas Filters. More...

bool	filter_padding_get (int l_, int r_, int t_, int b_) const
	Get the value of the extra padding set when a filter is used. More...

	operator::evas::image () const

	operator::evas::image & ()

	operator::evas::image const & () const

Static Public Member Functions
static Eo_Class const *	_eo_class ()

Member Function Documentation

void eo_cxx::evas::image::data_update_add	(	int	x_,
		int	y_,
		int	w_,
		int	h_
	)		const

inline

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

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

Parameters

x	X-offset of the region to be updated.
y	Y-offset of the region to be updated.
w	Width of the region to be updated.
h	Height of the region to be updated.

double eo_cxx::evas::image::animated_frame_duration_get	(	int	start_frame_,
		int	frame_num_
	)		const

inline

Get the duration of a sequence of frames.

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

Parameters

start_frame	The first frame
frame_num	Number of frames in the sequence

void eo_cxx::evas::image::data_set ( void * data_ ) const

inline

Sets the raw image data of the given image object.

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

data	The raw data, or `NULL`.

void * eo_cxx::evas::image::data_get ( bool for_writing_ ) const

inline

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

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

Parameters

for_writing Whether the data being retrieved will be modified (EINA_TRUE) or not (EINA_FALSE).

void * eo_cxx::evas::image::data_convert ( Evas_Colorspace to_cspace_ ) const

inline

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.

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

Parameters

to_cspace The colorspace to which the image raw data will be converted.

bool eo_cxx::evas::image::pixels_import ( Evas_Pixel_Import_Source * pixels_ ) const

inline

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

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

Parameters

pixels The pixel's source to be imported.

void eo_cxx::evas::image::reload ( ) const

inline

Reload an image object's image data.

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

double eo_cxx::evas::image::load_dpi_get ( ) const

inline

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

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

Parameters

dpi	The new DPI resolution.

void eo_cxx::evas::image::load_dpi_set ( double dpi_ ) const

inline

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

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

dpi	The new DPI resolution.

bool eo_cxx::evas::image::source_clip_get ( ) const

inline

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

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

Parameters

source_clip whether obj is clipped by the source clipper. (EINA_TRUE) or not (EINA_FALSE)

void eo_cxx::evas::image::source_clip_set ( bool source_clip_ ) const

inline

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

See also: evas_object_clip_set(); evas_object_image_source_set()

Since: 1.8

Parameters

source_clip whether obj is clipped by the source clipper. (EINA_TRUE) or not (EINA_FALSE)

efl::eina::optional<::evas::object > eo_cxx::evas::image::source_get ( ) const

inline

Get the current source object of an image 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

Parameters

src	Source object to use for the proxy.

bool eo_cxx::evas::image::source_set ( ::efl::eina::optional< ::evas::object > src_ ) const

inline

Set the source object on an image object to used as a 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(); evas_object_image_source_visible_set()

Parameters

src	Source object to use for the proxy.

bool eo_cxx::evas::image::filled_get ( ) const

inline

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

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

filled EINA_TRUE, to make the fill property follow object size or EINA_FALSE, otherwise.

void eo_cxx::evas::image::filled_set ( bool filled_ ) const

inline

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

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

filled EINA_TRUE, to make the fill property follow object size or EINA_FALSE, otherwise.

Evas_Image_Content_Hint eo_cxx::evas::image::content_hint_get ( ) const

inline

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

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

Parameters

hint	The content hint value, one of the Evas_Image_Content_Hint ones.

void eo_cxx::evas::image::content_hint_set ( Evas_Image_Content_Hint hint_ ) const

inline

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

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

hint	The content hint value, one of the Evas_Image_Content_Hint ones.

void eo_cxx::evas::image::load_region_get	(	int *	x_,
		int *	y_,
		int *	w_,
		int *	h_
	)		const

inline

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

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

Parameters

x	X-offset of the region to be loaded.
y	Y-offset of the region to be loaded.
w	Width of the region to be loaded.
h	Height of the region to be loaded.

void eo_cxx::evas::image::load_region_set	(	int	x_,
		int	y_,
		int	w_,
		int	h_
	)		const

inline

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

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

Parameters

x	X-offset of the region to be loaded.
y	Y-offset of the region to be loaded.
w	Width of the region to be loaded.
h	Height of the region to be loaded.

bool eo_cxx::evas::image::alpha_get ( ) const

inline

Retrieve whether alpha channel data is being used on the 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.

Parameters

alpha Whether to use alpha channel (EINA_TRUE) data or not (EINA_FALSE).

void eo_cxx::evas::image::alpha_set ( bool alpha_ ) const

inline

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

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

alpha Whether to use alpha channel (EINA_TRUE) data or not (EINA_FALSE).

void eo_cxx::evas::image::border_get	(	int *	l_,
		int *	r_,
		int *	t_,
		int *	b_
	)		const

inline

Retrieve the dimensions for an image object's border, a region which won't ever be scaled together with its center.

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.

Parameters

l	The border's left width.
r	The border's right width.
t	The border's top width.
b	The border's bottom width.

void eo_cxx::evas::image::border_set	(	int	l_,
		int	r_,
		int	t_,
		int	b_
	)		const

inline

Set the dimensions for an image object's border, a region which won't ever be scaled together with its center.

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

Parameters

l	The border's left width.
r	The border's right width.
t	The border's top width.
b	The border's bottom width.

double eo_cxx::evas::image::border_scale_get ( ) const

inline

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

Returns: The scale factor set for its borders

See also: evas_object_image_border_set(); evas_object_image_border_scale_set()

Parameters

scale The scale factor (default is 1.0 - i.e. no scaling)

void eo_cxx::evas::image::border_scale_set ( double scale_ ) const

inline

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

See also: evas_object_image_border_set(); evas_object_image_border_scale_get()

Parameters

scale The scale factor (default is 1.0 - i.e. no scaling)

bool eo_cxx::evas::image::pixels_dirty_get ( ) const

inline

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

Returns: Whether the image is dirty.

Parameters

dirty Whether the image is dirty.

void eo_cxx::evas::image::pixels_dirty_set ( bool dirty_ ) const

inline

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

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

dirty Whether the image is dirty.

const Evas_Video_Surface * eo_cxx::evas::image::video_surface_get ( ) const

inline

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

Returns: The video surface of the given canvas image.

Since: 1.1

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

Parameters

surf	The new video surface.

Since: 1.1

void eo_cxx::evas::image::video_surface_set ( Evas_Video_Surface * surf_ ) const

inline

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

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

Parameters

surf	The new video surface.

Since: 1.1

unsigned int eo_cxx::evas::image::video_surface_caps_get ( ) const

inline

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

Parameters

caps in

void eo_cxx::evas::image::video_surface_caps_set ( unsigned int caps_ ) const

inline

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

Parameters

caps in

bool eo_cxx::evas::image::load_orientation_get ( ) const

inline

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

Since: 1.1

Parameters

enable EINA_TRUE means that it should honor the orientation information

void eo_cxx::evas::image::load_orientation_set ( bool enable_ ) const

inline

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

Since: 1.1

Parameters

enable EINA_TRUE means that it should honor the orientation information

Evas_Fill_Spread eo_cxx::evas::image::fill_spread_get ( ) const

inline

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

Returns: The current spread mode of the image object.

Parameters

spread One of EVAS_TEXTURE_REFLECT, EVAS_TEXTURE_REPEAT,

void eo_cxx::evas::image::fill_spread_set ( Evas_Fill_Spread spread_ ) const

inline

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

EVAS_TEXTURE_RESTRICT, or EVAS_TEXTURE_PAD.

Parameters

spread One of EVAS_TEXTURE_REFLECT, EVAS_TEXTURE_REPEAT,

Evas_Border_Fill_Mode eo_cxx::evas::image::border_center_fill_get ( ) const

inline

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

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

fill	Fill mode of the center region of `obj` (a value in Evas_Border_Fill_Mode).

void eo_cxx::evas::image::border_center_fill_set ( Evas_Border_Fill_Mode fill_ ) const

inline

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

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

fill	Fill mode of the center region of `obj` (a value in Evas_Border_Fill_Mode).

void eo_cxx::evas::image::size_get	(	int *	w_,
		int *	h_
	)		const

inline

Retrieves the size of the given image object.

See evas_object_image_size_set() for more details.

Parameters

w	The new width of the image.
h	The new height of the image.

void eo_cxx::evas::image::size_set	(	int	w_,
		int	h_
	)		const

inline

Sets the size of the given image object.

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

w	The new width of the image.
h	The new height of the image.

bool eo_cxx::evas::image::source_visible_get ( ) const

inline

Get the state of the source object visibility.

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

Parameters

visible EINA_TRUE is source object to be shown, EINA_FALSE otherwise.

void eo_cxx::evas::image::source_visible_set ( bool visible_ ) const

inline

Set the source object to be visible or not.

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

Parameters

visible EINA_TRUE is source object to be shown, EINA_FALSE otherwise.

void eo_cxx::evas::image::fill_get	(	Evas_Coord *	x_,
		Evas_Coord *	y_,
		Evas_Coord *	w_,
		Evas_Coord *	h_
	)		const

inline

Retrieve how an image object is to fill its drawing rectangle, given the (real) image bound to it.

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.

Parameters

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

void eo_cxx::evas::image::fill_set	(	Evas_Coord	x_,
		Evas_Coord	y_,
		Evas_Coord	w_,
		Evas_Coord	h_
	)		const

inline

Set how to fill an image object's drawing rectangle given the (real) image bound to it.

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.

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

Parameters

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

Evas_Native_Surface * eo_cxx::evas::image::native_surface_get ( ) const

inline

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

Returns: The native surface of the given canvas image.

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

Parameters

surf	The new native surface.

void eo_cxx::evas::image::native_surface_set ( Evas_Native_Surface * surf_ ) const

inline

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

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

Parameters

surf	The new native surface.

int eo_cxx::evas::image::load_scale_down_get ( ) const

inline

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

See also: evas_object_image_load_scale_down_set() for more details

Parameters

scale_down The scale down factor.

void eo_cxx::evas::image::load_scale_down_set ( int scale_down_ ) const

inline

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

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

Parameters

scale_down The scale down factor.

Evas_Image_Scale_Hint eo_cxx::evas::image::scale_hint_get ( ) const

inline

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

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.

Parameters

hint	The scale hint, a value in #Evas_Image_Scale_Hint.

void eo_cxx::evas::image::scale_hint_set ( Evas_Image_Scale_Hint hint_ ) const

inline

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

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

hint	The scale hint, a value in #Evas_Image_Scale_Hint.

bool eo_cxx::evas::image::source_events_get ( ) const

inline

Determine whether an object is set to source events.

Returns: EINA_TRUE if source object has events, EINA_FALSE otherwise.

See also: evas_object_image_source_set(); evas_object_image_source_visible_set(); evas_object_image_source_events_set()

Since: 1.8

Parameters

source whether obj is to pass events (EINA_TRUE) or not (EINA_FALSE)

void eo_cxx::evas::image::source_events_set ( bool source_ ) const

inline

Set whether an Evas object is to source events.

Set whether an Evas object is to repeat events to source.

If source is EINA_TRUE, it will make events on obj to also be repeated for the source object (see evas_object_image_source_set()). Even the obj and source geometries are different, the event position will be transformed to the source object's space.

If source is EINA_FALSE, events occurring on obj will be processed only on it.

See also: evas_object_image_source_get(); evas_object_image_source_visible_set(); evas_object_image_source_events_get()

Since: 1.8

Parameters

source whether obj is to pass events (EINA_TRUE) or not (EINA_FALSE)

Evas_Colorspace eo_cxx::evas::image::colorspace_get ( ) const

inline

Get the colorspace of a given image of the canvas.

Returns: The colorspace of the image.

This function returns the colorspace of given canvas image.

Parameters

cspace The new color space.

void eo_cxx::evas::image::colorspace_set ( Evas_Colorspace cspace_ ) const

inline

Set the colorspace of a given image of the canvas.

This function sets the colorspace of given canvas image.

Parameters

cspace The new color space.

void eo_cxx::evas::image::pixels_get_callback_set	(	Evas_Object_Image_Pixels_Get_Cb	func_,
		void *	data_
	)		const

inline

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

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

Parameters

func	The callback function.
data	The data pointer to be passed to func.

void eo_cxx::evas::image::mmap_get	(	const Eina_File **	f_,
		const char **	key_
	)		const

inline

Get the source mmaped file from where an image object must fetch the real image data (it must be an Eina_File).

If the file supports multiple data stored in it (as Eet files do), you can get the key to be used as the index of the image in this file.

Since: 1.10

Parameters

f	The mmaped file
key	The image key in `file` (if its an Eet one), or `NULL`, otherwise.

void eo_cxx::evas::image::mmap_set	(	const Eina_File *	f_,
		::efl::eina::optional< std::string >	key_
	)		const

inline

Set the source mmaped file from where an image object must fetch the real image data (it must be an Eina_File).

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.

Since: 1.8

Parameters

f	The mmaped file
key	The image key in `file` (if its an Eet one), or `NULL`, otherwise.

void eo_cxx::evas::image::data_copy_set ( void * data_ ) const

inline

Replaces the raw image data of the given image object.

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

data	The raw data to replace.

void eo_cxx::evas::image::animated_frame_set ( int frame_index_ ) const

inline

Set the frame to current frame of an image object.

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

Parameters

frame_index The index of current frame

bool eo_cxx::evas::image::region_support_get ( ) const

inline

Get the support state of a given image.

Returns: The region support state

Since: 1.2

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

Evas_Load_Error eo_cxx::evas::image::load_error_get ( ) const

inline

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

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.

int eo_cxx::evas::image::animated_frame_count_get ( ) const

inline

Get the total number of frames of the image 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

int eo_cxx::evas::image::stride_get ( ) const

inline

Retrieves the row stride of the 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.

Evas_Image_Animated_Loop_Hint eo_cxx::evas::image::animated_loop_type_get ( ) const

inline

Get the kind of looping the image object does.

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

int eo_cxx::evas::image::animated_loop_count_get ( ) const

inline

Get the number times the animation of the object loops.

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

Evas_3D_Scene * eo_cxx::evas::image::scene_get ( ) const

inline

Get the 3D scene of a given image of the canvas.

Returns: The 3d scene of the given canvas image.

This function returns the 3d scene of a given canvas image.

See also: evas_object_image_scene_get

Since: 1.10

Parameters

scene 3D scene on an image object.

void eo_cxx::evas::image::scene_set ( Evas_3D_Scene * scene_ ) const

inline

Set the 3D scene of a given image of the canvas.

This function sets a 3d scene of a given canvas image.

See also: evas_object_image_scene_set

Since: 1.10

Parameters

scene 3D scene on an image object.

void eo_cxx::evas::image::filter_program_set ( ::efl::eina::optional< std::string > program_ ) const

inline

Set an Evas filter program on this Text Object.

If the program fails to compile (syntax error, invalid buffer name, etc...), the standard text effects will be applied instead (SHADOW, etc...). switch back to the standard text effects.

Since: 1.9

Note: EXPERIMENTAL FEATURE. This is an unstable API, please use only for testing purposes.

See also: Evas filters reference

Parameters

program The program code, as defined by the Evas filters script language. Pass NULL to remove the former program and switch back to the standard text effect

Since: 1.9

Note: EXPERIMENTAL FEATURE. This is an unstable API, please use only for testing purposes.

See also: Evas filters reference

void eo_cxx::evas::image::filter_source_set	(	::efl::eina::optional< std::string >	name_,
		::efl::eina::optional< ::efl::eo::concrete >	eobj_
	)		const

inline

Bind an object to use as a mask or texture with Evas Filters.

This will create automatically a new RGBA buffer containing the source object's pixels (as it is rendered).

Parameters

name	Object name as used in the program code
eobj	Eo object to use through proxy rendering

bool eo_cxx::evas::image::filter_padding_get	(	int *	l_,
		int *	r_,
		int *	t_,
		int *	b_
	)		const

inline

Get the value of the extra padding set when a filter is used.

Parameters

l	Left padding in pixels
r	Right padding in pixels
t	Top padding in pixels
b	Bottom padding in pixels

Returns: Returns false if the filter is invalid and padding is 0

Data Structures

Public Member Functions

Static Public Member Functions

Member Function Documentation