304 lines
11 KiB
C++
304 lines
11 KiB
C++
/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup bke
|
|
* \section aboutglobal Global settings
|
|
* Global settings, handles, pointers. This is the root for finding
|
|
* any data in Blender. This block is not serialized, but built anew
|
|
* for every fresh Blender run.
|
|
*/
|
|
|
|
#include "BLI_utildefines.h"
|
|
#include "DNA_listBase.h"
|
|
|
|
struct Main;
|
|
|
|
/**
|
|
* Global data, typically accessed from #G.
|
|
* See: #BKE_blender_globals_init & #BKE_blender_globals_clear.
|
|
*
|
|
* \note This is run-time only but some global data is written
|
|
* to #FileGlobal which is used to initialize members of #Global.
|
|
*/
|
|
struct Global {
|
|
|
|
/**
|
|
* Data for the current active blend file.
|
|
*
|
|
* Note that `CTX_data_main(C)` should be used where possible.
|
|
* Otherwise access via #G_MAIN.
|
|
*/
|
|
Main *main;
|
|
|
|
/**
|
|
* Preview main is stored to avoid loading the preview file in multiple scenarios.
|
|
* It is actually shared between shader node previews and asset previews.
|
|
*/
|
|
Main *pr_main;
|
|
|
|
/** Last saved location for images. */
|
|
char filepath_last_image[/*FILE_MAX*/ 1024];
|
|
/** Last used location for library link/append. */
|
|
char filepath_last_library[/*FILE_MAX*/ 1024];
|
|
|
|
/**
|
|
* Strings of recently opened files to show in the file menu.
|
|
* A list of #RecentFile read from #BLENDER_HISTORY_FILE.
|
|
*/
|
|
ListBase recent_files;
|
|
|
|
/**
|
|
* Set when Escape been pressed or `Ctrl-C` pressed in background mode.
|
|
* Used for render quit and some other background tasks such as baking.
|
|
*/
|
|
bool is_break;
|
|
|
|
/**
|
|
* Blender is running without any Windows or OpenGLES context.
|
|
* Typically set by the `--background` command-line argument.
|
|
*
|
|
* Also enabled when build defines `WITH_PYTHON_MODULE` or `WITH_HEADLESS` are set
|
|
* (which use background mode by definition).
|
|
*/
|
|
bool background;
|
|
|
|
/**
|
|
* When true, suppress any non-error print messages such as files saves, loaded, quitting etc.
|
|
* This is used so command line tools can control output without unnecessary noise.
|
|
*
|
|
* \note This should only be used to suppress printing (not reports or other kinds of logging).
|
|
*/
|
|
bool quiet;
|
|
|
|
/**
|
|
* Skip reading the startup file and user preferences.
|
|
* Also disable saving the preferences on exit (see #G_FLAG_USERPREF_NO_SAVE_ON_EXIT),
|
|
* see via the command line argument: `--factory-startup`.
|
|
*/
|
|
bool factory_startup;
|
|
|
|
/**
|
|
* Set when the user is interactively moving (transforming) content.
|
|
* see: #G_TRANSFORM_OBJ and related flags.
|
|
*/
|
|
short moving;
|
|
|
|
/** To indicate render is busy, prevent render-window events, animation playback etc. */
|
|
bool is_rendering;
|
|
|
|
/**
|
|
* Debug value, can be set from the UI and python, used for testing nonstandard features.
|
|
* DO NOT abuse it with generic checks like `if (G.debug_value > 0)`. Do not use it as bitflags.
|
|
* Only precise specific values should be checked for, to avoid unpredictable side-effects.
|
|
* Please document here the value(s) you are using (or a range of values reserved to some area):
|
|
* * -16384 and below: Reserved for python (add-ons) usage.
|
|
* * -1: Disable faster motion paths computation (since 08/2018).
|
|
* * 1 - 30: EEVEE debug/stats values (01/2018).
|
|
* * 31: Enable the Select Debug Engine. Only available with #WITH_DRAW_DEBUG (08/2021).
|
|
* * 101: Enable UI debug drawing of full-screen area's corner widget (10/2014).
|
|
* * 102: Enable extra items in string search UI (05/2022).
|
|
* * 666: Use quicker batch delete for outliners' delete hierarchy (01/2019).
|
|
* * 777: Enable UI node panel's sockets polling (11/2011).
|
|
* * 799: Enable some mysterious new depsgraph behavior (05/2015).
|
|
* * 1112: Disable new Cloth internal springs handling (09/2014).
|
|
* * 1234: Disable new dyntopo code fixing skinny faces generation (04/2015).
|
|
* * 3001: Enable additional Fluid modifier (Mantaflow) options (02/2020).
|
|
* * 4000: Line Art state output and debugging logs (03/2021).
|
|
* * 4001: Mesh topology information in the spreadsheet (01/2022).
|
|
* * 16384 and above: Reserved for python (add-ons) usage.
|
|
*/
|
|
short debug_value;
|
|
|
|
/**
|
|
* Saved to the blend file as #FileGlobal.globalf
|
|
*
|
|
* \note Currently this is only used for runtime options, adding flags to #G_FLAG_ALL_READFILE
|
|
* will cause them to be written and read to files.
|
|
*/
|
|
int f;
|
|
|
|
struct {
|
|
/**
|
|
* Logging vars (different loggers may use).
|
|
* Set via `--log-level` command line argument.
|
|
*/
|
|
int level;
|
|
/**
|
|
* FILE handle or use `stderr` (we own this so close when done).
|
|
* Set via `--log-file` command line argument.
|
|
*/
|
|
void *file;
|
|
} log;
|
|
|
|
/**
|
|
* Debug flag, #G_DEBUG, #G_DEBUG_PYTHON & friends, set via:
|
|
* - Command line arguments: `--debug`, `--debug-memory` ... etc.
|
|
* - Python API: `bpy.app.debug`, `bpy.app.debug_memory` ... etc.
|
|
*/
|
|
int debug;
|
|
|
|
/**
|
|
* When true, various geometry processing algorithms randomize the order of elements (e.g.
|
|
* vertices or edges) in the output. In many cases, we don't make guarantees about the exact
|
|
* order of elements. So if users depend on the indices with e.g. geometry nodes, their file can
|
|
* break in a different Blender version. Explicitly turning on randomization can help protect
|
|
* oneself against such breakages.
|
|
*/
|
|
bool randomize_geometry_element_order;
|
|
|
|
/**
|
|
* Control behavior of file reading/writing.
|
|
*
|
|
* This variable is written to / read from #FileGlobal.fileflags.
|
|
* See: #G_FILE_COMPRESS and related flags.
|
|
*/
|
|
int fileflags;
|
|
|
|
/**
|
|
* Message to show when loading a `.blend` file attempts to execute
|
|
* a Python script or driver-expression when doing so is disallowed.
|
|
*
|
|
* Set when `(G.f & G_FLAG_SCRIPT_AUTOEXEC_FAIL) == 0`,
|
|
* so users can be alerted to the reason why the file may not be behaving as expected.
|
|
* Typically Python drivers.
|
|
*/
|
|
char autoexec_fail[200];
|
|
|
|
/**
|
|
* Has there been an opengl deprecation call detected when running on a none OpenGL backend.
|
|
*/
|
|
bool opengl_deprecation_usage_detected;
|
|
const char *opengl_deprecation_usage_filename;
|
|
int opengl_deprecation_usage_lineno;
|
|
};
|
|
|
|
/* **************** GLOBAL ********************* */
|
|
|
|
/** #Global.f */
|
|
enum {
|
|
G_FLAG_RENDER_VIEWPORT = (1 << 0),
|
|
G_FLAG_PICKSEL = (1 << 2),
|
|
/** Support simulating events (for testing). */
|
|
G_FLAG_EVENT_SIMULATE = (1 << 3),
|
|
G_FLAG_USERPREF_NO_SAVE_ON_EXIT = (1 << 4),
|
|
|
|
G_FLAG_SCRIPT_AUTOEXEC = (1 << 13),
|
|
/** When this flag is set ignore the preferences #USER_SCRIPT_AUTOEXEC_DISABLE. */
|
|
G_FLAG_SCRIPT_OVERRIDE_PREF = (1 << 14),
|
|
G_FLAG_SCRIPT_AUTOEXEC_FAIL = (1 << 15),
|
|
G_FLAG_SCRIPT_AUTOEXEC_FAIL_QUIET = (1 << 16),
|
|
};
|
|
|
|
/** Don't overwrite these flags when reading a file. */
|
|
#define G_FLAG_ALL_RUNTIME \
|
|
(G_FLAG_SCRIPT_AUTOEXEC | G_FLAG_SCRIPT_OVERRIDE_PREF | G_FLAG_EVENT_SIMULATE | \
|
|
G_FLAG_USERPREF_NO_SAVE_ON_EXIT | \
|
|
\
|
|
/* #BPY_python_reset is responsible for resetting these flags on file load. */ \
|
|
G_FLAG_SCRIPT_AUTOEXEC_FAIL | G_FLAG_SCRIPT_AUTOEXEC_FAIL_QUIET)
|
|
|
|
/** Flags to read from blend file. */
|
|
#define G_FLAG_ALL_READFILE 0
|
|
|
|
/** #Global.debug */
|
|
enum {
|
|
G_DEBUG = (1 << 0), /* general debug flag, print more info in unexpected cases */
|
|
G_DEBUG_FFMPEG = (1 << 1),
|
|
G_DEBUG_PYTHON = (1 << 2), /* extra python info */
|
|
G_DEBUG_EVENTS = (1 << 3), /* input/window/screen events */
|
|
G_DEBUG_HANDLERS = (1 << 4), /* events handling */
|
|
G_DEBUG_WM = (1 << 5), /* operator, undo */
|
|
G_DEBUG_JOBS = (1 << 6), /* jobs time profiling */
|
|
G_DEBUG_FREESTYLE = (1 << 7), /* freestyle messages */
|
|
G_DEBUG_DEPSGRAPH_BUILD = (1 << 8), /* depsgraph construction messages */
|
|
G_DEBUG_DEPSGRAPH_EVAL = (1 << 9), /* depsgraph evaluation messages */
|
|
G_DEBUG_DEPSGRAPH_TAG = (1 << 10), /* depsgraph tagging messages */
|
|
G_DEBUG_DEPSGRAPH_TIME = (1 << 11), /* depsgraph timing statistics and messages */
|
|
G_DEBUG_DEPSGRAPH_NO_THREADS = (1 << 12), /* single threaded depsgraph */
|
|
G_DEBUG_DEPSGRAPH_PRETTY = (1 << 13), /* use pretty colors in depsgraph messages */
|
|
G_DEBUG_DEPSGRAPH_UID = (1 << 14), /* Verify validness of session-wide identifiers
|
|
* assigned to ID datablocks */
|
|
G_DEBUG_DEPSGRAPH = (G_DEBUG_DEPSGRAPH_BUILD | G_DEBUG_DEPSGRAPH_EVAL | G_DEBUG_DEPSGRAPH_TAG |
|
|
G_DEBUG_DEPSGRAPH_TIME | G_DEBUG_DEPSGRAPH_UID),
|
|
G_DEBUG_SIMDATA = (1 << 15), /* sim debug data display */
|
|
G_DEBUG_GPU = (1 << 16), /* gpu debug */
|
|
G_DEBUG_IO = (1 << 17), /* IO Debugging (for Collada, ...). */
|
|
G_DEBUG_GPU_FORCE_WORKAROUNDS = (1 << 18), /* force gpu workarounds bypassing detections. */
|
|
G_DEBUG_GPU_COMPILE_SHADERS = (1 << 19), /* Compile all statically defined shaders. . */
|
|
G_DEBUG_GPU_RENDERDOC = (1 << 20), /* Enable RenderDoc integration. */
|
|
G_DEBUG_XR = (1 << 21), /* XR/OpenXR messages */
|
|
G_DEBUG_XR_TIME = (1 << 22), /* XR/OpenXR timing messages */
|
|
|
|
G_DEBUG_GHOST = (1 << 23), /* Debug GHOST module. */
|
|
G_DEBUG_WINTAB = (1 << 24), /* Debug Wintab. */
|
|
};
|
|
|
|
#define G_DEBUG_ALL \
|
|
(G_DEBUG | G_DEBUG_FFMPEG | G_DEBUG_PYTHON | G_DEBUG_EVENTS | G_DEBUG_WM | G_DEBUG_JOBS | \
|
|
G_DEBUG_FREESTYLE | G_DEBUG_DEPSGRAPH | G_DEBUG_IO | G_DEBUG_GHOST | G_DEBUG_WINTAB)
|
|
|
|
/** #Global.fileflags */
|
|
enum {
|
|
G_FILE_AUTOPACK = (1 << 0),
|
|
G_FILE_COMPRESS = (1 << 1),
|
|
|
|
// G_FILE_DEPRECATED_9 = (1 << 9),
|
|
G_FILE_NO_UI = (1 << 10),
|
|
|
|
/* Bits 11 to 22 (inclusive) are deprecated & need to be cleared */
|
|
|
|
/**
|
|
* On read, use #FileGlobal.filename instead of the real location on-disk,
|
|
* needed for recovering temp files so relative paths resolve.
|
|
*
|
|
* \note In some ways it would be nicer to make this an argument passed to file loading.
|
|
* In practice this means recover needs to be passed around to too many low level functions,
|
|
* so keep this as a flag.
|
|
*/
|
|
G_FILE_RECOVER_READ = (1 << 23),
|
|
/**
|
|
* On write, assign use #FileGlobal.filename, otherwise leave it blank,
|
|
* needed so files can be recovered at their original locations.
|
|
*
|
|
* \note only #BLENDER_QUIT_FILE and auto-save files include recovery information.
|
|
* As users/developers may not want their paths exposed in publicly distributed files.
|
|
*/
|
|
G_FILE_RECOVER_WRITE = (1 << 24),
|
|
/** BMesh option to save as older mesh format */
|
|
/* #define G_FILE_MESH_COMPAT (1 << 26) */
|
|
/* #define G_FILE_GLSL_NO_ENV_LIGHTING (1 << 28) */ /* deprecated */
|
|
};
|
|
|
|
/**
|
|
* Run-time only #G.fileflags which are never read or written to/from Blend files.
|
|
* This means we can change the values without worrying about do-versions.
|
|
*/
|
|
#define G_FILE_FLAG_ALL_RUNTIME (G_FILE_NO_UI | G_FILE_RECOVER_READ | G_FILE_RECOVER_WRITE)
|
|
|
|
/** #Global.moving, signals drawing in (3d) window to denote transform */
|
|
enum {
|
|
G_TRANSFORM_OBJ = (1 << 0),
|
|
G_TRANSFORM_EDIT = (1 << 1),
|
|
G_TRANSFORM_SEQ = (1 << 2),
|
|
G_TRANSFORM_FCURVES = (1 << 3),
|
|
G_TRANSFORM_WM = (1 << 4),
|
|
/**
|
|
* Set when transforming the cursor itself.
|
|
* Used as a hint to draw the cursor (even when hidden).
|
|
* Otherwise it's not possible to see what's being transformed.
|
|
*/
|
|
G_TRANSFORM_CURSOR = (1 << 5),
|
|
};
|
|
|
|
/** Defined in `blender.cc` */
|
|
extern Global G;
|
|
|
|
/**
|
|
* Stupid macro to hide the few *valid* usages of `G.main` (from startup/exit code e.g.),
|
|
* helps with cleanup task.
|
|
*/
|
|
#define G_MAIN (G).main
|