Rename GP_Context -> GP_Pixmap
[gfxprim.git] / doc / environment_variables.txt
blob216f19f1e8a30fc557c2e687dcc8a51c2f55ce8b
1 Environment Variables
2 ---------------------
4 The GFXprim library behavior may be changed by a couple of environment
5 variables:
7 [[GP_THREADS]]
8 GP_THREADS
9 ~~~~~~~~~~
11 'GP_THREADS' overrides GP_NrThreadsSet() settings. The value is the same as it
12 would have been set by GP_NrThreadsSet() which is described in the table
13 below:
15 .GP_THREADS possible values
16 [width="60%",options="header"]
17 |=============================================================================
18 | Value | Description
19 |   0   | Use auto-detection, algorithms runs in nCPU threads unless the image
20           buffer is too small.
21 |   1   | Use one thread only.
22 |  >=2  | Use N threads unless the image buffer is too small.
23 |=============================================================================
25 [[GP_DEBUG]]
26 GP_DEBUG
27 ~~~~~~~~
29 The 'GP_DEBUG' environment variable may be used to set library debug level.
30 See link:debug.html[debug messages] description for more information.
32 The variable and its value is used only once at the time first debug message
33 is about to be printed.
35 The debug level is an integer number, the higher it is the more verbose
36 messages are printed. Current the maximum used in GFXprim sources is 4, this
37 may change in the future. Use 'GP_DEBUG=10' to enable all debug messages for
38 sure.
40 The output is, by default, written to stderr and will look like:
41 ------------------------------------------------------------------------------
42 1: GP_Debug.c:GP_DebugPrint():67: Using debug level GP_DEBUG=10 from enviroment variable
43 1: GP_Debug.c:GP_DebugPrint():71: GFXprim library version 1.0.0-rc0
44 1: GP_X11_Conn.h:x11_open():43: Opening X11 display '(null)'
45 1: GP_InputDriverX11.c:init_table():154: Initializing X11 KeyCode table
46   3: GP_InputDriverX11.c:init_table():174: Mapping Key 'Up' KeySym 'Up' (65362) to KeyCode 111
47 ...
48 1: GP_Loader.c:loader_by_filename():222: Loading file by filename extension 'pgm'
49 1: GP_Loader.c:loader_by_extension():198: Found loader 'Netpbm portable Graymap'
50 1: GP_PNM.c:load_header():244: Have header P2 (ASCII encoded PGM) 24x7 depth=15
51 1: GP_Pixmap.c:GP_PixmapAlloc():62: Allocating pixmap 24 x 7 - G4
52    4: GP_X11.c:x11_update_rect():71: Updating rect 222x458-418x479
53    4: GP_X11.c:x11_update_rect():71: Updating rect 214x458-426x479
54  2: GP_Blit.c:GP_BlitXYXY_Clipped():129: Blitting 23x6, available 332x244
55  2: GP_Blit.c:GP_BlitXYXY_Clipped():139: Blitting 0x0->23x6 in 24x7 to 308x236 in 640x480
56   3: GP_X11.c:x11_set_attributes():225: Setting window caption to 'Spiv ~ test.pgm 1:1.000'
57    4: GP_X11.c:x11_flip():91: Flipping pixmap
58 1: GP_Pixmap.c:GP_PixmapFree():102: Freeing pixmap (0x7f5008000b60)
59 1: GP_X11_Conn.h:x11_close():72: Closing X11 display
60 ------------------------------------------------------------------------------