summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2015-01-27 16:32:16 -0800
committerBryce Harrington <bryce@osg.samsung.com>2015-02-04 21:49:30 -0800
commit310fea467cf714d3ed7d66747c463790246f9be1 (patch)
tree9740f06b277a18bed6b8ee910176b408290ed0bb
parent8094426a4168b78b924210e97ef178c78c1d296f (diff)
downloadwayland-310fea467cf714d3ed7d66747c463790246f9be1.tar.gz
doc: Fill in high level description for Surfaces
Signed-off-by: Bryce Harrington <bryce@osg.samsung.com> Reviewed-by: Jon A. Cruz <jonc@osg.samsung.com>
-rw-r--r--doc/publican/sources/Protocol.xml13
1 files changed, 10 insertions, 3 deletions
diff --git a/doc/publican/sources/Protocol.xml b/doc/publican/sources/Protocol.xml
index 5f3e852..477063b 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-wl_surface"/> for the protocol