third_party_mesa3d/docs/macos.rst

Notes for macOS
================

.. image:: https://github.com/mesa3d/mesa/actions/workflows/macos.yml/badge.svg
    :target: https://github.com/mesa3d/mesa/actions/workflows/macos.yml
    :alt: macOS CI

Mesa builds on macOS without modifications. However, there are some details to
be aware of.

-  Mesa has a number of build-time dependencies. Most dependencies, including
   Meson itself, are available in `homebrew <https://brew.sh>`__, which has a
   Mesa package for reference. The exception seems to be Mako, a Python module
   used for templating, which you can install as ``pip3 install mako``.
-  macOS is picky about its build-time environment. Type ``brew sh`` before
   building to get the Homebrew dependencies in your path.

Mesa's default builds with the Apple GLX uses Mesa as a front for the
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``.

Mesa's Gallium drivers can be used on macOS by using the ``-Dgallium-drivers=<drivers>`` build option. Do not use with the previous software rasterizers options, instead add `swrast` to the ``<drivers>`` 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.
docs: Add some notes on building for macOS I intend this page to grow as I explore more about Mesa/Darwin. Signed-off-by: Alyssa Rosenzweig <alyssa@rosenzweig.io> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10152> 2021-04-10 07:44:14 +05:30			`Notes for macOS`
			`================`

ci: rename GitHub CI workflow from `ci` to `macos` to be a bit more explicit about what it covers Reviewed-by: Yonggang Luo <luoyonggang@gmail.com> Acked-by: Yurii Kolesnykov <root@yurikoles.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/18057> 2022-08-15 10:22:57 +01:00			`.. image:: https://github.com/mesa3d/mesa/actions/workflows/macos.yml/badge.svg`
			`:target: https://github.com/mesa3d/mesa/actions/workflows/macos.yml`
docs: show and link to the new macOS CI Show the badge with the status of the new macOS CI introduced in https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/16875, and make it a link to the build details. Signed-off-by: Eric Engestrom <eric@engestrom.ch> Reviewed-by: Yurii Kolesnykov <root@yurikoles.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/16941> 2022-06-09 10:47:00 +01:00			`:alt: macOS CI`

docs: Add some notes on building for macOS I intend this page to grow as I explore more about Mesa/Darwin. Signed-off-by: Alyssa Rosenzweig <alyssa@rosenzweig.io> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10152> 2021-04-10 07:44:14 +05:30			`Mesa builds on macOS without modifications. However, there are some details to`
			`be aware of.`

			`- Mesa has a number of build-time dependencies. Most dependencies, including`
docs: use anonymous links when possible Anonymous links has some benefits in that it reduces the chance of warnings when similar identifiers are used. So let's use them instead when we can. Reviewed-by: David Heidelberg <david.heidelberg@collabora.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19492> 2022-11-03 08:50:29 +01:00			Meson itself, are available in `homebrew <https://brew.sh>`__, which has a
docs: Add some notes on building for macOS I intend this page to grow as I explore more about Mesa/Darwin. Signed-off-by: Alyssa Rosenzweig <alyssa@rosenzweig.io> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10152> 2021-04-10 07:44:14 +05:30			`Mesa package for reference. The exception seems to be Mako, a Python module`
docs: use inline-code instead of default role A single backtick escaped string in Sphinx refers to the "default role" which is vague, and in practice ends up producing the HTML cite-element. That's almost certainly not what these uses wanted. A bunch of these would probably be better served using appropriate roles instead of inline-code markup, but this is almost certainly what was meant here instead. Let's not let perfect be the enemy of good here, and just do what was intended. Using the right roles everywhere is a big task. I usually don't do changes like these to the relnotes, but in this case there were a single article that had these mistakes. I assume that was an early bug in the script that generateg the relnotes. Let's patch it, so we don't get misrendering if we change the default-role. Reviewed-by: Yonggang Luo <luoyonggang@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19494> 2022-11-02 20:50:58 +01:00			used for templating, which you can install as ``pip3 install mako``.
			- macOS is picky about its build-time environment. Type ``brew sh`` before
docs: Add some notes on building for macOS I intend this page to grow as I explore more about Mesa/Darwin. Signed-off-by: Alyssa Rosenzweig <alyssa@rosenzweig.io> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10152> 2021-04-10 07:44:14 +05:30			`building to get the Homebrew dependencies in your path.`

docs/macos: Explain Apple GLX versus OSMesa on macOS Signed-off-by: Alyssa Rosenzweig <alyssa@rosenzweig.io> Reviewed-by: Jeremy Huddleston Sequoia <jeremyhu@apple.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10359> 2021-04-21 00:44:32 +05:30			`Mesa's default builds with the Apple GLX uses Mesa as a front for the`
			`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`
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 <michael.blumenkrantz@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/28330> 2024-03-22 09:07:58 +00:00			``-Dosmesa=true -Dglx=xlib``.

			Mesa's Gallium drivers can be used on macOS by using the ``-Dgallium-drivers=<drivers>`` build option. Do not use with the previous software rasterizers options, instead add `swrast` to the ``<drivers>`` 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.