diff options
author | Stefan Schmidt <stefan@osg.samsung.com> | 2016-11-15 15:51:32 +0100 |
---|---|---|
committer | Stefan Schmidt <stefan@osg.samsung.com> | 2016-11-15 17:45:31 +0100 |
commit | 9971a789a0790222b648a444d2ee4b3c3cabb3b4 (patch) | |
tree | 5d6751a17b4a63fd814ef02f51b842bc6137b09d /src/lib/ector | |
parent | 03176e578aaf2ad8e541818e6ada3219f327bc03 (diff) | |
download | efl-9971a789a0790222b648a444d2ee4b3c3cabb3b4.tar.gz |
docs: ector_gl: fill gaps in ector gl backend eo file documentation
Diffstat (limited to 'src/lib/ector')
-rw-r--r-- | src/lib/ector/gl/ector_gl_buffer.eo | 1 | ||||
-rw-r--r-- | src/lib/ector/gl/ector_gl_buffer_base.eo | 24 | ||||
-rw-r--r-- | src/lib/ector/gl/ector_gl_surface.eo | 24 | ||||
-rw-r--r-- | src/lib/ector/gl/ector_renderer_gl.eo | 12 | ||||
-rw-r--r-- | src/lib/ector/gl/ector_renderer_gl_gradient_linear.eo | 1 | ||||
-rw-r--r-- | src/lib/ector/gl/ector_renderer_gl_gradient_radial.eo | 1 | ||||
-rw-r--r-- | src/lib/ector/gl/ector_renderer_gl_shape.eo | 1 |
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 @@ class Ector.GL.Buffer (Efl.Object, Ector.GL.Buffer.Base) { + [[Ector GL buffer class]] data: null; } 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) ]] get {} values { - is_whole: bool; + is_whole: bool; [[$true if the image is covering the whole GL texture, $false otherwise]] } } @property vertices { @@ -43,17 +43,17 @@ mixin Ector.GL.Buffer.Base (Ector.Buffer) params { texid: int; [[GL texture ID]] fboid: int; [[Framebuffer object ID]] - cspace: Efl.Gfx.Colorspace; - imw: int; - imh: int; - tx: int; - ty: int; - tw: int; - th: int; - l: int; - r: int; - t: int; - b: int; + cspace: Efl.Gfx.Colorspace; [[Colorspace]] + imw: int; [[Image width]] + imh: int; [[Image height]] + tx: int; [[Texture X coordinate]] + ty: int; [[Texture Y coordinate]] + tw: int; [[Texture width]] + th: int; [[Texture height]] + l: int; [[Left padding]] + r: int; [[Right padding]] + t: int; [[Top padding]] + b: int; [[Bottom padding]] } } } 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; class Ector.GL.Surface (Ector.GL.Buffer, Ector.Surface) { + [[Ector GL surface class]] eo_prefix: ector_gl_surface; methods { shader_get { - return: uint; + [[Get shader]] + return: uint; [[Shader count]] params { - @in flags: uint64; + @in flags: uint64; [[Flags]] } } push { - return: bool; + [[Push surface to GPU]] + return: bool; [[$true on success, $false otherwise]] params { - @in flags: uint64; - @in vertex: ptr(GLshort); - @in vertex_count: uint; - @in mul_col: uint; + @in flags: uint64; [[GL flags]] + @in vertex: ptr(GLshort); [[GL vertex]] + @in vertex_count: uint; [[GL vertex count]] + @in mul_col: uint; [[Premultiplied color]] } } state_define { - return: bool; + [[Define state]] + return: bool; [[$true on success, $false otherwise]] params { - @in op: Efl.Gfx.Render_Op; - @in clips: array<ptr(Eina.Rectangle)>; [[array of @Eina.Rectangle clip]] + @in op: Efl.Gfx.Render_Op; [[Render operation]] + @in clips: array<ptr(Eina.Rectangle)>; [[Array of @Eina.Rectangle clip]] } } } 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; abstract Ector.Renderer.GL (Ector.Renderer) { + [[Ector GL renderer abstract class]] methods { fill @virtual_pure { - return: bool; + [[Fill operation]] + return: bool; [[$true on success, $false otherwise]] params { - @in flags: uint64; - @in vertex: ptr(GLshort); - @in vertex_count: uint; - @in mul_col: uint; + @in flags: uint64; [[GL flags]] + @in vertex: ptr(GLshort); [[GL vertex]] + @in vertex_count: uint; [[GL vertex count]] + @in mul_col: uint; [[Premultiplied color]] } } } 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 @@ class Ector.Renderer.GL.Gradient.Linear (Ector.Renderer.GL, Ector.Renderer.Gradient, Ector.Renderer.Gradient.Linear) { + [[Ector GL renderer gradient linear]] eo_prefix: ector_renderer_gl_gradient_linear; implements { 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 @@ class Ector.Renderer.GL.Gradient.Radial (Ector.Renderer.GL, Ector.Renderer.Gradient, Ector.Renderer.Gradient.Radial) { + [[Ector GL renderer gradient radial]] eo_prefix: ector_renderer_gl_gradient_radial; implements { 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 @@ class Ector.Renderer.GL.Shape (Ector.Renderer.GL, Ector.Renderer.Shape) { + [[Ector GL renderer shape class]] eo_prefix: ector_renderer_gl_shape; implements { Ector.Renderer.prepare; |