From 2743adac7fd58649caa4e455643520efcbaf1b2c Mon Sep 17 00:00:00 2001 From: "duncan.hopkins" Date: Fri, 22 Mar 2024 09:07:58 +0000 Subject: [PATCH] zink/apple: update docs to reflect the current status of Zink on macOS. Adds extra information to the "Notes for macOS" and "Zink" documentation pages to: 1) Better describe how to build on macOS 2) Temper expectations on running Zink on macOSx Closes: https://gitlab.freedesktop.org/mesa/mesa/-/issues/10768 Acked-by: Mike Blumenkrantz Part-of: --- docs/drivers/zink.rst | 10 ++++++++++ docs/macos.rst | 5 +++-- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/drivers/zink.rst b/docs/drivers/zink.rst index 6efa63e2e1d..db008fcf813 100644 --- a/docs/drivers/zink.rst +++ b/docs/drivers/zink.rst @@ -332,6 +332,16 @@ 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. +Apple macOS and MoltenVK +------------------------ + +Zink on macOS is experimental with very limited capabilities. +The Vulkan SDK (1.3.250 or newer) is required to build Zink. +Set the build option ``-Dmoltenvk-dir=`` to point at your Vulkan SDK install or MoltenVK build. +Add Zink to the Gallium drivers build option ``-Dgallium-drivers=zink``. +If installed using ``brew``, you can set ``-D moltenvk-dir=$(brew --prefix molten-vk)``. + + IRC --- diff --git a/docs/macos.rst b/docs/macos.rst index c74ee394aa5..f717185eec5 100644 --- a/docs/macos.rst +++ b/docs/macos.rst @@ -20,5 +20,6 @@ hardware-accelerated system OpenGL framework, to provide hardware acceleration to X11 applications on macOS running via XQuartz. Mesa's software rasterizers also work on macOS. To build, set the build options -``-Dosmesa=true -Dglx=xlib`` and select an appropriate Gallium software -rasterizer. +``-Dosmesa=true -Dglx=xlib``. + +Mesa's Gallium drivers can be used on macOS by using the ``-Dgallium-drivers=`` build option. Do not use with the previous software rasterizers options, instead add `swrast` to the ```` list. Only software renderers and drivers that forward to other APIs can work, any linux hardware drivers will not work. For details on each driver's macOS support see their specific documentation.