Update docs

Update the docs for environment variables that we parse to include
GDK_VULKAN_SKIP and GSK_GPU_SKIP.
This commit is contained in:
Matthias Clasen 2024-01-05 19:23:49 -05:00 committed by Benjamin Otte
parent 1723ab34e1
commit c0d49f296e

View File

@ -274,49 +274,46 @@ are only available when GTK has been configured with `-Ddebug=true`.
`renderer` `renderer`
: General renderer information : General renderer information
`cairo`
: cairo renderer information
`opengl` `opengl`
: OpenGL renderer information : OpenGL renderer information
`shaders`
: Shaders
`surface`
: Surfaces
`vulkan` `vulkan`
: Vulkan renderer information : Vulkan renderer information
`shaders`
: Information about shaders
`surface`
: Information about surfaces
`fallback` `fallback`
: Information about fallbacks : Information about fallback usage in renderers
`glyphcache` `glyphcache`
: Information about glyph caching : Information about glyph caching
`verbose`
: Print verbose output while rendering
A number of options affect behavior instead of logging: A number of options affect behavior instead of logging:
`diff`
: Show differences
`geometry` `geometry`
: Show borders : Show borders (when using cairo)
`full-redraw` `full-redraw`
: Force full redraws for every frame : Force full redraws
`sync` `sync`
: Sync after each frame : Sync after each frame
`staging`
: Use a staging image for texture upload (Vulkan only)
`offload-disable` `offload-disable`
: Disable graphics offload to subsurfaces : Disable graphics offload to subsurfaces
`vulkan-staging-image` `cairo`
: Use a staging image for Vulkan texture upload : Overlay error pattern over cairo drawing (finds fallbacks)
`vulkan-staging-buffer`
: Use a staging buffer for Vulkan texture upload
The special value `all` can be used to turn on all debug options. The special The special value `all` can be used to turn on all debug options. The special
value `help` can be used to obtain a list of all supported debug options. value `help` can be used to obtain a list of all supported debug options.
@ -357,6 +354,40 @@ the default selection of the device that is used for Vulkan rendering.
The special value `list` can be used to obtain a list of all Vulkan The special value `list` can be used to obtain a list of all Vulkan
devices. devices.
### `GDK_VULKAN_SKIP`
This variable can be set to a list of values, which cause GDK to
disable features of the Vulkan support.
Note that these features may already be disabled if the Vulkan driver
does not support them.
`dmabuf`
: Never import Dmabufs
`ycbr`
: Do not support Ycbcr textures
`descriptor-indexing`
: Force slow descriptor set layout codepath
`dynamic-indexing`
: Hardcode small number of buffer and texure arrays
`nonuniform-indexing`
: Split draw calls to ensure uniform texture accesses
`semaphore-export`
: Disable sync of exported dmabufs
`semaphore-import`
: Disable sync of imported dmabufs
`incremental-present`
: Do not send damage regions
The special value `all` can be used to turn on all values. The special
value `help` can be used to obtain a list of all supported values.
### `GSK_RENDERER` ### `GSK_RENDERER`
If set, selects the GSK renderer to use. The following renderers can If set, selects the GSK renderer to use. The following renderers can
@ -378,6 +409,9 @@ using and the GDK backend supports them:
`gl` `gl`
: Selects the "gl" OpenGL renderer : Selects the "gl" OpenGL renderer
`ngl`
: Selects the "ngl" OpenGL renderer
`vulkan` `vulkan`
: Selects the Vulkan renderer : Selects the Vulkan renderer
@ -395,6 +429,32 @@ to rememdy this on the GTK side; the best bet before trying the above
workarounds is to try to update your graphics drivers and Nahimic workarounds is to try to update your graphics drivers and Nahimic
installation. installation.
### `GSK_GPU_SKIP`
This variable can be set to a list of values, which cause GSK to
disable certain optimizations of the "ngl" and "vulkan" renderer.
`uber`
: Don't use the uber shader
`clear`
: Use shaders instead of vkCmdClearAttachment()/glClear()
`blit`
: Use shaders instead of vkCmdBlit()/glBlitFramebuffer()
`gradients`
: Don't supersample gradients
`mipmap`
: Avoid creating mipmaps
`gl-baseinstance`
: Assume no ARB/EXT_base_instance support
The special value `all` can be used to turn on all values. The special
value `help` can be used to obtain a list of all supported values.
### `GSK_MAX_TEXTURE_SIZE` ### `GSK_MAX_TEXTURE_SIZE`
Limit texture size to the minimum of this value and the OpenGL limit Limit texture size to the minimum of this value and the OpenGL limit