Move server-buffer example to manual tests

This is undocumented and demonstrates an experimental feature which
was never maintained or exercised. It's a nice feature, so we keep
the example around for when we get the time to bring it back.

Task-number: QTBUG-110993
Change-Id: I045cb2ef02a50017a26226c493607100ea0f1b95
Reviewed-by: Inho Lee <inho.lee@qt.io>
(cherry picked from commit acb68bd3bbbc0001bcf460dd175ff92cc3ce594a)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>

1 files changed, 32 insertions, 0 deletions

diff --git a/tests/manual/server-buffer/README b/tests/manual/server-buffer/README
new file mode 100644
index 00000000..da20b0f5
--- /dev/null
+++ b/tests/manual/server-buffer/README
@@ -0,0 +1,32 @@
+This example shows how to use the low-level server buffer extension. This
+version of Qt also provides a texture sharing extension that provides more
+functionality and convenience for sharing graphical assets with Qt Quick
+clients: see the texture-sharing example.
+
+Compile up both compositor and client.
+
+If you have the dmabuf-server buffer integration (and you are running Mesa)
+then start the compositor with:
+
+$ QT_WAYLAND_SERVER_BUFFER_INTEGRATION=dmabuf-server ./compositor
+
+
+Note: if you are running a compositor on an X11 desktop, you also need to
+set QT_XCB_GL_INTEGRATION=xcb_egl as usual.
+
+The compositor broadcasts the name of the server buffer integration to
+all clients through the hardware integration extension. Therefore,
+all you need to do is to start the client with
+
+$ ./cpp-client -platform wayland
+
+The client will show all the buffers shared by the compositor.
+
+For testing on desktop, there is also a shared memory based server buffer
+integration that works with any graphics hardware:
+
+$ QT_WAYLAND_SERVER_BUFFER_INTEGRATION=shm-emulation-server QT_XCB_GL_INTEGRATION=xcb_egl ./compositor
+
+Note: the shm-emulation-server integration does not actually share graphics
+buffers, so it will not give any graphics memory savings. It is intended solely
+for testing during development and should never be used in production.