BKE_global.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
#pragma once

 
#include "DNA_listBase.h"
 
struct Main;

struct Global {

  Main *main;

  Main *pr_main;

  char filepath_last_image[/*FILE_MAX*/ 1024];
  char filepath_last_library[/*FILE_MAX*/ 1024];
  char filepath_last_blend[/*FILE_MAX*/ 1024];

  ListBase recent_files;

  bool is_break;

  bool background;

  bool quiet;

  bool factory_startup;

  short moving;

  bool is_rendering;

  short debug_value;

  int f;
 
  struct {
    int level;
    void *file;
  } log;

  int debug;

  bool randomize_geometry_element_order;

  int fileflags;

  char autoexec_fail[200];

  bool opengl_deprecation_usage_detected;
  const char *opengl_deprecation_usage_filename;
  int opengl_deprecation_usage_lineno;

  char gpu_debug_scope_name[200];
 
  bool profile_gpu;
};
 
/* **************** GLOBAL ********************* */

enum {
  G_FLAG_RENDER_VIEWPORT = (1 << 0),
  G_FLAG_PICKSEL = (1 << 2),
  G_FLAG_EVENT_SIMULATE = (1 << 3),
  G_FLAG_USERPREF_NO_SAVE_ON_EXIT = (1 << 4),

  G_FLAG_INTERNET_ALLOW = (1 << 10),
 
  /* NOTE: storing both online/offline override is needed so changing the preference
   * can be disabled when launching Blender with `--offline-mode`.
   * This means that users in a controlled environment can launch
   * in offline-mode and the option can't be changed afterwards. */

  G_FLAG_INTERNET_OVERRIDE_PREF_ONLINE = (1 << 11),
  G_FLAG_INTERNET_OVERRIDE_PREF_OFFLINE = (1 << 12),
 
  G_FLAG_SCRIPT_AUTOEXEC = (1 << 13),
  G_FLAG_SCRIPT_OVERRIDE_PREF = (1 << 14),
  G_FLAG_SCRIPT_AUTOEXEC_FAIL = (1 << 15),
  G_FLAG_SCRIPT_AUTOEXEC_FAIL_QUIET = (1 << 16),

  G_FLAG_GPU_BACKEND_FALLBACK = (1 << 17),
  G_FLAG_GPU_BACKEND_FALLBACK_QUIET = (1 << 18),
 
};
 
#define G_FLAG_INTERNET_OVERRIDE_PREF_ANY \
  (G_FLAG_INTERNET_OVERRIDE_PREF_ONLINE | G_FLAG_INTERNET_OVERRIDE_PREF_OFFLINE)

#define G_FLAG_ALL_RUNTIME \
  (G_FLAG_SCRIPT_AUTOEXEC | G_FLAG_SCRIPT_OVERRIDE_PREF | G_FLAG_INTERNET_ALLOW | \
   G_FLAG_INTERNET_OVERRIDE_PREF_ONLINE | G_FLAG_INTERNET_OVERRIDE_PREF_OFFLINE | \
   G_FLAG_EVENT_SIMULATE | G_FLAG_USERPREF_NO_SAVE_ON_EXIT | G_FLAG_GPU_BACKEND_FALLBACK | \
   G_FLAG_GPU_BACKEND_FALLBACK_QUIET | \
\
   /* #BPY_python_reset is responsible for resetting these flags on file load. */ \
   G_FLAG_SCRIPT_AUTOEXEC_FAIL | G_FLAG_SCRIPT_AUTOEXEC_FAIL_QUIET)

#define G_FLAG_ALL_READFILE 0

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 detection. */
  G_DEBUG_GPU_FORCE_VULKAN_LOCAL_READ = (1 << 19), /* Force GPU dynamic rendering local read. */
  G_DEBUG_GPU_COMPILE_SHADERS = (1 << 20),         /* Compile all statically defined shaders. . */
  G_DEBUG_GPU_RENDERDOC = (1 << 21),               /* Enable RenderDoc integration. */
  G_DEBUG_XR = (1 << 22),                          /* XR/OpenXR messages */
  G_DEBUG_XR_TIME = (1 << 23),                     /* XR/OpenXR timing messages */
 
  G_DEBUG_GHOST = (1 << 24),  /* Debug GHOST module. */
  G_DEBUG_WINTAB = (1 << 25), /* 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)

enum {
  G_FILE_AUTOPACK = (1 << 0),
  G_FILE_COMPRESS = (1 << 1),

  G_BACKGROUND_NO_DEPSGRAPH = 1 << 2,

  G_LIBOVERRIDE_NO_AUTO_RESYNC = 1 << 3,
 
  // G_FILE_DEPRECATED_9 = (1 << 9),
  G_FILE_NO_UI = (1 << 10),
 
  /* Bits 11 to 22 (inclusive) are deprecated & need to be cleared */

  G_FILE_RECOVER_READ = (1 << 23),
  G_FILE_RECOVER_WRITE = (1 << 24),
  // #define G_FILE_MESH_COMPAT       (1 << 26)
  // #define G_FILE_GLSL_NO_ENV_LIGHTING (1 << 28) /* deprecated */
  G_FILE_ASSET_EDIT_FILE = (1 << 29),
};

#define G_FILE_FLAG_ALL_RUNTIME \
  (G_BACKGROUND_NO_DEPSGRAPH | G_LIBOVERRIDE_NO_AUTO_RESYNC | G_FILE_NO_UI | \
   G_FILE_RECOVER_READ | G_FILE_RECOVER_WRITE)

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),
  G_TRANSFORM_CURSOR = (1 << 5),
};

extern Global G;

#define G_MAIN (G).main