summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2016-11-15 15:51:32 +0100
committerStefan Schmidt <stefan@osg.samsung.com>2016-11-15 17:45:31 +0100
commit9971a789a0790222b648a444d2ee4b3c3cabb3b4 (patch)
tree5d6751a17b4a63fd814ef02f51b842bc6137b09d /src/lib
parent03176e578aaf2ad8e541818e6ada3219f327bc03 (diff)
docs: ector_gl: fill gaps in ector gl backend eo file documentation
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/ector/gl/ector_gl_buffer.eo1
-rw-r--r--src/lib/ector/gl/ector_gl_buffer_base.eo24
-rw-r--r--src/lib/ector/gl/ector_gl_surface.eo24
-rw-r--r--src/lib/ector/gl/ector_renderer_gl.eo12
-rw-r--r--src/lib/ector/gl/ector_renderer_gl_gradient_linear.eo1
-rw-r--r--src/lib/ector/gl/ector_renderer_gl_gradient_radial.eo1
-rw-r--r--src/lib/ector/gl/ector_renderer_gl_shape.eo1
7 files changed, 37 insertions, 27 deletions
diff --git a/src/lib/ector/gl/ector_gl_buffer.eo b/src/lib/ector/gl/ector_gl_buffer.eo
index ea1b327174..67b96ae4e9 100644
--- a/src/lib/ector/gl/ector_gl_buffer.eo
+++ b/src/lib/ector/gl/ector_gl_buffer.eo
@@ -1,4 +1,5 @@
1class Ector.GL.Buffer (Efl.Object, Ector.GL.Buffer.Base) 1class Ector.GL.Buffer (Efl.Object, Ector.GL.Buffer.Base)
2{ 2{
3 [[Ector GL buffer class]]
3 data: null; 4 data: null;
4} 5}
diff --git a/src/lib/ector/gl/ector_gl_buffer_base.eo b/src/lib/ector/gl/ector_gl_buffer_base.eo
index 87fad09479..2a1718246b 100644
--- a/src/lib/ector/gl/ector_gl_buffer_base.eo
+++ b/src/lib/ector/gl/ector_gl_buffer_base.eo
@@ -22,7 +22,7 @@ mixin Ector.GL.Buffer.Base (Ector.Buffer)
22 ]] 22 ]]
23 get {} 23 get {}
24 values { 24 values {
25 is_whole: bool; 25 is_whole: bool; [[$true if the image is covering the whole GL texture, $false otherwise]]
26 } 26 }
27 } 27 }
28 @property vertices { 28 @property vertices {
@@ -43,17 +43,17 @@ mixin Ector.GL.Buffer.Base (Ector.Buffer)
43 params { 43 params {
44 texid: int; [[GL texture ID]] 44 texid: int; [[GL texture ID]]
45 fboid: int; [[Framebuffer object ID]] 45 fboid: int; [[Framebuffer object ID]]
46 cspace: Efl.Gfx.Colorspace; 46 cspace: Efl.Gfx.Colorspace; [[Colorspace]]
47 imw: int; 47 imw: int; [[Image width]]
48 imh: int; 48 imh: int; [[Image height]]
49 tx: int; 49 tx: int; [[Texture X coordinate]]
50 ty: int; 50 ty: int; [[Texture Y coordinate]]
51 tw: int; 51 tw: int; [[Texture width]]
52 th: int; 52 th: int; [[Texture height]]
53 l: int; 53 l: int; [[Left padding]]
54 r: int; 54 r: int; [[Right padding]]
55 t: int; 55 t: int; [[Top padding]]
56 b: int; 56 b: int; [[Bottom padding]]
57 } 57 }
58 } 58 }
59 } 59 }
diff --git a/src/lib/ector/gl/ector_gl_surface.eo b/src/lib/ector/gl/ector_gl_surface.eo
index edefce10e3..531ad9ec7a 100644
--- a/src/lib/ector/gl/ector_gl_surface.eo
+++ b/src/lib/ector/gl/ector_gl_surface.eo
@@ -2,28 +2,32 @@ import ector_types;
2 2
3class Ector.GL.Surface (Ector.GL.Buffer, Ector.Surface) 3class Ector.GL.Surface (Ector.GL.Buffer, Ector.Surface)
4{ 4{
5 [[Ector GL surface class]]
5 eo_prefix: ector_gl_surface; 6 eo_prefix: ector_gl_surface;
6 methods { 7 methods {
7 shader_get { 8 shader_get {
8 return: uint; 9 [[Get shader]]
10 return: uint; [[Shader count]]
9 params { 11 params {
10 @in flags: uint64; 12 @in flags: uint64; [[Flags]]
11 } 13 }
12 } 14 }
13 push { 15 push {
14 return: bool; 16 [[Push surface to GPU]]
17 return: bool; [[$true on success, $false otherwise]]
15 params { 18 params {
16 @in flags: uint64; 19 @in flags: uint64; [[GL flags]]
17 @in vertex: ptr(GLshort); 20 @in vertex: ptr(GLshort); [[GL vertex]]
18 @in vertex_count: uint; 21 @in vertex_count: uint; [[GL vertex count]]
19 @in mul_col: uint; 22 @in mul_col: uint; [[Premultiplied color]]
20 } 23 }
21 } 24 }
22 state_define { 25 state_define {
23 return: bool; 26 [[Define state]]
27 return: bool; [[$true on success, $false otherwise]]
24 params { 28 params {
25 @in op: Efl.Gfx.Render_Op; 29 @in op: Efl.Gfx.Render_Op; [[Render operation]]
26 @in clips: array<ptr(Eina.Rectangle)>; [[array of @Eina.Rectangle clip]] 30 @in clips: array<ptr(Eina.Rectangle)>; [[Array of @Eina.Rectangle clip]]
27 } 31 }
28 } 32 }
29 } 33 }
diff --git a/src/lib/ector/gl/ector_renderer_gl.eo b/src/lib/ector/gl/ector_renderer_gl.eo
index 82fb387a87..f310b7e40d 100644
--- a/src/lib/ector/gl/ector_renderer_gl.eo
+++ b/src/lib/ector/gl/ector_renderer_gl.eo
@@ -2,14 +2,16 @@ import ector_types;
2 2
3abstract Ector.Renderer.GL (Ector.Renderer) 3abstract Ector.Renderer.GL (Ector.Renderer)
4{ 4{
5 [[Ector GL renderer abstract class]]
5 methods { 6 methods {
6 fill @virtual_pure { 7 fill @virtual_pure {
7 return: bool; 8 [[Fill operation]]
9 return: bool; [[$true on success, $false otherwise]]
8 params { 10 params {
9 @in flags: uint64; 11 @in flags: uint64; [[GL flags]]
10 @in vertex: ptr(GLshort); 12 @in vertex: ptr(GLshort); [[GL vertex]]
11 @in vertex_count: uint; 13 @in vertex_count: uint; [[GL vertex count]]
12 @in mul_col: uint; 14 @in mul_col: uint; [[Premultiplied color]]
13 } 15 }
14 } 16 }
15 } 17 }
diff --git a/src/lib/ector/gl/ector_renderer_gl_gradient_linear.eo b/src/lib/ector/gl/ector_renderer_gl_gradient_linear.eo
index 9ec8f1ffa7..cc6e1af50d 100644
--- a/src/lib/ector/gl/ector_renderer_gl_gradient_linear.eo
+++ b/src/lib/ector/gl/ector_renderer_gl_gradient_linear.eo
@@ -1,5 +1,6 @@
1class Ector.Renderer.GL.Gradient.Linear (Ector.Renderer.GL, Ector.Renderer.Gradient, Ector.Renderer.Gradient.Linear) 1class Ector.Renderer.GL.Gradient.Linear (Ector.Renderer.GL, Ector.Renderer.Gradient, Ector.Renderer.Gradient.Linear)
2{ 2{
3 [[Ector GL renderer gradient linear]]
3 eo_prefix: ector_renderer_gl_gradient_linear; 4 eo_prefix: ector_renderer_gl_gradient_linear;
4 implements { 5 implements {
5 Ector.Renderer.prepare; 6 Ector.Renderer.prepare;
diff --git a/src/lib/ector/gl/ector_renderer_gl_gradient_radial.eo b/src/lib/ector/gl/ector_renderer_gl_gradient_radial.eo
index a03b7c6a51..d1b67c15b6 100644
--- a/src/lib/ector/gl/ector_renderer_gl_gradient_radial.eo
+++ b/src/lib/ector/gl/ector_renderer_gl_gradient_radial.eo
@@ -1,5 +1,6 @@
1class Ector.Renderer.GL.Gradient.Radial (Ector.Renderer.GL, Ector.Renderer.Gradient, Ector.Renderer.Gradient.Radial) 1class Ector.Renderer.GL.Gradient.Radial (Ector.Renderer.GL, Ector.Renderer.Gradient, Ector.Renderer.Gradient.Radial)
2{ 2{
3 [[Ector GL renderer gradient radial]]
3 eo_prefix: ector_renderer_gl_gradient_radial; 4 eo_prefix: ector_renderer_gl_gradient_radial;
4 implements { 5 implements {
5 Ector.Renderer.prepare; 6 Ector.Renderer.prepare;
diff --git a/src/lib/ector/gl/ector_renderer_gl_shape.eo b/src/lib/ector/gl/ector_renderer_gl_shape.eo
index d4f1217bd5..8aea6ac014 100644
--- a/src/lib/ector/gl/ector_renderer_gl_shape.eo
+++ b/src/lib/ector/gl/ector_renderer_gl_shape.eo
@@ -1,5 +1,6 @@
1class Ector.Renderer.GL.Shape (Ector.Renderer.GL, Ector.Renderer.Shape) 1class Ector.Renderer.GL.Shape (Ector.Renderer.GL, Ector.Renderer.Shape)
2{ 2{
3 [[Ector GL renderer shape class]]
3 eo_prefix: ector_renderer_gl_shape; 4 eo_prefix: ector_renderer_gl_shape;
4 implements { 5 implements {
5 Ector.Renderer.prepare; 6 Ector.Renderer.prepare;