--debug-gpu-shader: Dump GLSL shaders to disk
[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         short debug_value;
78
79         /* saved to the blend file as FileGlobal.globalf,
80          * however this is now only used for runtime options */
81         int f;
82
83         /* debug flag, G_DEBUG, G_DEBUG_PYTHON & friends, set python or command line args */
84         int debug;
85
86         /* this variable is written to / read from FileGlobal->fileflags */
87         int fileflags;
88
89         /* message to use when autoexec fails */
90         char autoexec_fail[200];
91 } Global;
92
93 /* **************** GLOBAL ********************* */
94
95 /* G.f */
96 #define G_RENDER_OGL    (1 <<  0)
97 #define G_SWAP_EXCHANGE (1 <<  1)
98 /* also uses G_FILE_AUTOPLAY */
99 /* #define G_RENDER_SHADOW      (1 <<  3) */ /* temp flag, removed */
100 #define G_BACKBUFSEL    (1 <<  4)
101 #define G_PICKSEL       (1 <<  5)
102
103 /* #define G_FACESELECT (1 <<  8) use (mesh->editflag & ME_EDIT_PAINT_FACE_SEL) */
104
105 #define G_SCRIPT_AUTOEXEC (1 << 13)
106 #define G_SCRIPT_OVERRIDE_PREF (1 << 14) /* when this flag is set ignore the userprefs */
107 #define G_SCRIPT_AUTOEXEC_FAIL (1 << 15)
108 #define G_SCRIPT_AUTOEXEC_FAIL_QUIET (1 << 16)
109
110 /* #define G_NOFROZEN   (1 << 17) also removed */
111 /* #define G_GREASEPENCIL   (1 << 17)   also removed */
112
113 /* #define G_AUTOMATKEYS        (1 << 30)   also removed */
114
115 /* G.debug */
116 enum {
117         G_DEBUG =           (1 << 0), /* general debug flag, print more info in unexpected cases */
118         G_DEBUG_FFMPEG =    (1 << 1),
119         G_DEBUG_PYTHON =    (1 << 2), /* extra python info */
120         G_DEBUG_EVENTS =    (1 << 3), /* input/window/screen events */
121         G_DEBUG_HANDLERS =  (1 << 4), /* events handling */
122         G_DEBUG_WM =        (1 << 5), /* operator, undo */
123         G_DEBUG_JOBS =      (1 << 6), /* jobs time profiling */
124         G_DEBUG_FREESTYLE = (1 << 7), /* freestyle messages */
125         G_DEBUG_DEPSGRAPH = (1 << 8), /* depsgraph messages */
126         G_DEBUG_SIMDATA =   (1 << 9), /* sim debug data display */
127         G_DEBUG_GPU_MEM =   (1 << 10), /* gpu memory in status bar */
128         G_DEBUG_DEPSGRAPH_NO_THREADS = (1 << 11),  /* single threaded depsgraph */
129         G_DEBUG_GPU =        (1 << 12), /* gpu debug */
130         G_DEBUG_IO = (1 << 13),   /* IO Debugging (for Collada, ...)*/
131         G_DEBUG_GPU_SHADERS = (1 << 14),   /* GLSL shaders */
132 };
133
134 #define G_DEBUG_ALL  (G_DEBUG | G_DEBUG_FFMPEG | G_DEBUG_PYTHON | G_DEBUG_EVENTS | G_DEBUG_WM | G_DEBUG_JOBS | \
135                       G_DEBUG_FREESTYLE | G_DEBUG_DEPSGRAPH | G_DEBUG_GPU_MEM | G_DEBUG_IO | G_DEBUG_GPU_SHADERS)
136
137
138 /* G.fileflags */
139
140 #define G_AUTOPACK               (1 << 0)
141 #define G_FILE_COMPRESS          (1 << 1)
142 #define G_FILE_AUTOPLAY          (1 << 2)
143
144 #ifdef DNA_DEPRECATED_ALLOW
145 #define G_FILE_ENABLE_ALL_FRAMES (1 << 3)               /* deprecated */
146 #define G_FILE_SHOW_DEBUG_PROPS  (1 << 4)               /* deprecated */
147 #define G_FILE_SHOW_FRAMERATE    (1 << 5)               /* deprecated */
148 /* #define G_FILE_SHOW_PROFILE   (1 << 6) */            /* deprecated */
149 /* #define G_FILE_LOCK           (1 << 7) */            /* deprecated */
150 /* #define G_FILE_SIGN           (1 << 8) */            /* deprecated */
151 #endif  /* DNA_DEPRECATED_ALLOW */
152
153 #define G_FILE_USERPREFS         (1 << 9)
154 #define G_FILE_NO_UI             (1 << 10)
155 #ifdef DNA_DEPRECATED_ALLOW
156 /* #define G_FILE_GAME_TO_IPO    (1 << 11) */           /* deprecated */
157 #define G_FILE_GAME_MAT          (1 << 12)              /* deprecated */
158 /* #define G_FILE_DISPLAY_LISTS  (1 << 13) */           /* deprecated */
159 #define G_FILE_SHOW_PHYSICS      (1 << 14)              /* deprecated */
160 #define G_FILE_GAME_MAT_GLSL     (1 << 15)              /* deprecated */
161 /* #define G_FILE_GLSL_NO_LIGHTS     (1 << 16) */       /* deprecated */
162 #define G_FILE_GLSL_NO_SHADERS   (1 << 17)              /* deprecated */
163 #define G_FILE_GLSL_NO_SHADOWS   (1 << 18)              /* deprecated */
164 #define G_FILE_GLSL_NO_RAMPS     (1 << 19)              /* deprecated */
165 #define G_FILE_GLSL_NO_NODES     (1 << 20)              /* deprecated */
166 #define G_FILE_GLSL_NO_EXTRA_TEX (1 << 21)              /* deprecated */
167 #define G_FILE_IGNORE_DEPRECATION_WARNINGS  (1 << 22)   /* deprecated */
168 #endif  /* DNA_DEPRECATED_ALLOW */
169
170 /* On read, use #FileGlobal.filename instead of the real location on-disk,
171  * needed for recovering temp files so relative paths resolve */
172 #define G_FILE_RECOVER           (1 << 23)
173 /* On write, remap relative file paths to the new file location. */
174 #define G_FILE_RELATIVE_REMAP    (1 << 24)
175 /* On write, make backup `.blend1`, `.blend2` ... files, when the users preference is enabled */
176 #define G_FILE_HISTORY           (1 << 25)
177 /* BMesh option to save as older mesh format */
178 #define G_FILE_MESH_COMPAT       (1 << 26)
179 /* On write, restore paths after editing them (G_FILE_RELATIVE_REMAP) */
180 #define G_FILE_SAVE_COPY         (1 << 27)
181 #define G_FILE_GLSL_NO_ENV_LIGHTING (1 << 28)
182
183 #define G_FILE_FLAGS_RUNTIME (G_FILE_NO_UI | G_FILE_RELATIVE_REMAP | G_FILE_MESH_COMPAT | G_FILE_SAVE_COPY)
184
185 /* ENDIAN_ORDER: indicates what endianness the platform where the file was
186  * written had. */
187 #if !defined(__BIG_ENDIAN__) && !defined(__LITTLE_ENDIAN__)
188 #  error Either __BIG_ENDIAN__ or __LITTLE_ENDIAN__ must be defined.
189 #endif
190
191 #define L_ENDIAN    1
192 #define B_ENDIAN    0
193
194 #ifdef __BIG_ENDIAN__
195 #  define ENDIAN_ORDER B_ENDIAN
196 #else
197 #  define ENDIAN_ORDER L_ENDIAN
198 #endif
199
200 /* G.moving, signals drawing in (3d) window to denote transform */
201 #define G_TRANSFORM_OBJ         1
202 #define G_TRANSFORM_EDIT        2
203 #define G_TRANSFORM_SEQ         4
204 #define G_TRANSFORM_FCURVES     8
205
206 /* Memory is allocated where? blender.c */
207 extern Global G;
208
209 #ifdef __cplusplus
210 }
211 #endif
212         
213 #endif