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 (gen, gtk3/gtk4, qt5/qt6/kf5/kf6 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 * `SAL_NON_APPLICATION_FONT_USE` - control use of non-bundled fonts, values are `deny` or `abort`;
  16   for now only works on platforms using fontconfig (i.e., on Linux, but neither on macOS nor on
  17   Windows); also see gb_CppunitTest_set_non_application_font_use for using it in unit tests
  18 * `SAL_ALLOW_DEFAULT_HINTING` - use default font hinting for the platform. Enables medium/full hinting
  19   style which is otherwise reverted to (s)light.
  20
  21 * `LO_COLLECT_UIINFO` - enable the uitesting logging, value is expected to be a relative file name that
  22 will be used to write the log under `instdir/uitest/`.
  23
  24 * `VCL_DOUBLEBUFFERING_AVOID_PAINT` - don't paint the buffer, useful to see where we do direct painting
  25 * `VCL_DOUBLEBUFFERING_FORCE_ENABLE` - enable double buffered painting
  26 * `VCL_DOUBLEBUFFERING_ENABLE` - enable a safe subset of double buffered painting (currently in Writer, not in any other applications)
  27
  28 * `VCL_DEBUG_DISABLE_PDFCOMPRESSION` - disable compression in the PDF writer
  29
  30 * `SAL_DISABLE_WATCHDOG` - don't start the thread that watches for broken GL/Vulkan/OpenCL drivers
  31
  32 * `SAL_NO_MOUSEGRABS` - for debugging - stop blocking UI if a breakpoint is hit
  33
  34 ## Gtk+
  35
  36 * `VCL_GTK3_PAINTDEBUG` - in debug builds, if set to `1` then holding down `shift+0` forces a redraw event, `shift+1` repaints everything, and
  37 `shift+2` dumps cairo frames to pngs as `/tmp/frame<n>.png`
  38 * `GDK_SCALE=2` - for HiDPI scaling (just supports integers)
  39
  40 ## Bitmap
  41
  42 * `VCL_NO_THREAD_SCALE` - disable threaded bitmap scale
  43 * `VCL_NO_THREAD_IMPORT` - disable threaded bitmap import
  44 * `EMF_PLUS_DISABLE` - use EMF rendering and ignore EMF+ specifics
  45
  46 ## OpenGL
  47
  48 * `SAL_DISABLEGL` - disable OpenGL use
  49 * `SAL_GL_NO_SWAP` - disable buffer swapping if set (should show nothing)
  50 * `SAL_GL_SLEEP_ON_SWAP` - sleep for half a second on each swap-buffers.
  51
  52 ## Skia
  53
  54 * `SAL_DISABLESKIA=1` - force disabled Skia
  55 * `SAL_ENABLESKIA=1` - enable Skia, unless denylisted (and if the VCL backend supports Skia)
  56 * `SAL_FORCESKIA=1` - force using Skia, even if denylisted
  57 * `SAL_SKIA=raster|vulkan|metal` - select Skia's drawing method, by default Vulkan or Metal are used if available
  58 * `SAL_DISABLE_SKIA_CACHE=1` - disable caching of complex images
  59 * `SAL_SKIA_KEEP_BITMAP_BUFFER=1` - `SkiaSalBitmap` will keep its bitmap buffer even after storing in `SkImage`
  60
  61 ## OpenGL,Skia
  62
  63 * `SAL_WITHOUT_WIDGET_CACHE` - disable LRU caching of native widget textures
  64
  65 ## Qt
  66
  67 * `QT_SCALE_FACTOR=2` - for HiDPI testing (also supports float)
  68 * `SAL_VCL_QT_NO_FONTCONFIG` - ignore fontconfig provided font substitutions
  69 * `SAL_VCL_QT_NO_NATIVE` - disable `QStyle`'d controls
  70 * `SAL_VCL_QT_USE_QFONT` - use `QFont` for text layout and rendering (default is to use cairo)
  71 * `SAL_VCL_QT_NO_WELDED_WIDGETS` - disable the use of welded Qt widgets, reverts to previous VCL widget behavior
  72
  73 ## Mac
  74
  75 * `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)