From 4dd1eac7c46f7be257ce10cb2ce6b79939650938 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Sat, 28 May 2022 23:11:51 -0400 Subject: Update documentation --- examples/README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 examples/README.md (limited to 'examples/README.md') diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..20538c3 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,31 @@ +These programs serve as demonstrations, and as utilities for manual testing. + + * `pugl_embed_demo` shows a view embedded in another, and also tests + requesting attention (which happens after 5 seconds), keyboard focus + (switched by pressing tab), view moving (with the arrow keys), and view + resizing (with the arrow keys while shift is held). This program uses only + very old OpenGL and should work on any system. + + * `pugl_window_demo` demonstrates multiple top-level windows. + + * `pugl_shader_demo` demonstrates using more modern OpenGL (version 3 or 4) + where dynamic loading and shaders are required. It can also be used to test + performance by passing the number of rectangles to draw on the command line. + + * `pugl_cairo_demo` demonstrates using Cairo on top of the native windowing + system (without OpenGL), and partial redrawing. + + * `pugl_print_events` is a utility that prints all received events to the + console in a human readable format. + + * `pugl_cpp_demo` is a simple cube demo that uses the C++ API. + + * `pugl_vulkan_demo` is a simple example of using Vulkan in C that simply + clears the window. + + * `pugl_vulkan_cpp_demo` is a more advanced Vulkan demo in C++ that draws many + animated rectangles like `pugl_shader_demo`. + +All example programs support several command line options to control various +behaviours, see the output of `--help` for details. Please file an issue if +any of these programs do not work as expected on your system. -- cgit v1.2.1