[PATCH wayland v2] doc: Fill in high level description for Surfaces

Bryce Harrington bryce at osg.samsung.com
Tue Jan 27 16:32:16 PST 2015


Signed-off-by: Bryce Harrington <bryce at osg.samsung.com>
---
 doc/publican/sources/Protocol.xml | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/doc/publican/sources/Protocol.xml b/doc/publican/sources/Protocol.xml
index b79b6be..d2d7a7e 100644
--- a/doc/publican/sources/Protocol.xml
+++ b/doc/publican/sources/Protocol.xml
@@ -282,9 +282,16 @@
   <section id="sect-Protocol-Surface">
     <title>Surfaces</title>
     <para>
-      Surfaces are created by the client.
-      Clients don't know the global position of their surfaces, and
-      cannot access other clients surfaces.
+      A surface manages a rectangular grid of pixels that clients create
+      for displaying their content to the screen.  Clients don't know
+      the global position of their surfaces, and cannot access other
+      clients' surfaces.
+    </para>
+    <para>
+      Once the client has finished writing pixels, it 'commits' the
+      buffer; this permits the compositor to access the buffer and read
+      the pixels.  When the compositor is finished, it releases the
+      buffer back to the client.
     </para>
     <para>
       See <xref linkend="protocol-spec-interface-wl_surface"/> for the protocol
-- 
1.9.1



More information about the wayland-devel mailing list