aboutsummaryrefslogtreecommitdiffstats
path: root/pages/develop/api/efl/gfx/buffer/method
diff options
context:
space:
mode:
Diffstat (limited to 'pages/develop/api/efl/gfx/buffer/method')
-rw-r--r--pages/develop/api/efl/gfx/buffer/method/buffer_copy_set.txt26
-rw-r--r--pages/develop/api/efl/gfx/buffer/method/buffer_managed_get.txt14
-rw-r--r--pages/develop/api/efl/gfx/buffer/method/buffer_managed_set.txt26
-rw-r--r--pages/develop/api/efl/gfx/buffer/method/buffer_map.txt18
-rw-r--r--pages/develop/api/efl/gfx/buffer/method/buffer_unmap.txt22
-rw-r--r--pages/develop/api/efl/gfx/buffer/method/buffer_update_add.txt14
6 files changed, 60 insertions, 60 deletions
diff --git a/pages/develop/api/efl/gfx/buffer/method/buffer_copy_set.txt b/pages/develop/api/efl/gfx/buffer/method/buffer_copy_set.txt
index 985e7d486..30c5a9940 100644
--- a/pages/develop/api/efl/gfx/buffer/method/buffer_copy_set.txt
+++ b/pages/develop/api/efl/gfx/buffer/method/buffer_copy_set.txt
@@ -1,4 +1,17 @@
~~Title: Efl.Gfx.Buffer.buffer_copy_set~~
+===== Description =====
+
+%%Set the pixels for this buffer by copying them, or allocate a new memory region.%%
+
+%%This will allocate a new buffer in memory and copy the input %%''pixels''%% to it. The internal colorspace is not guaranteed to be preserved, and colorspace conversion may happen internally.%%
+
+%%If %%''pixels''%% is %%''null''%%, then a new empty buffer will be allocated. If the buffer already had pixel data, the previous image data will be dropped. This is the same as %%[[:develop:api:efl:gfx:buffer:method:buffer_managed_set|Efl.Gfx.Buffer.buffer_managed_set]]%%.%%
+
+%%The memory buffer %%''pixels''%% must be large enough to hold %%''width''%% x %%''height''%% pixels encoded in the colorspace %%''cspace''%%.%%
+
+%%%%''slice''%% should not be the return value of %%[[:develop:api:efl:gfx:buffer:method:buffer_managed_get|Efl.Gfx.Buffer.buffer_managed_get]]%%.%%
+{{page>:develop:api-include:efl:gfx:buffer:method:buffer_copy_set:description&nouser&nolink&nodate}}
+
===== Signature =====
<code>
@@ -28,19 +41,6 @@ Eina_Bool efl_gfx_buffer_copy_set(Eo *obj, const Eina_Slice *slice, Eina_Size2D
* **cspace** //(in)// - %%argb8888 by default.%%
* **plane** //(in)// - %%Plane ID. 0 by default. Useful for planar formats only.%%
-===== Description =====
-
-%%Set the pixels for this buffer by copying them, or allocate a new memory region.%%
-
-%%This will allocate a new buffer in memory and copy the input %%''pixels''%% to it. The internal colorspace is not guaranteed to be preserved, and colorspace conversion may happen internally.%%
-
-%%If %%''pixels''%% is %%''null''%%, then a new empty buffer will be allocated. If the buffer already had pixel data, the previous image data will be dropped. This is the same as %%[[:develop:api:efl:gfx:buffer:method:buffer_managed_set|Efl.Gfx.Buffer.buffer_managed_set]]%%.%%
-
-%%The memory buffer %%''pixels''%% must be large enough to hold %%''width''%% x %%''height''%% pixels encoded in the colorspace %%''cspace''%%.%%
-
-%%%%''slice''%% should not be the return value of %%[[:develop:api:efl:gfx:buffer:method:buffer_managed_get|Efl.Gfx.Buffer.buffer_managed_get]]%%.%%
-{{page>:develop:api-include:efl:gfx:buffer:method:buffer_copy_set:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* **Efl.Gfx.Buffer.buffer_copy_set**
diff --git a/pages/develop/api/efl/gfx/buffer/method/buffer_managed_get.txt b/pages/develop/api/efl/gfx/buffer/method/buffer_managed_get.txt
index f9f8d1021..70985a319 100644
--- a/pages/develop/api/efl/gfx/buffer/method/buffer_managed_get.txt
+++ b/pages/develop/api/efl/gfx/buffer/method/buffer_managed_get.txt
@@ -1,4 +1,11 @@
~~Title: Efl.Gfx.Buffer.buffer_managed_get~~
+===== Description =====
+
+%%Get a direct pointer to the internal pixel data, if available.%%
+
+%%This will return %%''null''%% unless %%[[:develop:api:efl:gfx:buffer:method:buffer_managed_set|Efl.Gfx.Buffer.buffer_managed_set]]%% was used to pass in an external data pointer.%%
+{{page>:develop:api-include:efl:gfx:buffer:method:buffer_managed_get:description&nouser&nolink&nodate}}
+
===== Signature =====
<code>
@@ -20,13 +27,6 @@ Eina_Slice efl_gfx_buffer_managed_get(Eo *obj, int plane);
* **plane** //(in)// - %%Plane ID. 0 by default. Useful for planar formats only.%%
-===== Description =====
-
-%%Get a direct pointer to the internal pixel data, if available.%%
-
-%%This will return %%''null''%% unless %%[[:develop:api:efl:gfx:buffer:method:buffer_managed_set|Efl.Gfx.Buffer.buffer_managed_set]]%% was used to pass in an external data pointer.%%
-{{page>:develop:api-include:efl:gfx:buffer:method:buffer_managed_get:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* **Efl.Gfx.Buffer.buffer_managed_get**
diff --git a/pages/develop/api/efl/gfx/buffer/method/buffer_managed_set.txt b/pages/develop/api/efl/gfx/buffer/method/buffer_managed_set.txt
index 269ba4756..812b75750 100644
--- a/pages/develop/api/efl/gfx/buffer/method/buffer_managed_set.txt
+++ b/pages/develop/api/efl/gfx/buffer/method/buffer_managed_set.txt
@@ -1,4 +1,17 @@
~~Title: Efl.Gfx.Buffer.buffer_managed_set~~
+===== Description =====
+
+%%Set the pixels for this buffer, managed externally by the client.%%
+
+%%EFL will use the pixel data directly, and update the GPU-side texture if required. This will mark the image as dirty. If %%''slice''%% is %%''null''%%, this will detach the pixel data.%%
+
+%%If the buffer already had pixel data, the previous image data will be dropped. This is the same as %%[[:develop:api:efl:gfx:buffer:method:buffer_copy_set|Efl.Gfx.Buffer.buffer_copy_set]]%%.%%
+
+%%The memory buffer %%''pixels''%% must be large enough to hold %%''width''%% x %%''height''%% pixels encoded in the colorspace %%''cspace''%%.%%
+
+%%See also %%[[:develop:api:efl:gfx:buffer:method:buffer_copy_set|Efl.Gfx.Buffer.buffer_copy_set]]%% if you want EFL to copy the input buffer internally.%%
+{{page>:develop:api-include:efl:gfx:buffer:method:buffer_managed_set:description&nouser&nolink&nodate}}
+
===== Signature =====
<code>
@@ -28,19 +41,6 @@ Eina_Bool efl_gfx_buffer_managed_set(Eo *obj, const Eina_Slice *slice, Eina_Size
* **cspace** //(in)// - %%argb8888 by default.%%
* **plane** //(in)// - %%Plane ID. 0 by default. Useful for planar formats only.%%
-===== Description =====
-
-%%Set the pixels for this buffer, managed externally by the client.%%
-
-%%EFL will use the pixel data directly, and update the GPU-side texture if required. This will mark the image as dirty. If %%''slice''%% is %%''null''%%, this will detach the pixel data.%%
-
-%%If the buffer already had pixel data, the previous image data will be dropped. This is the same as %%[[:develop:api:efl:gfx:buffer:method:buffer_copy_set|Efl.Gfx.Buffer.buffer_copy_set]]%%.%%
-
-%%The memory buffer %%''pixels''%% must be large enough to hold %%''width''%% x %%''height''%% pixels encoded in the colorspace %%''cspace''%%.%%
-
-%%See also %%[[:develop:api:efl:gfx:buffer:method:buffer_copy_set|Efl.Gfx.Buffer.buffer_copy_set]]%% if you want EFL to copy the input buffer internally.%%
-{{page>:develop:api-include:efl:gfx:buffer:method:buffer_managed_set:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* **Efl.Gfx.Buffer.buffer_managed_set**
diff --git a/pages/develop/api/efl/gfx/buffer/method/buffer_map.txt b/pages/develop/api/efl/gfx/buffer/method/buffer_map.txt
index 6258838b7..81c23cc6c 100644
--- a/pages/develop/api/efl/gfx/buffer/method/buffer_map.txt
+++ b/pages/develop/api/efl/gfx/buffer/method/buffer_map.txt
@@ -1,4 +1,13 @@
~~Title: Efl.Gfx.Buffer.buffer_map~~
+===== Description =====
+
+%%Map a region of this buffer for read or write access by the CPU.%%
+
+%%Fetches data from the GPU if needed. This operation may be slow if cpu_readable_fast or cpu_writeable_fast are not true, or if the required colorspace is different from the internal one.%%
+
+%%Note that if the buffer has %%[[:develop:api:efl:gfx:buffer:property:buffer_borders|Efl.Gfx.Buffer.buffer_borders]]%%, then %%''x''%% and %%''y''%% may be negative.%%
+{{page>:develop:api-include:efl:gfx:buffer:method:buffer_map:description&nouser&nolink&nodate}}
+
===== Signature =====
<code>
@@ -28,15 +37,6 @@ Eina_Rw_Slice efl_gfx_buffer_map(Eo *obj, Efl_Gfx_Buffer_Access_Mode mode, const
* **plane** //(in)// - %%Plane ID. 0 by default. Useful for planar formats only.%%
* **stride** //(out)// - %%Returns the length in bytes of a mapped line%%
-===== Description =====
-
-%%Map a region of this buffer for read or write access by the CPU.%%
-
-%%Fetches data from the GPU if needed. This operation may be slow if cpu_readable_fast or cpu_writeable_fast are not true, or if the required colorspace is different from the internal one.%%
-
-%%Note that if the buffer has %%[[:develop:api:efl:gfx:buffer:property:buffer_borders|Efl.Gfx.Buffer.buffer_borders]]%%, then %%''x''%% and %%''y''%% may be negative.%%
-{{page>:develop:api-include:efl:gfx:buffer:method:buffer_map:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* **Efl.Gfx.Buffer.buffer_map**
diff --git a/pages/develop/api/efl/gfx/buffer/method/buffer_unmap.txt b/pages/develop/api/efl/gfx/buffer/method/buffer_unmap.txt
index ca4f4d059..f86792bed 100644
--- a/pages/develop/api/efl/gfx/buffer/method/buffer_unmap.txt
+++ b/pages/develop/api/efl/gfx/buffer/method/buffer_unmap.txt
@@ -1,4 +1,15 @@
~~Title: Efl.Gfx.Buffer.buffer_unmap~~
+===== Description =====
+
+%%Unmap a region of this buffer, and update the internal data if needed.%%
+
+%%EFL will update the internal image if the map had write access.%%
+
+<note>
+%%The %%''slice''%% struct does not need to be the one returned by %%[[:develop:api:efl:gfx:buffer:method:buffer_map|Efl.Gfx.Buffer.buffer_map]]%%, only its contents (%%''mem''%% and %%''len''%%) must match. But after a call to %%[[:develop:api:efl:gfx:buffer:method:buffer_unmap|Efl.Gfx.Buffer.buffer_unmap]]%% the original %%''slice''%% structure is not valid anymore.%%
+</note>
+{{page>:develop:api-include:efl:gfx:buffer:method:buffer_unmap:description&nouser&nolink&nodate}}
+
===== Signature =====
<code>
@@ -20,17 +31,6 @@ Eina_Bool efl_gfx_buffer_unmap(Eo *obj, Eina_Rw_Slice slice);
* **slice** //(in)// - %%Data slice returned by a previous call to map.%%
-===== Description =====
-
-%%Unmap a region of this buffer, and update the internal data if needed.%%
-
-%%EFL will update the internal image if the map had write access.%%
-
-<note>
-%%The %%''slice''%% struct does not need to be the one returned by %%[[:develop:api:efl:gfx:buffer:method:buffer_map|Efl.Gfx.Buffer.buffer_map]]%%, only its contents (%%''mem''%% and %%''len''%%) must match. But after a call to %%[[:develop:api:efl:gfx:buffer:method:buffer_unmap|Efl.Gfx.Buffer.buffer_unmap]]%% the original %%''slice''%% structure is not valid anymore.%%
-</note>
-{{page>:develop:api-include:efl:gfx:buffer:method:buffer_unmap:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* **Efl.Gfx.Buffer.buffer_unmap**
diff --git a/pages/develop/api/efl/gfx/buffer/method/buffer_update_add.txt b/pages/develop/api/efl/gfx/buffer/method/buffer_update_add.txt
index d53de1d1d..1751cd254 100644
--- a/pages/develop/api/efl/gfx/buffer/method/buffer_update_add.txt
+++ b/pages/develop/api/efl/gfx/buffer/method/buffer_update_add.txt
@@ -1,4 +1,11 @@
~~Title: Efl.Gfx.Buffer.buffer_update_add~~
+===== Description =====
+
+%%Mark a sub-region of the given image object to be redrawn.%%
+
+%%This function schedules a particular rectangular region of an image object to be updated (redrawn) at the next rendering cycle.%%
+{{page>:develop:api-include:efl:gfx:buffer:method:buffer_update_add:description&nouser&nolink&nodate}}
+
===== Signature =====
<code>
@@ -19,13 +26,6 @@ void efl_gfx_buffer_update_add(Eo *obj, const Eina_Rect *region);
* **region** //(in)// - %%The updated region.%%
-===== Description =====
-
-%%Mark a sub-region of the given image object to be redrawn.%%
-
-%%This function schedules a particular rectangular region of an image object to be updated (redrawn) at the next rendering cycle.%%
-{{page>:develop:api-include:efl:gfx:buffer:method:buffer_update_add:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* **Efl.Gfx.Buffer.buffer_update_add**