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
  13 * `SAL_NO_FONT_LOOKUP` - disable font search and fallback and always use a hard-coded font name (for some unit tests)
  14
  15 * `LO_COLLECT_UIINFO` - enable the uitesting logging, value is expected to be a relative file name that
  16 will be used to write the log under `instdir/uitest/`.
  17
  18 * `VCL_DOUBLEBUFFERING_AVOID_PAINT` - don't paint the buffer, useful to see where we do direct painting
  19 * `VCL_DOUBLEBUFFERING_FORCE_ENABLE` - enable double buffered painting
  20 * `VCL_DOUBLEBUFFERING_ENABLE` - enable a safe subset of double buffered painting (currently in Writer, not in any other applications)
  21
  22 * `VCL_DEBUG_DISABLE_PDFCOMPRESSION` - disable compression in the PDF writer
  23
  24 * `SAL_DISABLE_WATCHDOG` - don't start the thread that watches for broken GL/Vulkan/OpenCL drivers
  25
  26 ## Gtk+
  27
  28 * `VCL_GTK3_PAINTDEBUG` - in debug builds, if set to `1` then holding down `shift+0` forces a redraw event, `shift+1` repaints everything, and
  29 `shift+2` dumps cairo frames to pngs as `/tmp/frame<n>.png`
  30 * `GDK_SCALE=2` - for HiDPI scaling (just supports integers)
  31
  32 ## Bitmap
  33
  34 * `VCL_NO_THREAD_SCALE` - disable threaded bitmap scale
  35 * `VCL_NO_THREAD_IMPORT` - disable threaded bitmap import
  36 * `EMF_PLUS_DISABLE` - use EMF rendering and ignore EMF+ specifics
  37
  38 ## OpenGL
  39
  40 * `SAL_DISABLEGL` - disable OpenGL use
  41 * `SAL_GL_NO_SWAP` - disable buffer swapping if set (should show nothing)
  42 * `SAL_GL_SLEEP_ON_SWAP` - sleep for half a second on each swap-buffers.
  43
  44 ## Skia
  45
  46 * `SAL_DISABLESKIA=1` - force disabled Skia
  47 * `SAL_ENABLESKIA=1` - enable Skia, unless denylisted (and if the VCL backend supports Skia)
  48 * `SAL_FORCESKIA=1` - force using Skia, even if denylisted
  49 * `SAL_SKIA=raster|vulkan|metal` - select Skia's drawing method, by default Vulkan or Metal are used if available
  50 * `SAL_DISABLE_SKIA_CACHE=1` - disable caching of complex images
  51 * `SAL_SKIA_KEEP_BITMAP_BUFFER=1` - `SkiaSalBitmap` will keep its bitmap buffer even after storing in `SkImage`
  52
  53 ## OpenGL,Skia
  54
  55 * `SAL_WITHOUT_WIDGET_CACHE` - disable LRU caching of native widget textures
  56
  57 ## Qt
  58
  59 * `QT_SCALE_FACTOR=2` - for HiDPI testing (also supports float)
  60 * `SAL_VCL_QT5_NO_FONTCONFIG` - ignore fontconfig provided font substitutions
  61 * `SAL_VCL_QT5_NO_NATIVE` - disable `QStyle`'d controls
  62 * `SAL_VCL_QT5_USE_CAIRO` - use cairo for text rendering and fonts (default for kf5, but not qt5)
  63
  64 ## Kf5
  65
  66 * `SAL_VCL_KF5_USE_QFONT` - use `QFont` for text rendering (default for qt5, but not kf5)
  67
  68 ## Mac
  69
  70 * `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)