summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTaehyub Kim <taehyub.kim@samsung.com>2020-03-17 16:23:49 +0900
committerJunsuChoi <jsuya.choi@samsung.com>2020-03-17 16:23:49 +0900
commit2eaa2e98740b6f590ee22412752e757da66b1b78 (patch)
tree1818b8af16053bcb1090e68b339d6b7d0d6db19d
parent2a54c0505f6269e6648e1119e40b6253f6f9aca0 (diff)
evas_vg: refined the documentation for evas vector APIs
Summary: Depends on D11517 Reviewers: jsuya, Hermet Reviewed By: jsuya Subscribers: cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D11518
-rw-r--r--src/lib/evas/Evas_Legacy.h600
-rw-r--r--src/lib/evas/canvas/efl_canvas_vg_container_eo.legacy.h10
-rw-r--r--src/lib/evas/canvas/efl_canvas_vg_node_eo.legacy.h5
-rw-r--r--src/lib/evas/canvas/efl_canvas_vg_object_eo.legacy.h5
-rw-r--r--src/lib/evas/canvas/efl_canvas_vg_shape_eo.legacy.h19
5 files changed, 331 insertions, 308 deletions
diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h
index 5623205355..ecc258fd15 100644
--- a/src/lib/evas/Evas_Legacy.h
+++ b/src/lib/evas/Evas_Legacy.h
@@ -3590,23 +3590,24 @@ EAPI Evas_Object *evas_object_rectangle_add(Evas *e) EINA_WARN_UNUSED_RESULT EIN
3590 * * evas_vg_node_origin_set(shape, 10, 10); 3590 * * evas_vg_node_origin_set(shape, 10, 10);
3591 * * efl_gfx_shape_stroke_width_set(shape, 1.0); 3591 * * efl_gfx_shape_stroke_width_set(shape, 1.0);
3592 * * evas_vg_node_color_set(shape, 128, 128, 128, 80); 3592 * * evas_vg_node_color_set(shape, 128, 128, 128, 80);
3593 * * efl_gfx_shape_path_set(shape, path_cmd, points); 3593 * * efl_gfx_shape_path_set(shape, path_cmd, points);
3594 * @endcode 3594 * @endcode
3595 * 3595 *
3596 * @since 1.14 3596 * @since 1.14
3597 */ 3597 */
3598 3598
3599/** 3599/**
3600 * Creates a new vector object on the given Evas @p e canvas. 3600 * @brief Creates a new vector object on the given Evas @p e canvas.
3601 *
3602 * @param e The given canvas.
3603 * @return The created vector object handle.
3604 * 3601 *
3605 * The shape object hierarchy can be added to the evas_object_vg by accessing 3602 * The shape object hierarchy can be added to the evas_object_vg by accessing
3606 * the root node of the vg canvas and adding the hierarchy as child to the root 3603 * the root node of the vg canvas and adding the hierarchy as child to the root
3607 * node. 3604 * node.
3608 * 3605 *
3606 * @param[in] e The given canvas.
3607 * @return The created vector object handle.
3608 *
3609 * @see evas_obj_vg_root_node_get() 3609 * @see evas_obj_vg_root_node_get()
3610 *
3610 * @since 1.14 3611 * @since 1.14
3611 */ 3612 */
3612EAPI Evas_Object *evas_object_vg_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; 3613EAPI Evas_Object *evas_object_vg_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
@@ -3815,9 +3816,9 @@ typedef struct _Evas_Vg_Dash
3815} Evas_Vg_Dash; 3816} Evas_Vg_Dash;
3816 3817
3817/** 3818/**
3818 * Creates a new vector shape object. 3819 * @brief Creates a new vector shape object.
3819 * 3820 *
3820 * @param parent The given vector container object. 3821 * @param[in] parent The given vector container object.
3821 * @return The created vector shape object handle. 3822 * @return The created vector shape object handle.
3822 * 3823 *
3823 * @since 1.14 3824 * @since 1.14
@@ -3825,9 +3826,9 @@ typedef struct _Evas_Vg_Dash
3825EAPI Evas_Vg_Shape* evas_vg_shape_add(Evas_Vg_Container *parent); 3826EAPI Evas_Vg_Shape* evas_vg_shape_add(Evas_Vg_Container *parent);
3826 3827
3827/** 3828/**
3828 * Creates a new vector container object. 3829 * @brief Creates a new vector container object.
3829 * 3830 *
3830 * @param parent The given vector container object. 3831 * @param[in] parent The given vector container object.
3831 * @return The created vector container object handle. 3832 * @return The created vector container object handle.
3832 * 3833 *
3833 * @since 1.14 3834 * @since 1.14
@@ -3836,25 +3837,24 @@ EAPI Evas_Vg_Shape* evas_vg_shape_add(Evas_Vg_Container *parent);
3836EAPI Evas_Vg_Container* evas_vg_container_add(Evas_Object *parent); 3837EAPI Evas_Vg_Container* evas_vg_container_add(Evas_Object *parent);
3837 3838
3838/** 3839/**
3840 * @brief Retrieves whether or not the given Evas_Vg_Node object is visible.
3839 * 3841 *
3840 * Retrieves whether or not the given Efl_Vg object is visible. 3842 * @param[in] obj The object.
3841 * 3843 * @return @c EINA_TRUE if the object is visible, @EINA_FALSE otherwise.
3842 * 3844 *
3843 */ 3845 */
3844EAPI Eina_Bool evas_vg_node_visible_get(Evas_Vg_Node *obj); 3846EAPI Eina_Bool evas_vg_node_visible_get(Evas_Vg_Node *obj);
3845 3847
3846/** 3848/**
3849 * @brief Makes the given Evas_Vg_Node object visible or invisible.
3847 * 3850 *
3848 * Makes the given Efl_Vg object visible or invisible. 3851 * @param[in] obj The object.
3849 * 3852 * @param[in] v @c EINA_TRUE if to make the object visible, @c EINA_FALSE otherwise.
3850 * @param[in] v @c EINA_TRUE if to make the object visible, @c EINA_FALSE otherwise
3851 *
3852 */ 3853 */
3853EAPI void evas_vg_node_visible_set(Evas_Vg_Node *obj, Eina_Bool v); 3854EAPI void evas_vg_node_visible_set(Evas_Vg_Node *obj, Eina_Bool v);
3854 3855
3855/** 3856/**
3856 * 3857 * @brief Retrieves the general/main color of the given Evas_Vg_Node object.
3857 * Retrieves the general/main color of the given Efl_Vg object.
3858 * 3858 *
3859 * Retrieves the “main” color's RGB component (and alpha channel) 3859 * Retrieves the “main” color's RGB component (and alpha channel)
3860 * values, <b>which range from 0 to 255</b>. For the alpha channel, 3860 * values, <b>which range from 0 to 255</b>. For the alpha channel,
@@ -3866,6 +3866,7 @@ EAPI void evas_vg_node_visible_set(Evas_Vg_Node *obj, Eina_Bool v);
3866 * @note Use @c NULL pointers on the components you're not interested 3866 * @note Use @c NULL pointers on the components you're not interested
3867 * in: they'll be ignored by the function. 3867 * in: they'll be ignored by the function.
3868 * 3868 *
3869 * @param[in] obj The object.
3869 * @param[out] r The red component of the given color. 3870 * @param[out] r The red component of the given color.
3870 * @param[out] g The green component of the given color. 3871 * @param[out] g The green component of the given color.
3871 * @param[out] b The blue component of the given color. 3872 * @param[out] b The blue component of the given color.
@@ -3875,8 +3876,7 @@ EAPI void evas_vg_node_visible_set(Evas_Vg_Node *obj, Eina_Bool v);
3875EAPI void evas_vg_node_color_get(Evas_Vg_Node *obj, int *r, int *g, int *b, int *a); 3876EAPI void evas_vg_node_color_get(Evas_Vg_Node *obj, int *r, int *g, int *b, int *a);
3876 3877
3877/** 3878/**
3878 * 3879 * @brief Sets the general/main color of the given Evas_Vg_Node object to the given
3879 * Sets the general/main color of the given Efl_Vg object to the given
3880 * one. 3880 * one.
3881 * 3881 *
3882 * @see evas_vg_node_color_get() (for an example) 3882 * @see evas_vg_node_color_get() (for an example)
@@ -3884,6 +3884,7 @@ EAPI void evas_vg_node_color_get(Evas_Vg_Node *obj, int *r, int *g, int *b, int
3884 * 3884 *
3885 * @ingroup Evas_Object_Group_Basic 3885 * @ingroup Evas_Object_Group_Basic
3886 * 3886 *
3887 * @param[in] obj The object.
3887 * @param[in] r The red component of the given color. 3888 * @param[in] r The red component of the given color.
3888 * @param[in] g The green component of the given color. 3889 * @param[in] g The green component of the given color.
3889 * @param[in] b The blue component of the given color. 3890 * @param[in] b The blue component of the given color.
@@ -3893,32 +3894,31 @@ EAPI void evas_vg_node_color_get(Evas_Vg_Node *obj, int *r, int *g, int *b, int
3893EAPI void evas_vg_node_color_set(Evas_Vg_Node *obj, int r, int g, int b, int a); 3894EAPI void evas_vg_node_color_set(Evas_Vg_Node *obj, int r, int g, int b, int a);
3894 3895
3895/** 3896/**
3897 * @brief Retrieves the geometry of the given Evas_Vg_Node object.
3896 * 3898 *
3897 * Retrieves the geometry of the given Efl_Vg object. 3899 * @param[in] obj The object.
3898 * 3900 * @param[out] x The x geometry of the given object.
3899 * @param[out] x in 3901 * @param[out] y The y geometry of the given object.
3900 * @param[out] y in 3902 * @param[out] w The w geometry of the given object.
3901 * @param[out] w in 3903 * @param[out] h The h geometry of the given object.
3902 * @param[out] h in
3903 * 3904 *
3904 */ 3905 */
3905EAPI void evas_vg_node_geometry_get(Evas_Vg_Node *obj, int *x, int *y, int *w, int *h); 3906EAPI void evas_vg_node_geometry_get(Evas_Vg_Node *obj, int *x, int *y, int *w, int *h);
3906 3907
3907/** 3908/**
3909 * @brief Changes the geometry of the given Evas_Vg_Node object.
3908 * 3910 *
3909 * Changes the geometry of the given Efl_Vg object. 3911 * @param[in] obj The object.
3910 * 3912 * @param[in] x The x geometry of the given object.
3911 * @param[in] x in 3913 * @param[in] y The y geometry of the given object.
3912 * @param[in] y in 3914 * @param[in] w The w geometry of the given object.
3913 * @param[in] w in 3915 * @param[in] h The h geometry of the given object.
3914 * @param[in] h in
3915 * 3916 *
3916 */ 3917 */
3917EAPI void evas_vg_node_geometry_set(Evas_Vg_Node *obj, int x, int y, int w, int h); 3918EAPI void evas_vg_node_geometry_set(Evas_Vg_Node *obj, int x, int y, int w, int h);
3918 3919
3919/** 3920/**
3920 * 3921 * @brief Stack @p obj immediately below @p below.
3921 * Stack @p obj immediately below @p below
3922 * 3922 *
3923 * Objects, in a given canvas, are stacked in the order they get added 3923 * Objects, in a given canvas, are stacked in the order they get added
3924 * to it. This means that, if they overlap, the highest ones will 3924 * to it. This means that, if they overlap, the highest ones will
@@ -3939,16 +3939,15 @@ EAPI void evas_vg_node_geometry_set(Evas_Vg_Node *obj, int x, int y, int w, int
3939 * @see evas_object_layer_get() 3939 * @see evas_object_layer_get()
3940 * @see evas_object_layer_set() 3940 * @see evas_object_layer_set()
3941 * @see evas_object_stack_below() 3941 * @see evas_object_stack_below()
3942 *
3943 * 3942 *
3944 * @param[in] below the object below which to stack 3943 * @param[in] obj The object.
3944 * @param[in] below The object below which to stack.
3945 * 3945 *
3946 */ 3946 */
3947EAPI void evas_vg_node_stack_below(Evas_Vg_Node *obj, Evas_Vg_Node *below); 3947EAPI void evas_vg_node_stack_below(Evas_Vg_Node *obj, Evas_Vg_Node *below);
3948 3948
3949/** 3949/**
3950 * 3950 * @brief Stack @p obj immediately above @p above.
3951 * Stack @p obj immediately above @p above
3952 * 3951 *
3953 * Objects, in a given canvas, are stacked in the order they get added 3952 * Objects, in a given canvas, are stacked in the order they get added
3954 * to it. This means that, if they overlap, the highest ones will 3953 * to it. This means that, if they overlap, the highest ones will
@@ -3969,16 +3968,15 @@ EAPI void evas_vg_node_stack_below(Evas_Vg_Node *obj, Evas_Vg_Node *below);
3969 * @see evas_object_layer_get() 3968 * @see evas_object_layer_get()
3970 * @see evas_object_layer_set() 3969 * @see evas_object_layer_set()
3971 * @see evas_object_stack_below() 3970 * @see evas_object_stack_below()
3972 *
3973 * 3971 *
3974 * @param[in] above the object above which to stack 3972 * @param[in] obj The object.
3973 * @param[in] above The object above which to stack.
3975 * 3974 *
3976 */ 3975 */
3977EAPI void evas_vg_node_stack_above(Evas_Vg_Node *obj, Evas_Vg_Node *above); 3976EAPI void evas_vg_node_stack_above(Evas_Vg_Node *obj, Evas_Vg_Node *above);
3978 3977
3979/** 3978/**
3980 * 3979 * @brief Raise @p obj to the top of its layer.
3981 * Raise @p obj to the top of its layer.
3982 * 3980 *
3983 * @p obj will, then, be the highest one in the layer it belongs 3981 * @p obj will, then, be the highest one in the layer it belongs
3984 * to. Object on other layers won't get touched. 3982 * to. Object on other layers won't get touched.
@@ -3987,12 +3985,12 @@ EAPI void evas_vg_node_stack_above(Evas_Vg_Node *obj, Evas_Vg_Node *above);
3987 * @see evas_object_stack_below() 3985 * @see evas_object_stack_below()
3988 * @see evas_object_lower() 3986 * @see evas_object_lower()
3989 * 3987 *
3988 * @param[in] obj The object.
3990 */ 3989 */
3991EAPI void evas_vg_node_raise(Evas_Vg_Node *obj); 3990EAPI void evas_vg_node_raise(Evas_Vg_Node *obj);
3992 3991
3993/** 3992/**
3994 * 3993 * @brief Lower @p obj to the bottom of its layer.
3995 * Lower @p obj to the bottom of its layer.
3996 * 3994 *
3997 * @p obj will, then, be the lowest one in the layer it belongs 3995 * @p obj will, then, be the lowest one in the layer it belongs
3998 * to. Objects on other layers won't get touched. 3996 * to. Objects on other layers won't get touched.
@@ -4000,8 +3998,8 @@ EAPI void evas_vg_node_raise(Evas_Vg_Node *obj);
4000 * @see evas_object_stack_above() 3998 * @see evas_object_stack_above()
4001 * @see evas_object_stack_below() 3999 * @see evas_object_stack_below()
4002 * @see evas_object_raise() 4000 * @see evas_object_raise()
4003 *
4004 * 4001 *
4002 * @param[in] obj The object.
4005 * 4003 *
4006 */ 4004 */
4007EAPI void evas_vg_node_lower(Evas_Vg_Node *obj); 4005EAPI void evas_vg_node_lower(Evas_Vg_Node *obj);
@@ -4009,30 +4007,30 @@ EAPI void evas_vg_node_lower(Evas_Vg_Node *obj);
4009#include "canvas/efl_canvas_vg_node_eo.legacy.h" 4007#include "canvas/efl_canvas_vg_node_eo.legacy.h"
4010 4008
4011/** 4009/**
4010 * @brief Get the stroke scaling factor used for stroking this path.
4012 * 4011 *
4013 * Get the stroke scaling factor used for stroking this path. 4012 * @param[in] obj The object.
4014 * @since 1.14 4013 * @return The stroke scale of the given object.
4015 *
4016 * 4014 *
4015 * @since 1.14
4017 */ 4016 */
4018EAPI double evas_vg_shape_stroke_scale_get(Evas_Vg_Shape *obj); 4017EAPI double evas_vg_shape_stroke_scale_get(Evas_Vg_Shape *obj);
4019 4018
4020/** 4019/**
4021 * 4020 * @brief Sets the stroke scale to be used for stroking the path.
4022 * Sets the stroke scale to be used for stroking the path.
4023 * the scale property will be used along with stroke width property. 4021 * the scale property will be used along with stroke width property.
4024 * @since 1.14
4025 * 4022 *
4026 * @param[in] s stroke scale value 4023 * @param[in] obj The object.
4024 * @param[in] s The stroke scale value.
4027 * 4025 *
4026 * @since 1.14
4028 */ 4027 */
4029EAPI void evas_vg_shape_stroke_scale_set(Evas_Vg_Shape *obj, double s); 4028EAPI void evas_vg_shape_stroke_scale_set(Evas_Vg_Shape *obj, double s);
4030 4029
4031/** 4030/**
4031 * @brief Gets the color used for stroking the path.
4032 * 4032 *
4033 * Gets the color used for stroking the path. 4033 * @param[in] obj The object.
4034 * @since 1.14
4035 *
4036 * @param[out] r The red component of the given color. 4034 * @param[out] r The red component of the given color.
4037 * @param[out] g The green component of the given color. 4035 * @param[out] g The green component of the given color.
4038 * @param[out] b The blue component of the given color. 4036 * @param[out] b The blue component of the given color.
@@ -4042,10 +4040,9 @@ EAPI void evas_vg_shape_stroke_scale_set(Evas_Vg_Shape *obj, double s);
4042EAPI void evas_vg_shape_stroke_color_get(Evas_Vg_Shape *obj, int *r, int *g, int *b, int *a); 4040EAPI void evas_vg_shape_stroke_color_get(Evas_Vg_Shape *obj, int *r, int *g, int *b, int *a);
4043 4041
4044/** 4042/**
4043 * @brief Sets the color to be used for stroking the path.
4045 * 4044 *
4046 * Sets the color to be used for stroking the path. 4045 * @param[in] obj The object.
4047 * @since 1.14
4048 *
4049 * @param[in] r The red component of the given color. 4046 * @param[in] r The red component of the given color.
4050 * @param[in] g The green component of the given color. 4047 * @param[in] g The green component of the given color.
4051 * @param[in] b The blue component of the given color. 4048 * @param[in] b The blue component of the given color.
@@ -4055,287 +4052,285 @@ EAPI void evas_vg_shape_stroke_color_get(Evas_Vg_Shape *obj, int *r, int *g, int
4055EAPI void evas_vg_shape_stroke_color_set(Evas_Vg_Shape *obj, int r, int g, int b, int a); 4052EAPI void evas_vg_shape_stroke_color_set(Evas_Vg_Shape *obj, int r, int g, int b, int a);
4056 4053
4057/** 4054/**
4055 * @brief Gets the stroke width to be used for stroking the path.
4058 * 4056 *
4059 * Gets the stroke width to be used for stroking the path. 4057 * @param[in] obj The object.
4060 * @since 1.14 4058 * @return The stroke width of the given object.
4061 * 4059 *
4060 * @since 1.14
4062 * 4061 *
4063 */ 4062 */
4064EAPI double evas_vg_shape_stroke_width_get(Evas_Vg_Shape *obj); 4063EAPI double evas_vg_shape_stroke_width_get(Evas_Vg_Shape *obj);
4065 4064
4066/** 4065/**
4066 * @brief Sets the stroke width to be used for stroking the path.
4067 * 4067 *
4068 * Sets the stroke width to be used for stroking the path. 4068 * @param[in] obj The object.
4069 * @since 1.14 4069 * @param[in] w The stroke width to be used.
4070 *
4071 * @param[in] w stroke width to be used
4072 * 4070 *
4071 * @since 1.14
4073 */ 4072 */
4074EAPI void evas_vg_shape_stroke_width_set(Evas_Vg_Shape *obj, double w); 4073EAPI void evas_vg_shape_stroke_width_set(Evas_Vg_Shape *obj, double w);
4075 4074
4076/** 4075/**
4076 * @brief Gets the stroke location to be used for stroking the path.
4077 * 4077 *
4078 * Not Implemented 4078 * @param[in] obj The object.
4079 * 4079 * @return The stroke location.
4080 *
4081 */ 4080 */
4082EAPI double evas_vg_shape_stroke_location_get(Evas_Vg_Shape *obj); 4081EAPI double evas_vg_shape_stroke_location_get(Evas_Vg_Shape *obj);
4083 4082
4084/** 4083/**
4084 * @brief Sets the stroke location to be used for stroking the path.
4085 * 4085 *
4086 * Not Implemented 4086 * @param[in] obj The object.
4087 * 4087 * @param[in] centered The stroke location.
4088 * @param[in] centered
4089 *
4090 */ 4088 */
4091EAPI void evas_vg_shape_stroke_location_set(Evas_Vg_Shape *obj, double centered); 4089EAPI void evas_vg_shape_stroke_location_set(Evas_Vg_Shape *obj, double centered);
4092 4090
4093/** 4091/**
4092 * @brief Gets the stroke dash type used for stroking path.
4094 * 4093 *
4095 * Not Implemented 4094 * @param[in] obj The object.
4096 * 4095 * @param[out] dash The dash types.
4097 * @param[out] dash 4096 * @param[out] length The length of dash types.
4098 * @param[out] length
4099 *
4100 */ 4097 */
4101EAPI void evas_vg_shape_stroke_dash_get(Evas_Vg_Shape *obj, const Evas_Vg_Dash **dash, unsigned int *length); 4098EAPI void evas_vg_shape_stroke_dash_get(Evas_Vg_Shape *obj, const Evas_Vg_Dash **dash, unsigned int *length);
4102 4099
4103/** 4100/**
4101 * @brief Sets the stroke dash type to be used for stroking the path.
4104 * 4102 *
4105 * Not Implemented 4103 * @param[in] obj The object.
4106 * 4104 * @param[in] dash The dash types.
4107 * @param[in] dash 4105 * @param[in] length The length of dash types.
4108 * @param[in] length
4109 *
4110 */ 4106 */
4111EAPI void evas_vg_shape_stroke_dash_set(Evas_Vg_Shape *obj, const Evas_Vg_Dash *dash, unsigned int length); 4107EAPI void evas_vg_shape_stroke_dash_set(Evas_Vg_Shape *obj, const Evas_Vg_Dash *dash, unsigned int length);
4112 4108
4113/** 4109/**
4110 * @brief Gets the cap style used for stroking path.
4114 * 4111 *
4115 * Gets the cap style used for stroking path. 4112 * @param[in] obj The object.
4116 * @since 1.14 4113 * @return The cap style of the given object.
4117 *
4118 * 4114 *
4115 * @since 1.14
4119 */ 4116 */
4120EAPI Evas_Vg_Cap evas_vg_shape_stroke_cap_get(Evas_Vg_Shape *obj); 4117EAPI Evas_Vg_Cap evas_vg_shape_stroke_cap_get(Evas_Vg_Shape *obj);
4121 4118
4122/** 4119/**
4120 * @brief Sets the cap style to be used for stroking the path.
4123 * 4121 *
4124 * Sets the cap style to be used for stroking the path. 4122 * The cap will be used for capping the end point of a
4125 * The cap will be used for capping the end point of a
4126 * open subpath. 4123 * open subpath.
4127 * 4124 *
4128 * @see Efl_Gfx_Cap 4125 * @see Evas_Vg_Cap
4129 * @since 1.14
4130 * 4126 *
4131 * @param[in] c cap style to use , default is EFL_GFX_CAP_BUTT 4127 * @param[in] obj The object.
4128 * @param[in] c The cap style to use , default is EVAS_VG_CAP_BUTT
4132 * 4129 *
4133 */ 4130 */
4134EAPI void evas_vg_shape_stroke_cap_set(Evas_Vg_Shape *obj, Evas_Vg_Cap c); 4131EAPI void evas_vg_shape_stroke_cap_set(Evas_Vg_Shape *obj, Evas_Vg_Cap c);
4135 4132
4136/** 4133/**
4134 * @brief Gets the join style used for stroking path.
4137 * 4135 *
4138 * Gets the join style used for stroking path. 4136 * @param[in] obj The object.
4139 * @since 1.14 4137 * @return The join style of the given object.
4140 *
4141 * 4138 *
4139 * @since 1.14
4142 */ 4140 */
4143EAPI Evas_Vg_Join evas_vg_shape_stroke_join_get(Evas_Vg_Shape *obj); 4141EAPI Evas_Vg_Join evas_vg_shape_stroke_join_get(Evas_Vg_Shape *obj);
4144 4142
4145/** 4143/**
4144 * @brief Sets the join style to be used for stroking the path.
4146 * 4145 *
4147 * Sets the join style to be used for stroking the path.
4148 * The join style will be used for joining the two line segment 4146 * The join style will be used for joining the two line segment
4149 * while stroking the path. 4147 * while stroking the path.
4150 * 4148 *
4151 * @see Efl_Gfx_Join 4149 * @see Evas_Vg_Join
4152 * @since 1.14
4153 * 4150 *
4154 * @param[in] j join style to use , default is 4151 * @param[in] obj The object.
4155EFL_GFX_JOIN_MITER 4152 * @param[in] j The join style to use, default is EVAS_VG_JOIN_MITER.
4156 * 4153 *
4157 */ 4154 */
4158EAPI void evas_vg_shape_stroke_join_set(Evas_Vg_Shape *obj, Evas_Vg_Join j); 4155EAPI void evas_vg_shape_stroke_join_set(Evas_Vg_Shape *obj, Evas_Vg_Join j);
4159 4156
4160/** 4157/**
4161 * 4158 * @brief Set the list of commands and points to be used to create the
4162 * Set the list of commands and points to be used to create the
4163 * content of shape. 4159 * content of shape.
4164 * 4160 *
4165 * @note see efl_gfx_path interface for how to create a command list. 4161 * @see Evas_Vg_Path_Command
4166 * @see Efl_Gfx_Path_Command
4167 * @since 1.14
4168 * 4162 *
4169 * @param[in] op command list 4163 * @param[in] obj The object.
4170 * @param[in] points point list 4164 * @param[in] op The command list.
4165 * @param[in] points The point list.
4171 * 4166 *
4172 */ 4167 */
4173EAPI void evas_vg_shape_path_set(Evas_Vg_Shape *obj, const Evas_Vg_Path_Command *op, const double *points); 4168EAPI void evas_vg_shape_path_set(Evas_Vg_Shape *obj, const Evas_Vg_Path_Command *op, const double *points);
4174 4169
4175/** 4170/**
4171 * @brief Gets the command and points list.
4176 * 4172 *
4177 * Gets the command and points list 4173 * @param[in] obj The object.
4178 * @since 1.14 4174 * @param[out] op The command list.
4179 * 4175 * @param[out] points The point list.
4180 * @param[out] op command list
4181 * @param[out] points point list
4182 * 4176 *
4177 * @since 1.14
4183 */ 4178 */
4184 4179
4185EAPI void evas_vg_shape_path_get(Evas_Vg_Shape *obj, const Evas_Vg_Path_Command **op, const double **points); 4180EAPI void evas_vg_shape_path_get(Evas_Vg_Shape *obj, const Evas_Vg_Path_Command **op, const double **points);
4186EAPI void evas_vg_shape_path_length_get(Evas_Vg_Shape *obj, unsigned int *commands, unsigned int *points);
4187EAPI void evas_vg_shape_current_get(Evas_Vg_Shape *obj, double *x, double *y);
4188EAPI void evas_vg_shape_current_ctrl_get(Evas_Vg_Shape *obj, double *x, double *y);
4189 4181
4190/** 4182/**
4183 * @brief Gets the command and points length.
4191 * 4184 *
4192 * Copy the shape data from the object specified . 4185 * @param[in] obj The object.
4193 * 4186 * @param[out] commands The command length.
4194 * @since 1.14 4187 * @param[out] points The points length.
4188 */
4189EAPI void evas_vg_shape_path_length_get(Evas_Vg_Shape *obj, unsigned int *commands, unsigned int *points);
4190
4191/**
4192 * @brief Gets the current points.
4195 * 4193 *
4194 * @param[in] obj The object.
4195 * @param[out] x The x co-ordinate of current point.
4196 * @param[out] y The y co-ordinate of current point.
4197 */
4198EAPI void evas_vg_shape_current_get(Evas_Vg_Shape *obj, double *x, double *y);
4199
4200/**
4201 * @brief Gets the current control points.
4196 * 4202 *
4197 * @param[in] dup_from Shape object from where data will be copied. 4203 * @param[in] obj The object.
4204 * @param[out] x The x co-ordinate of control point.
4205 * @param[out] y The y co-ordinate of control point.
4206 */
4207EAPI void evas_vg_shape_current_ctrl_get(Evas_Vg_Shape *obj, double *x, double *y);
4208
4209/**
4210 * @brief Copy the shape data from the object specified.
4198 * 4211 *
4212 * @param[in] obj The object.
4213 * @param[in] dup_from The Shape object from where data will be copied.
4199 */ 4214 */
4200EAPI void evas_vg_shape_dup(Evas_Vg_Shape *obj, Evas_Vg_Shape *dup_from); 4215EAPI void evas_vg_shape_dup(Evas_Vg_Shape *obj, Evas_Vg_Shape *dup_from);
4201 4216
4202/** 4217/**
4218 * @brief Reset the shape data of the shape object.
4203 * 4219 *
4204 * Reset the shape data of the shape object. 4220 * @param[in] obj The object.
4205 * 4221 *
4206 * @since 1.14 4222 * @since 1.14
4207 *
4208 *
4209 *
4210 */ 4223 */
4211EAPI void evas_vg_shape_reset(Evas_Vg_Shape *obj); 4224EAPI void evas_vg_shape_reset(Evas_Vg_Shape *obj);
4212 4225
4213/** 4226/**
4214 * 4227 * @brief Moves the current point to the given point,
4215 * Moves the current point to the given point,
4216 * implicitly starting a new subpath and closing the previous one. 4228 * implicitly starting a new subpath and closing the previous one.
4217 * 4229 *
4218 * @see efl_gfx_path_append_close() 4230 * @see evas_vg_shape_append_close()
4219 * @since 1.14
4220 *
4221 *
4222 * @param[in] x X co-ordinate of the current point.
4223 * @param[in] y Y co-ordinate of the current point.
4224 * 4231 *
4232 * @param[in] obj The object.
4233 * @param[in] x The x co-ordinate of the current point.
4234 * @param[in] y The y co-ordinate of the current point.
4225 */ 4235 */
4226EAPI void evas_vg_shape_append_move_to(Evas_Vg_Shape *obj, double x, double y); 4236EAPI void evas_vg_shape_append_move_to(Evas_Vg_Shape *obj, double x, double y);
4227 4237
4228/** 4238/**
4229 * 4239 * @brief Adds a straight line from the current position to the given endPoint.
4230 * Adds a straight line from the current position to the given endPoint.
4231 * After the line is drawn, the current position is updated to be at the end 4240 * After the line is drawn, the current position is updated to be at the end
4232 * point of the line. 4241 * point of the line.
4233 * 4242 *
4234 * @note if no current position present, it draws a line to itself, basically 4243 * @note if no current position present, it draws a line to itself, basically
4235 * a point. 4244 * a point.
4236 * 4245 *
4237 * @see efl_gfx_path_append_move_to() 4246 * @see evas_vg_shape_append_move_to()
4238 * @since 1.14
4239 *
4240 *
4241 * @param[in] x X co-ordinate of end point of the line.
4242 * @param[in] y Y co-ordinate of end point of the line.
4243 * 4247 *
4248 * @param[in] obj The object.
4249 * @param[in] x The x co-ordinate of end point of the line.
4250 * @param[in] y The y co-ordinate of end point of the line.
4244 */ 4251 */
4245EAPI void evas_vg_shape_append_line_to(Evas_Vg_Shape *obj, double x, double y); 4252EAPI void evas_vg_shape_append_line_to(Evas_Vg_Shape *obj, double x, double y);
4246 4253
4247/** 4254/**
4248 * 4255 * @brief Adds a quadratic Bezier curve between the current position and the
4249 * Adds a quadratic Bezier curve between the current position and the
4250 * given end point (x,y) using the control points specified by (ctrl_x, ctrl_y). 4256 * given end point (x,y) using the control points specified by (ctrl_x, ctrl_y).
4251 * After the path is drawn, the current position is updated to be at the end 4257 * After the path is drawn, the current position is updated to be at the end
4252 * point of the path. 4258 * point of the path.
4253 * 4259 *
4254 * @since 1.14 4260 * @param[in] obj The object.
4255 * 4261 * @param[in] x The x co-ordinate of end point of the line.
4256 * 4262 * @param[in] y The y co-ordinate of end point of the line.
4257 * @param[in] x X co-ordinate of end point of the line. 4263 * @param[in] ctrl_x The x co-ordinate of control point.
4258 * @param[in] y Y co-ordinate of end point of the line. 4264 * @param[in] ctrl_y The y co-ordinate of control point.
4259 * @param[in] ctrl_x X co-ordinate of control point.
4260 * @param[in] ctrl_y Y co-ordinate of control point.
4261 * 4265 *
4266 * @since 1.14
4262 */ 4267 */
4263EAPI void evas_vg_shape_append_quadratic_to(Evas_Vg_Shape *obj, double x, double y, double ctrl_x, double ctrl_y); 4268EAPI void evas_vg_shape_append_quadratic_to(Evas_Vg_Shape *obj, double x, double y, double ctrl_x, double ctrl_y);
4264 4269
4265/** 4270/**
4266 * 4271 * @brief Same as evas_vg_shape_append_quadratic_to() api only difference is that it
4267 * Same as efl_gfx_path_append_quadratic_to() api only difference is that it
4268 * uses the current control point to draw the bezier. 4272 * uses the current control point to draw the bezier.
4269 * 4273 *
4270 * @see efl_gfx_path_append_quadratic_to() 4274 * @see evas_vg_shape_append_quadratic_to()
4271 * @since 1.14
4272 *
4273 *
4274 * @param[in] x X co-ordinate of end point of the line.
4275 * @param[in] y Y co-ordinate of end point of the line.
4276 * 4275 *
4276 * @param[in] obj The object.
4277 * @param[in] x The x co-ordinate of end point of the line.
4278 * @param[in] y The y co-ordinate of end point of the line.
4277 */ 4279 */
4278EAPI void evas_vg_shape_append_squadratic_to(Evas_Vg_Shape *obj, double x, double y); 4280EAPI void evas_vg_shape_append_squadratic_to(Evas_Vg_Shape *obj, double x, double y);
4279 4281
4280/** 4282/**
4281 * 4283 * @brief Adds a cubic Bezier curve between the current position and the
4282 * Adds a cubic Bezier curve between the current position and the
4283 * given end point (x,y) using the control points specified by 4284 * given end point (x,y) using the control points specified by
4284 * (ctrl_x0, ctrl_y0), and (ctrl_x1, ctrl_y1). After the path is drawn, 4285 * (ctrl_x0, ctrl_y0), and (ctrl_x1, ctrl_y1). After the path is drawn,
4285 * the current position is updated to be at the end point of the path. 4286 * the current position is updated to be at the end point of the path.
4286 * 4287 *
4287 * @since 1.14 4288 * @param[in] obj The object.
4288 * 4289 * @param[in] x The x co-ordinate of end point of the line.
4289 * 4290 * @param[in] y The y co-ordinate of end point of the line.
4290 * @param[in] x X co-ordinate of end point of the line. 4291 * @param[in] ctrl_x0 The x co-ordinate of 1st control point.
4291 * @param[in] y Y co-ordinate of end point of the line. 4292 * @param[in] ctrl_y0 The y co-ordinate of 1st control point.
4292 * @param[in] ctrl_x0 X co-ordinate of 1st control point. 4293 * @param[in] ctrl_x1 The x co-ordinate of 2nd control point.
4293 * @param[in] ctrl_y0 Y co-ordinate of 1st control point. 4294 * @param[in] ctrl_y1 The y co-ordinate of 2nd control point.
4294 * @param[in] ctrl_x1 X co-ordinate of 2nd control point.
4295 * @param[in] ctrl_y1 Y co-ordinate of 2nd control point.
4296 * 4295 *
4296 * @since 1.14
4297 */ 4297 */
4298EAPI void evas_vg_shape_append_cubic_to(Evas_Vg_Shape *obj, double x, double y, double ctrl_x0, double ctrl_y0, double ctrl_x1, double ctrl_y1); 4298EAPI void evas_vg_shape_append_cubic_to(Evas_Vg_Shape *obj, double x, double y, double ctrl_x0, double ctrl_y0, double ctrl_x1, double ctrl_y1);
4299 4299
4300/** 4300/**
4301 * 4301 * @brief Same as evas_vg_shape_append_cubic_to() api only difference is that it uses
4302 * Same as efl_gfx_path_append_cubic_to() api only difference is that it uses
4303 * the current control point to draw the bezier. 4302 * the current control point to draw the bezier.
4304 * 4303 *
4305 * @see efl_gfx_path_append_cubic_to() 4304 * @see evas_vg_shape_append_cubic_to()
4306 *
4307 * @since 1.14
4308 *
4309 * 4305 *
4310 * @param[in] x X co-ordinate of end point of the line. 4306 * @param[in] obj The object.
4311 * @param[in] y Y co-ordinate of end point of the line. 4307 * @param[in] x The x co-ordinate of end point of the line.
4312 * @param[in] ctrl_x X co-ordinate of 2nd control point. 4308 * @param[in] y The x co-ordinate of end point of the line.
4313 * @param[in] ctrl_y Y co-ordinate of 2nd control point. 4309 * @param[in] ctrl_x The x co-ordinate of 2nd control point.
4310 * @param[in] ctrl_y The y co-ordinate of 2nd control point.
4314 * 4311 *
4312 * @since 1.14
4315 */ 4313 */
4316EAPI void evas_vg_shape_append_scubic_to(Evas_Vg_Shape *obj, double x, double y, double ctrl_x, double ctrl_y); 4314EAPI void evas_vg_shape_append_scubic_to(Evas_Vg_Shape *obj, double x, double y, double ctrl_x, double ctrl_y);
4317 4315
4318/** 4316/**
4319 * 4317 * @brief Append an arc that connects from the current point int the point list
4320 * Append an arc that connects from the current point int the point list 4318 * to the given point (x,y). The arc is defined by the given radius in
4321 * to the given point (x,y). The arc is defined by the given radius in 4319 * x-direction (rx) and radius in y direction (ry).
4322 * x-direction (rx) and radius in y direction (ry) .
4323 * 4320 *
4324 * @note Use this api if you know the end point's of the arc otherwise 4321 * @note Use this api if you know the end point's of the arc otherwise
4325 * use more convenient function efl_gfx_path_append_arc_to() 4322 * use more convenient function evas_vg_shape_append_arc_to()
4326 *
4327 * @see efl_gfx_path_append_arc_to()
4328 * @since 1.14
4329 * 4323 *
4324 * @see evas_vg_shape_append_arc_to()
4330 * 4325 *
4331 * @param[in] x X co-ordinate of end point of the arc. 4326 * @param[in] obj The object.
4332 * @param[in] y Y co-ordinate of end point of the arc. 4327 * @param[in] x The x co-ordinate of end point of the arc.
4333 * @param[in] rx radius of arc in x direction. 4328 * @param[in] y The y co-ordinate of end point of the arc.
4334 * @param[in] ry radius of arc in y direction. 4329 * @param[in] rx The radius of arc in x direction.
4335 * @param[in] angle x-axis rotation , normally 0. 4330 * @param[in] ry The radius of arc in y direction.
4331 * @param[in] angle The x-axis rotation , normally 0.
4336 * @param[in] large_arc Defines whether to draw the larger arc or smaller arc joining two point. 4332 * @param[in] large_arc Defines whether to draw the larger arc or smaller arc joining two point.
4337 * @param[in] sweep Defines whether the arc will be drawn counter-clockwise or clockwise from current point to the end point taking into account the large_arc property. 4333 * @param[in] sweep Defines whether the arc will be drawn counter-clockwise or clockwise from current point to the end point taking into account the large_arc property.
4338 *
4339 */ 4334 */
4340EAPI void evas_vg_shape_append_arc_to(Evas_Vg_Shape *obj, double x, double y, double rx, double ry, double angle, Eina_Bool large_arc, Eina_Bool sweep); 4335EAPI void evas_vg_shape_append_arc_to(Evas_Vg_Shape *obj, double x, double y, double rx, double ry, double angle, Eina_Bool large_arc, Eina_Bool sweep);
4341 4336
@@ -4343,107 +4338,136 @@ EAPI void evas_vg_shape_append_arc_to(Evas_Vg_Shape *obj, double x, double y, do
4343 * @brief Append an arc that enclosed in the given rectangle (x, y, w, h). The 4338 * @brief Append an arc that enclosed in the given rectangle (x, y, w, h). The
4344 * angle is defined in counter clock wise , use -ve angle for clockwise arc. 4339 * angle is defined in counter clock wise , use -ve angle for clockwise arc.
4345 * 4340 *
4346 * @param[in] y Y co-ordinate of the rect. 4341 * @param[in] obj The object.
4347 * @param[in] w width of the rect. 4342 * @param[in] y The x co-ordinate of the rect.
4348 * @param[in] h height of the rect. 4343 * @param[in] y The y co-ordinate of the rect.
4349 * @param[in] start_angle Angle at which the arc will start 4344 * @param[in] w The width of the rect.
4350 * @param[in] sweep_length @ Length of the arc. 4345 * @param[in] h The height of the rect.
4346 * @param[in] start_angle The angle at which the arc will start.
4347 * @param[in] sweep_length The length of the arc.
4351 * 4348 *
4352 * @since 1.18 4349 * @since 1.18
4353 * 4350 *
4354 * @ingroup Efl_Gfx_Shape 4351 * @ingroup Evas_Vg_Shape
4355 */ 4352 */
4356EAPI void evas_vg_shape_append_arc(Evas_Vg_Shape *obj, double x, double y, double w, double h, double start_angle, double sweep_length); 4353EAPI void evas_vg_shape_append_arc(Evas_Vg_Shape *obj, double x, double y, double w, double h, double start_angle, double sweep_length);
4357 4354
4358/** 4355/**
4359 * 4356 * @brief Closes the current subpath by drawing a line to the beginning of the subpath,
4360 * Closes the current subpath by drawing a line to the beginning of the subpath,
4361 * automatically starting a new path. The current point of the new path is 4357 * automatically starting a new path. The current point of the new path is
4362 * (0, 0). 4358 * (0, 0).
4363 * 4359 *
4364 * @note If the subpath does not contain any points, this function does nothing. 4360 * @note If the subpath does not contain any points, this function does nothing.
4365 * 4361 *
4366 * @since 1.14 4362 * @param[in] obj The object.
4367 *
4368 *
4369 * 4363 *
4364 * @since 1.14
4370 */ 4365 */
4371EAPI void evas_vg_shape_append_close(Evas_Vg_Shape *obj); 4366EAPI void evas_vg_shape_append_close(Evas_Vg_Shape *obj);
4372 4367
4373/** 4368/**
4369 * @brief Append a circle with given center and radius.
4374 * 4370 *
4375 * Append a circle with given center and radius. 4371 * @see evas_vg_shape_append_arc()
4376 *
4377 * @see efl_gfx_path_append_arc()
4378 * @since 1.14
4379 *
4380 * 4372 *
4381 * @param[in] x X co-ordinate of the center of the circle. 4373 * @param[in] obj The object.
4382 * @param[in] y Y co-ordinate of the center of the circle. 4374 * @param[in] x The x co-ordinate of the center of the circle.
4383 * @param[in] radius radius of the circle. 4375 * @param[in] y The y co-ordinate of the center of the circle.
4376 * @param[in] radius The radius of the circle.
4384 * 4377 *
4378 * @since 1.14
4385 */ 4379 */
4386EAPI void evas_vg_shape_append_circle(Evas_Vg_Shape *obj, double x, double y, double radius); 4380EAPI void evas_vg_shape_append_circle(Evas_Vg_Shape *obj, double x, double y, double radius);
4387 4381
4388/** 4382/**
4389 * 4383 * @brief Append the given rectangle with rounded corner to the path.
4390 * Append the given rectangle with rounded corner to the path.
4391 * 4384 *
4392 * The xr and yr arguments specify the radii of the ellipses defining the 4385 * The xr and yr arguments specify the radii of the ellipses defining the
4393 * corners of the rounded rectangle. 4386 * corners of the rounded rectangle.
4394 * 4387 *
4395 * @note xr and yr are specified in terms of width and height respectively. 4388 * @note xr and yr are specified in terms of width and height respectively.
4396 *
4397 * @note if xr and yr are 0, then it will draw a rectangle without rounded corner. 4389 * @note if xr and yr are 0, then it will draw a rectangle without rounded corner.
4398 * 4390 *
4391 * @param[in] obj The object.
4392 * @param[in] x The x co-ordinate of the rectangle.
4393 * @param[in] y The y co-ordinate of the rectangle.
4394 * @param[in] w The width of the rectangle.
4395 * @param[in] h The height of the rectangle.
4396 * @param[in] rx The x radius of the rounded corner and should be in range [0 to w/2].
4397 * @param[in] ry The y radius of the rounded corner and should be in range [0 to h/2].
4398 *
4399 * @since 1.14 4399 * @since 1.14
4400 */
4401EAPI void evas_vg_shape_append_rect(Evas_Vg_Shape *obj, double x, double y, double w, double h, double rx, double ry);
4402
4403/**
4404 * @brief Append the SVG path data.
4400 * 4405 *
4406 * @param[in] obj The object.
4407 * @param[in] svg_path_data The svg path data to append.
4408 */
4409EAPI void evas_vg_shape_append_svg_path(Evas_Vg_Shape *obj, const char *svg_path_data);
4410
4411/**
4412 * @brief Creates intermediary path part-way between two paths
4413 *
4414 * Sets the points of the @c obj as the linear interpolation of the points in
4415 * the @c from and @c to paths. The path's x,y position and control point
4416 * coordinates are likewise interpolated.
4401 * 4417 *
4402 * @param[in] x X co-ordinate of the rectangle. 4418 * The @c from and @c to paths must not already have equivalent points, and
4403 * @param[in] y Y co-ordinate of the rectangle. 4419 * @c to must contain at least as many points as @c from, else the function
4404 * @param[in] w Width of the rectangle. 4420 * returns @c false with no interpolation performed. If @c to has more points
4405 * @param[in] h Height of the rectangle. 4421 * than @c from, the excess points are ignored.
4406 * @param[in] rx The x radius of the rounded corner and should be in range [ 0 to w/2 ]
4407 * @param[in] ry The y radius of the rounded corner and should be in range [ 0 to h/2 ]
4408 * 4422 *
4423 * @param[in] obj The object.
4424 * @param[in] from The source path.
4425 * @param[in] to The destination path.
4426 * @param[in] pos_map The position map in range 0.0 to 1.0.
4409 */ 4427 */
4410EAPI void evas_vg_shape_append_rect(Evas_Vg_Shape *obj, double x, double y, double w, double h, double rx, double ry); 4428EAPI Eina_Bool evas_vg_shape_interpolate(Evas_Vg_Shape *obj, const Eo *from, const Eo *to, double pos_map);
4411 4429
4412EAPI void evas_vg_shape_append_svg_path(Evas_Vg_Shape *obj, const char *svg_path_data); 4430/**
4413EAPI Eina_Bool evas_vg_shape_interpolate(Evas_Vg_Shape *obj, const Evas_Vg_Shape *from, const Evas_Vg_Shape *to, double pos_map); 4431 * @brief Check if the given objects have equal commands.
4414EAPI Eina_Bool evas_vg_shape_equal_commands(Evas_Vg_Shape *obj, const Evas_Vg_Shape *with); 4432 *
4433 * @param[in] obj The object.
4434 * @param[in] with The target object.
4435 *
4436 * @return True on equal, @c false otherwise.
4437 */
4438EAPI Eina_Bool evas_vg_shape_equal_commands(Evas_Vg_Shape *obj, const Eo *with);
4415 4439
4416/** 4440/**
4417 * set a vg object as the fill property 4441 * @brief Set a vg object as the fill property.
4418 * 4442 *
4419 * @param obj The object whose fill property gets modified. 4443 * @param[in] obj The object whose fill property gets modified.
4420 * @param f The object content will be used for filling. 4444 * @param[in] The object content will be used for filling.
4421 * 4445 *
4422 */ 4446 */
4423EAPI void evas_vg_shape_fill_set(Evas_Vg_Shape *obj, Evas_Vg_Node *f); 4447EAPI void evas_vg_shape_fill_set(Evas_Vg_Shape *obj, Evas_Vg_Node *f);
4424 4448
4425/** 4449/**
4426 * returns the object that is set for the fill property 4450 * @brief Returns the object that is set for the fill property.
4427 * 4451 *
4428 * @param obj The object whose fill property is inspected. 4452 * @param[in] obj The object whose fill property is inspected.
4429 * @return The object that is set as fill property. 4453 * @return The object that is set as fill property.
4430 * 4454 *
4431 */ 4455 */
4432EAPI Evas_Vg_Node* evas_vg_shape_fill_get(const Evas_Vg_Shape *obj); 4456EAPI Evas_Vg_Node* evas_vg_shape_fill_get(const Evas_Vg_Shape *obj);
4433 4457
4434/** 4458/**
4435 * set a vg object as the stroke fill property 4459 * @brief Set a vg object as the stroke fill property.
4436 * 4460 *
4437 * @param obj The object whose stroke fill property gets modified. 4461 * @param[in] obj The object whose stroke fill property gets modified.
4438 * @param f The object content will be used for stroke filling. 4462 * @param[in] f The object content will be used for stroke filling.
4439 * 4463 *
4440 */ 4464 */
4441EAPI void evas_vg_shape_stroke_fill_set(Evas_Vg_Shape *obj, Evas_Vg_Node *f); 4465EAPI void evas_vg_shape_stroke_fill_set(Evas_Vg_Shape *obj, Evas_Vg_Node *f);
4442 4466
4443/** 4467/**
4444 * returns the object that is set for the stroke fill property 4468 * @brief Returns the object that is set for the stroke fill property.
4445 * 4469 *
4446 * @param obj The object whose stroke fill property is inspected. 4470 * @param[in] obj The object whose stroke fill property is inspected.
4447 * @return The object that is set as stroke fill property. 4471 * @return The object that is set as stroke fill property.
4448 * 4472 *
4449 */ 4473 */
@@ -4452,158 +4476,160 @@ EAPI Evas_Vg_Node* evas_vg_shape_stroke_fill_get(const Evas_Vg_Shape *obj);
4452#include "canvas/efl_canvas_vg_shape_eo.legacy.h" 4476#include "canvas/efl_canvas_vg_shape_eo.legacy.h"
4453 4477
4454/** 4478/**
4479 * @brief Set the list of color stops for the gradient.
4455 * 4480 *
4456 * Set the list of color stops for the gradient 4481 * @param[in] obj The object.
4457 * @since 1.14 4482 * @param[in] colors The color stops list.
4458 * 4483 * @param[in] length The length of the list.
4459 * @param[in] colors color stops list
4460 * @param[in] length length of the list
4461 * 4484 *
4485 * @since 1.14
4462 */ 4486 */
4463EAPI void evas_vg_gradient_stop_set(Evas_Vg_Gradient *obj, const Evas_Vg_Gradient_Stop *colors, unsigned int length); 4487EAPI void evas_vg_gradient_stop_set(Evas_Vg_Gradient *obj, const Evas_Vg_Gradient_Stop *colors, unsigned int length);
4464 4488
4465/** 4489/**
4490 * @brief Get the list of color stops.
4466 * 4491 *
4467 * get the list of color stops. 4492 * @param[in] obj The object.
4468 * @since 1.14 4493 * @param[out] colors The color stops list.
4469 * 4494 * @param[out] length The length of the list.
4470 * @param[out] colors color stops list
4471 * @param[out] length length of the list
4472 * 4495 *
4496 * @since 1.14
4473 */ 4497 */
4474EAPI void evas_vg_gradient_stop_get(Evas_Vg_Gradient *obj, const Evas_Vg_Gradient_Stop **colors, unsigned int *length); 4498EAPI void evas_vg_gradient_stop_get(Evas_Vg_Gradient *obj, const Evas_Vg_Gradient_Stop **colors, unsigned int *length);
4475 4499
4476/** 4500/**
4501 * @brief Specifies the spread method that should be used for this gradient.
4477 * 4502 *
4478 * Specifies the spread method that should be used for this gradient. 4503 * @param[in] obj The object.
4479 * @since 1.14 4504 * @param[in] s The spread type to be used.
4480 *
4481 * @param[in] s spread type to be used
4482 * 4505 *
4506 * @since 1.14
4483 */ 4507 */
4484EAPI void evas_vg_gradient_spread_set(Evas_Vg_Gradient *obj, Evas_Vg_Gradient_Spread s); 4508EAPI void evas_vg_gradient_spread_set(Evas_Vg_Gradient *obj, Evas_Vg_Gradient_Spread s);
4485 4509
4486/** 4510/**
4487 * 4511 * @brief Returns the spread method use by this gradient. The default is
4488 * Returns the spread method use by this gradient. The default is 4512 * EVAS_VG_GRADIENT_SPREAD_PAD.
4489 * EFL_GFX_GRADIENT_SPREAD_PAD.
4490 * @since 1.14 4513 * @since 1.14
4491 * 4514 *
4515 * @param[in] obj The object.
4516 * @return The spread type of the given object.
4492 * 4517 *
4493 */ 4518 */
4494EAPI Evas_Vg_Gradient_Spread evas_vg_gradient_spread_get(Evas_Vg_Gradient *obj); 4519EAPI Evas_Vg_Gradient_Spread evas_vg_gradient_spread_get(Evas_Vg_Gradient *obj);
4495 4520
4496/** 4521/**
4497 * Creates a new linear gradient object \. 4522 * @brief Creates a new linear gradient object.
4498 * 4523 *
4499 * @param parent The given vector container object. 4524 * @param[in] parent The given vector container object.
4500 * @return The created linear gradient object handle. 4525 * @return The created linear gradient object handle.
4501 * 4526 *
4502 */ 4527 */
4503EAPI Evas_Vg_Gradient_Linear* evas_vg_gradient_linear_add(Evas_Vg_Container *parent); 4528EAPI Evas_Vg_Gradient_Linear* evas_vg_gradient_linear_add(Evas_Vg_Container *parent);
4504 4529
4505/** 4530/**
4531 * @brief Sets the start point of this linear gradient.
4506 * 4532 *
4507 * Sets the start point of this linear gradient. 4533 * @param[in] obj The object.
4508 * 4534 * @param[in] x The x co-ordinate of start point.
4509 * @param[in] x x co-ordinate of start point 4535 * @param[in] y The y co-ordinate of start point
4510 * @param[in] y y co-ordinate of start point
4511 * 4536 *
4512 */ 4537 */
4513EAPI void evas_vg_gradient_linear_start_set(Evas_Vg_Gradient_Linear *obj, double x, double y); 4538EAPI void evas_vg_gradient_linear_start_set(Evas_Vg_Gradient_Linear *obj, double x, double y);
4514 4539
4515/** 4540/**
4541 * @biref Gets the start point of this linear gradient.
4516 * 4542 *
4517 * Gets the start point of this linear gradient. 4543 * @param[in] obj The object.
4518 * 4544 * @param[out] x The x co-ordinate of start point.
4519 * @param[out] x x co-ordinate of start point 4545 * @param[out] y The y co-ordinate of start point.
4520 * @param[out] y y co-ordinate of start point
4521 * 4546 *
4522 */ 4547 */
4523EAPI void evas_vg_gradient_linear_start_get(Evas_Vg_Gradient_Linear *obj, double *x, double *y); 4548EAPI void evas_vg_gradient_linear_start_get(Evas_Vg_Gradient_Linear *obj, double *x, double *y);
4524 4549
4525/** 4550/**
4551 * @brief Sets the end point of this linear gradient.
4526 * 4552 *
4527 * Sets the end point of this linear gradient. 4553 * @param[in] obj The object.
4528 * 4554 * @param[in] x The x co-ordinate of end point.
4529 * @param[in] x x co-ordinate of end point 4555 * @param[in] y The y co-ordinate of end point.
4530 * @param[in] y y co-ordinate of end point
4531 * 4556 *
4532 */ 4557 */
4533EAPI void evas_vg_gradient_linear_end_set(Evas_Vg_Gradient_Linear *obj, double x, double y); 4558EAPI void evas_vg_gradient_linear_end_set(Evas_Vg_Gradient_Linear *obj, double x, double y);
4534 4559
4535/** 4560/**
4561 * @brief Gets the end point of this linear gradient.
4536 * 4562 *
4537 * Gets the end point of this linear gradient. 4563 * @param[in] obj The object.
4538 * 4564 * @param[out] x The x co-ordinate of end point.
4539 * @param[out] x x co-ordinate of end point 4565 * @param[out] y The y co-ordinate of end point.
4540 * @param[out] y y co-ordinate of end point
4541 * 4566 *
4542 */ 4567 */
4543EAPI void evas_vg_gradient_linear_end_get(Evas_Vg_Gradient_Linear *obj, double *x, double *y); 4568EAPI void evas_vg_gradient_linear_end_get(Evas_Vg_Gradient_Linear *obj, double *x, double *y);
4544 4569
4545/** 4570/**
4546 * Creates a new radial gradient object \. 4571 * @brief Creates a new radial gradient object.
4547 * 4572 *
4548 * @param parent The given vector container object. 4573 * @param[in] parent The given vector container object.
4549 * @return The created radial gradient object handle. 4574 * @return The created radial gradient object handle.
4550 * 4575 *
4551 */ 4576 */
4552EAPI Evas_Vg_Gradient_Radial* evas_vg_gradient_radial_add(Evas_Vg_Container *parent); 4577EAPI Evas_Vg_Gradient_Radial* evas_vg_gradient_radial_add(Evas_Vg_Container *parent);
4553 4578
4554/** 4579/**
4580 * @brief Sets the center of this radial gradient.
4555 * 4581 *
4556 * Sets the center of this radial gradient. 4582 * @param[in] obj The object.
4557 * 4583 * @param[in] x The x co-ordinate of center point.
4558 * @param[in] x x co-ordinate of center point 4584 * @param[in] y The y co-ordinate of center point.
4559 * @param[in] y y co-ordinate of center point
4560 * 4585 *
4561 */ 4586 */
4562EAPI void evas_vg_gradient_radial_center_set(Evas_Vg_Gradient_Radial *obj, double x, double y); 4587EAPI void evas_vg_gradient_radial_center_set(Evas_Vg_Gradient_Radial *obj, double x, double y);
4563 4588
4564/** 4589/**
4590 * @brief Gets the center of this radial gradient.
4565 * 4591 *
4566 * Gets the center of this radial gradient. 4592 * @param[in] obj The object.
4567 * 4593 * @param[out] x The x co-ordinate of center point.
4568 * @param[out] x x co-ordinate of center point 4594 * @param[out] y The y co-ordinate of center point.
4569 * @param[out] y y co-ordinate of center point
4570 * 4595 *
4571 */ 4596 */
4572EAPI void evas_vg_gradient_radial_center_get(Evas_Vg_Gradient_Radial *obj, double *x, double *y); 4597EAPI void evas_vg_gradient_radial_center_get(Evas_Vg_Gradient_Radial *obj, double *x, double *y);
4573 4598
4574/** 4599/**
4600 * @brief Sets the center radius of this radial gradient.
4575 * 4601 *
4576 * Sets the center radius of this radial gradient. 4602 * @param[in] obj The object.
4577 * 4603 * @param[in] r The center radius.
4578 * @param[in] r center radius
4579 * 4604 *
4580 */ 4605 */
4581EAPI void evas_vg_gradient_radial_radius_set(Evas_Vg_Gradient_Radial *obj, double r); 4606EAPI void evas_vg_gradient_radial_radius_set(Evas_Vg_Gradient_Radial *obj, double r);
4582 4607
4583/** 4608/**
4609 * @brief Gets the center radius of this radial gradient.
4584 * 4610 *
4585 * Gets the center radius of this radial gradient. 4611 * @param[in] obj The object.
4586 * 4612 * @return The center radius of the given object.
4587 * 4613 *
4588 */ 4614 */
4589EAPI double evas_vg_gradient_radial_radius_get(Evas_Vg_Gradient_Radial *obj); 4615EAPI double evas_vg_gradient_radial_radius_get(Evas_Vg_Gradient_Radial *obj);
4590 4616
4591/** 4617/**
4618 * @brief Sets the focal point of this radial gradient.
4592 * 4619 *
4593 * Sets the focal point of this radial gradient. 4620 * @param[in] obj The object.
4594 * 4621 * @param[in] x The x co-ordinate of focal point.
4595 * @param[in] x x co-ordinate of focal point 4622 * @param[in] y The y co-ordinate of focal point.
4596 * @param[in] y y co-ordinate of focal point
4597 * 4623 *
4598 */ 4624 */
4599EAPI void evas_vg_gradient_radial_focal_set(Evas_Vg_Gradient_Radial *obj, double x, double y); 4625EAPI void evas_vg_gradient_radial_focal_set(Evas_Vg_Gradient_Radial *obj, double x, double y);
4600 4626
4601/** 4627/**
4628 * @brief Gets the focal point of this radial gradient.
4602 * 4629 *
4603 * Gets the focal point of this radial gradient. 4630 * @param[in] obj The object.
4604 * 4631 * @param[out] x The x co-ordinate of focal point.
4605 * @param[out] x x co-ordinate of focal point 4632 * @param[out] y The y co-ordinate of focal point.
4606 * @param[out] y y co-ordinate of focal point
4607 * 4633 *
4608 */ 4634 */
4609EAPI void evas_vg_gradient_radial_focal_get(Evas_Vg_Gradient_Radial *obj, double *x, double *y); 4635EAPI void evas_vg_gradient_radial_focal_get(Evas_Vg_Gradient_Radial *obj, double *x, double *y);
diff --git a/src/lib/evas/canvas/efl_canvas_vg_container_eo.legacy.h b/src/lib/evas/canvas/efl_canvas_vg_container_eo.legacy.h
index 3ce85d03fc..4cc9122db2 100644
--- a/src/lib/evas/canvas/efl_canvas_vg_container_eo.legacy.h
+++ b/src/lib/evas/canvas/efl_canvas_vg_container_eo.legacy.h
@@ -15,23 +15,23 @@ typedef Eo Evas_Vg_Container;
15#endif 15#endif
16 16
17/** 17/**
18 * @brief Get child of container 18 * @brief Get child of container.
19 * 19 *
20 * @param[in] obj The object. 20 * @param[in] obj The object.
21 * @param[in] name Child node name 21 * @param[in] name The Child node name.
22 * 22 *
23 * @return Child object 23 * @return The child object.
24 * 24 *
25 * @ingroup Evas_Vg_Container_Group 25 * @ingroup Evas_Vg_Container_Group
26 */ 26 */
27EAPI Evas_Vg_Node *evas_vg_container_child_get(Evas_Vg_Container *obj, const char *name); 27EAPI Evas_Vg_Node *evas_vg_container_child_get(Evas_Vg_Container *obj, const char *name);
28 28
29/** 29/**
30 * @brief Get all children of container 30 * @brief Get all children of container.
31 * 31 *
32 * @param[in] obj The object. 32 * @param[in] obj The object.
33 * 33 *
34 * @return Iterator to children 34 * @return The iterator to children.
35 * 35 *
36 * @ingroup Evas_Vg_Container_Group 36 * @ingroup Evas_Vg_Container_Group
37 */ 37 */
diff --git a/src/lib/evas/canvas/efl_canvas_vg_node_eo.legacy.h b/src/lib/evas/canvas/efl_canvas_vg_node_eo.legacy.h
index ca85475ff5..5902f7b79d 100644
--- a/src/lib/evas/canvas/efl_canvas_vg_node_eo.legacy.h
+++ b/src/lib/evas/canvas/efl_canvas_vg_node_eo.legacy.h
@@ -20,7 +20,7 @@ typedef Eo Evas_Vg_Node;
20 * @note Pass @c null to cancel the applied transformation. 20 * @note Pass @c null to cancel the applied transformation.
21 * 21 *
22 * @param[in] obj The object. 22 * @param[in] obj The object.
23 * @param[in] m Transformation matrix. 23 * @param[in] m The transformation matrix.
24 * 24 *
25 * @since 1.14 25 * @since 1.14
26 * 26 *
@@ -32,8 +32,7 @@ EAPI void evas_vg_node_transformation_set(Evas_Vg_Node *obj, const Eina_Matrix3
32 * @brief Gets the transformation matrix used for this node object. 32 * @brief Gets the transformation matrix used for this node object.
33 * 33 *
34 * @param[in] obj The object. 34 * @param[in] obj The object.
35 * 35 * @return The transformation matrix.
36 * @return Transformation matrix.
37 * 36 *
38 * @since 1.14 37 * @since 1.14
39 * 38 *
diff --git a/src/lib/evas/canvas/efl_canvas_vg_object_eo.legacy.h b/src/lib/evas/canvas/efl_canvas_vg_object_eo.legacy.h
index 8877db086c..6e238be97a 100644
--- a/src/lib/evas/canvas/efl_canvas_vg_object_eo.legacy.h
+++ b/src/lib/evas/canvas/efl_canvas_vg_object_eo.legacy.h
@@ -4,7 +4,8 @@
4#ifndef _EVAS_OBJECT_VG_EO_LEGACY_TYPES 4#ifndef _EVAS_OBJECT_VG_EO_LEGACY_TYPES
5#define _EVAS_OBJECT_VG_EO_LEGACY_TYPES 5#define _EVAS_OBJECT_VG_EO_LEGACY_TYPES
6 6
7/** Enumeration that defines how viewbox will be filled int the vg canvs's 7/**
8 * @brief Enumeration that defines how viewbox will be filled int the vg canvs's
8 * viewport. default Fill_Mode is @c none 9 * viewport. default Fill_Mode is @c none
9 * 10 *
10 * @ingroup Evas_Object_Vg_Group 11 * @ingroup Evas_Object_Vg_Group
@@ -106,7 +107,7 @@ EAPI void evas_object_vg_viewbox_align_get(const Evas_Object *obj, double *align
106 * It takes the ownership of the root node. 107 * It takes the ownership of the root node.
107 * 108 *
108 * @param[in] obj The object. 109 * @param[in] obj The object.
109 * @param[in] root Root node(Efl_Canvas_Vg_Container) of the VG canvas. 110 * @param[in] root Root node(Evas_Vg_Container) of the VG canvas.
110 * 111 *
111 * @ingroup Evas_Object_Vg_Group 112 * @ingroup Evas_Object_Vg_Group
112 */ 113 */
diff --git a/src/lib/evas/canvas/efl_canvas_vg_shape_eo.legacy.h b/src/lib/evas/canvas/efl_canvas_vg_shape_eo.legacy.h
index a721c95928..52e2baf7ae 100644
--- a/src/lib/evas/canvas/efl_canvas_vg_shape_eo.legacy.h
+++ b/src/lib/evas/canvas/efl_canvas_vg_shape_eo.legacy.h
@@ -14,42 +14,40 @@ typedef Eo Evas_Vg_Shape;
14#endif 14#endif
15 15
16/** 16/**
17 * @brief Fill of the shape object 17 * @brief Fill of the shape object.
18 * 18 *
19 * @param[in] obj The object. 19 * @param[in] obj The object.
20 * @param[in] f Fill object 20 * @param[in] f The fill object.
21 * 21 *
22 * @ingroup Evas_Vg_Shape_Group 22 * @ingroup Evas_Vg_Shape_Group
23 */ 23 */
24EAPI void evas_vg_shape_fill_set(Evas_Vg_Shape *obj, Evas_Vg_Node *f); 24EAPI void evas_vg_shape_fill_set(Evas_Vg_Shape *obj, Evas_Vg_Node *f);
25 25
26/** 26/**
27 * @brief Fill of the shape object 27 * @brief Fill of the shape object.
28 * 28 *
29 * @param[in] obj The object. 29 * @param[in] obj The object.
30 * 30 * @return The fill object.
31 * @return Fill object
32 * 31 *
33 * @ingroup Evas_Vg_Shape_Group 32 * @ingroup Evas_Vg_Shape_Group
34 */ 33 */
35EAPI Evas_Vg_Node *evas_vg_shape_fill_get(const Evas_Vg_Shape *obj); 34EAPI Evas_Vg_Node *evas_vg_shape_fill_get(const Evas_Vg_Shape *obj);
36 35
37/** 36/**
38 * @brief Stroke fill of the shape object 37 * @brief Stroke fill of the shape object.
39 * 38 *
40 * @param[in] obj The object. 39 * @param[in] obj The object.
41 * @param[in] f Stroke fill object 40 * @param[in] f The stroke fill object.
42 * 41 *
43 * @ingroup Evas_Vg_Shape_Group 42 * @ingroup Evas_Vg_Shape_Group
44 */ 43 */
45EAPI void evas_vg_shape_stroke_fill_set(Evas_Vg_Shape *obj, Evas_Vg_Node *f); 44EAPI void evas_vg_shape_stroke_fill_set(Evas_Vg_Shape *obj, Evas_Vg_Node *f);
46 45
47/** 46/**
48 * @brief Stroke fill of the shape object 47 * @brief Stroke fill of the shape object.
49 * 48 *
50 * @param[in] obj The object. 49 * @param[in] obj The object.
51 * 50 * @return The stroke fill object.
52 * @return Stroke fill object
53 * 51 *
54 * @ingroup Evas_Vg_Shape_Group 52 * @ingroup Evas_Vg_Shape_Group
55 */ 53 */
@@ -69,7 +67,6 @@ EAPI void evas_vg_shape_stroke_marker_set(Evas_Vg_Shape *obj, Evas_Vg_Node *m);
69 * @brief Stroke marker of the shape object 67 * @brief Stroke marker of the shape object
70 * 68 *
71 * @param[in] obj The object. 69 * @param[in] obj The object.
72 *
73 * @return Stroke marker object 70 * @return Stroke marker object
74 * 71 *
75 * @ingroup Evas_Vg_Shape_Group 72 * @ingroup Evas_Vg_Shape_Group