docs/index.rst

   1 Introduction
   2 ============
   3
   4 The Mesa project began as an open-source implementation of the
   5 `OpenGL`_ specification - a system for rendering interactive 3D graphics.
   6
   7 Over the years the project has grown to implement more graphics APIs,
   8 including `OpenGL ES`_, `OpenCL`_, `OpenMAX`_, `VDPAU`_, `VA-API`_,
   9 `Vulkan`_ and `EGL`_.
  10
  11 A variety of device drivers allows the Mesa libraries to be used in many
  12 different environments ranging from software emulation to complete
  13 hardware acceleration for modern GPUs.
  14
  15 Mesa ties into several other open-source projects: the `Direct Rendering
  16 Infrastructure`_, `X.org`_, and `Wayland`_ to provide OpenGL support on
  17 Linux, 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 .. _OpenMAX: https://www.khronos.org/openmax/
  23 .. _VDPAU: https://en.wikipedia.org/wiki/VDPAU
  24 .. _VA-API: https://en.wikipedia.org/wiki/Video_Acceleration_API
  25 .. _Vulkan: https://www.khronos.org/vulkan/
  26 .. _EGL: https://www.khronos.org/egl/
  27 .. _Direct Rendering Infrastructure: https://dri.freedesktop.org/
  28 .. _X.org: https://x.org
  29 .. _Wayland: https://wayland.freedesktop.org
  30
  31 .. toctree::
  32    :maxdepth: 1
  33    :caption: Documentation
  34    :hidden:
  35
  36    self
  37    history
  38    developers
  39    amber
  40    systems
  41    license
  42    faq
  43    relnotes
  44    thanks
  45
  46 .. toctree::
  47    :maxdepth: 2
  48    :caption: Download and Install
  49    :hidden:
  50
  51    download
  52    install
  53    precompiled
  54
  55 .. toctree::
  56    :maxdepth: 1
  57    :caption: Need help?
  58    :hidden:
  59
  60    lists
  61    bugs
  62
  63 .. toctree::
  64    :maxdepth: 1
  65    :caption: User Topics
  66    :hidden:
  67
  68    shading
  69    egl
  70    opengles
  71    envvars
  72    osmesa
  73    debugging
  74    perf
  75    gpu-perf-tracing
  76    extensions
  77    application-issues
  78    gallium-nine
  79    viewperf
  80    xlibdriver
  81
  82 .. toctree::
  83    :maxdepth: 1
  84    :caption: Drivers
  85    :hidden:
  86
  87    drivers/anv
  88    drivers/asahi
  89    drivers/d3d12
  90    drivers/freedreno
  91    drivers/lima
  92    drivers/llvmpipe
  93    drivers/panfrost
  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    releasing
 115    release-calendar
 116    dispatch
 117    gallium/index
 118    vulkan/index
 119    nir/index
 120    isl/index
 121    rusticl
 122    android
 123    macos
 124    Linux Kernel Drivers <https://www.kernel.org/doc/html/latest/gpu/>
 125
 126 .. toctree::
 127    :maxdepth: 1
 128    :caption: Testing
 129    :hidden:
 130
 131    conform
 132    ci/index
 133
 134 .. toctree::
 135    :maxdepth: 1
 136    :caption: Links
 137    :hidden:
 138
 139    OpenGL Website <https://www.opengl.org>
 140    DRI Website <https://dri.freedesktop.org>
 141    Developer Blogs <https://planet.freedesktop.org>
 142
 143 .. toctree::
 144    :maxdepth: 1
 145    :caption: Hosted by:
 146    :hidden:
 147
 148    freedesktop.org <https://www.freedesktop.org>