dimmus
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: efl_gfx: fill gaps in efl_gfx eo file documentation

This commit is contained in:
Stefan Schmidt 2016-11-15 16:04:03 +01:00
parent dbe01dd2b9
commit 237ab9c681
4 changed files with 54 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/lib/efl/interfaces/efl_gfx_buffer.eo
View File

@ -224,7 +224,7 @@ interface Efl.Gfx.Buffer ()
freed by the caller. freed by the caller.
]] ]]
params { params {
@out slice: Eina.Slice; @out slice: Eina.Slice; [[Data slice]]
@in plane: int @optional; [[Plane ID. 0 by default. Useful for planar formats only.]] @in plane: int @optional; [[Plane ID. 0 by default. Useful for planar formats only.]]
} }
return: bool; [[$true on success, $false otherwise]] return: bool; [[$true on success, $false otherwise]]

12
src/lib/efl/interfaces/efl_gfx_filter.eo
View File

@ -49,11 +49,11 @@ interface Efl.Gfx.Filter
get {} get {}
set {} set {}
values { values {
cur_state: string; cur_state: string; [[Current state of the filter]]
cur_val: double; cur_val: double; [[Current value]]
next_state: string @optional; next_state: string @optional; [[Next filter state, optional]]
next_val: double @optional; next_val: double @optional; [[Next value, optional]]
pos: double @optional; pos: double @optional; [[Position, optional]]
} }
} }
@property filter_padding { @property filter_padding {
@ -68,7 +68,7 @@ interface Efl.Gfx.Filter
} }
values { values {
l: int; [[Padding on the left]] l: int; [[Padding on the left]]
r: int; [[Padding on the ight]] r: int; [[Padding on the right]]
t: int; [[Padding on the top]] t: int; [[Padding on the top]]
b: int; [[Padding on the bottom]] b: int; [[Padding on the bottom]]
} }

40
src/lib/efl/interfaces/efl_gfx_shape.eo
View File

@ -55,7 +55,7 @@ mixin Efl.Gfx.Shape
get { get {
} }
values { values {
centered: double; centered: double; [[Centered stroke location]]
} }
} }
@property stroke_dash { @property stroke_dash {
@ -65,8 +65,8 @@ mixin Efl.Gfx.Shape
get { get {
} }
values { values {
dash: ptr(const(Efl.Gfx.Dash)); dash: ptr(const(Efl.Gfx.Dash)); [[Stroke dash]]
length: uint; length: uint; [[Stroke dash length]]
} }
} }
@property stroke_cap { @property stroke_cap {
@ -136,11 +136,12 @@ mixin Efl.Gfx.Shape
} }
} }
@property path_length { @property path_length {
[[Path length property]]
get { get {
} }
values { values {
commands: uint; commands: uint; [[Commands]]
points: uint; points: uint; [[Points]]
} }
} }
@property current { @property current {
@ -288,9 +289,9 @@ mixin Efl.Gfx.Shape
params { params {
@in x: double; [[X co-ordinate of end point of the arc.]] @in x: double; [[X co-ordinate of end point of the arc.]]
@in y: double; [[Y co-ordinate of end point of the arc.]] @in y: double; [[Y co-ordinate of end point of the arc.]]
@in rx: double; [[radius of arc in x direction.]] @in rx: double; [[Radius of arc in x direction.]]
@in ry: double; [[radius of arc in y direction.]] @in ry: double; [[Radius of arc in y direction.]]
@in angle: double; [[x-axis rotation , normally 0.]] @in angle: double; [[X-axis rotation , normally 0.]]
@in large_arc: bool; [[Defines whether to draw the larger arc or @in large_arc: bool; [[Defines whether to draw the larger arc or
smaller arc joining two point.]] smaller arc joining two point.]]
@in sweep: bool; [[Defines whether the arc will be drawn @in sweep: bool; [[Defines whether the arc will be drawn
@ -308,8 +309,8 @@ mixin Efl.Gfx.Shape
params { params {
@in x: double; [[X co-ordinate of the rect.]] @in x: double; [[X co-ordinate of the rect.]]
@in y: double; [[Y co-ordinate of the rect.]] @in y: double; [[Y co-ordinate of the rect.]]
@in w: double; [[width of the rect.]] @in w: double; [[Width of the rect.]]
@in h: double; [[height of the rect.]] @in h: double; [[Height of the rect.]]
@in start_angle: double; [[Angle at which the arc will start]] @in start_angle: double; [[Angle at which the arc will start]]
@in sweep_length: double; [[@ Length of the arc.]] @in sweep_length: double; [[@ Length of the arc.]]
} }
@ -332,7 +333,7 @@ mixin Efl.Gfx.Shape
params { params {
@in x: double; [[X co-ordinate of the center of the circle.]] @in x: double; [[X co-ordinate of the center of the circle.]]
@in y: double; [[Y co-ordinate of the center of the circle.]] @in y: double; [[Y co-ordinate of the center of the circle.]]
@in radius: double; [[radius of the circle.]] @in radius: double; [[Radius of the circle.]]
} }
} }
append_rect { append_rect {
@ -362,22 +363,25 @@ mixin Efl.Gfx.Shape
} }
} }
append_svg_path { append_svg_path {
[[Append SVG path data]]
params { params {
@in svg_path_data: string; @in svg_path_data: string; [[SVG path data to append]]
} }
} }
interpolate { interpolate {
return: bool; [[Interpolate object]]
return: bool; [[$true on success, $false otherwise]]
params { params {
@in from: const(Efl.Object); @in from: const(Efl.Object); [[Source object]]
@in to: const(Efl.Object); @in to: const(Efl.Object); [[Destination object]]
@in pos_map: double; @in pos_map: double; [[Position map]]
} }
} }
equal_commands { equal_commands {
return: bool; [[Equal commands in object]]
return: bool; [[True on success, $false otherwise]]
params { params {
@in with: const(Efl.Object); @in with: const(Efl.Object); [[Object]]
} }
} }
} }

50
src/lib/evas/canvas/efl_gfx_map.eo
View File

@ -59,7 +59,7 @@ mixin Efl.Gfx.Map (Efl.Interface, Efl.Object)
]] ]]
get {} get {}
values { values {
cw: bool; [[$true if CW, $false if CCW.]] cw: bool; [[$true if clockwise, $false if counter clockwise]]
} }
} }
@property map_smooth { @property map_smooth {
@ -170,17 +170,17 @@ mixin Efl.Gfx.Map (Efl.Interface, Efl.Object)
]] ]]
get {} get {}
keys { keys {
idx: int; idx: int; [[Point]]
} }
values { values {
z: double; z: double; [[Z coordinate for point]]
} }
} }
map_populate { map_populate {
[[Populate source and destination map points to match this object. [[Populate source and destination map points to match this object.
]] ]]
params { params {
z: double @optional; [[Point Z coordinate (pre-perpective transform), z: double @optional; [[Point Z coordinate (pre-pesrpective transform),
used for all 4 points. 0 by default.]] used for all 4 points. 0 by default.]]
} }
return: bool; [[$false in case of error.]] return: bool; [[$false in case of error.]]
@ -194,11 +194,11 @@ mixin Efl.Gfx.Map (Efl.Interface, Efl.Object)
image uv (@.map_point_image_uv). image uv (@.map_point_image_uv).
]] ]]
params { params {
x: double; x: double; [[X coordinate]]
y: double; y: double; [[Y coordinate]]
w: double; w: double; [[Width]]
h: double; h: double; [[Height]]
z: double @optional; [[Point Z coordinate (pre-perpective transform), z: double @optional; [[Point Z coordinate (pre-perspective transform),
used for all 4 points. 0 by default.]] used for all 4 points. 0 by default.]]
} }
return: bool; [[$false in case of error.]] return: bool; [[$false in case of error.]]
@ -229,8 +229,8 @@ mixin Efl.Gfx.Map (Efl.Interface, Efl.Object)
"half the size" etc. All coordinates are canvas global coordinates. "half the size" etc. All coordinates are canvas global coordinates.
]] ]]
params { params {
zoomx: double; zoomx: double; [[Zoom in X direction]]
zoomy: double; zoomy: double; [[Zoom in Y direction]]
cx: double; [[X coordinate of the center point.]] cx: double; [[X coordinate of the center point.]]
cy: double; [[Y coordinate of the center point.]] cy: double; [[Y coordinate of the center point.]]
} }
@ -264,13 +264,13 @@ mixin Efl.Gfx.Map (Efl.Interface, Efl.Object)
to rotate around (in 3D). to rotate around (in 3D).
]] ]]
params { params {
qx: double; [[the x component of the imaginary part of the quaternion.]] qx: double; [[The x component of the imaginary part of the quaternion.]]
qy: double; [[the y component of the imaginary part of the quaternion.]] qy: double; [[The y component of the imaginary part of the quaternion.]]
qz: double; [[the z component of the imaginary part of the quaternion.]] qz: double; [[The z component of the imaginary part of the quaternion.]]
qw: double; [[the w component of the real part of the quaternion.]] qw: double; [[The w component of the real part of the quaternion.]]
cx: double; [[rotation's center x.]] cx: double; [[Rotation's center x.]]
cy: double; [[rotation's center y.]] cy: double; [[Rotation's center y.]]
cz: double; [[rotation's center z.]] cz: double; [[Rotation's center z.]]
} }
return: bool; [[$false in case of error.]] return: bool; [[$false in case of error.]]
} }
@ -289,12 +289,12 @@ mixin Efl.Gfx.Map (Efl.Interface, Efl.Object)
lx: double; [[X coordinate in space of light point.]] lx: double; [[X coordinate in space of light point.]]
ly: double; [[Y coordinate in space of light point.]] ly: double; [[Y coordinate in space of light point.]]
lz: double; [[Z coordinate in space of light point.]] lz: double; [[Z coordinate in space of light point.]]
lr: int; [[light red value (0 - 255).]] lr: int; [[Light red value (0 - 255).]]
lg: int; [[light green value (0 - 255).]] lg: int; [[Light green value (0 - 255).]]
lb: int; [[light blue value (0 - 255).]] lb: int; [[Light blue value (0 - 255).]]
ar: int; [[ambient color red value (0 - 255).]] ar: int; [[Ambient color red value (0 - 255).]]
ag: int; [[ambient color green value (0 - 255).]] ag: int; [[Ambient color green value (0 - 255).]]
ab: int; [[ambient color blue value (0 - 255).]] ab: int; [[Ambient color blue value (0 - 255).]]
} }
return: bool; [[$false in case of error.]] return: bool; [[$false in case of error.]]
} }
@ -325,7 +325,7 @@ mixin Efl.Gfx.Map (Efl.Interface, Efl.Object)
map_dup { map_dup {
[[Duplicate the map information from another object.]] [[Duplicate the map information from another object.]]
params { params {
other: const(Efl.Gfx.Map); other: const(Efl.Gfx.Map); [[Map object to duplicate]]
} }
return: bool; [[$false in case of error.]] return: bool; [[$false in case of error.]]
} }