From: Erik Faye-Lund Date: Sun, 19 Jul 2020 10:13:40 +0000 (+0200) Subject: docs: add some very basic documentation about zink X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=fd20e986249f88129d81353d79dd248d7664953b;p=mesa.git docs: add some very basic documentation about zink Reviewed-by: Eric Engestrom Reviewed-By: Mike Blumenkrantz Reviewed-by: Marcin Ślusarz Part-of: --- diff --git a/docs/gallium/drivers/zink.rst b/docs/gallium/drivers/zink.rst new file mode 100644 index 00000000000..0756c52b232 --- /dev/null +++ b/docs/gallium/drivers/zink.rst @@ -0,0 +1,45 @@ +Zink +==== + +Overview +-------- + +The Zink driver is a Gallium driver that emits Vulkan API calls instead +of targeting a specific GPU architecture. This can be used to get full +desktop OpenGL support on devices that only support Vulkan. + +Debugging +--------- + +There's a few tools that are useful for debugging Zink, like this environment +variable: + +.. envvar:: ZINK_DEBUG ("") + +``nir`` + Print the NIR form of all shaders to stderr. +``spirv`` + Write the binary SPIR-V form of all compiled shaders to a file in the + current directory, and print a message with the filename to stderr. +``tgsi`` + Print the TGSI form of TGSI shaders to stderr. + +Vulkan Validation Layers +^^^^^^^^^^^^^^^^^^^^^^^^ + +Another useful tool for debugging is the `Vulkan Validation Layers +`_. + +The validation layers effectively insert extra checking between Zink and the +Vulkan driver, pointing out incorrect usage of the Vulkan API. The layers can +be enabled by setting the environment variable :envvar:`VK_INSTANCE_LAYERS` to +"VK_LAYER_KHRONOS_validation". You can read more about the Validation Layers +in the link above. + +IRC +--- + +In order to make things a bit easier to follow, we have decided to create our +own IRC channel. If you're interested in contributing, or have any technical +questions, don't hesitate to visit `#zink on FreeNode +`_ and say hi!