aboutsummaryrefslogtreecommitdiffstats
path: root/pages/develop/api/efl/gfx/buffer.txt
diff options
context:
space:
mode:
Diffstat (limited to 'pages/develop/api/efl/gfx/buffer.txt')
-rw-r--r--pages/develop/api/efl/gfx/buffer.txt77
1 files changed, 33 insertions, 44 deletions
diff --git a/pages/develop/api/efl/gfx/buffer.txt b/pages/develop/api/efl/gfx/buffer.txt
index d2aa1cd19..15b079532 100644
--- a/pages/develop/api/efl/gfx/buffer.txt
+++ b/pages/develop/api/efl/gfx/buffer.txt
@@ -35,85 +35,74 @@ digraph hierarchy {
++++
===== Members =====
-**[[:develop:api:efl:gfx:buffer:method:buffer_copy_set|buffer_copy_set]]**
+**[[:develop:api:efl:gfx:buffer:method:buffer_copy_set|buffer_copy_set]]**\\
+> %%Set the pixels for this buffer by copying them, or allocate a new memory region.%%
<code c>
Eina_Bool efl_gfx_buffer_copy_set(Eo *obj, const Eina_Slice *slice, Eina_Size2D size, int stride, Efl_Gfx_Colorspace cspace, int plane);
</code>
-
-%%Set the pixels for this buffer by copying them, or allocate a new memory region.%%\\
-\\
-**[[:develop:api:efl:gfx:buffer:method:buffer_managed_get|buffer_managed_get]]**
+\\
+**[[:develop:api:efl:gfx:buffer:method:buffer_managed_get|buffer_managed_get]]**\\
+> %%Get a direct pointer to the internal pixel data, if available.%%
<code c>
Eina_Slice efl_gfx_buffer_managed_get(Eo *obj, int plane);
</code>
-
-%%Get a direct pointer to the internal pixel data, if available.%%\\
-\\
-**[[:develop:api:efl:gfx:buffer:method:buffer_managed_set|buffer_managed_set]]**
+\\
+**[[:develop:api:efl:gfx:buffer:method:buffer_managed_set|buffer_managed_set]]**\\
+> %%Set the pixels for this buffer, managed externally by the client.%%
<code c>
Eina_Bool efl_gfx_buffer_managed_set(Eo *obj, const Eina_Slice *slice, Eina_Size2D size, int stride, Efl_Gfx_Colorspace cspace, int plane);
</code>
-
-%%Set the pixels for this buffer, managed externally by the client.%%\\
-\\
-**[[:develop:api:efl:gfx:buffer:method:buffer_map|buffer_map]]**
+\\
+**[[:develop:api:efl:gfx:buffer:method:buffer_map|buffer_map]]**\\
+> %%Map a region of this buffer for read or write access by the CPU.%%
<code c>
Eina_Rw_Slice efl_gfx_buffer_map(Eo *obj, Efl_Gfx_Buffer_Access_Mode mode, const Eina_Rect *region, Efl_Gfx_Colorspace cspace, int plane, int *stride);
</code>
-
-%%Map a region of this buffer for read or write access by the CPU.%%\\
-\\
-**[[:develop:api:efl:gfx:buffer:method:buffer_unmap|buffer_unmap]]**
+\\
+**[[:develop:api:efl:gfx:buffer:method:buffer_unmap|buffer_unmap]]**\\
+> %%Unmap a region of this buffer, and update the internal data if needed.%%
<code c>
Eina_Bool efl_gfx_buffer_unmap(Eo *obj, Eina_Rw_Slice slice);
</code>
-
-%%Unmap a region of this buffer, and update the internal data if needed.%%\\
-\\
-**[[:develop:api:efl:gfx:buffer:method:buffer_update_add|buffer_update_add]]**
+\\
+**[[:develop:api:efl:gfx:buffer:method:buffer_update_add|buffer_update_add]]**\\
+> %%Mark a sub-region of the given image object to be redrawn.%%
<code c>
void efl_gfx_buffer_update_add(Eo *obj, const Eina_Rect *region);
</code>
-
-%%Mark a sub-region of the given image object to be redrawn.%%\\
-\\
-**[[:develop:api:efl:gfx:buffer:property:alpha|alpha]]** //**(get, set)**//
+\\
+**[[:develop:api:efl:gfx:buffer:property:alpha|alpha]]** //**(get, set)**//\\
+> %%Indicates whether the alpha channel should be used.%%
<code c>
Eina_Bool efl_gfx_buffer_alpha_get(const Eo *obj);
void efl_gfx_buffer_alpha_set(Eo *obj, Eina_Bool alpha);
</code>
-
-%%Indicates whether the alpha channel should be used.%%\\
-\\
-**[[:develop:api:efl:gfx:buffer:property:buffer_borders|buffer_borders]]** //**(get)**//
+\\
+**[[:develop:api:efl:gfx:buffer:property:buffer_borders|buffer_borders]]** //**(get)**//\\
+> %%Duplicated pixel borders inside this buffer.%%
<code c>
void efl_gfx_buffer_borders_get(const Eo *obj, unsigned int *l, unsigned int *r, unsigned int *t, unsigned int *b);
</code>
-
-%%Duplicated pixel borders inside this buffer.%%\\
-\\
-**[[:develop:api:efl:gfx:buffer:property:buffer_size|buffer_size]]** //**(get, set)**//
+\\
+**[[:develop:api:efl:gfx:buffer:property:buffer_size|buffer_size]]** //**(get, set)**//\\
+> %%Rectangular size of the pixel buffer as allocated in memory.%%
<code c>
Eina_Size2D efl_gfx_buffer_size_get(const Eo *obj);
void efl_gfx_buffer_size_set(Eo *obj, Eina_Size2D sz);
</code>
-
-%%Rectangular size of the pixel buffer as allocated in memory.%%\\
-\\
-**[[:develop:api:efl:gfx:buffer:property:colorspace|colorspace]]** //**(get)**//
+\\
+**[[:develop:api:efl:gfx:buffer:property:colorspace|colorspace]]** //**(get)**//\\
+> %%The colorspace defines how pixels are encoded in the image in memory.%%
<code c>
Efl_Gfx_Colorspace efl_gfx_buffer_colorspace_get(const Eo *obj);
</code>
-
-%%The colorspace defines how pixels are encoded in the image in memory.%%\\
-\\
-**[[:develop:api:efl:gfx:buffer:property:stride|stride]]** //**(get)**//
+\\
+**[[:develop:api:efl:gfx:buffer:property:stride|stride]]** //**(get)**//\\
+> %%Length in bytes of one row of pixels in memory.%%
<code c>
int efl_gfx_buffer_stride_get(const Eo *obj);
</code>
-
-%%Length in bytes of one row of pixels in memory.%%\\
-\\
+\\
===== Events =====