mirrors
/
mesa
mirror of https://gitlab.freedesktop.org/mesa/mesa
1
0
Fork 0
Code Issues 9 Packages Projects Releases Wiki Activity
mesa/docs/isl/index.rst

18 lines
443 B
ReStructuredText
Raw Normal View History

docs: Begin documenting ISL This commit mostly just adds the framework required to scrape documentation out of the ISL sources and headers. The method chosen here is a combination of doxygen and breathe (a sphinx extension for doxygen integration). I'll freely admit that doxygen is pretty terrible but it seems like the best option we have available to us today. Acked-by: Emma Anholt <emma@anholt.net> Acked-by: Daniel Stone <daniels@collabora.com> Acked-by: Erik Faye-Lund <erik.faye-lund@collabora.com>. Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11366>
2021-06-14 22:55:21 +01:00
Intel Surface Layout (ISL)
==========================
The Intel Surface Layout library (**ISL**) is a subproject in Mesa for doing
surface layout calculations for Intel graphics drivers. It was originally
written by Chad Versace and is now maintained by Jason Ekstrand and Nanley
Chery.
docs/isl: Document ISL's units Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11366>
2021-06-15 03:33:35 +01:00
.. toctree::
:maxdepth: 2
units
docs: Begin documenting ISL This commit mostly just adds the framework required to scrape documentation out of the ISL sources and headers. The method chosen here is a combination of doxygen and breathe (a sphinx extension for doxygen integration). I'll freely admit that doxygen is pretty terrible but it seems like the best option we have available to us today. Acked-by: Emma Anholt <emma@anholt.net> Acked-by: Daniel Stone <daniels@collabora.com> Acked-by: Erik Faye-Lund <erik.faye-lund@collabora.com>. Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11366>
2021-06-14 22:55:21 +01:00
The core representation of a surface in ISL is :cpp:struct:`isl_surf`.
.. doxygenstruct:: isl_surf
:members: