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

docs: ector: improve docs for the abstract renderer base class 

Not everything is docuement here yet. Might need some help from people more
familiar with ector.
This commit is contained in:
Stefan Schmidt 2016-04-22 12:52:42 +02:00
parent c2823cfb18
commit 6e19e4f46d
1 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/lib/ector/ector_renderer_generic_base.eo
View File

@ -11,10 +11,13 @@ enum Ector.Quality
abstract Ector.Renderer.Generic.Base (Eo.Base)
{
[[Ector renderer abstract interface]]
eo_prefix: ector_renderer;
legacy_prefix: null;
methods {
@property surface {
[[Surface associated to this renderer]]
set {
[[Do not use.]]
}
@ -22,7 +25,7 @@ abstract Ector.Renderer.Generic.Base (Eo.Base)
[[Get the surface associated to this renderer. Can not be set.]]
}
values {
s: Ector.Generic.Surface *;
s: Ector.Generic.Surface *; [[Associated surface]]
}
}
@property transformation {
@ -45,25 +48,16 @@ abstract Ector.Renderer.Generic.Base (Eo.Base)
}
}
@property visibility {
[[The given Ector renderer visible or invisible.]]
set {
[[Makes the given Ector renderer visible or invisible.]]
}
get {
[[Retrieves whether or not the given Ector renderer is visible.]]
}
values {
v: bool; [[true if to make the object visible, false otherwise]]
}
}
@property color {
set {
[[Sets the general/main color of the given Ector renderer to the
given one.
These color values are expected to be premultiplied by alpha.
]]
}
get {
[[Retrieves the general/main color of the given Ector renderer.
Retrieves the main color's RGB component (and alpha channel)
@ -75,6 +69,9 @@ abstract Ector.Renderer.Generic.Base (Eo.Base)
Use null pointers on the components you're not interested in,
they'll be ignored by the function.
]]
set {
}
get {
}
values {
r: int; [[The red component of the given color.]]
@ -93,22 +90,25 @@ abstract Ector.Renderer.Generic.Base (Eo.Base)
}
}
@property quality {
[[Quality of the renderer]]
set {
}
get {
}
values {
q: Ector.Quality;
q: Ector.Quality; [[Quality of the renderer]]
}
}
@property crc {
[[Cyclic redundancy check]]
get {
return: uint;
return: uint; [[CRC value]]
}
}
bounds_get {
[[Retrieve the bounds of the renderer]]
params {
@out r: Eina.Rectangle;
@out r: Eina.Rectangle; [[Bounds as @Eina.Rectangle]]
}
}
draw {