docs/environment.adoc

   1 Environment
   2 -----------
   3
   4 Some environment variables can be set to alter how GEGL runs, these
   5 options are also available as properties on a singleton GObject returned
   6 from `gegl_config()`. The defaults should be what one normally use -
   7 overriding
   8
   9 [[GEGL_MIPMAP_RENDERING]]
  10 GEGL_MIPMAP_RENDERING::
  11   [`true`, `false`] default: `false` +
  12   Render output as an image preview mipmap. `1` and `yes` are synonyms
  13   for `true`, everything else is taken as `false`.
  14
  15 [[GEGL_QUALITY]]
  16 GEGL_QUALITY::
  17   [`0.0-1.0, fast, good, best`] default: `1.0` +
  18   The quality of the rendering, a value between `0.0` (fast) and `1.0`
  19   (reference). The values `fast`, `good` and `best` are also accepted as
  20   synonyms for `0.0`, `0.5` and `1.0` respectively.
  21
  22 [[BABL_TOLERANCE]]
  23 BABL_TOLERANCE::
  24   [`0.0-1.0`] default: `0.000001` +
  25   Controls a accuracy/performance trade off with low values representing
  26   high numerical accuracy. By default `BABL_TOLERANCE` is set to a very
  27   low (`0.000001`) value. Values in the range `0.01-0.1` are suitable for
  28   providing preview images with reasonable performance an accuracy.
  29
  30 [[GEGL_CACHE_SIZE]]
  31 GEGL_CACHE_SIZE::
  32   The size, in megabytes, of the tile cache used by `GeglBuffer`.
  33
  34 [[GEGL_CHUNK_SIZE]]
  35 GEGL_CHUNK_SIZE::
  36   The number of pixels processed simultaneously.
  37
  38 [[GEGL_TILE_SIZE]]
  39 GEGL_TILE_SIZE::
  40   [`<width>x<height>`] default: `128x64` +
  41   The tile size used internally by GEGL, in pixels.
  42
  43 [[GEGL_THREADS]]
  44 GEGL_THREADS::
  45   [`1-64`] +
  46   Number of threads to use. Setting to `1` ensures single threaded
  47   processing.
  48
  49 [[GEGL_SWAP]]
  50 GEGL_SWAP::
  51   The directory where temporary swap files are written. If not specified
  52   GEGL will not swap to disk.
  53
  54 [[GEGL_DEBUG]]
  55 GEGL_DEBUG::
  56   [`process, cache, buffer-load, buffer-save, tile-backend, processor,
  57   invalidation, opencl, license, all`] +
  58   Enable internal debug tooling on one or more domains - `all` enables
  59   all debug domains.
  60
  61 [[GEGL_DEBUG_BUFS]]
  62 GEGL_DEBUG_BUFS::
  63   Display tile/buffer leakage statistics.
  64
  65 [[GEGL_DEBUG_RECTS]]
  66 GEGL_DEBUG_RECTS::
  67   Show the results of have/need rect negotiations.
  68
  69 [[GEGL_DEBUG_TIME]]
  70 GEGL_DEBUG_TIME::
  71   Setting to any value will print a performance instrumentation
  72   breakdown of GEGL and it's operations.
  73
  74 [[GEGL_USE_OPENCL]]
  75 GEGL_USE_OPENCL::
  76   [`yes, no, cpu, gpu, accelerator`] +
  77   Enable use of OpenCL processing.
  78
  79 [[GEGL_PATH]]
  80 GEGL_PATH::
  81   The directory where GEGL looks (recursively) for dynamically
  82   loadable operation libraries.
  83
  84 [[BABL_PATH]]
  85 BABL_PATH::
  86   The directory containing babl extensions, both new pixel formats/color
  87   models as well as fast-paths for efficient pixel format conversions.