mirror of
https://gitlab.freedesktop.org/mesa/mesa.git
synced 2026-05-18 22:28:06 +02:00
eda55c7c2f
This change adds a Vulkan screenshot layer that allows users to take screenshots from a Vulkan application, but has an emphasis on performance, decreasing the performance impact on the application involved. This allows for automated setups to use this layer to take screenshots for navigating various in-application menus. This layer works by hooking into various common Vulkan setup functions, until it enters the vkQueuePresentKHR function, and from there it copies the current frame's image from the swapchain as an RGB image to host-cached memory, where we will receive the information as a framebuffer pointer. From there, we copy the framebuffer contents to a thread that will detach from the main process so it can write the image to a PNG file without holding back the main thread. This layer was created from using the existing overlay layer as a template, then adding portions of LunarG's VulkanTools screenshot layer: https://github.com/LunarG/VulkanTools/blob/main/layersvt/screenshot.cpp More specifically, there were usages of functions, along with modifications of various functions from screenshot.cpp in the VulkanTools project, used in screenshot.cpp. There are some sections of the screenshotting functionality that remain unmodified from the original screenshot.cpp file in VulkanTools, including the global locking structures and the writeFile() function, which takes care of obtaining the images from the swapchain. There were various areas in which modifications were made, including how images are written to a file (using PNG instead of PPM, introducing threading, added fences/semaphores, etc), along with many smaller changes. v2: Fix segfault upon application exit v3: Fix filename issue with concatenation, along with some leftover memory handling that wasn't cleaned up. v4: Fix some error handling and nits v5: Fix output directory handling Reviewed-by: Ivan Briano <ivan.briano@intel.com Signed-off-by: Casey Bowman <casey.g.bowman@intel.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/30527> |
||
|---|---|---|
| .. | ||
| LICENSE.txt | ||
| mesa-screenshot-control.py | ||
| meson.build | ||
| README.rst | ||
| screenshot.cpp | ||
| screenshot_params.c | ||
| screenshot_params.h | ||
| VkLayer_MESA_screenshot.json | ||
A Vulkan layer to display information about the running application using an overlay. Building ======== The overlay layer will be built if :code:`screenshot` is passed as a :code:`vulkan-layers` argument. For example: .. code-block:: sh meson -Dvulkan-layers=device-select,screenshot builddir/ ninja -C builddir/ sudo ninja -C builddir/ install See `docs/install.rst <https://gitlab.freedesktop.org/mesa/mesa/-/blob/master/docs/install.rst>`__ for more information. Basic Usage =========== Turn on the layer: .. code-block:: sh VK_LOADER_LAYERS_ENABLE=VK_LAYER_MESA_screenshot /path/to/my_vulkan_app List the help menu: .. code-block:: sh VK_LOADER_LAYERS_ENABLE=VK_LAYER_MESA_screenshot VK_LAYER_MESA_SCREENSHOT_CONFIG=help /path/to/my_vulkan_app Enable log output in stdout/stderr: .. code-block:: sh VK_LOADER_LAYERS_ENABLE=VK_LAYER_MESA_screenshot VK_LAYER_MESA_SCREENSHOT_CONFIG=log_type=<info|debug> /path/to/my_vulkan_app Redirect screenshots taken to a different directory: .. code-block:: sh VK_LOADER_LAYERS_ENABLE=VK_LAYER_MESA_screenshot VK_LAYER_MESA_SCREENSHOT_CONFIG=output_dir=/path/to/new_dir /path/to/my_vulkan_app Capture pre-determined screenshots: .. code-block:: sh VK_LOADER_LAYERS_ENABLE=VK_LAYER_MESA_screenshot VK_LAYER_MESA_SCREENSHOT_CONFIG=frames=1/5/7/15-4-5 /path/to/my_vulkan_app Note: - Individual frames are separated by '/' and must be listed before the frame range - The frame range is determined by <range start>-<range count>-<range interval> - Example: '1/5/7/15-4-5' gives individual frames [1,5,7], then the frame range gives [15,20,25,30], combining into [1,5,7,15,20,25,30] To capture all frames: .. code-block:: sh VK_LOADER_LAYERS_ENABLE=VK_LAYER_MESA_screenshot VK_LAYER_MESA_SCREENSHOT_CONFIG=frames=all /path/to/my_vulkan_app Direct Socket Control --------------------- Enabling communication with the client can be done with the following setup: .. code-block:: sh VK_LOADER_LAYERS_ENABLE=VK_LAYER_MESA_screenshot VK_LAYER_MESA_SCREENSHOT_CONFIG=comms /path/to/my_vulkan_app The Unix socket may be used directly if needed. Once a client connects to the socket, the overlay layer will immediately send the following commands to the client: .. code-block:: sh :MesaOverlayControlVersion=1; :DeviceName=<device name>; :MesaVersion=<mesa version>; The client connected to the overlay layer can trigger a screenshot to be taken by sending the command: .. code-block:: sh :capture=<screenshot_name.png>; Note that the screenshot name must include '.png', other image types are not supported. .. _docs/install.rst: ../../docs/install.rst