yquake2/yquake2remaster
0
0
Fork 0
mirror of https://github.com/yquake2/yquake2remaster.git synced 2024-11-10 07:12:07 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update documentation for GLES3 and gl3_usefbo

Browse source
This commit is contained in:
Daniel Gibson 2022-04-26 21:24:14 +02:00
parent 56e1b9bc1e
commit ef7ba41932
3 changed files with 16 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/030_configuration.md
View file

@ -8,7 +8,7 @@ with the defaults and the options that can be set through the menu.
## Choosing a Renderer ## Choosing a Renderer
Yamagi Quake II ships with 3 renderers: Yamagi Quake II ships with 4 renderers:
* The **OpenGL 3.2** renderer: This renderer was developed for the needs * The **OpenGL 3.2** renderer: This renderer was developed for the needs
of modern graphics hardware and is usually the best choice for OpenGL of modern graphics hardware and is usually the best choice for OpenGL
@ -17,6 +17,11 @@ Yamagi Quake II ships with 3 renderers:
rendering looks mostly the same on all GPU drivers. Depending on the rendering looks mostly the same on all GPU drivers. Depending on the
display, the default lighting may be too bright or too dark, it can be display, the default lighting may be too bright or too dark, it can be
adjusted through the menu or through the *vid_gamma* cvar. adjusted through the menu or through the *vid_gamma* cvar.
* The **OpenGL ES3** renderer: This is pretty much the same as the
OpenGL 3.2 renderer (and uses the same cvars for configuration), but
uses OpenGL ES 3.0 instead of "desktop" OpenGL, so it also works on
the Raspberry Pi 4, for example. Reportedly it also has slightly
better performance on Wayland, at least with the open source AMD drivers.
* The **OpenGL 1.4** renderer: This is a slightly enhanced version of * The **OpenGL 1.4** renderer: This is a slightly enhanced version of
the original OpenGL renderer shipped in 1997 with the retail release. the original OpenGL renderer shipped in 1997 with the retail release.
It's provided for older graphics cards, not able to run the OpenGL 3.2 It's provided for older graphics cards, not able to run the OpenGL 3.2

12
doc/040_cvarlist.md
View file

@ -9,7 +9,7 @@ have been renamed. The prefixes are:
* `cl_`: Client. * `cl_`: Client.
* `gl_`: Common to all OpenGL renderers. * `gl_`: Common to all OpenGL renderers.
* `gl1_`: OpenGL 1.4 renderer. * `gl1_`: OpenGL 1.4 renderer.
* `gl3_`: OpenGL 3.2 renderer. * `gl3_`: OpenGL 3.2 and OpenGL ES3 renderers.
* `ogg_`: Ogg/Vorbis music playback. * `ogg_`: Ogg/Vorbis music playback.
* `r_`: Common to all renderers. * `r_`: Common to all renderers.
* `s_`: Sound system. * `s_`: Sound system.
@ -349,7 +349,8 @@ it's `+set busywait 0` (setting the `busywait` cvar) and `-portable`
* **vid_renderer**: Selects the renderer library. Possible options are * **vid_renderer**: Selects the renderer library. Possible options are
`gl1` (the default) for the old OpenGL 1.4 renderer, `gl3` for the `gl1` (the default) for the old OpenGL 1.4 renderer, `gl3` for the
OpenGL 3.2 renderer and `soft` for the software renderer. OpenGL 3.2 renderer, `gles3` for the OpenGL ES3 renderer
and `soft` for the software renderer.
## Graphics (GL renderers only) ## Graphics (GL renderers only)
@ -388,7 +389,7 @@ it's `+set busywait 0` (setting the `busywait` cvar) and `-portable`
look a bit better (no flickering) by using the stencil buffer. look a bit better (no flickering) by using the stencil buffer.
## Graphics (OpenGL 3.2 only) ## Graphics (OpenGL 3.2 and OpenGL ES3 only)
* **gl3_debugcontext**: Enables the OpenGL 3.2 renderers debug context, * **gl3_debugcontext**: Enables the OpenGL 3.2 renderers debug context,
e.g. prints warnings and errors emitted by the GPU driver. Not e.g. prints warnings and errors emitted by the GPU driver. Not
@ -423,6 +424,11 @@ it's `+set busywait 0` (setting the `busywait` cvar) and `-portable`
colorless (greyscale-only), like in the original soft renderer. colorless (greyscale-only), like in the original soft renderer.
Default is `1`. Default is `1`.
* **gl3_usefbo**: When set to `1` (the default), an OpenGL Framebuffer
Object is used to implement a warping underwater-effect (like the
software renderer has). Set to `0` to disable this, in case you don't
like the effect or it's too slow on your machine.
## Graphics (Software only) ## Graphics (Software only)

1
doc/090_filelists.md
View file

@ -34,6 +34,7 @@ level.
# Renderer libraries: # Renderer libraries:
/ref_gl1.dll /ref_gl1.dll
/ref_gl3.dll /ref_gl3.dll
/ref_gles3.dll
/ref_soft.dll /ref_soft.dll
# The Executables: # The Executables: