xref: /aosp_15_r20/external/mesa3d/docs/index.rst (revision 6104692788411f58d303aa86923a9ff6ecaded22)
1Introduction
2============
3
4The Mesa project began as an open-source implementation of the
5`OpenGL`_ specification - a system for rendering interactive 3D graphics.
6
7Over the years the project has grown to implement more graphics APIs,
8including `OpenGL ES`_, `OpenCL`_, `VDPAU`_, `VA-API`_,
9`Vulkan`_ and `EGL`_.
10
11A variety of device drivers allows the Mesa libraries to be used in many
12different environments ranging from software emulation to complete
13hardware acceleration for modern GPUs.
14
15Mesa ties into several other open-source projects: the `Direct Rendering
16Infrastructure`_, `X.org`_, and `Wayland`_ to provide OpenGL support on
17Linux, FreeBSD, and other operating systems.
18
19.. _OpenGL: https://www.opengl.org/
20.. _OpenGL ES: https://www.khronos.org/opengles/
21.. _OpenCL: https://www.khronos.org/opencl/
22.. _VDPAU: https://en.wikipedia.org/wiki/VDPAU
23.. _VA-API: https://en.wikipedia.org/wiki/Video_Acceleration_API
24.. _Vulkan: https://www.vulkan.org/
25.. _EGL: https://www.khronos.org/egl/
26.. _Direct Rendering Infrastructure: https://dri.freedesktop.org/
27.. _X.org: https://x.org
28.. _Wayland: https://wayland.freedesktop.org
29
30.. toctree::
31   :maxdepth: 1
32   :caption: Documentation
33   :hidden:
34
35   self
36   history
37   amber
38   systems
39   license
40   faq
41   relnotes
42
43.. toctree::
44   :maxdepth: 2
45   :caption: Download and Install
46   :hidden:
47
48   download
49   install
50   precompiled
51
52.. toctree::
53   :maxdepth: 1
54   :caption: Need help?
55   :hidden:
56
57   lists
58   bugs
59
60.. toctree::
61   :maxdepth: 1
62   :caption: User Topics
63   :hidden:
64
65   shading
66   egl
67   opengles
68   envvars
69   osmesa
70   debugging
71   perf
72   gpu-perf-tracing
73   extensions
74   application-issues
75   gallium-nine
76   viewperf
77   xlibdriver
78   teflon
79
80.. toctree::
81   :maxdepth: 1
82   :caption: Drivers
83   :hidden:
84
85   drivers/anv
86   drivers/asahi
87   drivers/d3d12
88   drivers/freedreno
89   drivers/lima
90   drivers/llvmpipe
91   drivers/nvk
92   drivers/panfrost
93   drivers/powervr
94   drivers/radv
95   drivers/svga3d
96   drivers/v3d
97   drivers/vc4
98   drivers/venus
99   drivers/virgl
100   drivers/zink
101
102.. toctree::
103   :maxdepth: 1
104   :caption: Developer Topics
105   :hidden:
106
107   repository
108   sourcetree
109   utilities
110   helpwanted
111   devinfo
112   codingstyle
113   submittingpatches
114   rust
115   releasing
116   release-calendar
117   dispatch
118   gallium/index
119   vulkan/index
120   nir/index
121   isl/index
122   isaspec
123   rusticl
124   android
125   macos
126   Linux Kernel Drivers <https://www.kernel.org/doc/html/latest/gpu/>
127
128.. toctree::
129   :maxdepth: 1
130   :caption: Testing
131   :hidden:
132
133   conform
134   ci/index
135
136.. toctree::
137   :maxdepth: 1
138   :caption: Links
139   :hidden:
140
141   OpenGL Website <https://www.opengl.org>
142   DRI Website <https://dri.freedesktop.org>
143   Developer Blogs <https://planet.freedesktop.org>
144