forked from enlightenment/efl
995 lines
34 KiB
Plaintext
995 lines
34 KiB
Plaintext
class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View)
|
|
{
|
|
legacy_prefix: evas_object_image;
|
|
eo_prefix: evas_obj_image;
|
|
properties {
|
|
load_dpi {
|
|
set {
|
|
/*@
|
|
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 evas_object_image_load_dpi_get() */
|
|
}
|
|
get {
|
|
/*@
|
|
Get the DPI resolution of a loaded image object in the canvas.
|
|
|
|
@return The DPI resolution of the given canvas image.
|
|
|
|
This function returns the DPI resolution of the given canvas image.
|
|
|
|
@see evas_object_image_load_dpi_set() for more details */
|
|
}
|
|
values {
|
|
double dpi; /*@ The new DPI resolution. */
|
|
}
|
|
}
|
|
|
|
source_clip {
|
|
set {
|
|
/*@
|
|
Clip the proxy object with the source object's clipper.
|
|
|
|
@see evas_object_clip_set()
|
|
@see evas_object_image_source_set()
|
|
@since 1.8 */
|
|
}
|
|
get {
|
|
/*@
|
|
Determine whether an object is clipped by source object's clipper.
|
|
|
|
@return @c EINA_TRUE if source clip is enabled, @c EINA_FALSE otherwise.
|
|
|
|
@see evas_object_clip_set()
|
|
@see evas_object_image_source_set()
|
|
@see evas_object_image_source_clip_set()
|
|
@since 1.8 */
|
|
}
|
|
values {
|
|
bool source_clip; /*@ whether @p obj is clipped by the source clipper.
|
|
(@c EINA_TRUE) or not (@c EINA_FALSE) */
|
|
}
|
|
}
|
|
source {
|
|
set {
|
|
/*@
|
|
Set the source object on an image object to used as a @b proxy.
|
|
|
|
@return @c EINA_TRUE on success, @c EINA_FALSE on error.
|
|
|
|
If an image object is set to behave as a @b proxy, it will mirror
|
|
the rendering contents of a given @b 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 @p obj will be removed after this
|
|
call. Setting @p src to @c NULL clears the proxy object (not in
|
|
"proxy state" anymore).
|
|
|
|
@warning You cannot set a proxy as another proxy's source.
|
|
|
|
@see evas_object_image_source_get()
|
|
@see evas_object_image_source_unset()
|
|
@see evas_object_image_source_visible_set() */
|
|
return: bool;
|
|
}
|
|
get {
|
|
/*@
|
|
Get the current source object of an image object.
|
|
|
|
@return Source object (if any), or @c NULL, if not in "proxy mode"
|
|
(or on errors).
|
|
|
|
@see evas_object_image_source_set() for more details */
|
|
}
|
|
values {
|
|
Evas_Object *src; /*@ Source object to use for the proxy. */
|
|
}
|
|
}
|
|
filled {
|
|
set {
|
|
/*@
|
|
Set whether the image object's fill property should track the
|
|
object's size.
|
|
|
|
If @p setting is @c EINA_TRUE, then every evas_object_resize() will
|
|
@b automatically trigger a call to evas_object_image_fill_set()
|
|
with the that new size (and @c 0, @c 0 as source image's origin),
|
|
so the bound image will fill the whole object's area.
|
|
|
|
@see evas_object_image_filled_add()
|
|
@see evas_object_image_fill_get() */
|
|
}
|
|
get {
|
|
/*@
|
|
Retrieve whether the image object's fill property should track the
|
|
object's size.
|
|
|
|
@return @c EINA_TRUE if it is tracking, @c EINA_FALSE, if not (and
|
|
evas_object_fill_set() must be called manually).
|
|
|
|
@see evas_object_image_filled_set() for more information */
|
|
}
|
|
values {
|
|
bool filled; /*@ @c EINA_TRUE, to make the fill property follow
|
|
object size or @c EINA_FALSE, otherwise. */
|
|
}
|
|
}
|
|
content_hint {
|
|
set {
|
|
/*@
|
|
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 @b zero copies
|
|
at texture upload time, which is an "expensive" operation.
|
|
|
|
@see evas_object_image_content_hint_get() */
|
|
}
|
|
get {
|
|
/*@
|
|
Get the content hint setting of a given image object of the canvas.
|
|
|
|
@return 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 evas_object_image_content_hint_set() */
|
|
}
|
|
values {
|
|
Evas_Image_Content_Hint hint; /*@ The content hint value, one of the
|
|
#Evas_Image_Content_Hint ones. */
|
|
}
|
|
}
|
|
load_region {
|
|
set {
|
|
/*@
|
|
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 evas_object_image_load_region_get() */
|
|
}
|
|
get {
|
|
/*@
|
|
Retrieve the coordinates of a given image object's selective
|
|
(source image) load region.
|
|
|
|
@note Use @c NULL pointers on the coordinates you're not interested
|
|
in: they'll be ignored by the function.
|
|
|
|
@see evas_object_image_load_region_get() */
|
|
}
|
|
values {
|
|
int x; /*@ X-offset of the region to be loaded. */
|
|
int y; /*@ Y-offset of the region to be loaded. */
|
|
int w; /*@ Width of the region to be loaded. */
|
|
int h; /*@ Height of the region to be loaded. */
|
|
}
|
|
}
|
|
alpha {
|
|
set {
|
|
/*@
|
|
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 @c EINA_TRUE makes it use
|
|
alpha channel data, and @c 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 evas_object_image_alpha_get() */
|
|
}
|
|
get {
|
|
/*@
|
|
Retrieve whether alpha channel data is being used on the given
|
|
image object.
|
|
|
|
@return Whether the alpha channel data is being used (@c EINA_TRUE)
|
|
or not (@c EINA_FALSE).
|
|
|
|
This function returns @c EINA_TRUE if the image object's alpha
|
|
channel is being used, or @c EINA_FALSE otherwise.
|
|
|
|
See @ref evas_object_image_alpha_set() for more details. */
|
|
}
|
|
values {
|
|
bool alpha; /*@ Whether to use alpha channel (@c EINA_TRUE) data
|
|
or not (@c EINA_FALSE). */
|
|
}
|
|
}
|
|
border {
|
|
set {
|
|
/*@
|
|
Set the dimensions for an image object's border, a region which @b
|
|
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 @b 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 @p l, @p r, @p t and @p b are canvas units.
|
|
|
|
@note The border region itself @b may be scaled by the
|
|
evas_object_image_border_scale_set() function.
|
|
|
|
@note By default, image objects have no borders set, i. e. @c l, @c
|
|
r, @c t and @c b start as @c 0.
|
|
|
|
See the following figures for visual explanation:\n
|
|
@htmlonly
|
|
<img src="image-borders.png" style="max-width: 100%;" />
|
|
<a href="image-borders.png">Full-size</a>
|
|
@endhtmlonly
|
|
@image rtf image-borders.png
|
|
@image latex image-borders.eps width=\textwidth
|
|
@htmlonly
|
|
<img src="border-effect.png" style="max-width: 100%;" />
|
|
<a href="border-effect.png">Full-size</a>
|
|
@endhtmlonly
|
|
@image rtf border-effect.png
|
|
@image latex border-effect.eps width=\textwidth
|
|
|
|
@see evas_object_image_border_get()
|
|
@see evas_object_image_border_center_fill_set() */
|
|
}
|
|
get {
|
|
/*@
|
|
Retrieve the dimensions for an image object's border, a region
|
|
which @b won't ever be scaled together with its center.
|
|
|
|
@note Use @c NULL pointers on the border components you're not
|
|
interested in: they'll be ignored by the function.
|
|
|
|
See @ref evas_object_image_border_set() for more details. */
|
|
}
|
|
values {
|
|
int l; /*@ The border's left width. */
|
|
int r; /*@ The border's right width. */
|
|
int t; /*@ The border's top width. */
|
|
int b; /*@ The border's bottom width. */
|
|
}
|
|
}
|
|
border_scale {
|
|
set {
|
|
/*@
|
|
Sets the scaling factor (multiplier) for the borders of an image
|
|
object.
|
|
|
|
@see evas_object_image_border_set()
|
|
@see evas_object_image_border_scale_get() */
|
|
}
|
|
get {
|
|
/*@
|
|
Retrieves the scaling factor (multiplier) for the borders of an
|
|
image object.
|
|
|
|
@return The scale factor set for its borders
|
|
|
|
@see evas_object_image_border_set()
|
|
@see evas_object_image_border_scale_set() */
|
|
}
|
|
values {
|
|
double scale; /*@ The scale factor (default is @c 1.0 - i.e. no scaling) */
|
|
}
|
|
}
|
|
pixels_dirty {
|
|
set {
|
|
/*@
|
|
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 evas_object_image_pixels_get_callback_set() */
|
|
}
|
|
get {
|
|
/*@
|
|
Retrieves whether the given image object is dirty (needs to be redrawn).
|
|
|
|
@return Whether the image is dirty. */
|
|
}
|
|
values {
|
|
bool dirty; /*@ Whether the image is dirty. */
|
|
}
|
|
}
|
|
video_surface {
|
|
set {
|
|
/*@
|
|
Set the video surface linked to a given image of the canvas
|
|
|
|
This function links a video surface to a given canvas image. */
|
|
}
|
|
get {
|
|
/*@
|
|
Get the video surface linekd to a given image of the canvas
|
|
|
|
@return The video surface of the given canvas image.
|
|
@since 1.1
|
|
|
|
This function returns the video surface linked to a given canvas image. */
|
|
}
|
|
values {
|
|
Evas_Video_Surface *surf @const_get; /*@ The new video surface.
|
|
@since 1.1 */
|
|
}
|
|
}
|
|
video_surface_caps {
|
|
set {
|
|
/*@ Set the video surface capabilities to a given image of the canvas */
|
|
}
|
|
get {
|
|
/*@ Get the video surface capabilities to a given image of the canvas */
|
|
}
|
|
values {
|
|
uint caps; /*@ in */
|
|
}
|
|
}
|
|
load_orientation {
|
|
set {
|
|
/*@
|
|
Define if the orientation information in the image file should be honored.
|
|
|
|
@since 1.1 */
|
|
}
|
|
get {
|
|
/*@
|
|
Get if the orientation information in the image file should be honored.
|
|
|
|
@since 1.1 */
|
|
}
|
|
values {
|
|
bool enable; /*@ @c EINA_TRUE means that it should honor the orientation information */
|
|
}
|
|
}
|
|
border_center_fill {
|
|
set {
|
|
/*@
|
|
Sets @b 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 evas_object_image_border_center_fill_get() */
|
|
}
|
|
get {
|
|
/*@
|
|
Retrieves @b how the center part of the given image object (not the
|
|
borders) is to be drawn when Evas is rendering it.
|
|
|
|
@return fill Fill mode of the center region of @p obj (a value in
|
|
#Evas_Border_Fill_Mode).
|
|
|
|
See @ref evas_object_image_fill_set() for more details. */
|
|
}
|
|
values {
|
|
Evas_Border_Fill_Mode fill; /*@ Fill mode of the center region of @p obj (a value in
|
|
#Evas_Border_Fill_Mode). */
|
|
}
|
|
}
|
|
source_visible {
|
|
set {
|
|
/*@
|
|
Set the source object to be visible or not.
|
|
|
|
If the @p visible set to @c EINA_FALSE, the source object of the proxy(@p 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 evas_object_image_source_visible_get()
|
|
@see evas_object_image_source_set()
|
|
@see evas_object_show()
|
|
@see evas_object_hide()
|
|
@since 1.8 */
|
|
}
|
|
get {
|
|
/*@
|
|
Get the state of the source object visibility.
|
|
|
|
@return @c EINA_TRUE if source object is visible, @c EINA_FALSE otherwise.
|
|
|
|
@see evas_object_image_source_visible_set()
|
|
@see evas_object_image_source_set()
|
|
@see evas_object_show()
|
|
@see evas_object_hide()
|
|
@since 1.8 */
|
|
}
|
|
values {
|
|
bool visible; /*@ @c EINA_TRUE is source object to be shown, @c EINA_FALSE
|
|
otherwise. */
|
|
}
|
|
}
|
|
native_surface {
|
|
set {
|
|
/*@
|
|
Set the native surface of a given image of the canvas
|
|
|
|
This function sets a native surface of a given canvas image. */
|
|
|
|
legacy: null;
|
|
}
|
|
get {
|
|
/*@
|
|
Get the native surface of a given image of the canvas
|
|
|
|
@return The native surface of the given canvas image.
|
|
|
|
This function returns the native surface of a given canvas image. */
|
|
}
|
|
values {
|
|
Evas_Native_Surface *surf/* @const_get*/ @nonull; /*@ The new native surface. */
|
|
}
|
|
}
|
|
load_scale_down {
|
|
set {
|
|
/*@
|
|
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 evas_object_image_load_scale_down_get() */
|
|
}
|
|
get {
|
|
/*@
|
|
get the scale down factor of a given image object's source image,
|
|
when loading it.
|
|
|
|
@see evas_object_image_load_scale_down_set() for more details */
|
|
}
|
|
values {
|
|
int scale_down; /*@ The scale down factor. */
|
|
}
|
|
}
|
|
scale_hint {
|
|
set {
|
|
/*@
|
|
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 evas_object_image_scale_hint_get() */
|
|
}
|
|
get {
|
|
/*@
|
|
Get the scale hint of a given image of the canvas.
|
|
|
|
@return The scale hint value set on @p obj, a value in
|
|
#Evas_Image_Scale_Hint.
|
|
|
|
This function returns the scale hint value of the given image
|
|
object of the canvas.
|
|
|
|
@see evas_object_image_scale_hint_set() for more details. */
|
|
}
|
|
values {
|
|
Evas_Image_Scale_Hint hint; /*@ The scale hint, a value in
|
|
#Evas_Image_Scale_Hint. */
|
|
}
|
|
}
|
|
source_events {
|
|
set {
|
|
/*@
|
|
Set whether an Evas object is to source events.
|
|
|
|
Set whether an Evas object is to repeat events to source.
|
|
|
|
If @p source is @c EINA_TRUE, it will make events on @p obj to also be
|
|
repeated for the source object (see evas_object_image_source_set()). Even the
|
|
@p obj and source geometries are different, the event position will be
|
|
transformed to the source object's space.
|
|
|
|
If @p source is @c EINA_FALSE, events occurring on @p obj will be
|
|
processed only on it.
|
|
|
|
@see evas_object_image_source_get()
|
|
@see evas_object_image_source_visible_set()
|
|
@see evas_object_image_source_events_get()
|
|
@since 1.8 */
|
|
}
|
|
get {
|
|
/*@
|
|
Determine whether an object is set to source events.
|
|
|
|
@return @c EINA_TRUE if source object has events, @c EINA_FALSE otherwise.
|
|
|
|
@see evas_object_image_source_set()
|
|
@see evas_object_image_source_visible_set()
|
|
@see evas_object_image_source_events_set()
|
|
@since 1.8 */
|
|
}
|
|
values {
|
|
bool source; /*@ whether @p obj is to pass events (@c EINA_TRUE) or not
|
|
(@c EINA_FALSE) */
|
|
}
|
|
}
|
|
colorspace {
|
|
set {
|
|
/*@
|
|
Set the colorspace of a given image of the canvas.
|
|
|
|
This function sets the colorspace of given canvas image. */
|
|
}
|
|
get {
|
|
/*@
|
|
Get the colorspace of a given image of the canvas.
|
|
|
|
@return The colorspace of the image.
|
|
|
|
This function returns the colorspace of given canvas image. */
|
|
}
|
|
values {
|
|
Evas_Colorspace cspace; /*@ The new color space. */
|
|
}
|
|
}
|
|
pixels_get_callback {
|
|
set {
|
|
/*@
|
|
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. */
|
|
}
|
|
values {
|
|
Evas_Object_Image_Pixels_Get_Cb func @nonull; /*@ The callback function. */
|
|
void *data; /*@ The data pointer to be passed to @a func. */
|
|
}
|
|
}
|
|
data_copy {
|
|
set {
|
|
/*@
|
|
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 @ref evas_object_image_data_get() for more details. */
|
|
}
|
|
values {
|
|
void *data; /*@ The raw data to replace. */
|
|
}
|
|
}
|
|
animated_frame {
|
|
set {
|
|
/*@
|
|
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 evas_object_image_animated_get()
|
|
@see evas_object_image_animated_frame_count_get()
|
|
@see evas_object_image_animated_loop_type_get()
|
|
@see evas_object_image_animated_loop_count_get()
|
|
@see evas_object_image_animated_frame_duration_get()
|
|
@see evas_object_image_animated_frame_set()
|
|
@since 1.1 */
|
|
}
|
|
values {
|
|
int frame_index; /*@ The index of current frame */
|
|
}
|
|
}
|
|
region_support {
|
|
get {
|
|
/*@
|
|
Get the support state of a given image
|
|
|
|
@return The region support state
|
|
@since 1.2
|
|
|
|
This function returns the state of the region support of given image */
|
|
return: bool @warn_unused;
|
|
}
|
|
}
|
|
load_error {
|
|
get {
|
|
/*@
|
|
Retrieves a number representing any error that occurred during the
|
|
last loading of the given image object's source image.
|
|
|
|
@return 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. */
|
|
return: Evas_Load_Error @warn_unused;
|
|
}
|
|
}
|
|
animated_frame_count {
|
|
get {
|
|
/*@
|
|
Get the total number of frames of the image object.
|
|
|
|
@return The number of frames
|
|
|
|
This returns total number of frames the image object supports (if animated)
|
|
|
|
@see evas_object_image_animated_get()
|
|
@see evas_object_image_animated_frame_count_get()
|
|
@see evas_object_image_animated_loop_type_get()
|
|
@see evas_object_image_animated_loop_count_get()
|
|
@see evas_object_image_animated_frame_duration_get()
|
|
@see evas_object_image_animated_frame_set()
|
|
@since 1.1 */
|
|
return: int;
|
|
}
|
|
}
|
|
stride {
|
|
get {
|
|
/*@
|
|
Retrieves the row stride of the given image object.
|
|
|
|
@return The stride of the image (<b>in bytes</b>).
|
|
|
|
The row stride is the number of bytes between the start of a row
|
|
and the start of the next row for image data. */
|
|
return: int @warn_unused;
|
|
}
|
|
}
|
|
animated_loop_type {
|
|
get {
|
|
/*@
|
|
Get the kind of looping the image object does.
|
|
|
|
@return 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 evas_object_image_animated_get()
|
|
@see evas_object_image_animated_frame_count_get()
|
|
@see evas_object_image_animated_loop_type_get()
|
|
@see evas_object_image_animated_loop_count_get()
|
|
@see evas_object_image_animated_frame_duration_get()
|
|
@see evas_object_image_animated_frame_set()
|
|
@since 1.1 */
|
|
return: Evas_Image_Animated_Loop_Hint;
|
|
}
|
|
}
|
|
animated_loop_count {
|
|
get {
|
|
/*@
|
|
Get the number times the animation of the object loops.
|
|
|
|
@return 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 evas_object_image_animated_get()
|
|
@see evas_object_image_animated_frame_count_get()
|
|
@see evas_object_image_animated_loop_type_get()
|
|
@see evas_object_image_animated_loop_count_get()
|
|
@see evas_object_image_animated_frame_duration_get()
|
|
@see evas_object_image_animated_frame_set()
|
|
@since 1.1 */
|
|
return: int;
|
|
}
|
|
}
|
|
|
|
scene {
|
|
set {
|
|
/*@
|
|
Set the 3D scene of a given image of the canvas.
|
|
|
|
This function sets a 3d scene of a given canvas image.
|
|
|
|
@see evas_object_image_scene_set
|
|
@since 1.10 */
|
|
legacy: null;
|
|
}
|
|
get {
|
|
/*@
|
|
Get the 3D scene of a given image of the canvas.
|
|
|
|
@return The 3d scene of the given canvas image.
|
|
|
|
This function returns the 3d scene of a given canvas image.
|
|
|
|
@see evas_object_image_scene_get
|
|
@since 1.10 */
|
|
legacy: null;
|
|
}
|
|
values {
|
|
Evas_3D_Scene *scene; /*@ 3D scene on an image object. */
|
|
}
|
|
}
|
|
filter_program {
|
|
set {
|
|
/*@ 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 @ref evasfiltersref "Evas filters reference"
|
|
*/
|
|
legacy: null;
|
|
}
|
|
values {
|
|
const(char)* program; /*@ The program code, as defined
|
|
by the @ref evasfiltersref "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 @ref evasfiltersref "Evas filters reference"
|
|
*/
|
|
}
|
|
}
|
|
filter_source {
|
|
set {
|
|
/*@ 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). */
|
|
legacy: null;
|
|
}
|
|
values {
|
|
const(char)* name; /*@ Object name as used in the program code */
|
|
Eo* eobj; /*@ Eo object to use through proxy rendering */
|
|
}
|
|
}
|
|
filter_padding {
|
|
get {
|
|
/*@ Get the value of the extra padding set when a filter is used. */
|
|
return: bool; /*@ Returns false if the filter is invalid and padding is 0 */
|
|
legacy: null;
|
|
}
|
|
values {
|
|
int l; /*@ Left padding in pixels */
|
|
int r; /*@ Right padding in pixels */
|
|
int t; /*@ Top padding in pixels */
|
|
int b; /*@ Bottom padding in pixels */
|
|
}
|
|
}
|
|
orient {
|
|
set {
|
|
/*@
|
|
Set the image orientation.
|
|
|
|
This function allows to rotate or flip the image.
|
|
|
|
@see evas_object_image_orient_get()
|
|
@see @ref Evas_Image_Orient
|
|
|
|
@since 1.14*/
|
|
}
|
|
get {
|
|
/*@
|
|
Get the image orientation.
|
|
|
|
@return The image orientation @ref Evas_Image_Orient
|
|
|
|
@see evas_object_image_orient_set()
|
|
@see @ref Evas_Image_Orient
|
|
|
|
@since 1.14*/
|
|
}
|
|
values {
|
|
Evas_Image_Orient orient; /*@ The image orientation @ref Evas_Image_Orient
|
|
Default is #EVAS_IMAGE_ORIENT_NONE. */
|
|
}
|
|
}
|
|
}
|
|
methods {
|
|
preload_begin {
|
|
/*@ Begin preloading an image object's image data in the background */
|
|
legacy: null;
|
|
}
|
|
data_update_add {
|
|
/*@
|
|
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. */
|
|
|
|
params {
|
|
@in int x; /*@ X-offset of the region to be updated. */
|
|
@in int y; /*@ Y-offset of the region to be updated. */
|
|
@in int w; /*@ Width of the region to be updated. */
|
|
@in int h; /*@ Height of the region to be updated. */
|
|
}
|
|
}
|
|
animated_frame_duration_get @const {
|
|
/*@
|
|
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 evas_object_image_animated_get()
|
|
@see evas_object_image_animated_frame_count_get()
|
|
@see evas_object_image_animated_loop_type_get()
|
|
@see evas_object_image_animated_loop_count_get()
|
|
@see evas_object_image_animated_frame_duration_get()
|
|
@see evas_object_image_animated_frame_set()
|
|
@since 1.1 */
|
|
return: double;
|
|
params {
|
|
@in int start_frame; /*@ The first frame */
|
|
@in int frame_num; /*@ Number of frames in the sequence */
|
|
}
|
|
}
|
|
data_set {
|
|
/*@
|
|
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 @b before this
|
|
one) and colorspace (see evas_object_image_colorspace_set()) of the
|
|
image. If data is @c 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 evas_object_image_data_get() */
|
|
|
|
params {
|
|
@in void *data; /*@ The raw data, or @c NULL. */
|
|
}
|
|
}
|
|
data_get @const {
|
|
/*@
|
|
Get a pointer to the raw image data of the given image object.
|
|
|
|
@return 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.
|
|
|
|
@note You may want to use evas_object_image_data_update_add() to
|
|
inform data changes, if you did any.
|
|
|
|
@see evas_object_image_data_set() */
|
|
return: void * @warn_unused;
|
|
params {
|
|
@in bool for_writing; /*@ Whether the data being retrieved will be
|
|
modified (@c EINA_TRUE) or not (@c EINA_FALSE). */
|
|
}
|
|
}
|
|
preload_cancel {
|
|
/*@ Cancel preloading an image object's image data in the background */
|
|
legacy: null;
|
|
}
|
|
data_convert {
|
|
/*@
|
|
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 @c NULL is returned. You should use
|
|
evas_object_image_colorspace_get() to check the current image
|
|
colorspace.
|
|
|
|
See @ref evas_object_image_colorspace_get.
|
|
|
|
@return data A newly allocated data in the format specified by to_cspace. */
|
|
|
|
return: void * @warn_unused;
|
|
params {
|
|
@in Evas_Colorspace to_cspace; /*@ The colorspace to which the image raw data will be converted. */
|
|
}
|
|
}
|
|
pixels_import {
|
|
/*@
|
|
Import pixels from given source to a given canvas image object.
|
|
|
|
This function imports pixels from a given source to a given canvas image. */
|
|
|
|
return: bool;
|
|
params {
|
|
@in Evas_Pixel_Import_Source *pixels @nonull; /*@ The pixel's source to be imported. */
|
|
}
|
|
}
|
|
reload {
|
|
/*@
|
|
Reload an image object's image data.
|
|
|
|
This function reloads the image data bound to image object @p obj. */
|
|
}
|
|
}
|
|
implements {
|
|
Eo.Base.constructor;
|
|
Eo.Base.destructor;
|
|
Eo.Base.dbg_info_get;
|
|
Efl.File.file.set;
|
|
Efl.File.file.get;
|
|
Efl.File.mmap.set;
|
|
Efl.File.mmap.get;
|
|
Efl.File.save;
|
|
Efl.Image.animated.get;
|
|
Efl.Image.load_size.set;
|
|
Efl.Image.load_size.get;
|
|
Efl.Image.smooth_scale.set;
|
|
Efl.Image.smooth_scale.get;
|
|
Efl.Gfx.Fill.fill_spread.set;
|
|
Efl.Gfx.Fill.fill_spread.get;
|
|
Efl.Gfx.Fill.fill.set;
|
|
Efl.Gfx.Fill.fill.get;
|
|
Efl.Gfx.View.size.set;
|
|
Efl.Gfx.View.size.get;
|
|
}
|
|
}
|