vcl/README.vars.md

   1 # Environment variables in VCL
   2
   3 ## General
   4
   5 These are the general environment variables used in the VCL:
   6
   7 * `SAL_USE_VCLPLUGIN` - use a VCL plugin
   8 * `SAL_RTL_ENABLED` - Enable RTL UI
   9 * `SAL_NO_NWF` - disable native widgets
  10 * `SAL_FORCEDPI` - force a specific DPI (gtk3 & qt5/kf5 plugins only)
  11 * `SAL_FORCE_HC` - force high-contrast mode
  12 * `SAL_USE_SYSTEM_LOOP` - calls std::abort on nested event loop calls. Currently just for Qt with many crashes. WIP.
  13
  14 * `SAL_NO_FONT_LOOKUP` - disable font search and fallback and always use a hard-coded font name (for some unit tests)
  15
  16 * `LO_COLLECT_UIINFO` - enable the uitesting logging, value is expected to be a relative file name that
  17 will be used to write the log under `instdir/uitest/`.
  18
  19 * `VCL_DOUBLEBUFFERING_AVOID_PAINT` - don't paint the buffer, useful to see where we do direct painting
  20 * `VCL_DOUBLEBUFFERING_FORCE_ENABLE` - enable double buffered painting
  21 * `VCL_DOUBLEBUFFERING_ENABLE` - enable a safe subset of double buffered painting (currently in Writer, not in any other applications)
  22
  23 * `VCL_DEBUG_DISABLE_PDFCOMPRESSION` - disable compression in the PDF writer
  24
  25 * `SAL_DISABLE_WATCHDOG` - don't start the thread that watches for broken GL/Vulkan/OpenCL drivers
  26
  27 * `SAL_NO_MOUSEGRABS` - for debugging - stop blocking UI if a breakpoint is hit
  28
  29 ## Gtk+
  30
  31 * `VCL_GTK3_PAINTDEBUG` - in debug builds, if set to `1` then holding down `shift+0` forces a redraw event, `shift+1` repaints everything, and
  32 `shift+2` dumps cairo frames to pngs as `/tmp/frame<n>.png`
  33 * `GDK_SCALE=2` - for HiDPI scaling (just supports integers)
  34
  35 ## Bitmap
  36
  37 * `VCL_NO_THREAD_SCALE` - disable threaded bitmap scale
  38 * `VCL_NO_THREAD_IMPORT` - disable threaded bitmap import
  39 * `EMF_PLUS_DISABLE` - use EMF rendering and ignore EMF+ specifics
  40
  41 ## OpenGL
  42
  43 * `SAL_DISABLEGL` - disable OpenGL use
  44 * `SAL_GL_NO_SWAP` - disable buffer swapping if set (should show nothing)
  45 * `SAL_GL_SLEEP_ON_SWAP` - sleep for half a second on each swap-buffers.
  46
  47 ## Skia
  48
  49 * `SAL_DISABLESKIA=1` - force disabled Skia
  50 * `SAL_ENABLESKIA=1` - enable Skia, unless denylisted (and if the VCL backend supports Skia)
  51 * `SAL_FORCESKIA=1` - force using Skia, even if denylisted
  52 * `SAL_SKIA=raster|vulkan|metal` - select Skia's drawing method, by default Vulkan or Metal are used if available
  53 * `SAL_DISABLE_SKIA_CACHE=1` - disable caching of complex images
  54 * `SAL_SKIA_KEEP_BITMAP_BUFFER=1` - `SkiaSalBitmap` will keep its bitmap buffer even after storing in `SkImage`
  55
  56 ## OpenGL,Skia
  57
  58 * `SAL_WITHOUT_WIDGET_CACHE` - disable LRU caching of native widget textures
  59
  60 ## Qt
  61
  62 * `QT_SCALE_FACTOR=2` - for HiDPI testing (also supports float)
  63 * `SAL_VCL_QT5_NO_FONTCONFIG` - ignore fontconfig provided font substitutions
  64 * `SAL_VCL_QT5_NO_NATIVE` - disable `QStyle`'d controls
  65 * `SAL_VCL_QT_USE_QFONT` - use `QFont` for text layout and rendering (default is to use cairo)
  66
  67 ## Mac
  68
  69 * `SAL_FORCE_HIDPI_SCALING` - set to 2 to fake HiDPI drawing (useful for unittests, windows may draw only top-left 1/4 of the content scaled)