OpenHarmony/third_party_mesa3d
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Begin documenting ISL

Browse Source 
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>
This commit is contained in:
Jason Ekstrand
2021-06-14 16:55:21 -05:00
committed by Marge Bot
parent d3a63149da
commit 831750b40b
5 changed files with 117 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/isl/index.rst Normal file
View File

@@ -0,0 +1,12 @@
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.
The core representation of a surface in ISL is :cpp:struct:`isl_surf`.
.. doxygenstruct:: isl_surf
:members: