Physically based defaults for Eevee Bloom and Shutter
[blender.git] / source / blender / blenkernel / BKE_global.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef __BKE_GLOBAL_H__
28 #define __BKE_GLOBAL_H__
29
30 /** \file BKE_global.h
31  *  \ingroup bke
32  *  \since March 2001
33  *  \author nzc
34  *  \section aboutglobal Global settings
35  *   Global settings, handles, pointers. This is the root for finding
36  *   any data in Blender. This block is not serialized, but built anew
37  *   for every fresh Blender run.
38  */
39
40 #include "DNA_listBase.h"
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 /* forwards */
47 struct Main;
48
49 typedef struct Global {
50
51         /* active pointers */
52         struct Main *main;
53
54         /* strings: lastsaved */
55         char ima[1024], lib[1024]; /* 1024 = FILE_MAX */
56
57         /* when set: G_MAIN->name contains valid relative base path */
58         bool relbase_valid;
59         bool file_loaded;
60         bool save_over;
61
62         /* strings of recent opened files */
63         struct ListBase recent_files;
64
65         /* has escape been pressed or Ctrl+C pressed in background mode, used for render quit */
66         bool is_break;
67
68         bool background;
69         bool factory_startup;
70
71         short moving;
72
73         /* to indicate render is busy, prevent renderwindow events etc */
74         bool is_rendering;
75
76         /* Debug value, can be set from the UI and python, used for testing nonstandard features.
77          * DO NOT abuse it with generic checks like `if (G.debug_value > 0)`. Do not use it as bitflags.
78          * Only precise specific values should be checked for, to avoid unpredictable side-effects.
79          * Please document here the value(s) you are using (or a range of values reserved to some area).
80          *   * -16384 and below: Reserved for python (add-ons) usage.
81          *   *     -1: Disable faster motion paths computation (since 08/2018).
82          *   * 1 - 30: EEVEE debug/stats values (01/2018).
83          *   *    101: Enable UI debug drawing of fullscreen area's corner widget (10/2014).
84          *   *    527: Old mysterious switch in behavior of MeshDeform modifier (before 04/2010).
85          *   *    666: Use quicker batch delete for outliners' delete hierarchy (01/2019).
86          *   *    777: Enable UI node panel's sockets polling (11/2011).
87          *   *    799: Enable some mysterious new depsgraph behavior (05/2015).
88          *   *   1112: Disable new Cloth internal springs hanlding (09/2014).
89          *   *   1234: Disable new dyntopo code fixing skinny faces generation (04/2015).
90          *   * 16384 and above: Reserved for python (add-ons) usage.
91          */
92         short debug_value;
93
94         /* saved to the blend file as FileGlobal.globalf,
95          * however this is now only used for runtime options */
96         int f;
97
98         struct {
99                 /* Logging vars (different loggers may use). */
100                 int level;
101                 /* FILE handle or use stderr (we own this so close when done). */
102                 void *file;
103         } log;
104
105         /* debug flag, G_DEBUG, G_DEBUG_PYTHON & friends, set python or command line args */
106         int debug;
107
108         /* this variable is written to / read from FileGlobal->fileflags */
109         int fileflags;
110
111         /* message to use when autoexec fails */
112         char autoexec_fail[200];
113 } Global;
114
115 /* **************** GLOBAL ********************* */
116
117 /* G.f */
118 #define G_RENDER_OGL    (1 <<  0)
119 #define G_SWAP_EXCHANGE (1 <<  1)
120 /* #define G_RENDER_SHADOW      (1 <<  3) */ /* temp flag, removed */
121 #define G_BACKBUFSEL    (1 <<  4)
122 #define G_PICKSEL       (1 <<  5)
123
124 /* #define G_FACESELECT (1 <<  8) use (mesh->editflag & ME_EDIT_PAINT_FACE_SEL) */
125
126 #define G_SCRIPT_AUTOEXEC (1 << 13)
127 #define G_SCRIPT_OVERRIDE_PREF (1 << 14) /* when this flag is set ignore the userprefs */
128 #define G_SCRIPT_AUTOEXEC_FAIL (1 << 15)
129 #define G_SCRIPT_AUTOEXEC_FAIL_QUIET (1 << 16)
130
131 /* #define G_NOFROZEN   (1 << 17) also removed */
132 /* #define G_GREASEPENCIL   (1 << 17)   also removed */
133
134 /* #define G_AUTOMATKEYS        (1 << 30)   also removed */
135
136 /* G.debug */
137 enum {
138         G_DEBUG =           (1 << 0),  /* general debug flag, print more info in unexpected cases */
139         G_DEBUG_FFMPEG =    (1 << 1),
140         G_DEBUG_PYTHON =    (1 << 2),  /* extra python info */
141         G_DEBUG_EVENTS =    (1 << 3),  /* input/window/screen events */
142         G_DEBUG_HANDLERS =  (1 << 4),  /* events handling */
143         G_DEBUG_WM =        (1 << 5),  /* operator, undo */
144         G_DEBUG_JOBS =      (1 << 6),  /* jobs time profiling */
145         G_DEBUG_FREESTYLE = (1 << 7),  /* freestyle messages */
146         G_DEBUG_DEPSGRAPH_BUILD      = (1 << 8),   /* depsgraph construction messages */
147         G_DEBUG_DEPSGRAPH_EVAL       = (1 << 9),   /* depsgraph evaluation messages */
148         G_DEBUG_DEPSGRAPH_TAG        = (1 << 10),  /* depsgraph tagging messages */
149         G_DEBUG_DEPSGRAPH_TIME       = (1 << 11),  /* depsgraph timing statistics and messages */
150         G_DEBUG_DEPSGRAPH_NO_THREADS = (1 << 12),  /* single threaded depsgraph */
151         G_DEBUG_DEPSGRAPH_PRETTY     = (1 << 13),  /* use pretty colors in depsgraph messages */
152         G_DEBUG_DEPSGRAPH = (G_DEBUG_DEPSGRAPH_BUILD |
153                              G_DEBUG_DEPSGRAPH_EVAL |
154                              G_DEBUG_DEPSGRAPH_TAG |
155                              G_DEBUG_DEPSGRAPH_TIME),
156         G_DEBUG_SIMDATA =   (1 << 14),  /* sim debug data display */
157         G_DEBUG_GPU_MEM =   (1 << 15),  /* gpu memory in status bar */
158         G_DEBUG_GPU =       (1 << 16),  /* gpu debug */
159         G_DEBUG_IO =        (1 << 17),  /* IO Debugging (for Collada, ...)*/
160         G_DEBUG_GPU_SHADERS = (1 << 18),  /* GLSL shaders */
161         G_DEBUG_GPU_FORCE_WORKAROUNDS = (1 << 19),  /* force gpu workarounds bypassing detections. */
162 };
163
164 #define G_DEBUG_ALL  (G_DEBUG | G_DEBUG_FFMPEG | G_DEBUG_PYTHON | G_DEBUG_EVENTS | G_DEBUG_WM | G_DEBUG_JOBS | \
165                       G_DEBUG_FREESTYLE | G_DEBUG_DEPSGRAPH | G_DEBUG_GPU_MEM | G_DEBUG_IO | G_DEBUG_GPU_SHADERS)
166
167
168 /* G.fileflags */
169
170 #define G_AUTOPACK               (1 << 0)
171 #define G_FILE_COMPRESS          (1 << 1)
172
173 #define G_FILE_USERPREFS         (1 << 9)
174 #define G_FILE_NO_UI             (1 << 10)
175 #ifdef DNA_DEPRECATED_ALLOW
176 /* #define G_FILE_GAME_TO_IPO    (1 << 11) */           /* deprecated */
177 #define G_FILE_GAME_MAT          (1 << 12)              /* deprecated */
178 /* #define G_FILE_DISPLAY_LISTS  (1 << 13) */           /* deprecated */
179 #define G_FILE_SHOW_PHYSICS      (1 << 14)              /* deprecated */
180 #define G_FILE_GAME_MAT_GLSL     (1 << 15)              /* deprecated */
181 /* #define G_FILE_GLSL_NO_LIGHTS     (1 << 16) */       /* deprecated */
182 #define G_FILE_GLSL_NO_SHADERS   (1 << 17)              /* deprecated */
183 #define G_FILE_GLSL_NO_SHADOWS   (1 << 18)              /* deprecated */
184 #define G_FILE_GLSL_NO_RAMPS     (1 << 19)              /* deprecated */
185 #define G_FILE_GLSL_NO_NODES     (1 << 20)              /* deprecated */
186 #define G_FILE_GLSL_NO_EXTRA_TEX (1 << 21)              /* deprecated */
187 #define G_FILE_IGNORE_DEPRECATION_WARNINGS  (1 << 22)   /* deprecated */
188 #endif  /* DNA_DEPRECATED_ALLOW */
189
190 /* On read, use #FileGlobal.filename instead of the real location on-disk,
191  * needed for recovering temp files so relative paths resolve */
192 #define G_FILE_RECOVER           (1 << 23)
193 /* On write, remap relative file paths to the new file location. */
194 #define G_FILE_RELATIVE_REMAP    (1 << 24)
195 /* On write, make backup `.blend1`, `.blend2` ... files, when the users preference is enabled */
196 #define G_FILE_HISTORY           (1 << 25)
197 /* BMesh option to save as older mesh format */
198 // #define G_FILE_MESH_COMPAT       (1 << 26)
199 /* On write, restore paths after editing them (G_FILE_RELATIVE_REMAP) */
200 #define G_FILE_SAVE_COPY         (1 << 27)
201 #define G_FILE_GLSL_NO_ENV_LIGHTING (1 << 28)
202
203 #define G_FILE_FLAGS_RUNTIME (G_FILE_NO_UI | G_FILE_RELATIVE_REMAP | G_FILE_SAVE_COPY)
204
205 /* ENDIAN_ORDER: indicates what endianness the platform where the file was
206  * written had. */
207 #if !defined(__BIG_ENDIAN__) && !defined(__LITTLE_ENDIAN__)
208 #  error Either __BIG_ENDIAN__ or __LITTLE_ENDIAN__ must be defined.
209 #endif
210
211 #define L_ENDIAN    1
212 #define B_ENDIAN    0
213
214 #ifdef __BIG_ENDIAN__
215 #  define ENDIAN_ORDER B_ENDIAN
216 #else
217 #  define ENDIAN_ORDER L_ENDIAN
218 #endif
219
220 /* G.moving, signals drawing in (3d) window to denote transform */
221 #define G_TRANSFORM_OBJ         1
222 #define G_TRANSFORM_EDIT        2
223 #define G_TRANSFORM_SEQ         4
224 #define G_TRANSFORM_FCURVES     8
225 #define G_TRANSFORM_WM          16
226
227 /* Memory is allocated where? blender.c */
228 extern Global G;
229
230 /**
231  * Stupid macro to hide the few *valid* usages of G.main (from startup/exit code e.g.), helps with cleanup task.
232  */
233 #define G_MAIN (G).main
234
235 #ifdef __cplusplus
236 }
237 #endif
238
239 #endif