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

docs: use tables instead of pre-formatted text

Browse Source 
This makes this easier to read.

Reviewed-by: Eric Anholt <eric@anholt.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10281>
This commit is contained in:
Erik Faye-Lund
2021-04-15 15:32:26 +02:00
committed by Marge Bot
parent 1e4e22e6ba
commit 525f7b6a23
3 changed files with 44 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/codingstyle.rst
View File

@@ -101,13 +101,21 @@ Basic formatting guidelines
- Function names follow various conventions depending on the type of - Function names follow various conventions depending on the type of
function: function:
:: +---------------------+------------------------------------------+
| Convention | Explanation |
glFooBar() - a public GL entry point (in glapi_dispatch.c) +=====================+==========================================+
_mesa_FooBar() - the internal immediate mode function | ``glFooBar()`` | a public GL entry point (in |
save_FooBar() - retained mode (display list) function in dlist.c | | :file:`glapi_dispatch.c`) |
foo_bar() - a static (private) function +---------------------+------------------------------------------+
_mesa_foo_bar() - an internal non-static Mesa function | ``_mesa_FooBar()`` | the internal immediate mode function |
+---------------------+------------------------------------------+
| ``save_FooBar()`` | retained mode (display list) function in |
| | :file:`dlist.c` |
+---------------------+------------------------------------------+
| ``foo_bar()`` | a static (private) function |
+---------------------+------------------------------------------+
| ``_mesa_foo_bar()`` | an internal non-static Mesa function |
+---------------------+------------------------------------------+
- Constants, macros and enum names are ``ALL_UPPERCASE``, with \_ - Constants, macros and enum names are ``ALL_UPPERCASE``, with \_
between words. between words.

34
docs/versions.rst
View File

@@ -67,23 +67,23 @@ extensions incorporated as standard features:
Also note that several OpenGL tokens were renamed in OpenGL 1.5 for the Also note that several OpenGL tokens were renamed in OpenGL 1.5 for the
sake of consistency. The old tokens are still available. sake of consistency. The old tokens are still available.
:: ========================== ===============================
New Token Old Token
New Token Old Token ========================== ===============================
------------------------------------------------------------ GL_FOG_COORD_SRC GL_FOG_COORDINATE_SOURCE
GL_FOG_COORD_SRC GL_FOG_COORDINATE_SOURCE GL_FOG_COORD GL_FOG_COORDINATE
GL_FOG_COORD GL_FOG_COORDINATE GL_CURRENT_FOG_COORD GL_CURRENT_FOG_COORDINATE
GL_CURRENT_FOG_COORD GL_CURRENT_FOG_COORDINATE GL_FOG_COORD_ARRAY_TYPE GL_FOG_COORDINATE_ARRAY_TYPE
GL_FOG_COORD_ARRAY_TYPE GL_FOG_COORDINATE_ARRAY_TYPE GL_FOG_COORD_ARRAY_STRIDE GL_FOG_COORDINATE_ARRAY_STRIDE
GL_FOG_COORD_ARRAY_STRIDE GL_FOG_COORDINATE_ARRAY_STRIDE GL_FOG_COORD_ARRAY_POINTER GL_FOG_COORDINATE_ARRAY_POINTER
GL_FOG_COORD_ARRAY_POINTER GL_FOG_COORDINATE_ARRAY_POINTER GL_FOG_COORD_ARRAY GL_FOG_COORDINATE_ARRAY
GL_FOG_COORD_ARRAY GL_FOG_COORDINATE_ARRAY GL_SRC0_RGB GL_SOURCE0_RGB
GL_SRC0_RGB GL_SOURCE0_RGB GL_SRC1_RGB GL_SOURCE1_RGB
GL_SRC1_RGB GL_SOURCE1_RGB GL_SRC2_RGB GL_SOURCE2_RGB
GL_SRC2_RGB GL_SOURCE2_RGB GL_SRC0_ALPHA GL_SOURCE0_ALPHA
GL_SRC0_ALPHA GL_SOURCE0_ALPHA GL_SRC1_ALPHA GL_SOURCE1_ALPHA
GL_SRC1_ALPHA GL_SOURCE1_ALPHA GL_SRC2_ALPHA GL_SOURCE2_ALPHA
GL_SRC2_ALPHA GL_SOURCE2_ALPHA ========================== ===============================
See the `OpenGL See the `OpenGL
specification <https://www.opengl.org/documentation/spec.html>`__ for specification <https://www.opengl.org/documentation/spec.html>`__ for

17
docs/xlibdriver.rst
View File

@@ -200,8 +200,15 @@ This extension was added in Mesa 2.6
Summary of X-related environment variables Summary of X-related environment variables
------------------------------------------ ------------------------------------------
:: +-----------------------------+--------------------------------------+
| Environment variable | Description |
MESA_RGB_VISUAL - specifies the X visual and depth for RGB mode (X only) +=============================+======================================+
MESA_BACK_BUFFER - specifies how to implement the back color buffer (X only) | :envvar:`MESA_RGB_VISUAL` | specifies the X visual and depth for |
MESA_GAMMA - gamma correction coefficients (X only) | | RGB mode (X only) |
+-----------------------------+--------------------------------------+
| :envvar:`MESA_BACK_BUFFER` | specifies how to implement the back |
| | color buffer (X only) |
+-----------------------------+--------------------------------------+
| :envvar:`MESA_GAMMA` | gamma correction coefficients |
| | (X only) |
+-----------------------------+--------------------------------------+