Files
test2/source/creator/creator_args.cc

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

3108 lines
100 KiB
C++
Raw Normal View History

/* SPDX-FileCopyrightText: 2023 Blender Authors
*
* SPDX-License-Identifier: GPL-2.0-or-later */
/** \file
* \ingroup creator
*/
#ifndef WITH_PYTHON_MODULE
# include <cerrno>
# include <cstdlib>
# include <cstring>
# include "MEM_guardedalloc.h"
# include "CLG_log.h"
# ifdef WIN32
# include "BLI_winstuff.h"
# endif
# include "BLI_args.h"
# include "BLI_dynstr.h"
# include "BLI_fileops.h"
# include "BLI_listbase.h"
# include "BLI_path_utils.hh"
# include "BLI_string.h"
# include "BLI_string_utf8.h"
2018-05-18 13:43:30 +02:00
# include "BLI_system.h"
# include "BLI_threads.h"
# include "BLI_utildefines.h"
# ifndef NDEBUG
# include "BLI_mempool.h"
# endif
# include "BKE_appdir.hh"
# include "BKE_blender.hh"
# include "BKE_blender_cli_command.hh"
# include "BKE_blender_version.h"
# include "BKE_blendfile.hh"
# include "BKE_context.hh"
# include "BKE_global.hh"
# include "BKE_image_format.hh"
2024-01-15 12:44:04 -05:00
# include "BKE_lib_id.hh"
# include "BKE_main.hh"
# include "BKE_report.hh"
# include "BKE_scene.hh"
# include "BKE_sound.h"
# include "GPU_context.hh"
# ifdef WITH_OPENGL_BACKEND
# include "GPU_capabilities.hh"
# include "GPU_compilation_subprocess.hh"
# endif
# ifdef WITH_PYTHON
# include "BPY_extern_python.hh"
# include "BPY_extern_run.hh"
# endif
# include "RE_engine.h"
# include "RE_pipeline.h"
# include "WM_api.hh"
# ifdef WITH_LIBMV
# include "libmv-capi.h"
# endif
# include "DEG_depsgraph.hh"
# include "WM_types.hh"
# include "creator_intern.h" /* Own include. */
/* -------------------------------------------------------------------- */
/** \name Build Defines
* \{ */
/**
* Support extracting arguments for all platforms (for documentation purposes).
* These names match the upper case defines.
*/
struct BuildDefs {
bool win32;
bool with_cycles;
bool with_ffmpeg;
bool with_freestyle;
bool with_libmv;
Refactor: OpenColorIO integration Briefly about this change: - OpenColorIO C-API is removed. - The information about color spaces in ImBuf module is removed. It was stored in global ListBase in colormanagement.cc. - Both OpenColorIO and fallback implementation supports GPU drawing. - Fallback implementation supports white point, RGB curves, etc. - Removed check for support of GPU drawing in IMB. Historically it was implemented in a separate library with C-API, this is because way back C++ code needed to stay in intern. This causes all sort of overheads, and even calls that are strictly considered bad level. This change moves OpenColorIO integration into a module within imbuf, next to movie, and next to IMB_colormanagement which is the main user of it. This allows to avoid copy of color spaces, displays, views etc in the ImBuf: they were used to help quickly querying information to be shown on the interface. With this change it can be stored in the same data structures as what is used by the OpenColorIO integration. While it might not be fully avoiding duplication it is now less, and there is no need in the user code to maintain the copies. In a lot of cases this change also avoids allocations done per access to the OpenColorIO. For example, it is not needed anymore to allocate image descriptor in a heap. The bigger user-visible change is that the fallback implementation now supports GLSL drawing, with the whole list of supported features, such as curve mapping and white point. This should help simplifying code which relies on color space conversion on GPU: there is no need to figure out fallback solution in such cases. The only case when drawing will not work is when there is some actual bug, or driver issue, and shader has failed to compile. The change avoids having an opaque type for color space, and instead uses forward declaration. It is a bit verbose on declaration, but helps avoiding unsafe type-casts. There are ways to solve this in the future, like having a header for forward declaration, or to flatten the name space a bit. There should be no user-level changes under normal operation. When building without OpenColorIO or the configuration has a typo or is missing a fuller set of color management tools is applies (such as the white point correction). Pull Request: https://projects.blender.org/blender/blender/pulls/138433
2025-05-09 14:01:43 +02:00
bool with_opencolorio;
bool with_opengl_backend;
bool with_renderdoc;
bool with_vulkan_backend;
bool with_xr_openxr;
};
static void build_defs_init(BuildDefs *build_defs, bool force_all)
{
if (force_all) {
bool *var_end = (bool *)(build_defs + 1);
for (bool *var = (bool *)build_defs; var < var_end; var++) {
*var = true;
}
return;
}
memset(build_defs, 0x0, sizeof(*build_defs));
# ifdef WIN32
build_defs->win32 = true;
# endif
# ifdef WITH_CYCLES
build_defs->with_cycles = true;
# endif
# ifdef WITH_FFMPEG
build_defs->with_ffmpeg = true;
# endif
# ifdef WITH_FREESTYLE
build_defs->with_freestyle = true;
# endif
# ifdef WITH_LIBMV
build_defs->with_libmv = true;
# endif
# ifdef WITH_OPENGL_BACKEND
build_defs->with_opengl_backend = true;
# endif
Refactor: OpenColorIO integration Briefly about this change: - OpenColorIO C-API is removed. - The information about color spaces in ImBuf module is removed. It was stored in global ListBase in colormanagement.cc. - Both OpenColorIO and fallback implementation supports GPU drawing. - Fallback implementation supports white point, RGB curves, etc. - Removed check for support of GPU drawing in IMB. Historically it was implemented in a separate library with C-API, this is because way back C++ code needed to stay in intern. This causes all sort of overheads, and even calls that are strictly considered bad level. This change moves OpenColorIO integration into a module within imbuf, next to movie, and next to IMB_colormanagement which is the main user of it. This allows to avoid copy of color spaces, displays, views etc in the ImBuf: they were used to help quickly querying information to be shown on the interface. With this change it can be stored in the same data structures as what is used by the OpenColorIO integration. While it might not be fully avoiding duplication it is now less, and there is no need in the user code to maintain the copies. In a lot of cases this change also avoids allocations done per access to the OpenColorIO. For example, it is not needed anymore to allocate image descriptor in a heap. The bigger user-visible change is that the fallback implementation now supports GLSL drawing, with the whole list of supported features, such as curve mapping and white point. This should help simplifying code which relies on color space conversion on GPU: there is no need to figure out fallback solution in such cases. The only case when drawing will not work is when there is some actual bug, or driver issue, and shader has failed to compile. The change avoids having an opaque type for color space, and instead uses forward declaration. It is a bit verbose on declaration, but helps avoiding unsafe type-casts. There are ways to solve this in the future, like having a header for forward declaration, or to flatten the name space a bit. There should be no user-level changes under normal operation. When building without OpenColorIO or the configuration has a typo or is missing a fuller set of color management tools is applies (such as the white point correction). Pull Request: https://projects.blender.org/blender/blender/pulls/138433
2025-05-09 14:01:43 +02:00
# ifdef WITH_OPENCOLORIO
build_defs->with_opencolorio = true;
# endif
# ifdef WITH_RENDERDOC
build_defs->with_renderdoc = true;
# endif
# ifdef WITH_VULKAN_BACKEND
build_defs->with_vulkan_backend = true;
# endif
# ifdef WITH_XR_OPENXR
build_defs->with_xr_openxr = true;
# endif
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Utility String Parsing
* \{ */
static bool parse_int_relative(const char *str,
const char *str_end_test,
int pos,
int neg,
int *r_value,
const char **r_err_msg)
{
char *str_end = nullptr;
long value;
errno = 0;
switch (*str) {
case '+':
value = pos + strtol(str + 1, &str_end, 10);
break;
case '-':
value = (neg - strtol(str + 1, &str_end, 10)) + 1;
break;
default:
value = strtol(str, &str_end, 10);
break;
}
if (*str_end != '\0' && (str_end != str_end_test)) {
static const char *msg = "not a number";
*r_err_msg = msg;
return false;
}
2021-08-05 16:48:29 +10:00
if ((errno == ERANGE) || ((value < INT_MIN) || (value > INT_MAX))) {
static const char *msg = "exceeds range";
*r_err_msg = msg;
return false;
}
*r_value = int(value);
return true;
}
static const char *parse_int_range_sep_search(const char *str, const char *str_end_test)
{
const char *str_end_range = nullptr;
if (str_end_test) {
str_end_range = static_cast<const char *>(memchr(str, '.', (str_end_test - str) - 1));
if (str_end_range && (str_end_range[1] != '.')) {
str_end_range = nullptr;
}
}
else {
str_end_range = strstr(str, "..");
if (str_end_range && (str_end_range[2] == '\0')) {
str_end_range = nullptr;
}
}
return str_end_range;
}
/**
* Parse a number as a range, eg: `1..4`.
*
* The \a str_end_range argument is a result of #parse_int_range_sep_search.
*/
static bool parse_int_range_relative(const char *str,
const char *str_end_range,
const char *str_end_test,
int pos,
int neg,
int r_value_range[2],
const char **r_err_msg)
{
if (parse_int_relative(str, str_end_range, pos, neg, &r_value_range[0], r_err_msg) &&
parse_int_relative(str_end_range + 2, str_end_test, pos, neg, &r_value_range[1], r_err_msg))
{
return true;
}
2020-11-07 18:24:56 +05:30
return false;
}
static bool parse_int_relative_clamp(const char *str,
const char *str_end_test,
int pos,
int neg,
int min,
int max,
int *r_value,
const char **r_err_msg)
{
if (parse_int_relative(str, str_end_test, pos, neg, r_value, r_err_msg)) {
CLAMP(*r_value, min, max);
return true;
}
2020-11-07 18:24:56 +05:30
return false;
}
static bool parse_int_range_relative_clamp(const char *str,
const char *str_end_range,
const char *str_end_test,
int pos,
int neg,
int min,
int max,
int r_value_range[2],
const char **r_err_msg)
{
if (parse_int_range_relative(
str, str_end_range, str_end_test, pos, neg, r_value_range, r_err_msg))
{
CLAMP(r_value_range[0], min, max);
CLAMP(r_value_range[1], min, max);
return true;
}
2020-11-07 18:24:56 +05:30
return false;
}
/**
* No clamping, fails with any number outside the range.
*/
static bool parse_int_strict_range(const char *str,
const char *str_end_test,
const int min,
const int max,
int *r_value,
const char **r_err_msg)
{
char *str_end = nullptr;
long value;
errno = 0;
value = strtol(str, &str_end, 10);
if (*str_end != '\0' && (str_end != str_end_test)) {
static const char *msg = "not a number";
*r_err_msg = msg;
return false;
}
2021-08-05 16:48:29 +10:00
if ((errno == ERANGE) || ((value < min) || (value > max))) {
static const char *msg = "exceeds range";
*r_err_msg = msg;
return false;
}
*r_value = int(value);
return true;
}
static bool parse_int(const char *str,
const char *str_end_test,
int *r_value,
const char **r_err_msg)
{
return parse_int_strict_range(str, str_end_test, INT_MIN, INT_MAX, r_value, r_err_msg);
}
static bool parse_int_clamp(const char *str,
const char *str_end_test,
int min,
int max,
int *r_value,
const char **r_err_msg)
{
if (parse_int(str, str_end_test, r_value, r_err_msg)) {
CLAMP(*r_value, min, max);
return true;
}
2020-11-07 18:24:56 +05:30
return false;
}
# if 0
/**
* Version of #parse_int_relative_clamp
* that parses a comma separated list of numbers.
*/
static int *parse_int_relative_clamp_n(
const char *str, int pos, int neg, int min, int max, int *r_value_len, const char **r_err_msg)
{
const char sep = ',';
int len = 1;
for (int i = 0; str[i]; i++) {
if (str[i] == sep) {
len++;
}
}
int *values = MEM_malloc_arrayN<int>(size_t(len), __func__);
int i = 0;
while (true) {
const char *str_end = strchr(str, sep);
2022-03-09 09:35:37 +11:00
if (ELEM(*str, sep, '\0')) {
static const char *msg = "incorrect comma use";
*r_err_msg = msg;
goto fail;
}
else if (parse_int_relative_clamp(str, str_end, pos, neg, min, max, &values[i], r_err_msg)) {
i++;
}
else {
goto fail; /* Error message already set. */
}
if (str_end) { /* Next. */
str = str_end + 1;
}
else { /* Finished. */
break;
}
}
*r_value_len = i;
return values;
fail:
MEM_freeN(values);
return nullptr;
}
# endif
/**
* Version of #parse_int_relative_clamp & #parse_int_range_relative_clamp
* that parses a comma separated list of numbers.
*
* \note single values are evaluated as a range with matching start/end.
*/
static int (*parse_int_range_relative_clamp_n(const char *str,
int pos,
int neg,
int min,
int max,
int *r_value_len,
const char **r_err_msg))[2]
{
const char sep = ',';
int len = 1;
for (int i = 0; str[i]; i++) {
if (str[i] == sep) {
len++;
}
}
int(*values)[2] = MEM_malloc_arrayN<int[2]>(size_t(len), __func__);
int i = 0;
while (true) {
const char *str_end_range;
const char *str_end = strchr(str, sep);
2020-11-06 12:30:59 +11:00
if (ELEM(*str, sep, '\0')) {
static const char *msg = "incorrect comma use";
*r_err_msg = msg;
goto fail;
}
else if ((str_end_range = parse_int_range_sep_search(str, str_end)) ?
parse_int_range_relative_clamp(
str, str_end_range, str_end, pos, neg, min, max, values[i], r_err_msg) :
parse_int_relative_clamp(
str, str_end, pos, neg, min, max, &values[i][0], r_err_msg))
{
if (str_end_range == nullptr) {
values[i][1] = values[i][0];
}
i++;
}
else {
goto fail; /* Error message already set. */
}
if (str_end) { /* Next. */
str = str_end + 1;
}
else { /* Finished. */
break;
}
}
*r_value_len = i;
return values;
fail:
MEM_freeN(values);
return nullptr;
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Deferred Argument Handling
*
* Support executing an argument running instead of #WM_main which is deferred.
* Needed for arguments which are handled early but require sub-systems
* (Python in particular) * to be initialized.
* \{ */
/* When the deferred argument is handled on Windows the `argv` will have been freed,
* see `USE_WIN32_UNICODE_ARGS` in `creator.cc`. */
# ifdef WIN32
static char **argv_duplicate(const char **argv, int argc)
{
char **argv_copy = MEM_malloc_arrayN<char *>(size_t(argc), __func__);
for (int i = 0; i < argc; i++) {
argv_copy[i] = BLI_strdup(argv[i]);
}
return argv_copy;
}
static void argv_free(char **argv, int argc)
{
for (int i = 0; i < argc; i++) {
MEM_freeN(argv[i]);
}
MEM_freeN(argv);
}
# endif /* !WIN32 */
struct BA_ArgCallback_Deferred {
BA_ArgCallback func;
int argc;
const char **argv;
void *data;
/** Return-code. */
int exit_code;
};
static bool main_arg_deferred_is_set()
{
return app_state.main_arg_deferred != nullptr;
}
static void main_arg_deferred_setup(BA_ArgCallback func, int argc, const char **argv, void *data)
{
BLI_assert(app_state.main_arg_deferred == nullptr);
BA_ArgCallback_Deferred *d = MEM_callocN<BA_ArgCallback_Deferred>(__func__);
d->func = func;
d->argc = argc;
d->argv = argv;
d->data = data;
d->exit_code = 0;
# ifdef WIN32
d->argv = const_cast<const char **>(argv_duplicate(d->argv, d->argc));
# endif
app_state.main_arg_deferred = d;
}
void main_arg_deferred_free()
{
BA_ArgCallback_Deferred *d = app_state.main_arg_deferred;
app_state.main_arg_deferred = nullptr;
# ifdef WIN32
argv_free(const_cast<char **>(d->argv), d->argc);
# endif
MEM_freeN(d);
}
static void main_arg_deferred_exit_code_set(int exit_code)
{
BA_ArgCallback_Deferred *d = app_state.main_arg_deferred;
BLI_assert(d != nullptr);
d->exit_code = exit_code;
}
int main_arg_deferred_handle()
{
BA_ArgCallback_Deferred *d = app_state.main_arg_deferred;
d->func(d->argc, d->argv, d->data);
return d->exit_code;
}
/** \} */
/* -------------------------------------------------------------------- */
2019-08-02 12:25:39 +10:00
/** \name Utilities Python Context Macro (#BPY_CTX_SETUP)
* \{ */
# ifdef WITH_PYTHON
struct BlendePyContextStore {
wmWindowManager *wm;
Scene *scene;
wmWindow *win;
bool has_win;
};
static void arg_py_context_backup(bContext *C, BlendePyContextStore *c_py)
{
c_py->wm = CTX_wm_manager(C);
c_py->scene = CTX_data_scene(C);
c_py->has_win = c_py->wm && !BLI_listbase_is_empty(&c_py->wm->windows);
if (c_py->has_win) {
c_py->win = CTX_wm_window(C);
CTX_wm_window_set(C, static_cast<wmWindow *>(c_py->wm->windows.first));
}
else {
/* NOTE: this should never happen, although it may be possible when loading
* `.blend` files without windowing data. Whatever the case, it shouldn't crash,
* although typical scripts that accesses the context is not expected to work usefully. */
c_py->win = nullptr;
fprintf(stderr, "Python script running with missing context data.\n");
}
}
static void arg_py_context_restore(bContext *C, BlendePyContextStore *c_py)
{
/* Script may load a file, check old data is valid before using. */
if (c_py->has_win) {
if ((c_py->win == nullptr) || ((BLI_findindex(&G_MAIN->wm, c_py->wm) != -1) &&
(BLI_findindex(&c_py->wm->windows, c_py->win) != -1)))
{
CTX_wm_window_set(C, c_py->win);
}
}
if ((c_py->scene == nullptr) || BLI_findindex(&G_MAIN->scenes, c_py->scene) != -1) {
CTX_data_scene_set(C, c_py->scene);
}
}
/* Macro for context setup/reset. */
# define BPY_CTX_SETUP(_cmd) \
{ \
BlendePyContextStore py_c; \
arg_py_context_backup(C, &py_c); \
{ \
_cmd; \
} \
arg_py_context_restore(C, &py_c); \
} \
((void)0)
# endif /* WITH_PYTHON */
/** \} */
/* -------------------------------------------------------------------- */
/** \name Handle Argument Callbacks
*
* \note Doc strings here are used in differently:
*
* - The `--help` message.
* - The man page (for Unix systems),
* see: `doc/manpage/blender.1.py`
* - Parsed and extracted for the manual,
* which converts our ad-hoc formatting to reStructuredText.
2017-01-23 19:09:45 -05:00
* see: https://docs.blender.org/manual/en/dev/advanced/command_line.html
*
* \{ */
static void print_version_full()
{
printf("Blender %s\n", BKE_blender_version_string());
# ifdef BUILD_DATE
printf("\tbuild date: %s\n", build_date);
printf("\tbuild time: %s\n", build_time);
printf("\tbuild commit date: %s\n", build_commit_date);
printf("\tbuild commit time: %s\n", build_commit_time);
printf("\tbuild hash: %s\n", build_hash);
printf("\tbuild branch: %s\n", build_branch);
printf("\tbuild platform: %s\n", build_platform);
printf("\tbuild type: %s\n", build_type);
printf("\tbuild c flags: %s\n", build_cflags);
printf("\tbuild c++ flags: %s\n", build_cxxflags);
printf("\tbuild link flags: %s\n", build_linkflags);
printf("\tbuild system: %s\n", build_system);
# endif
}
static void print_version_short()
{
# ifdef BUILD_DATE
/* NOTE: We include built time since sometimes we need to tell broken from
* working built of the same hash. */
printf("Blender %s (hash %s built %s %s)\n",
BKE_blender_version_string(),
build_hash,
build_date,
build_time);
# else
printf("Blender %s\n", BKE_blender_version_string());
# endif
}
static const char arg_handle_print_version_doc[] =
"\n\t"
"Print Blender version and exit.";
static int arg_handle_print_version(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
print_version_full();
/* Handles cleanup before exit. */
BKE_blender_atexit();
exit(EXIT_SUCCESS);
BLI_assert_unreachable();
return 0;
}
static void print_help(bArgs *ba, bool all)
{
BuildDefs defs;
build_defs_init(&defs, all);
/* All printing must go via `PRINT` macro. */
# define printf __ERROR__
# define PRINT(...) BLI_args_printf(ba, __VA_ARGS__)
PRINT("Blender %s\n", BKE_blender_version_string());
PRINT("Usage: blender [args ...] [file] [args ...]\n");
PRINT("\n");
PRINT("Render Options:\n");
BLI_args_print_arg_doc(ba, "--background");
BLI_args_print_arg_doc(ba, "--render-anim");
BLI_args_print_arg_doc(ba, "--scene");
BLI_args_print_arg_doc(ba, "--render-frame");
BLI_args_print_arg_doc(ba, "--frame-start");
BLI_args_print_arg_doc(ba, "--frame-end");
BLI_args_print_arg_doc(ba, "--frame-jump");
BLI_args_print_arg_doc(ba, "--render-output");
BLI_args_print_arg_doc(ba, "--engine");
BLI_args_print_arg_doc(ba, "--threads");
if (defs.with_cycles) {
PRINT("Cycles Render Options:\n");
PRINT("\tCycles add-on options must be specified following a double dash.\n");
PRINT("\n");
PRINT("--cycles-device <device>\n");
PRINT("\tSet the device used for rendering.\n");
PRINT("\tValid options are: 'CPU' 'CUDA' 'OPTIX' 'HIP' 'ONEAPI' 'METAL'.\n");
PRINT("\n");
PRINT("\tAppend +CPU to a GPU device to render on both CPU and GPU.\n");
PRINT("\n");
PRINT("\tExample:\n");
PRINT("\t# blender -b file.blend -f 20 -- --cycles-device OPTIX\n");
PRINT("--cycles-print-stats\n");
PRINT("\tLog statistics about render memory and time usage.\n");
}
PRINT("\n");
PRINT("Format Options:\n");
BLI_args_print_arg_doc(ba, "--render-format");
BLI_args_print_arg_doc(ba, "--use-extension");
PRINT("\n");
PRINT("Animation Playback Options:\n");
BLI_args_print_arg_doc(ba, "-a");
PRINT("\n");
PRINT("Window Options:\n");
BLI_args_print_arg_doc(ba, "--window-border");
BLI_args_print_arg_doc(ba, "--window-fullscreen");
BLI_args_print_arg_doc(ba, "--window-geometry");
BLI_args_print_arg_doc(ba, "--window-maximized");
BLI_args_print_arg_doc(ba, "--start-console");
BLI_args_print_arg_doc(ba, "--no-native-pixels");
BLI_args_print_arg_doc(ba, "--no-window-focus");
PRINT("\n");
PRINT("Python Options:\n");
BLI_args_print_arg_doc(ba, "--enable-autoexec");
BLI_args_print_arg_doc(ba, "--disable-autoexec");
PRINT("\n");
BLI_args_print_arg_doc(ba, "--python");
BLI_args_print_arg_doc(ba, "--python-text");
BLI_args_print_arg_doc(ba, "--python-expr");
BLI_args_print_arg_doc(ba, "--python-console");
BLI_args_print_arg_doc(ba, "--python-exit-code");
BLI_args_print_arg_doc(ba, "--python-use-system-env");
BLI_args_print_arg_doc(ba, "--addons");
PRINT("\n");
PRINT("Network Options:\n");
BLI_args_print_arg_doc(ba, "--online-mode");
BLI_args_print_arg_doc(ba, "--offline-mode");
PRINT("\n");
PRINT("Logging Options:\n");
BLI_args_print_arg_doc(ba, "--log");
BLI_args_print_arg_doc(ba, "--log-level");
BLI_args_print_arg_doc(ba, "--log-show-memory");
BLI_args_print_arg_doc(ba, "--log-show-source");
BLI_args_print_arg_doc(ba, "--log-show-backtrace");
BLI_args_print_arg_doc(ba, "--log-file");
PRINT("\n");
PRINT("Debug Options:\n");
BLI_args_print_arg_doc(ba, "--debug");
BLI_args_print_arg_doc(ba, "--debug-value");
PRINT("\n");
BLI_args_print_arg_doc(ba, "--debug-events");
BLI_args_print_arg_doc(ba, "--debug-handlers");
if (defs.with_libmv) {
BLI_args_print_arg_doc(ba, "--debug-libmv");
}
BLI_args_print_arg_doc(ba, "--debug-memory");
BLI_args_print_arg_doc(ba, "--debug-jobs");
BLI_args_print_arg_doc(ba, "--debug-python");
BLI_args_print_arg_doc(ba, "--debug-depsgraph");
BLI_args_print_arg_doc(ba, "--debug-depsgraph-eval");
BLI_args_print_arg_doc(ba, "--debug-depsgraph-build");
BLI_args_print_arg_doc(ba, "--debug-depsgraph-tag");
BLI_args_print_arg_doc(ba, "--debug-depsgraph-no-threads");
BLI_args_print_arg_doc(ba, "--debug-depsgraph-time");
BLI_args_print_arg_doc(ba, "--debug-depsgraph-pretty");
BLI_args_print_arg_doc(ba, "--debug-depsgraph-uid");
BLI_args_print_arg_doc(ba, "--debug-ghost");
BLI_args_print_arg_doc(ba, "--debug-wintab");
BLI_args_print_arg_doc(ba, "--debug-gpu");
BLI_args_print_arg_doc(ba, "--debug-gpu-force-workarounds");
BLI_args_print_arg_doc(ba, "--debug-gpu-compile-shaders");
BLI_args_print_arg_doc(ba, "--debug-gpu-shader-debug-info");
if (defs.with_renderdoc) {
BLI_args_print_arg_doc(ba, "--debug-gpu-scope-capture");
BLI_args_print_arg_doc(ba, "--debug-gpu-renderdoc");
}
if (defs.with_vulkan_backend) {
BLI_args_print_arg_doc(ba, "--debug-gpu-vulkan-local-read");
}
BLI_args_print_arg_doc(ba, "--debug-wm");
if (defs.with_xr_openxr) {
BLI_args_print_arg_doc(ba, "--debug-xr");
BLI_args_print_arg_doc(ba, "--debug-xr-time");
}
BLI_args_print_arg_doc(ba, "--debug-all");
BLI_args_print_arg_doc(ba, "--debug-io");
PRINT("\n");
BLI_args_print_arg_doc(ba, "--debug-fpe");
BLI_args_print_arg_doc(ba, "--debug-exit-on-error");
if (defs.with_freestyle) {
BLI_args_print_arg_doc(ba, "--debug-freestyle");
}
BLI_args_print_arg_doc(ba, "--disable-crash-handler");
BLI_args_print_arg_doc(ba, "--disable-abort-handler");
BLI_args_print_arg_doc(ba, "--verbose");
BLI_args_print_arg_doc(ba, "--quiet");
PRINT("\n");
PRINT("GPU Options:\n");
BLI_args_print_arg_doc(ba, "--gpu-backend");
BLI_args_print_arg_doc(ba, "--gpu-vsync");
if (defs.with_opengl_backend) {
BLI_args_print_arg_doc(ba, "--gpu-compilation-subprocesses");
}
BLI_args_print_arg_doc(ba, "--profile-gpu");
PRINT("\n");
PRINT("Misc Options:\n");
BLI_args_print_arg_doc(ba, "--open-last");
BLI_args_print_arg_doc(ba, "--app-template");
BLI_args_print_arg_doc(ba, "--factory-startup");
BLI_args_print_arg_doc(ba, "--enable-event-simulate");
PRINT("\n");
BLI_args_print_arg_doc(ba, "--env-system-datafiles");
BLI_args_print_arg_doc(ba, "--env-system-scripts");
BLI_args_print_arg_doc(ba, "--env-system-extensions");
BLI_args_print_arg_doc(ba, "--env-system-python");
PRINT("\n");
BLI_args_print_arg_doc(ba, "-noaudio");
BLI_args_print_arg_doc(ba, "-setaudio");
PRINT("\n");
BLI_args_print_arg_doc(ba, "--command");
PRINT("\n");
BLI_args_print_arg_doc(ba, "--help");
BLI_args_print_arg_doc(ba, "/?");
/* File type registration (Windows & Linux only). */
BLI_args_print_arg_doc(ba, "--register");
BLI_args_print_arg_doc(ba, "--register-allusers");
BLI_args_print_arg_doc(ba, "--unregister");
BLI_args_print_arg_doc(ba, "--unregister-allusers");
BLI_args_print_arg_doc(ba, "--qos");
BLI_args_print_arg_doc(ba, "--version");
BLI_args_print_arg_doc(ba, "--");
// PRINT("\n");
// PRINT("Experimental Features:\n");
/* Other options _must_ be last (anything not handled will show here).
*
* Note that it's good practice for this to remain empty,
* nevertheless print if any exist. */
if (BLI_args_has_other_doc(ba)) {
PRINT("\n");
PRINT("Other Options:\n");
BLI_args_print_other_doc(ba);
}
PRINT("\n");
PRINT("Argument Parsing:\n");
PRINT("\tArguments must be separated by white space, eg:\n");
PRINT("\t# blender -ba test.blend\n");
PRINT("\t...will exit since '-ba' is an unknown argument.\n");
PRINT("\n");
PRINT("Argument Order:\n");
PRINT("\tArguments are executed in the order they are given. eg:\n");
PRINT("\t# blender --background test.blend --render-frame 1 --render-output \"/tmp\"\n");
PRINT(
2017-10-08 18:46:26 +11:00
"\t...will not render to '/tmp' because '--render-frame 1' renders before the output path "
"is set.\n");
PRINT("\t# blender --background --render-output /tmp test.blend --render-frame 1\n");
PRINT(
2017-10-08 18:46:26 +11:00
"\t...will not render to '/tmp' because loading the blend-file overwrites the render output "
"that was set.\n");
PRINT("\t# blender --background test.blend --render-output /tmp --render-frame 1\n");
PRINT("\t...works as expected.\n");
PRINT("\n");
PRINT("Environment Variables:\n");
PRINT(" $BLENDER_USER_RESOURCES Replace default directory of all user files.\n");
PRINT(" Other 'BLENDER_USER_*' variables override when set.\n");
PRINT(" $BLENDER_USER_CONFIG Directory for user configuration files.\n");
PRINT(" $BLENDER_USER_SCRIPTS Directory for user scripts.\n");
PRINT(" $BLENDER_USER_EXTENSIONS Directory for user extensions.\n");
PRINT(" $BLENDER_USER_DATAFILES Directory for user data files (icons, translations, ..).\n");
PRINT("\n");
PRINT(" $BLENDER_SYSTEM_RESOURCES Replace default directory of all bundled resource files.\n");
PRINT(" $BLENDER_SYSTEM_SCRIPTS Directories to add extra scripts.\n");
PRINT(" $BLENDER_SYSTEM_EXTENSIONS Directory for system extensions repository.\n");
PRINT(" $BLENDER_SYSTEM_DATAFILES Directory to replace bundled datafiles.\n");
PRINT(" $BLENDER_SYSTEM_PYTHON Directory to replace bundled Python libraries.\n");
PRINT(" $BLENDER_CUSTOM_SPLASH Full path to an image that replaces the splash screen.\n");
PRINT(
" $BLENDER_CUSTOM_SPLASH_BANNER Full path to an image to overlay on the splash screen.\n");
Refactor: OpenColorIO integration Briefly about this change: - OpenColorIO C-API is removed. - The information about color spaces in ImBuf module is removed. It was stored in global ListBase in colormanagement.cc. - Both OpenColorIO and fallback implementation supports GPU drawing. - Fallback implementation supports white point, RGB curves, etc. - Removed check for support of GPU drawing in IMB. Historically it was implemented in a separate library with C-API, this is because way back C++ code needed to stay in intern. This causes all sort of overheads, and even calls that are strictly considered bad level. This change moves OpenColorIO integration into a module within imbuf, next to movie, and next to IMB_colormanagement which is the main user of it. This allows to avoid copy of color spaces, displays, views etc in the ImBuf: they were used to help quickly querying information to be shown on the interface. With this change it can be stored in the same data structures as what is used by the OpenColorIO integration. While it might not be fully avoiding duplication it is now less, and there is no need in the user code to maintain the copies. In a lot of cases this change also avoids allocations done per access to the OpenColorIO. For example, it is not needed anymore to allocate image descriptor in a heap. The bigger user-visible change is that the fallback implementation now supports GLSL drawing, with the whole list of supported features, such as curve mapping and white point. This should help simplifying code which relies on color space conversion on GPU: there is no need to figure out fallback solution in such cases. The only case when drawing will not work is when there is some actual bug, or driver issue, and shader has failed to compile. The change avoids having an opaque type for color space, and instead uses forward declaration. It is a bit verbose on declaration, but helps avoiding unsafe type-casts. There are ways to solve this in the future, like having a header for forward declaration, or to flatten the name space a bit. There should be no user-level changes under normal operation. When building without OpenColorIO or the configuration has a typo or is missing a fuller set of color management tools is applies (such as the white point correction). Pull Request: https://projects.blender.org/blender/blender/pulls/138433
2025-05-09 14:01:43 +02:00
if (defs.with_opencolorio) {
PRINT(" $OCIO Path to override the OpenColorIO configuration file.\n");
}
if (defs.win32 || all) {
PRINT(" $TEMP Store temporary files here (MS-Windows).\n");
}
if (!defs.win32 || all) {
PRINT(" $TMPDIR Store temporary files here (UNIX Systems).\n");
}
PRINT(
" The path must reference an existing directory "
"or it will be ignored.\n");
# undef printf
# undef PRINT
}
ATTR_PRINTF_FORMAT(2, 0)
static void help_print_ds_fn(void *ds_v, const char *format, va_list args)
{
DynStr *ds = static_cast<DynStr *>(ds_v);
BLI_dynstr_vappendf(ds, format, args);
}
static char *main_args_help_as_string(bool all)
{
DynStr *ds = BLI_dynstr_new();
{
bArgs *ba = BLI_args_create(0, nullptr);
main_args_setup(nullptr, ba, all);
BLI_args_print_fn_set(ba, help_print_ds_fn, ds);
print_help(ba, all);
BLI_args_destroy(ba);
}
char *buf = BLI_dynstr_get_cstring(ds);
BLI_dynstr_free(ds);
return buf;
}
static const char arg_handle_print_help_doc[] =
"\n\t"
"Print this help text and exit.";
static const char arg_handle_print_help_doc_win32[] =
"\n\t"
"Print this help text and exit (Windows only).";
static int arg_handle_print_help(int /*argc*/, const char ** /*argv*/, void *data)
{
bArgs *ba = (bArgs *)data;
print_help(ba, false);
/* Handles cleanup before exit. */
BKE_blender_atexit();
exit(EXIT_SUCCESS);
BLI_assert_unreachable();
return 0;
}
static const char arg_handle_arguments_end_doc[] =
"\n\t"
"End option processing, following arguments passed unchanged. Access via Python's "
2017-10-08 18:46:26 +11:00
"'sys.argv'.";
static int arg_handle_arguments_end(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
return -1;
}
/* Only to give help message. */
# ifdef WITH_PYTHON_SECURITY /* Default. */
# define PY_ENABLE_AUTO ""
# define PY_DISABLE_AUTO ", (default)"
# else
# define PY_ENABLE_AUTO ", (default, non-standard compilation option)"
# define PY_DISABLE_AUTO ""
# endif
static const char arg_handle_python_set_doc_enable[] =
"\n\t"
"Enable automatic Python script execution" PY_ENABLE_AUTO ".";
static const char arg_handle_python_set_doc_disable[] =
"\n\t"
"Disable automatic Python script execution "
"(Python-drivers & startup scripts)" PY_DISABLE_AUTO ".";
# undef PY_ENABLE_AUTO
# undef PY_DISABLE_AUTO
static int arg_handle_python_set(int /*argc*/, const char ** /*argv*/, void *data)
{
if (bool(data)) {
G.f |= G_FLAG_SCRIPT_AUTOEXEC;
}
else {
G.f &= ~G_FLAG_SCRIPT_AUTOEXEC;
}
G.f |= G_FLAG_SCRIPT_OVERRIDE_PREF;
return 0;
}
static const char arg_handle_internet_allow_set_doc_online[] =
"\n\t"
"Allow internet access, overriding the preference.";
static const char arg_handle_internet_allow_set_doc_offline[] =
"\n\t"
"Disallow internet access, overriding the preference.";
static int arg_handle_internet_allow_set(int /*argc*/, const char ** /*argv*/, void *data)
{
G.f &= ~G_FLAG_INTERNET_OVERRIDE_PREF_ANY;
if (bool(data)) {
G.f |= G_FLAG_INTERNET_ALLOW;
G.f |= G_FLAG_INTERNET_OVERRIDE_PREF_ONLINE;
}
else {
G.f &= ~G_FLAG_INTERNET_ALLOW;
G.f |= G_FLAG_INTERNET_OVERRIDE_PREF_OFFLINE;
}
return 0;
}
static const char arg_handle_crash_handler_disable_doc[] =
"\n\t"
"Disable the crash handler.";
static int arg_handle_crash_handler_disable(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
app_state.signal.use_crash_handler = false;
return 0;
}
static const char arg_handle_abort_handler_disable_doc[] =
"\n\t"
"Disable the abort handler.";
static int arg_handle_abort_handler_disable(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
app_state.signal.use_abort_handler = false;
return 0;
}
static void clog_abort_on_error_callback(void *fp)
{
BLI_system_backtrace(static_cast<FILE *>(fp));
fflush(static_cast<FILE *>(fp));
abort();
}
static const char arg_handle_debug_exit_on_error_doc[] =
"\n\t"
"Immediately exit when internal errors are detected.";
static int arg_handle_debug_exit_on_error(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
MEM_enable_fail_on_memleak();
CLG_error_fn_set(clog_abort_on_error_callback);
return 0;
}
static const char arg_handle_quiet_set_doc[] =
"\n\t"
"Suppress status printing (warnings & errors are still printed).";
static int arg_handle_quiet_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
CLG_quiet_set(true);
return 0;
}
/** Shared by `--background` & `--command`. */
static void background_mode_set()
{
G.background = true;
/* Background Mode Defaults:
*
* In general background mode should strive to match the behavior of running
* Blender inside a graphical session, any exception to this should have a well
* justified reason and be noted in the doc-string. */
/* NOTE(@ideasman42): While there is no requirement for sound to be disabled in background-mode,
* the use case for playing audio in background mode is enough of a special-case
* that users who wish to do this can explicitly enable audio in background mode.
* While the down sides for connecting to an audio device aren't terrible they include:
* - Listing Blender as an active application which may output audio.
* - Unnecessary overhead running an operation in background mode or ...
* - Having to remember to include `-noaudio` with batch operations.
* - A quiet but audible click when Blender starts & configures its audio device.
*/
BKE_sound_force_device("None");
}
static const char arg_handle_background_mode_set_doc[] =
"\n"
"\tRun in background (often used for UI-less rendering).\n"
"\n"
"\tThe audio device is disabled in background-mode by default\n"
"\tand can be re-enabled by passing in '-setaudio Default' afterwards.";
static int arg_handle_background_mode_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
if (!CLG_quiet_get()) {
print_version_short();
}
background_mode_set();
return 0;
}
static const char arg_handle_command_set_doc[] =
"<command>\n"
"\tRun a command which consumes all remaining arguments.\n"
"\tUse '-c help' to list all other commands.\n"
"\tPass '--help' after the command to see its help text.\n"
"\n"
"\tThis implies '--background' mode.";
static int arg_handle_command_set(int argc, const char **argv, void *data)
{
if (!main_arg_deferred_is_set()) {
if (argc < 2) {
fprintf(stderr, "%s requires at least one argument\n", argv[0]);
exit(EXIT_FAILURE);
BLI_assert_unreachable();
}
/* Application "info" messages get in the way of command line output, suppress them. */
CLG_quiet_set(true);
background_mode_set();
main_arg_deferred_setup(arg_handle_command_set, argc, argv, data);
}
else {
bContext *C = static_cast<bContext *>(data);
const char *id = argv[1];
int exit_code;
if (STREQ(id, "help")) {
BKE_blender_cli_command_print_help();
exit_code = EXIT_SUCCESS;
}
else {
exit_code = BKE_blender_cli_command_exec(C, id, argc - 2, argv + 2);
}
main_arg_deferred_exit_code_set(exit_code);
}
/* Consume remaining arguments. */
return argc - 1;
}
static const char arg_handle_disable_depsgraph_on_file_load_doc[] =
"\n"
"\tBackground mode: Do not systematically build and evaluate ViewLayers' dependency graphs\n"
"\twhen loading a blend-file in background mode ('-b' or '-c' options).\n"
"\n"
2025-01-03 22:33:33 -05:00
"\tScripts requiring evaluated data then need to explicitly ensure that\n"
"\tan evaluated depsgraph is available\n"
"\t(e.g. by calling 'depsgraph = context.evaluated_depsgraph_get()').\n"
"\n"
"\tNOTE: this is a temporary option, in the future depsgraph will never be\n"
"\tautomatically generated on file load in background mode.";
static int arg_handle_disable_depsgraph_on_file_load(int /*argc*/,
const char ** /*argv*/,
void * /*data*/)
{
G.fileflags |= G_BACKGROUND_NO_DEPSGRAPH;
return 0;
}
static const char arg_handle_disable_liboverride_auto_resync_doc[] =
"\n"
"\tDo not perform library override automatic resync when loading a new blend-file.\n"
"\n"
"\tNOTE: this is an alternative way to get the same effect as when setting the\n"
"\t'No Override Auto Resync' User Preferences Debug option.";
static int arg_handle_disable_liboverride_auto_resync(int /*argc*/,
const char ** /*argv*/,
void * /*data*/)
{
G.fileflags |= G_LIBOVERRIDE_NO_AUTO_RESYNC;
return 0;
}
static const char arg_handle_log_level_set_doc[] =
"<level>\n"
"\tSet the logging verbosity level.\n"
"\n"
"\tfatal: Fatal errors only\n"
"\terror: Errors only\n"
"\twarning: Warnings\n"
"\tinfo: Information about devices, files, configuration, operations\n"
"\tdebug: Verbose messages for developers\n"
"\ttrace: Very verbose code execution tracing";
static int arg_handle_log_level_set(int argc, const char **argv, void * /*data*/)
{
const char *arg_id = "--log-level";
if (argc > 1) {
const char *err_msg = nullptr;
if (STRCASEEQ(argv[1], "fatal")) {
G.log.level = CLG_LEVEL_FATAL;
}
else if (STRCASEEQ(argv[1], "error")) {
G.log.level = CLG_LEVEL_ERROR;
}
else if (STRCASEEQ(argv[1], "warning")) {
G.log.level = CLG_LEVEL_WARN;
}
else if (STRCASEEQ(argv[1], "info")) {
G.log.level = CLG_LEVEL_INFO;
}
else if (STRCASEEQ(argv[1], "debug")) {
G.log.level = CLG_LEVEL_DEBUG;
}
else if (STRCASEEQ(argv[1], "trace")) {
G.log.level = CLG_LEVEL_TRACE;
}
else if (parse_int_clamp(argv[1], nullptr, -1, INT_MAX, &G.log.level, &err_msg)) {
/* Numeric level for backwards compatibility. */
if (G.log.level < 0) {
G.log.level = CLG_LEVEL_LEN - 1;
}
else {
G.log.level = std::min(CLG_LEVEL_INFO + G.log.level, CLG_LEVEL_LEN - 1);
}
}
else {
fprintf(stderr, "\nError: Invalid log level '%s %s'.\n", arg_id, argv[1]);
return 1;
}
CLG_level_set(CLG_Level(G.log.level));
return 1;
}
fprintf(stderr, "\nError: '%s' no args given.\n", arg_id);
2020-11-07 18:24:56 +05:30
return 0;
}
static const char arg_handle_log_show_source_set_doc[] =
"\n\t"
"Show source file and function name in output.";
static int arg_handle_log_show_source_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
CLG_output_use_source_set(true);
return 0;
}
static const char arg_handle_log_show_backtrace_set_doc[] =
"\n\t"
"Show a back trace for each log message (debug builds only).";
static int arg_handle_log_show_backtrace_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
/* Ensure types don't become incompatible. */
void (*fn)(FILE *fp) = BLI_system_backtrace;
CLG_backtrace_fn_set((void (*)(void *))fn);
return 0;
}
static const char arg_handle_log_show_memory_set_doc[] =
"\n\t"
"Show memory usage for each log message.";
static int arg_handle_log_show_memory_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
CLG_output_use_memory_set(true);
return 0;
}
static const char arg_handle_log_file_set_doc[] =
"<filepath>\n"
"\tSet a file to output the log to.";
static int arg_handle_log_file_set(int argc, const char **argv, void * /*data*/)
{
const char *arg_id = "--log-file";
if (argc > 1) {
errno = 0;
FILE *fp = BLI_fopen(argv[1], "w");
if (fp == nullptr) {
const char *err_msg = errno ? strerror(errno) : "unknown";
fprintf(stderr, "\nError: %s '%s %s'.\n", err_msg, arg_id, argv[1]);
}
else {
if (UNLIKELY(G.log.file != nullptr)) {
fclose(static_cast<FILE *>(G.log.file));
}
G.log.file = fp;
CLG_output_set(G.log.file);
}
return 1;
}
fprintf(stderr, "\nError: '%s' no args given.\n", arg_id);
2020-11-07 18:24:56 +05:30
return 0;
}
static const char arg_handle_log_set_doc[] =
"<match>\n"
"\tEnable logging categories, taking a single comma separated argument.\n"
"\n"
"\t--log \"*\": log everything\n"
"\t--log \"event\": logs every category starting with 'event'.\n"
"\t--log \"render,cycles\": log both render and cycles messages.\n"
"\t--log \"*mesh*\": log every category containing 'mesh' sub-string.\n"
"\t--log \"*,^operator\": log everything except operators, with '^prefix' to exclude.";
static int arg_handle_log_set(int argc, const char **argv, void * /*data*/)
{
const char *arg_id = "--log";
if (argc > 1) {
const char *str_step = argv[1];
while (*str_step) {
const char *str_step_end = strchr(str_step, ',');
int str_step_len = str_step_end ? (str_step_end - str_step) : strlen(str_step);
if (str_step[0] == '^') {
CLG_type_filter_exclude(str_step + 1, str_step_len - 1);
}
else {
CLG_type_filter_include(str_step, str_step_len);
}
if (str_step_end) {
2019-09-19 13:18:52 +10:00
/* Typically only be one, but don't fail on multiple. */
while (*str_step_end == ',') {
str_step_end++;
}
str_step = str_step_end;
}
else {
break;
}
}
return 1;
}
fprintf(stderr, "\nError: '%s' no args given.\n", arg_id);
2020-11-07 18:24:56 +05:30
return 0;
}
static const char arg_handle_debug_mode_set_doc[] =
2016-04-06 09:28:22 +10:00
"\n"
2017-10-08 18:46:26 +11:00
"\tTurn debugging on.\n"
2016-04-06 09:28:22 +10:00
"\n"
"\t* Enables memory error detection\n"
"\t* Disables mouse grab (to interact with a debugger in some cases)\n"
"\t* Keeps Python's 'sys.stdin' rather than setting it to None";
static int arg_handle_debug_mode_set(int /*argc*/, const char ** /*argv*/, void *data)
{
G.debug |= G_DEBUG;
printf("Blender %s\n", BKE_blender_version_string());
MEM_set_memory_debug();
# ifndef NDEBUG
BLI_mempool_set_memory_debug();
# endif
# ifdef WITH_BUILDINFO
printf("Build: %s %s %s %s\n", build_date, build_time, build_platform, build_type);
# endif
BLI_args_print(static_cast<bArgs *>(data));
return 0;
}
static const char arg_handle_debug_mode_generic_set_doc_freestyle[] =
"\n\t"
"Enable debug messages for Freestyle.";
static const char arg_handle_debug_mode_generic_set_doc_python[] =
"\n\t"
"Enable debug messages for Python.";
static const char arg_handle_debug_mode_generic_set_doc_events[] =
"\n\t"
"Enable debug messages for the event system.";
static const char arg_handle_debug_mode_generic_set_doc_handlers[] =
"\n\t"
"Enable debug messages for event handling.";
static const char arg_handle_debug_mode_generic_set_doc_wm[] =
"\n\t"
"Enable debug messages for the window manager, shows all operators in search, shows "
2018-04-25 12:30:11 +02:00
"keymap errors.";
static const char arg_handle_debug_mode_generic_set_doc_ghost[] =
"\n\t"
"Enable debug messages for Ghost (Linux only).";
static const char arg_handle_debug_mode_generic_set_doc_wintab[] =
"\n\t"
"Enable debug messages for Wintab.";
VR: Initial Virtual Reality support - Milestone 1, Scene Inspection NOTE: While most of the milestone 1 goals are there, a few smaller features and improvements are still to be done. Big picture of this milestone: Initial, OpenXR-based virtual reality support for users and foundation for advanced use cases. Maniphest Task: https://developer.blender.org/T71347 The tasks contains more information about this milestone. To be clear: This is not a feature rich VR implementation, it's focused on the initial scene inspection use case. We intentionally focused on that, further features like controller support are part of the next milestone. - How to use? Instructions on how to use this are here: https://wiki.blender.org/wiki/User:Severin/GSoC-2019/How_to_Test These will be updated and moved to a more official place (likely the manual) soon. Currently Windows Mixed Reality and Oculus devices are usable. Valve/HTC headsets don't support the OpenXR standard yet and hence, do not work with this implementation. --------------- This is the C-side implementation of the features added for initial VR support as per milestone 1. A "VR Scene Inspection" Add-on will be committed separately, to expose the VR functionality in the UI. It also adds some further features for milestone 1, namely a landmarking system (stored view locations in the VR space) Main additions/features: * Support for rendering viewports to an HMD, with good performance. * Option to sync the VR view perspective with a fully interactive, regular 3D View (VR-Mirror). * Option to disable positional tracking. Keeps the current position (calculated based on the VR eye center pose) when enabled while a VR session is running. * Some regular viewport settings for the VR view * RNA/Python-API to query and set VR session state information. * WM-XR: Layer tying Ghost-XR to the Blender specific APIs/data * wmSurface API: drawable, non-window container (manages Ghost-OpenGL and GPU context) * DNA/RNA for management of VR session settings * `--debug-xr` and `--debug-xr-time` commandline options * Utility batch & config file for using the Oculus runtime on Windows. * Most VR data is runtime only. The exception is user settings which are saved to files (`XrSessionSettings`). * VR support can be disabled through the `WITH_XR_OPENXR` compiler flag. For architecture and code documentation, see https://wiki.blender.org/wiki/Source/Interface/XR. --------------- A few thank you's: * A huge shoutout to Ray Molenkamp for his help during the project - it would have not been that successful without him! * Sebastian Koenig and Simeon Conzendorf for testing and feedback! * The reviewers, especially Brecht Van Lommel! * Dalai Felinto for pushing and managing me to get this done ;) * The OpenXR working group for providing an open standard. I think we're the first bigger application to adopt OpenXR. Congratulations to them and ourselves :) This project started as a Google Summer of Code 2019 project - "Core Support of Virtual Reality Headsets through OpenXR" (see https://wiki.blender.org/wiki/User:Severin/GSoC-2019/). Some further information, including ideas for further improvements can be found in the final GSoC report: https://wiki.blender.org/wiki/User:Severin/GSoC-2019/Final_Report Differential Revisions: D6193, D7098 Reviewed by: Brecht Van Lommel, Jeroen Bakker
2020-03-17 20:20:55 +01:00
static const char arg_handle_debug_mode_generic_set_doc_xr[] =
"\n\t"
"Enable debug messages for virtual reality contexts.\n"
"\tEnables the OpenXR API validation layer, (OpenXR) debug messages and general information "
"prints.";
static const char arg_handle_debug_mode_generic_set_doc_xr_time[] =
"\n\t"
"Enable debug messages for virtual reality frame rendering times.";
static const char arg_handle_debug_mode_generic_set_doc_jobs[] =
"\n\t"
"Enable time profiling for background jobs.";
static const char arg_handle_debug_mode_generic_set_doc_depsgraph[] =
"\n\t"
"Enable all debug messages from dependency graph.";
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_build[] =
"\n\t"
"Enable debug messages from dependency graph related on graph construction.";
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_tag[] =
"\n\t"
"Enable debug messages from dependency graph related on tagging.";
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_time[] =
"\n\t"
"Enable debug messages from dependency graph related on timing.";
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_eval[] =
"\n\t"
"Enable debug messages from dependency graph related on evaluation.";
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_no_threads[] =
"\n\t"
"Switch dependency graph to a single threaded evaluation.";
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_pretty[] =
"\n\t"
"Enable colors for dependency graph debug messages.";
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_uid[] =
"\n\t"
"Verify validness of session-wide identifiers assigned to ID data-blocks.";
static const char arg_handle_debug_mode_generic_set_doc_gpu_force_workarounds[] =
"\n\t"
"Enable workarounds for typical GPU issues and disable all GPU extensions.";
static const char arg_handle_debug_mode_generic_set_doc_gpu_force_vulkan_local_read[] =
"\n\t"
"Force Vulkan dynamic rendering local read when supported by device.";
static int arg_handle_debug_mode_generic_set(int /*argc*/, const char ** /*argv*/, void *data)
{
G.debug |= POINTER_AS_INT(data);
return 0;
}
2016-12-09 17:19:59 +01:00
static const char arg_handle_debug_mode_io_doc[] =
"\n\t"
"Enable debug messages for I/O.";
static int arg_handle_debug_mode_io(int /*argc*/, const char ** /*argv*/, void * /*data*/)
2016-12-09 17:19:59 +01:00
{
G.debug |= G_DEBUG_IO;
return 0;
}
static const char arg_handle_debug_mode_all_doc[] =
"\n\t"
"Enable all debug messages.";
static int arg_handle_debug_mode_all(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
G.debug |= G_DEBUG_ALL;
# ifdef WITH_LIBMV
libmv_startDebugLogging();
# endif
return 0;
}
static const char arg_handle_debug_mode_libmv_doc[] =
"\n\t"
"Enable debug messages from libmv library.";
static int arg_handle_debug_mode_libmv(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
# ifdef WITH_LIBMV
libmv_startDebugLogging();
# endif
return 0;
}
static const char arg_handle_debug_mode_cycles_doc[] =
"\n\t"
"Enable debug messages from Cycles.";
static int arg_handle_debug_mode_cycles(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
const char *cycles_filter = "cycles.*";
CLG_type_filter_include(cycles_filter, strlen(cycles_filter));
return 0;
}
static const char arg_handle_debug_mode_ffmpeg_doc[] =
"\n\t"
"Enable debug messages from FFmpeg video input and output.";
static int arg_handle_debug_mode_ffmpeg(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
const char *video_filter = "video.*";
CLG_type_filter_include(video_filter, strlen(video_filter));
return 0;
}
static const char arg_handle_debug_mode_memory_set_doc[] =
"\n\t"
"Enable fully guarded memory allocation and debugging.";
static int arg_handle_debug_mode_memory_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
MEM_set_memory_debug();
return 0;
}
static const char arg_handle_debug_value_set_doc[] =
2016-04-06 09:28:22 +10:00
"<value>\n"
2017-10-08 18:46:26 +11:00
"\tSet debug value of <value> on startup.";
static int arg_handle_debug_value_set(int argc, const char **argv, void * /*data*/)
{
const char *arg_id = "--debug-value";
if (argc > 1) {
const char *err_msg = nullptr;
int value;
if (!parse_int(argv[1], nullptr, &value, &err_msg)) {
fprintf(stderr, "\nError: %s '%s %s'.\n", err_msg, arg_id, argv[1]);
return 1;
}
G.debug_value = value;
return 1;
}
fprintf(stderr, "\nError: you must specify debug value to set.\n");
2020-11-07 18:24:56 +05:30
return 0;
}
static const char arg_handle_debug_gpu_set_doc[] =
"\n"
"\tEnable GPU debug context and information for OpenGL 4.3+.";
static int arg_handle_debug_gpu_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
/* Also enable logging because that how gl errors are reported. */
const char *gpu_filter = "gpu.*";
CLG_type_filter_include(gpu_filter, strlen(gpu_filter));
G.debug |= G_DEBUG_GPU;
return 0;
}
static const char arg_handle_debug_gpu_compile_shaders_set_doc[] =
"\n"
2024-02-16 14:26:46 +11:00
"\tCompile all statically defined shaders to test platform compatibility.";
static int arg_handle_debug_gpu_compile_shaders_set(int /*argc*/,
const char ** /*argv*/,
void * /*data*/)
{
G.debug |= G_DEBUG_GPU_COMPILE_SHADERS;
return 0;
}
static const char arg_handle_debug_gpu_scope_capture_set_doc[] =
"\n"
"\tCapture the GPU commands issued inside the give scope name.";
static int arg_handle_debug_gpu_scope_capture_set(int argc, const char **argv, void * /*data*/)
{
if (argc > 1) {
# ifdef WITH_RENDERDOC
STRNCPY(G.gpu_debug_scope_name, argv[1]);
# else
UNUSED_VARS(argc, argv);
BLI_assert_unreachable();
# endif
return 1;
}
fprintf(stderr, "\nError: you must specify a scope name to capture.\n");
return 0;
}
static const char arg_handle_debug_gpu_renderdoc_set_doc[] =
"\n"
"\tEnable RenderDoc integration for GPU frame grabbing and debugging.";
static int arg_handle_debug_gpu_renderdoc_set(int /*argc*/,
const char ** /*argv*/,
void * /*data*/)
{
# ifdef WITH_RENDERDOC
GPU: Add flag for shader debug info generation This PR proposes to add a new flag `--shader-debug-info` that enables the generation of shader debug information. I created this PR as WIP due to the following reasons: - Currently it only works for the Vulkan backend. I do not know if it makes sense for other backends. For example, OpenGL directly receives the GLSL code, so there no need for this might exist. - So far `--debug-gpu-renderdoc` already turns on the following changes for GLSL shader compilation with shaderc: ``` options.SetOptimizationLevel(shaderc_optimization_level_zero); options.SetGenerateDebugInfo(); ``` - While combining optimization level zero with debug info is a sensible choice for frame debuggers like RenderDoc, my use case for creating this PR is shader profiling. In this case, one does not want compiler optimizations to be turned off. At the current point in time, the only information my profiler uses (which is unfortunately not public at this point in time) is the name of the shader. When turning on debug information, shaderc/glslang store this information in the generated SPIR-V data. Otherwise, it would be impossible for the profiler to tell the user what the name of the shader it is that is profiled. - An alternative solution would be to rename the entry point `main` of a shader to the name of the shader. But this might be an even uglier hack, as it requires editing the source code (and the name of the shader then needs to be a valid GLSL function name). - We should first clarify if there is interest in the Blender side in upstreaming an option like this. While I could just keep this in my local fork of Blender, there is merit in having the possibility to profile arbitrary Blender builds. Pull Request: https://projects.blender.org/blender/blender/pulls/142986
2025-08-13 13:41:41 +02:00
G.debug |= G_DEBUG_GPU_RENDERDOC | G_DEBUG_GPU | G_DEBUG_GPU_SHADER_DEBUG_INFO;
# else
BLI_assert_unreachable();
# endif
return 0;
}
GPU: Add flag for shader debug info generation This PR proposes to add a new flag `--shader-debug-info` that enables the generation of shader debug information. I created this PR as WIP due to the following reasons: - Currently it only works for the Vulkan backend. I do not know if it makes sense for other backends. For example, OpenGL directly receives the GLSL code, so there no need for this might exist. - So far `--debug-gpu-renderdoc` already turns on the following changes for GLSL shader compilation with shaderc: ``` options.SetOptimizationLevel(shaderc_optimization_level_zero); options.SetGenerateDebugInfo(); ``` - While combining optimization level zero with debug info is a sensible choice for frame debuggers like RenderDoc, my use case for creating this PR is shader profiling. In this case, one does not want compiler optimizations to be turned off. At the current point in time, the only information my profiler uses (which is unfortunately not public at this point in time) is the name of the shader. When turning on debug information, shaderc/glslang store this information in the generated SPIR-V data. Otherwise, it would be impossible for the profiler to tell the user what the name of the shader it is that is profiled. - An alternative solution would be to rename the entry point `main` of a shader to the name of the shader. But this might be an even uglier hack, as it requires editing the source code (and the name of the shader then needs to be a valid GLSL function name). - We should first clarify if there is interest in the Blender side in upstreaming an option like this. While I could just keep this in my local fork of Blender, there is merit in having the possibility to profile arbitrary Blender builds. Pull Request: https://projects.blender.org/blender/blender/pulls/142986
2025-08-13 13:41:41 +02:00
static const char arg_handle_debug_gpu_shader_debug_info_set_doc[] =
"\n"
"\tEnable shader debug info generation (Vulkan only).";
static int arg_handle_debug_gpu_shader_debug_info_set(int /*argc*/,
const char ** /*argv*/,
void * /*data*/)
{
G.debug |= G_DEBUG_GPU_SHADER_DEBUG_INFO;
return 0;
}
static const char arg_handle_gpu_backend_set_doc_all[] =
"\n"
"\tForce to use a specific GPU backend. Valid options: "
"'vulkan', "
"'metal', "
"'opengl'.";
static const char arg_handle_gpu_backend_set_doc[] =
"\n"
"\tForce to use a specific GPU backend. Valid options: "
Vulkan: Enable as Experimental Option This PR enables vulkan backend as experimental option. It will only be available in alpha builds on Linux and Windows. This option is highly experimental and enabled to get some insight on supported platforms. Don't expect a fully working Blender yet. Also don't expect it to have usable performance. **What is known to not work?** * OCIO textures are not supported on Intel and AMD GPUs. sRGB/Standard is supported on those platforms. * AMD Polaris based GPUs on Linux will generate a crash when drawing the 3d cursor as it doesn't support the needed vertex format. Comment out `DRW_draw_cursor` in `DRW_draw_region_info`. * The colors in the node editor and sequencer are of as sRGB viewports aren't detected correctly. * The image / UV editor isn't working as many texture formats haven't been tested yet. Some tweaks are also needed to do correct depth testing. * 3D Viewport is known to be flickering. Sometimes workbench doesn't display anything. * 3D Viewport wireframe will crash as it uses a framebuffer with gaps between color attachments, which isn't supported yet. (#113141) * Rotate the view widget is partially drawn due to incompatible depth clipping. * GPU Selection isn't working. It is expected to be solved when Overlay-Next will become the default engine. For now disable GPU depth picking in the preferences. * Cycles/EEVEE are known to not work with Vulkan yet. Cycles requires Vulkan Pixel Buffer. Cuda <-> Vulkan interop might require a different approach than OpenGL as Vulkan doesn't allow importing memory from a Cuda context. EEVEE uses features that aren't available yet in the backend * Workbench is working, except Workbench shadows. * EEVEE-Next basics are working. Shadows, lights are known to be not working. Materials/Shading works in simple scenes. Changes are expected in EEVEE-Next that will break Vulkan compatibility in the near future. * Systems with multiple GPUs is not expected to work. * Wayland support is in development and requires some iterations. You can start Blender, but the protocols are not aligned yet. * OpenXR hasn't been modified and is expected to fail. * The backend is very strict when mis-using the GPU module. In debug builds it may crash on asserts. * Older drivers/GPUs might not have all the features that we require. The workarounds for the missing features still need to be implemented. **A word about performance** In the project planning we focus first on stability and platform support. The performance of Vulkan is around 20% of what we want to achieve. The reason is that each command sent to the GPU is done one at a time. The implementation even waits until we have feedback that the GPU is idle again. Geometry is currently stored in System RAM. The GPU will read and cache the data when accessing geometry. This slows down when using objects with much geometry. Some performance features like MDI (Multi-Draw-Indirect) hasn't been implemented and falls back to Single Draw Indirect. **Why enable it is an experimental option?** * Ensures that new features are being tested with Vulkan * Ensure that building with Vulkan is possible on supported platforms * Get feedback from developers if Vulkan can run on their system or that there are special cases that we are not aware of. Main development environment has been Linux/X11 with occasionally testing using Windows. * Validate Add-ons that use the `gpu` module. * Possible to enable GLSL validation on the buildbot. (Needs more work). * Does it compile on all machines or does it require more changes to cmake config. We expect it to be able to compile without installing the Vulkan SDK. The Vulkan SDK is a very powerful tool, but only when actually doing GPU development. Otherwise it is an overhead which slows down other activities. **How can the backend be enabled?** Currently the Vulkan backend can be enabled per Blender session by starting using the command line argument `--gpu-backend vulkan`. In the future, when the backend is more mature, we will add a user preference to switch between OpenGL and Vulkan. Pull Request: https://projects.blender.org/blender/blender/pulls/113057
2023-10-06 15:24:21 +02:00
# ifdef WITH_OPENGL_BACKEND
"'opengl'"
# endif
# ifdef WITH_METAL_BACKEND
"'metal'"
# endif
# ifdef WITH_VULKAN_BACKEND
# if defined(WITH_OPENGL_BACKEND) || defined(WITH_METAL_BACKEND)
" or "
# endif
"'vulkan'"
# endif
".";
static int arg_handle_gpu_backend_set(int argc, const char **argv, void * /*data*/)
{
if (argc < 2) {
fprintf(stderr, "\nError: GPU backend must follow '--gpu-backend'.\n");
return 0;
}
const char *backends_supported[3] = {nullptr};
int backends_supported_num = 0;
eGPUBackendType gpu_backend = GPU_BACKEND_NONE;
/* NOLINTBEGIN: bugprone-assignment-in-if-condition */
if (false) {
/* Use a dummy block to make the following `ifdef` blocks work. */
}
# ifdef WITH_OPENGL_BACKEND
else if (STREQ(argv[1], (backends_supported[backends_supported_num++] = "opengl"))) {
gpu_backend = GPU_BACKEND_OPENGL;
}
# endif
# ifdef WITH_VULKAN_BACKEND
else if (STREQ(argv[1], (backends_supported[backends_supported_num++] = "vulkan"))) {
gpu_backend = GPU_BACKEND_VULKAN;
}
# endif
# ifdef WITH_METAL_BACKEND
else if (STREQ(argv[1], (backends_supported[backends_supported_num++] = "metal"))) {
gpu_backend = GPU_BACKEND_METAL;
}
# endif
else {
fprintf(stderr, "\nError: Unrecognized GPU backend for '--gpu-backend', expected one of [");
for (int i = 0; i < backends_supported_num; i++) {
fprintf(stderr, (i + 1 != backends_supported_num) ? "%s, " : "%s", backends_supported[i]);
}
fprintf(stderr, "].\n");
return 1;
}
/* NOLINTEND: bugprone-assignment-in-if-condition */
GPU_backend_type_selection_set_override(gpu_backend);
return 1;
}
static const char arg_handle_gpu_vsync_set_doc[] =
"\n"
"\tSet the VSync.\n"
"\tValid options are: 'on', 'off' & 'auto' for adaptive sync.\n"
"\n"
"\t* The default settings depend on the GPU driver.\n"
"\t* Disabling VSync can be useful for testing performance.\n"
"\t* 'auto' is only supported by the OpenGL backend.";
static int arg_handle_gpu_vsync_set(int argc, const char **argv, void * /*data*/)
{
const char *arg_id = "--gpu-vsync";
if (argc < 2) {
fprintf(stderr, "\nError: VSync value must follow '%s'.\n", arg_id);
return 0;
}
/* Must be compatible with #GHOST_TVSyncModes. */
int vsync;
if (STREQ(argv[1], "on")) {
vsync = 1;
}
else if (STREQ(argv[1], "off")) {
vsync = 0;
}
else if (STREQ(argv[1], "auto")) {
vsync = -1;
}
else {
fprintf(stderr, "\nError: expected a value in [on, off, auto] '%s %s'.\n", arg_id, argv[1]);
return 1;
}
GPU_backend_vsync_set_override(vsync);
return 1;
}
static const char arg_handle_gpu_compilation_subprocesses_set_doc[] =
"\n"
"\tOverride the Max Compilation Subprocesses setting (OpenGL only).";
static int arg_handle_gpu_compilation_subprocesses_set(int argc,
const char **argv,
void * /*data*/)
{
const char *arg_id = "--gpu-compilation-subprocesses";
const int min = 0, max = BLI_system_thread_count();
if (argc > 1) {
const char *err_msg = nullptr;
int subprocesses;
if (!parse_int_strict_range(argv[1], nullptr, min, max, &subprocesses, &err_msg)) {
fprintf(stderr,
"\nError: %s '%s %s', expected number in [%d..%d].\n",
err_msg,
arg_id,
argv[1],
min,
max);
return 1;
}
# ifdef WITH_OPENGL_BACKEND
GPU_compilation_subprocess_override_set(subprocesses);
# else
UNUSED_VARS(subprocesses);
BLI_assert_unreachable();
# endif
return 1;
}
fprintf(stderr,
"\nError: you must specify a number of subprocesses in [%d..%d] '%s'.\n",
min,
max,
arg_id);
return 0;
}
static const char arg_handle_debug_fpe_set_doc[] =
"\n\t"
"Enable floating-point exceptions.";
static int arg_handle_debug_fpe_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
main_signal_setup_fpe();
return 0;
}
static const char arg_handle_app_template_doc[] =
"<template>\n"
"\tSet the application template (matching the directory name), use 'default' for none.";
static int arg_handle_app_template(int argc, const char **argv, void * /*data*/)
{
if (argc > 1) {
const char *app_template = STREQ(argv[1], "default") ? "" : argv[1];
WM_init_state_app_template_set(app_template);
return 1;
}
fprintf(stderr, "\nError: App template must follow '--app-template'.\n");
2020-11-07 18:24:56 +05:30
return 0;
}
static const char arg_handle_factory_startup_set_doc[] =
"\n\t"
"Skip reading the '" BLENDER_STARTUP_FILE "' in the users home directory.";
static int arg_handle_factory_startup_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
G.factory_startup = true;
G.f |= G_FLAG_USERPREF_NO_SAVE_ON_EXIT;
return 0;
}
static const char arg_handle_enable_event_simulate_doc[] =
"\n\t"
"Enable event simulation testing feature 'bpy.types.Window.event_simulate'.";
static int arg_handle_enable_event_simulate(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
G.f |= G_FLAG_EVENT_SIMULATE;
return 0;
}
static const char arg_handle_env_system_set_doc_datafiles[] =
"\n\t"
"Set the " STRINGIFY_ARG(BLENDER_SYSTEM_DATAFILES) " environment variable.";
static const char arg_handle_env_system_set_doc_scripts[] =
"\n\t"
"Set the " STRINGIFY_ARG(BLENDER_SYSTEM_SCRIPTS) " environment variable.";
static const char arg_handle_env_system_set_doc_python[] =
"\n\t"
"Set the " STRINGIFY_ARG(BLENDER_SYSTEM_PYTHON) " environment variable.";
static const char arg_handle_env_system_set_doc_extensions[] =
"\n\t"
"Set the " STRINGIFY_ARG(BLENDER_SYSTEM_EXTENSIONS) " environment variable.";
static int arg_handle_env_system_set(int argc, const char **argv, void * /*data*/)
{
2021-03-06 13:03:30 +11:00
/* `--env-system-scripts` -> `BLENDER_SYSTEM_SCRIPTS` */
char env[64] = "BLENDER";
char *ch_dst = env + 7; /* Skip `BLENDER`. */
const char *ch_src = argv[0] + 5; /* Skip `--env`. */
if (argc < 2) {
fprintf(stderr, "%s requires one argument\n", argv[0]);
exit(EXIT_FAILURE);
BLI_assert_unreachable();
}
for (; *ch_src; ch_src++, ch_dst++) {
*ch_dst = (*ch_src == '-') ? '_' : (*ch_src) - 32; /* Inline #toupper(). */
}
*ch_dst = '\0';
BLI_setenv(env, argv[1]);
return 1;
}
static const char arg_handle_playback_mode_doc[] =
"<options> <file(s)>\n"
"\tInstead of showing Blender's user interface, this runs Blender as an animation player,\n"
"\tto view movies and image sequences rendered in Blender (ignored if '-b' is set).\n"
"\n"
"\tPlayback Arguments:\n"
"\n"
2017-10-08 18:46:26 +11:00
"\t-p <sx> <sy>\n"
"\t\tOpen with lower left corner at <sx>, <sy>.\n"
"\t-m\n"
"\t\tRead from disk (Do not buffer).\n"
"\t-f <fps> <fps_base>\n"
2017-10-08 18:46:26 +11:00
"\t\tSpecify FPS to start with.\n"
"\t-j <frame>\n"
"\t\tSet frame step to <frame>.\n"
"\t-s <frame>\n"
"\t\tPlay from <frame>.\n"
"\t-e <frame>\n"
"\t\tPlay until <frame>.\n"
"\t-c <cache_memory>\n"
"\t\tAmount of memory in megabytes to allow for caching images during playback.\n"
"\t\tZero disables (clamping to a fixed number of frames instead).";
static int arg_handle_playback_mode(int argc, const char **argv, void * /*data*/)
{
/* Ignore the animation player if `-b` was given first. */
if (G.background == 0) {
/* Skip this argument (`-a`). */
const int exit_code = WM_main_playanim(argc - 1, argv + 1);
exit(exit_code);
}
return -2;
}
static const char arg_handle_window_geometry_doc[] =
"<sx> <sy> <w> <h>\n"
2017-10-08 18:46:26 +11:00
"\tOpen with lower left corner at <sx>, <sy> and width and height as <w>, <h>.";
static int arg_handle_window_geometry(int argc, const char **argv, void * /*data*/)
{
const char *arg_id = "-p / --window-geometry";
int params[4], i;
if (argc < 5) {
fprintf(stderr, "Error: requires four arguments '%s'\n", arg_id);
exit(1);
}
for (i = 0; i < 4; i++) {
const char *err_msg = nullptr;
if (!parse_int(argv[i + 1], nullptr, &params[i], &err_msg)) {
fprintf(stderr, "\nError: %s '%s %s'.\n", err_msg, arg_id, argv[1]);
exit(1);
}
}
WM_init_state_size_set(UNPACK4(params));
return 4;
}
static const char arg_handle_native_pixels_set_doc[] =
"\n\t"
"Do not use native pixel size, for high resolution displays (MacBook 'Retina').";
static int arg_handle_native_pixels_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
WM_init_native_pixels(false);
return 0;
}
static const char arg_handle_with_borders_doc[] =
"\n\t"
"Force opening with borders.";
static int arg_handle_with_borders(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
WM_init_state_normal_set();
return 0;
}
static const char arg_handle_without_borders_doc[] =
"\n\t"
"Force opening in full-screen mode.";
static int arg_handle_without_borders(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
WM_init_state_fullscreen_set();
return 0;
}
static const char arg_handle_window_maximized_doc[] =
"\n\t"
"Force opening maximized.";
static int arg_handle_window_maximized(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
WM_init_state_maximized_set();
return 0;
}
static const char arg_handle_no_window_focus_doc[] =
"\n\t"
"Open behind other windows and without taking focus.";
static int arg_handle_no_window_focus(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
WM_init_window_focus_set(false);
return 0;
}
static const char arg_handle_start_with_console_doc[] =
"\n\t"
"Start with the console window open (ignored if '-b' is set), (Windows only).";
static int arg_handle_start_with_console(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
WM_init_state_start_with_console_set(true);
return 0;
}
static bool arg_handle_extension_registration(const bool do_register, const bool all_users)
{
/* Logic runs in #main_args_handle_registration. */
# ifdef WIN32
/* This process has been launched with the permissions needed
* to register or unregister, so just do it now and then exit. */
if (do_register) {
BLI_windows_register_blend_extension(all_users);
}
else {
BLI_windows_unregister_blend_extension(all_users);
}
TerminateProcess(GetCurrentProcess(), 0);
return true;
# else
char *error_msg = nullptr;
bool result = WM_platform_associate_set(do_register, all_users, &error_msg);
if (error_msg) {
fprintf(stderr, "Error: %s\n", error_msg);
MEM_freeN(error_msg);
}
return result;
# endif
}
static const char arg_handle_register_extension_doc[] =
"\n\t"
"Register blend-file extension for current user, then exit (Windows & Linux only).";
static int arg_handle_register_extension(int argc, const char **argv, void *data)
{
CLG_quiet_set(true);
background_mode_set();
# if !(defined(WIN32) || defined(__APPLE__))
if (!main_arg_deferred_is_set()) {
main_arg_deferred_setup(arg_handle_register_extension, argc, argv, data);
return argc - 1;
}
# endif
arg_handle_extension_registration(true, false);
return argc - 1;
}
static const char arg_handle_register_extension_all_doc[] =
"\n\t"
"Register blend-file extension for all users, then exit (Windows & Linux only).";
static int arg_handle_register_extension_all(int argc, const char **argv, void *data)
{
CLG_quiet_set(true);
background_mode_set();
# if !(defined(WIN32) || defined(__APPLE__))
if (!main_arg_deferred_is_set()) {
main_arg_deferred_setup(arg_handle_register_extension_all, argc, argv, data);
return argc - 1;
}
# endif
arg_handle_extension_registration(true, true);
return argc - 1;
}
static const char arg_handle_unregister_extension_doc[] =
"\n\t"
"Unregister blend-file extension for current user, then exit (Windows & Linux only).";
static int arg_handle_unregister_extension(int argc, const char **argv, void *data)
{
CLG_quiet_set(true);
background_mode_set();
# if !(defined(WIN32) || defined(__APPLE__))
if (!main_arg_deferred_is_set()) {
main_arg_deferred_setup(arg_handle_unregister_extension, argc, argv, data);
return argc - 1;
}
# endif
arg_handle_extension_registration(false, false);
return 0;
}
static const char arg_handle_unregister_extension_all_doc[] =
"\n\t"
"Unregister blend-file extension for all users, then exit (Windows & Linux only).";
static int arg_handle_unregister_extension_all(int argc, const char **argv, void *data)
{
CLG_quiet_set(true);
background_mode_set();
# if !(defined(WIN32) || defined(__APPLE__))
if (!main_arg_deferred_is_set()) {
main_arg_deferred_setup(arg_handle_unregister_extension_all, argc, argv, data);
return argc - 1;
}
# endif
arg_handle_extension_registration(false, true);
return 0;
}
static const char arg_handle_qos_set_doc[] =
"<level>\n"
"\tSet the Quality of Service (QoS) mode for hybrid CPU architectures (Windows only).\n"
"\n"
"\tdefault: Uses the default behavior of the OS.\n"
"\thigh: Always makes use of performance cores.\n"
"\teco: Schedules Blender threads exclusively to efficiency cores.";
static int arg_handle_qos_set(int argc, const char **argv, void * /*data*/)
{
const char *arg_id = "--qos";
if (argc > 1) {
# ifdef _WIN32
QoSMode qos_mode;
if (STRCASEEQ(argv[1], "default")) {
qos_mode = QoSMode::DEFAULT;
}
else if (STRCASEEQ(argv[1], "high")) {
qos_mode = QoSMode::HIGH;
}
else if (STRCASEEQ(argv[1], "eco")) {
qos_mode = QoSMode::ECO;
}
else {
fprintf(stderr, "\nError: Invalid QoS level '%s %s'.\n", arg_id, argv[1]);
return 1;
}
BLI_windows_process_set_qos(qos_mode, QoSPrecedence::CMDLINE_ARG);
# else
UNUSED_VARS(argv);
fprintf(stderr, "\nError: '%s' is Windows only.\n", arg_id);
# endif
return 1;
}
fprintf(stderr, "\nError: '%s' no args given.\n", arg_id);
return 0;
}
static const char arg_handle_audio_disable_doc[] =
"\n\t"
"Force sound system to None.";
static int arg_handle_audio_disable(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
BKE_sound_force_device("None");
return 0;
}
static const char arg_handle_audio_set_doc[] =
"\n\t"
"Force sound system to a specific device.\n"
"\t'None' 'Default' 'SDL' 'OpenAL' 'CoreAudio' 'JACK' 'PulseAudio' 'WASAPI'.";
static int arg_handle_audio_set(int argc, const char **argv, void * /*data*/)
{
if (argc < 1) {
fprintf(stderr, "-setaudio requires one argument\n");
exit(1);
}
const char *device = argv[1];
if (STREQ(device, "Default")) {
/* Unset any forced device. */
device = nullptr;
}
BKE_sound_force_device(device);
return 1;
}
static const char arg_handle_output_set_doc[] =
"<path>\n"
"\tSet the render path and file name.\n"
2016-03-02 17:01:38 +11:00
"\tUse '//' at the start of the path to render relative to the blend-file.\n"
"\n"
Templates for render output paths This adds basic templating support to render output paths. By putting "{variable_name}" in the path string, it will be replaced by the named variable's value when generating the actual output path. This is similar to how "//" is already substituted with the path to the blend file's current directory. This templating system is implemented for both the primary render output path as well as the File Output node in the compositing nodes. Support for using templates in other places can be implemented in future PRs. In addition to the "{variable_name}" syntax, some additional syntax is also supported: - Since "{" and "}" now have special meaning, "{{" and "}}" are now escape sequences for literal "{" and "}". - "{variable_name:format_specifier}", where "format_specifier" is a special syntax using "#", which allows the user to specify how numeric variables should be formatted: - "{variable_name:###}" will format the number as an integer with at least 3 characters (padding with zeros as needed). - "{variable_name:.##}" will format the number as a float with precisely 2 fractional digits. - "{variable_name:###.##}" will format the number as a float with at least 3 characters for the integer part and precisely 2 for the fractional part. For the primary render output path: if there is a template syntax error, a variable doesn't exist, or a format specifier isn't valid (e.g. trying to format a string with "##"), the render that needs to write to the output path fails with a descriptive error message. For both the primary and File Output node paths: if there are template syntax errors the field is highlighted in red in the UI, and a tooltip describes the offending syntax errors. Note that these do *not* yet reflect errors due to missing variables. That will be for a follow-up PR. In addition to the general system, this PR also implements a limited set of variables for use in templates, but more can be implemented in future PRs. The variables added in this PR are: - `blend_name`: the name of the current blend file without the file extension. - `fps`: the frames per second of the current scene. - `resolution_x` and `resolution_y`: the render output resolution. Pull Request: https://projects.blender.org/blender/blender/pulls/134860
2025-05-08 15:37:28 +02:00
"\tYou can use path templating features such as '{blend_name}' in the path.\n"
"\tSee Blender's documentation on path templates for more details.\n"
"\n"
"\tThe '#' characters are replaced by the frame number, and used to define zero padding.\n"
2016-04-06 09:28:22 +10:00
"\n"
"\t* 'animation_##_test.png' becomes 'animation_01_test.png'\n"
"\t* 'test-######.png' becomes 'test-000001.png'\n"
"\n"
"\tWhen the filename does not contain '#', the suffix '####' is added to the filename.\n"
"\n"
"\tThe frame number will be added at the end of the filename, eg:\n"
"\t# blender -b animation.blend -o //render_ -F PNG -x 1 -a\n"
"\t'//render_' becomes '//render_####', writing frames as '//render_0001.png'";
static int arg_handle_output_set(int argc, const char **argv, void *data)
{
bContext *C = static_cast<bContext *>(data);
if (argc > 1) {
Scene *scene = CTX_data_scene(C);
if (scene) {
2023-05-09 12:50:37 +10:00
STRNCPY(scene->r.pic, argv[1]);
DEG_id_tag_update(&scene->id, ID_RECALC_SYNC_TO_EVAL);
}
else {
fprintf(stderr, "\nError: no blend loaded. cannot use '-o / --render-output'.\n");
}
return 1;
}
fprintf(stderr, "\nError: you must specify a path after '-o / --render-output'.\n");
2020-11-07 18:24:56 +05:30
return 0;
}
static const char arg_handle_engine_set_doc[] =
"<engine>\n"
"\tSpecify the render engine.\n"
"\tUse '-E help' to list available engines.";
static int arg_handle_engine_set(int argc, const char **argv, void *data)
{
bContext *C = static_cast<bContext *>(data);
if (argc >= 2) {
const char *engine_name = argv[1];
if (STREQ(engine_name, "help")) {
printf("Blender Engine Listing:\n");
LISTBASE_FOREACH (RenderEngineType *, type, &R_engines) {
printf("\t%s\n", type->idname);
}
exit(0);
}
else {
Scene *scene = CTX_data_scene(C);
if (scene) {
/* Backwards compatibility. */
if (STREQ(engine_name, "BLENDER_EEVEE_NEXT")) {
engine_name = "BLENDER_EEVEE";
}
if (BLI_findstring(&R_engines, engine_name, offsetof(RenderEngineType, idname))) {
STRNCPY_UTF8(scene->r.engine, engine_name);
DEG_id_tag_update(&scene->id, ID_RECALC_SYNC_TO_EVAL);
}
else {
fprintf(stderr, "\nError: engine not found '%s'\n", engine_name);
exit(1);
}
}
else {
fprintf(stderr,
"\nError: no blend loaded. "
"order the arguments so '-E / --engine' is after a blend is loaded.\n");
}
}
return 1;
}
fprintf(stderr, "\nEngine not specified, give 'help' for a list of available engines.\n");
2020-11-07 18:24:56 +05:30
return 0;
}
static const char arg_handle_image_type_set_doc[] =
"<format>\n"
2017-10-08 18:46:26 +11:00
"\tSet the render format.\n"
"\tValid options are:\n"
"\t'TGA' 'RAWTGA' 'JPEG' 'IRIS' 'PNG' 'BMP' 'HDR' 'TIFF'.\n"
2017-10-08 18:46:26 +11:00
"\n"
"\tFormats that can be compiled into Blender, not available on all systems:\n"
"\t'OPEN_EXR' 'OPEN_EXR_MULTILAYER' 'FFMPEG' 'CINEON' 'DPX' 'JP2' 'WEBP'.";
static int arg_handle_image_type_set(int argc, const char **argv, void *data)
{
bContext *C = static_cast<bContext *>(data);
if (argc > 1) {
const char *imtype = argv[1];
Scene *scene = CTX_data_scene(C);
if (scene) {
const char imtype_new = BKE_imtype_from_arg(imtype);
if (imtype_new == R_IMF_IMTYPE_INVALID) {
fprintf(stderr,
"\nError: Format from '-F / --render-format' not known or not compiled in this "
"release.\n");
}
else {
BKE_image_format_set(&scene->r.im_format, &scene->id, imtype_new);
DEG_id_tag_update(&scene->id, ID_RECALC_SYNC_TO_EVAL);
}
}
else {
fprintf(stderr,
"\nError: no blend loaded. "
"order the arguments so '-F / --render-format' is after the blend is loaded.\n");
}
return 1;
}
fprintf(stderr, "\nError: you must specify a format after '-F / --render-format'.\n");
2020-11-07 18:24:56 +05:30
return 0;
}
static const char arg_handle_threads_set_doc[] =
"<threads>\n"
"\tUse amount of <threads> for rendering and other operations\n"
"\t[1-" STRINGIFY(BLENDER_MAX_THREADS) "], 0 to use the systems processor count.";
static int arg_handle_threads_set(int argc, const char **argv, void * /*data*/)
{
const char *arg_id = "-t / --threads";
const int min = 0, max = BLENDER_MAX_THREADS;
if (argc > 1) {
const char *err_msg = nullptr;
int threads;
if (!parse_int_strict_range(argv[1], nullptr, min, max, &threads, &err_msg)) {
fprintf(stderr,
"\nError: %s '%s %s', expected number in [%d..%d].\n",
err_msg,
arg_id,
argv[1],
min,
max);
return 1;
}
BLI_system_num_threads_override_set(threads);
return 1;
}
fprintf(stderr,
"\nError: you must specify a number of threads in [%d..%d] '%s'.\n",
min,
max,
arg_id);
2020-11-07 18:24:56 +05:30
return 0;
}
static const char arg_handle_verbosity_set_doc[] =
2016-04-06 09:28:22 +10:00
"<verbose>\n"
"\tSet the logging verbosity level for debug messages that support it.";
static int arg_handle_verbosity_set(int argc, const char **argv, void * /*data*/)
{
const char *arg_id = "--verbose";
if (argc > 1) {
const char *err_msg = nullptr;
int level;
if (!parse_int(argv[1], nullptr, &level, &err_msg)) {
fprintf(stderr, "\nError: %s '%s %s'.\n", err_msg, arg_id, argv[1]);
}
# ifdef WITH_LIBMV
libmv_setLoggingVerbosity(level);
# endif
return 1;
}
fprintf(stderr, "\nError: you must specify a verbosity level.\n");
2020-11-07 18:24:56 +05:30
return 0;
}
static const char arg_handle_extension_set_doc[] =
"<bool>\n"
2017-10-08 18:46:26 +11:00
"\tSet option to add the file extension to the end of the file.";
static int arg_handle_extension_set(int argc, const char **argv, void *data)
{
bContext *C = static_cast<bContext *>(data);
if (argc > 1) {
Scene *scene = CTX_data_scene(C);
if (scene) {
if (argv[1][0] == '0') {
scene->r.scemode &= ~R_EXTENSION;
DEG_id_tag_update(&scene->id, ID_RECALC_SYNC_TO_EVAL);
}
else if (argv[1][0] == '1') {
scene->r.scemode |= R_EXTENSION;
DEG_id_tag_update(&scene->id, ID_RECALC_SYNC_TO_EVAL);
}
else {
fprintf(stderr,
"\nError: Use '-x 1 / -x 0' To set the extension option or '--use-extension'\n");
}
}
else {
fprintf(stderr,
"\nError: no blend loaded. "
"order the arguments so '-o ' is after '-x '.\n");
}
return 1;
}
fprintf(stderr, "\nError: you must specify a path after '- '.\n");
2020-11-07 18:24:56 +05:30
return 0;
}
static void add_log_render_filter()
{
const char *render_filter = "render.*";
CLG_type_filter_include(render_filter, strlen(render_filter));
}
static const char arg_handle_render_frame_doc[] =
"<frame>\n"
"\tRender frame <frame> and save it.\n"
"\n"
"\t* +<frame> start frame relative, -<frame> end frame relative.\n"
"\t* A comma separated list of frames can also be used (no spaces).\n"
2018-01-30 21:02:27 +11:00
"\t* A range of frames can be expressed using '..' separator between the first and last "
"frames (inclusive).\n";
static int arg_handle_render_frame(int argc, const char **argv, void *data)
{
const char *arg_id = "-f / --render-frame";
bContext *C = static_cast<bContext *>(data);
Scene *scene = CTX_data_scene(C);
if (scene) {
add_log_render_filter();
Main *bmain = CTX_data_main(C);
if (argc > 1) {
const char *err_msg = nullptr;
Render *re;
ReportList reports;
int(*frame_range_arr)[2], frames_range_len;
if ((frame_range_arr = parse_int_range_relative_clamp_n(argv[1],
scene->r.sfra,
scene->r.efra,
MINAFRAME,
MAXFRAME,
&frames_range_len,
&err_msg)) == nullptr)
{
fprintf(stderr, "\nError: %s '%s %s'.\n", err_msg, arg_id, argv[1]);
return 1;
}
re = RE_NewSceneRender(scene);
BKE_reports_init(&reports, RPT_STORE);
RE_SetReports(re, &reports);
for (int i = 0; i < frames_range_len; i++) {
/* We could pass in frame ranges,
* but prefer having exact behavior as passing in multiple frames. */
if ((frame_range_arr[i][0] <= frame_range_arr[i][1]) == 0) {
fprintf(stderr, "\nWarning: negative range ignored '%s %s'.\n", arg_id, argv[1]);
}
for (int frame = frame_range_arr[i][0]; frame <= frame_range_arr[i][1]; frame++) {
RE_RenderAnim(re, bmain, scene, nullptr, nullptr, frame, frame, scene->r.frame_step);
}
}
RE_SetReports(re, nullptr);
BKE_reports_free(&reports);
MEM_freeN(frame_range_arr);
return 1;
}
fprintf(stderr, "\nError: frame number must follow '%s'.\n", arg_id);
2020-11-07 18:24:56 +05:30
return 0;
}
fprintf(stderr, "\nError: no blend loaded. cannot use '%s'.\n", arg_id);
return 0;
}
static const char arg_handle_render_animation_doc[] =
"\n\t"
"Render frames from start to end (inclusive).";
static int arg_handle_render_animation(int /*argc*/, const char ** /*argv*/, void *data)
{
bContext *C = static_cast<bContext *>(data);
Scene *scene = CTX_data_scene(C);
if (scene) {
add_log_render_filter();
Main *bmain = CTX_data_main(C);
Render *re = RE_NewSceneRender(scene);
ReportList reports;
BKE_reports_init(&reports, RPT_STORE);
RE_SetReports(re, &reports);
RE_RenderAnim(
re, bmain, scene, nullptr, nullptr, scene->r.sfra, scene->r.efra, scene->r.frame_step);
RE_SetReports(re, nullptr);
BKE_reports_free(&reports);
}
else {
fprintf(stderr, "\nError: no blend loaded. cannot use '-a'.\n");
}
return 0;
}
static const char arg_handle_scene_set_doc[] =
"<name>\n"
2017-10-08 18:46:26 +11:00
"\tSet the active scene <name> for rendering.";
static int arg_handle_scene_set(int argc, const char **argv, void *data)
{
if (argc > 1) {
bContext *C = static_cast<bContext *>(data);
Scene *scene = BKE_scene_set_name(CTX_data_main(C), argv[1]);
if (scene) {
CTX_data_scene_set(C, scene);
/* Set the scene of the first window, see: #55991,
* otherwise scripts that run later won't get this scene back from the context. */
wmWindow *win = CTX_wm_window(C);
if (win == nullptr) {
win = static_cast<wmWindow *>(CTX_wm_manager(C)->windows.first);
}
if (win != nullptr) {
2018-07-27 17:09:38 +10:00
WM_window_set_active_scene(CTX_data_main(C), C, win, scene);
}
}
return 1;
}
fprintf(stderr, "\nError: Scene name must follow '-S / --scene'.\n");
2020-11-07 18:24:56 +05:30
return 0;
}
static const char arg_handle_frame_start_set_doc[] =
2016-04-06 09:28:22 +10:00
"<frame>\n"
"\tSet start to frame <frame>, supports +/- for relative frames too.";
static int arg_handle_frame_start_set(int argc, const char **argv, void *data)
{
const char *arg_id = "-s / --frame-start";
bContext *C = static_cast<bContext *>(data);
Scene *scene = CTX_data_scene(C);
if (scene) {
if (argc > 1) {
const char *err_msg = nullptr;
if (!parse_int_relative_clamp(argv[1],
nullptr,
scene->r.sfra,
scene->r.sfra - 1,
MINAFRAME,
MAXFRAME,
&scene->r.sfra,
&err_msg))
{
fprintf(stderr, "\nError: %s '%s %s'.\n", err_msg, arg_id, argv[1]);
}
else {
DEG_id_tag_update(&scene->id, ID_RECALC_SYNC_TO_EVAL);
}
return 1;
}
fprintf(stderr, "\nError: frame number must follow '%s'.\n", arg_id);
2020-11-07 18:24:56 +05:30
return 0;
}
fprintf(stderr, "\nError: no blend loaded. cannot use '%s'.\n", arg_id);
return 0;
}
static const char arg_handle_frame_end_set_doc[] =
"<frame>\n"
"\tSet end to frame <frame>, supports +/- for relative frames too.";
static int arg_handle_frame_end_set(int argc, const char **argv, void *data)
{
const char *arg_id = "-e / --frame-end";
bContext *C = static_cast<bContext *>(data);
Scene *scene = CTX_data_scene(C);
if (scene) {
if (argc > 1) {
const char *err_msg = nullptr;
if (!parse_int_relative_clamp(argv[1],
nullptr,
scene->r.efra,
scene->r.efra - 1,
MINAFRAME,
MAXFRAME,
&scene->r.efra,
&err_msg))
{
fprintf(stderr, "\nError: %s '%s %s'.\n", err_msg, arg_id, argv[1]);
}
else {
DEG_id_tag_update(&scene->id, ID_RECALC_SYNC_TO_EVAL);
}
return 1;
}
fprintf(stderr, "\nError: frame number must follow '%s'.\n", arg_id);
2020-11-07 18:24:56 +05:30
return 0;
}
fprintf(stderr, "\nError: no blend loaded. cannot use '%s'.\n", arg_id);
return 0;
}
static const char arg_handle_frame_skip_set_doc[] =
2016-04-06 09:28:22 +10:00
"<frames>\n"
2017-10-08 18:46:26 +11:00
"\tSet number of frames to step forward after each rendered frame.";
static int arg_handle_frame_skip_set(int argc, const char **argv, void *data)
{
const char *arg_id = "-j / --frame-jump";
bContext *C = static_cast<bContext *>(data);
Scene *scene = CTX_data_scene(C);
if (scene) {
if (argc > 1) {
const char *err_msg = nullptr;
if (!parse_int_clamp(argv[1], nullptr, 1, MAXFRAME, &scene->r.frame_step, &err_msg)) {
fprintf(stderr, "\nError: %s '%s %s'.\n", err_msg, arg_id, argv[1]);
}
else {
DEG_id_tag_update(&scene->id, ID_RECALC_SYNC_TO_EVAL);
}
return 1;
}
fprintf(stderr, "\nError: number of frames to step must follow '%s'.\n", arg_id);
2020-11-07 18:24:56 +05:30
return 0;
}
fprintf(stderr, "\nError: no blend loaded. cannot use '%s'.\n", arg_id);
return 0;
}
static const char arg_handle_python_file_run_doc[] =
"<filepath>\n"
2017-10-08 18:46:26 +11:00
"\tRun the given Python script file.";
static int arg_handle_python_file_run(int argc, const char **argv, void *data)
{
bContext *C = static_cast<bContext *>(data);
/* Workaround for scripts not getting a `bpy.context.scene`, causes internal errors elsewhere. */
if (argc > 1) {
# ifdef WITH_PYTHON
/* Make the path absolute because its needed for relative linked blends to be found. */
char filepath[FILE_MAX];
2023-05-09 12:50:37 +10:00
STRNCPY(filepath, argv[1]);
BLI_path_canonicalize_native(filepath, sizeof(filepath));
bool ok;
BPY_CTX_SETUP(ok = BPY_run_filepath(C, filepath, nullptr));
if (!ok && app_state.exit_code_on_error.python) {
fprintf(stderr, "\nError: script failed, file: '%s', exiting.\n", argv[1]);
WM_exit(C, app_state.exit_code_on_error.python);
}
# else
UNUSED_VARS(C);
fprintf(stderr, "This Blender was built without Python support\n");
# endif /* WITH_PYTHON */
return 1;
}
fprintf(stderr, "\nError: you must specify a filepath after '%s'.\n", argv[0]);
2020-11-07 18:24:56 +05:30
return 0;
}
static const char arg_handle_python_text_run_doc[] =
"<name>\n"
2017-10-08 18:46:26 +11:00
"\tRun the given Python script text block.";
static int arg_handle_python_text_run(int argc, const char **argv, void *data)
{
bContext *C = static_cast<bContext *>(data);
/* Workaround for scripts not getting a `bpy.context.scene`, causes internal errors elsewhere. */
if (argc > 1) {
# ifdef WITH_PYTHON
Main *bmain = CTX_data_main(C);
/* Make the path absolute because its needed for relative linked blends to be found. */
Text *text = (Text *)BKE_libblock_find_name(bmain, ID_TXT, argv[1]);
bool ok;
if (text) {
BPY_CTX_SETUP(ok = BPY_run_text(C, text, nullptr, false));
}
else {
fprintf(stderr, "\nError: text block not found %s.\n", argv[1]);
ok = false;
}
if (!ok && app_state.exit_code_on_error.python) {
fprintf(stderr, "\nError: script failed, text: '%s', exiting.\n", argv[1]);
WM_exit(C, app_state.exit_code_on_error.python);
}
# else
UNUSED_VARS(C);
fprintf(stderr, "This Blender was built without Python support\n");
# endif /* WITH_PYTHON */
return 1;
}
2020-11-07 18:24:56 +05:30
fprintf(stderr, "\nError: you must specify a text block after '%s'.\n", argv[0]);
return 0;
}
static const char arg_handle_python_expr_run_doc[] =
"<expression>\n"
2017-10-08 18:46:26 +11:00
"\tRun the given expression as a Python script.";
static int arg_handle_python_expr_run(int argc, const char **argv, void *data)
{
bContext *C = static_cast<bContext *>(data);
/* Workaround for scripts not getting a `bpy.context.scene`, causes internal errors elsewhere. */
if (argc > 1) {
# ifdef WITH_PYTHON
bool ok;
BPY_CTX_SETUP(ok = BPY_run_string_exec(C, nullptr, argv[1]));
if (!ok && app_state.exit_code_on_error.python) {
fprintf(stderr, "\nError: script failed, expr: '%s', exiting.\n", argv[1]);
WM_exit(C, app_state.exit_code_on_error.python);
}
# else
UNUSED_VARS(C);
fprintf(stderr, "This Blender was built without Python support\n");
# endif /* WITH_PYTHON */
return 1;
}
fprintf(stderr, "\nError: you must specify a Python expression after '%s'.\n", argv[0]);
2020-11-07 18:24:56 +05:30
return 0;
}
static const char arg_handle_python_console_run_doc[] =
"\n\t"
"Run Blender with an interactive console.";
static int arg_handle_python_console_run(int /*argc*/, const char ** /*argv*/, void *data)
{
bContext *C = static_cast<bContext *>(data);
# ifdef WITH_PYTHON
const char *imports[] = {"code", nullptr};
BPY_CTX_SETUP(BPY_run_string_eval(C, imports, "code.interact()"));
# else
UNUSED_VARS(C);
fprintf(stderr, "This Blender was built without python support\n");
# endif /* WITH_PYTHON */
return 0;
}
static const char arg_handle_python_exit_code_set_doc[] =
"<code>\n"
2016-04-06 09:28:22 +10:00
"\tSet the exit-code in [0..255] to exit if a Python exception is raised\n"
"\t(only for scripts executed from the command line), zero disables.";
static int arg_handle_python_exit_code_set(int argc, const char **argv, void * /*data*/)
{
const char *arg_id = "--python-exit-code";
if (argc > 1) {
const char *err_msg = nullptr;
const int min = 0, max = 255;
int exit_code;
if (!parse_int_strict_range(argv[1], nullptr, min, max, &exit_code, &err_msg)) {
fprintf(stderr,
"\nError: %s '%s %s', expected number in [%d..%d].\n",
err_msg,
arg_id,
argv[1],
min,
max);
return 1;
}
app_state.exit_code_on_error.python = uchar(exit_code);
return 1;
}
fprintf(stderr, "\nError: you must specify an exit code number '%s'.\n", arg_id);
2020-11-07 18:24:56 +05:30
return 0;
}
static const char arg_handle_python_use_system_env_set_doc[] =
"\n\t"
"Allow Python to use system environment variables such as 'PYTHONPATH' and the user "
"site-packages directory.";
static int arg_handle_python_use_system_env_set(int /*argc*/,
const char ** /*argv*/,
void * /*data*/)
{
# ifdef WITH_PYTHON
BPY_python_use_system_env();
# endif
return 0;
}
static const char arg_handle_addons_set_doc[] =
"<addon(s)>\n"
"\tComma separated list (no spaces) of add-ons to enable in addition to any default add-ons.";
static int arg_handle_addons_set(int argc, const char **argv, void *data)
{
/* Workaround for scripts not getting a `bpy.context.scene`, causes internal errors elsewhere. */
if (argc > 1) {
# ifdef WITH_PYTHON
const char script_str[] =
Extensions: detect external changes on startup & loading preferences Changes to an extensions manifest weren't accounted for. This was particularly a problem for "System" extensions which aren't intended to be managed inside Blender however the problem existed for any changes made outside of Blender. Now enabled extensions are checked on startup to ensure: - They are compatible with Blender. - The Python wheels are synchronized. Resolves #123645. Details: - Any extension incompatibilities prevent the add-on being enabled with a message printing the reason for it being disabled. - Incompatible add-ons are kept enabled in the preferences to avoid loosing their own preferences and allow for an upgrade to restore compatibility. - To avoid slowing down Blender's startup: - Checks are skipped when no extensions are enabled (as is the case for `--factory-startup` & running tests). - Compatibility data is cached so in common case, the cache is loaded and all enabled extensions `stat` their manifests to detect changes without having to parse them. - The cache is re-generated if any extensions change or the Blender/Python version changes. - Compatibility data is updated: - On startup (when needed). - On an explicit "Refresh Local" (mainly for developers who may edit the manifest). - When refreshing extensions after install/uninstall etc. since an incompatible extensions may become compatible after an update. - When reloading preferences. - Additional info is shown when the `--debug-python` is enabled, if there are ever issues with the extension compatibility cache generation not working as expected. - The behavior for Python wheels has changed so they are only setup when the extension is enabled. This was done to simplify startup checks and has the benefit that an installed but disabled extension never runs code - as the ability to install wheels means it could have been imported from other scripts. It also means users can disable an extension to avoid wheel version conflicts. This does add the complication however that enabling add-on which is an extension must first ensure it's wheels are setup. See `addon_utils.extensions_refresh(..)`. See code-comments for further details.
2024-07-01 15:08:14 +10:00
"from _bpy_internal.addons.cli import set_from_cli\n"
"set_from_cli('%s')";
const int slen = strlen(argv[1]) + (sizeof(script_str) - 2);
char *str = static_cast<char *>(malloc(slen));
bContext *C = static_cast<bContext *>(data);
BLI_snprintf(str, slen, script_str, argv[1]);
BLI_assert(strlen(str) + 1 == slen);
BPY_CTX_SETUP(BPY_run_string_exec(C, nullptr, str));
free(str);
# else
UNUSED_VARS(argv, data);
# endif /* WITH_PYTHON */
return 1;
}
fprintf(stderr, "\nError: you must specify a comma separated list after '--addons'.\n");
2020-11-07 18:24:56 +05:30
return 0;
}
static const char arg_handle_profile_gpu_set_doc[] =
"\n"
"\tEnable CPU & GPU performance profiling for GPU debug groups\n"
"\t(Outputs a profile.json file in the Trace Event Format to the current directory)";
static int arg_handle_profile_gpu_set(int /*argc*/, const char ** /*argv*/, void * /*data*/)
{
G.profile_gpu = true;
return 0;
}
/**
* Implementation for #arg_handle_load_last_file, also used by `--open-last`.
* \return true on success.
*/
static bool handle_load_file(bContext *C, const char *filepath_arg, const bool load_empty_file)
{
/* Make the path absolute because its needed for relative linked blends to be found. */
char filepath[FILE_MAX];
STRNCPY(filepath, filepath_arg);
BLI_path_canonicalize_native(filepath, sizeof(filepath));
/* Load the file. */
ReportList reports;
BKE_reports_init(&reports, RPT_PRINT);
/* When activating from the command line there isn't an exact equivalent to operator properties.
* Instead, enabling auto-execution via `--enable-autoexec` causes the auto-execution
* check to be skipped (if it's set), so it's fine to always enable the check here. */
const bool use_scripts_autoexec_check = true;
const bool success = WM_file_read(C, filepath, use_scripts_autoexec_check, &reports);
BKE_reports_free(&reports);
if (success) {
if (G.background) {
2021-02-05 16:23:34 +11:00
/* Ensure we use 'C->data.scene' for background render. */
CTX_wm_window_set(C, nullptr);
}
}
else {
/* Failed to load file, stop processing arguments if running in background mode. */
if (G.background) {
/* Set `is_break` if running in the background mode so
* blender will return non-zero exit code which then
* could be used in automated script to control how
* good or bad things are. */
G.is_break = true;
return false;
}
const char *error_msg_generic = "file could not be loaded";
const char *error_msg = nullptr;
if (load_empty_file == false) {
error_msg = error_msg_generic;
}
else if (!BKE_blendfile_extension_check(filepath)) {
/* Non-blend. Continue loading and give warning. */
G_MAIN->is_read_invalid = true;
return true;
}
else if (BLI_exists(filepath)) {
/* When a file is found but can't be loaded, handling it as a new file
* could cause it to be unintentionally overwritten (data loss).
* Further this is almost certainly not that a user would expect or want.
* If they do, they can delete the file beforehand. */
error_msg = error_msg_generic;
}
if (error_msg) {
fprintf(stderr, "Error: %s, exiting! %s\n", error_msg, filepath);
WM_exit(C, EXIT_FAILURE);
/* Unreachable, return for clarity. */
return false;
}
/* Behave as if a file was loaded, calling "Save" will write to the `filepath` from the CLI.
*
* WARNING: The path referenced may be incorrect, no attempt is made to validate the path
* here or check that writing to it will work. If the users enters the path of a directory
* that doesn't exist (for example) saving will fail.
* Attempting to create the file at this point is possible but likely to cause more
* trouble than it's worth (what with network drives), removable devices ... etc. */
STRNCPY(G_MAIN->filepath, filepath);
printf("... opened default scene instead; saving will write to: %s\n", filepath);
}
return true;
}
int main_args_handle_load_file(int /*argc*/, const char **argv, void *data)
{
bContext *C = static_cast<bContext *>(data);
const char *filepath = argv[0];
/* NOTE: we could skip these, but so far we always tried to load these files. */
if (argv[0][0] == '-') {
fprintf(stderr, "unknown argument, loading as file: %s\n", filepath);
}
if (!handle_load_file(C, filepath, true)) {
return -1;
}
return 0;
}
static const char arg_handle_load_last_file_doc[] =
"\n\t"
"Open the most recently opened blend file, instead of the default startup file.";
static int arg_handle_load_last_file(int /*argc*/, const char ** /*argv*/, void *data)
{
if (BLI_listbase_is_empty(&G.recent_files)) {
fprintf(stderr, "Warning: no recent files known, opening default startup file instead.\n");
return -1;
}
bContext *C = static_cast<bContext *>(data);
const RecentFile *recent_file = static_cast<const RecentFile *>(G.recent_files.first);
if (!handle_load_file(C, recent_file->filepath, false)) {
return -1;
}
return 0;
}
void main_args_setup(bContext *C, bArgs *ba, bool all)
{
/** Expand the doc-string from the function. */
# define CB(a) a##_doc, a
/** A version of `CB` that expands an additional suffix. */
# define CB_EX(a, b) a##_doc_##b, a
/** A version of `CB` that uses `all`, needed when the doc-string depends on build options. */
# define CB_ALL(a) (all ? a##_doc_all : a##_doc), a
BuildDefs defs;
build_defs_init(&defs, all);
/* end argument processing after -- */
BLI_args_pass_set(ba, -1);
BLI_args_add(ba, "--", nullptr, CB(arg_handle_arguments_end), nullptr);
/* Pass: Environment Setup
*
* It's important these run before any initialization is done, since they set up
* the environment used to access data-files, which are be used when initializing
* sub-systems such as color management. */
BLI_args_pass_set(ba, ARG_PASS_ENVIRONMENT);
BLI_args_add(
ba, nullptr, "--python-use-system-env", CB(arg_handle_python_use_system_env_set), nullptr);
/* Note that we could add used environment variables too. */
BLI_args_add(
ba, nullptr, "--env-system-datafiles", CB_EX(arg_handle_env_system_set, datafiles), nullptr);
BLI_args_add(
ba, nullptr, "--env-system-scripts", CB_EX(arg_handle_env_system_set, scripts), nullptr);
BLI_args_add(
ba, nullptr, "--env-system-python", CB_EX(arg_handle_env_system_set, python), nullptr);
BLI_args_add(ba,
nullptr,
"--env-system-extensions",
CB_EX(arg_handle_env_system_set, extensions),
nullptr);
BLI_args_add(ba, "-t", "--threads", CB(arg_handle_threads_set), nullptr);
/* Include in the environment pass so it's possible display errors initializing subsystems,
* especially `bpy.appdir` since it's useful to show errors finding paths on startup. */
BLI_args_add(ba, nullptr, "--log", CB(arg_handle_log_set), ba);
BLI_args_add(ba, nullptr, "--log-level", CB(arg_handle_log_level_set), ba);
BLI_args_add(ba, nullptr, "--log-show-source", CB(arg_handle_log_show_source_set), ba);
BLI_args_add(ba, nullptr, "--log-show-backtrace", CB(arg_handle_log_show_backtrace_set), ba);
BLI_args_add(ba, nullptr, "--log-show-memory", CB(arg_handle_log_show_memory_set), ba);
BLI_args_add(ba, nullptr, "--log-file", CB(arg_handle_log_file_set), ba);
/* GPU backend selection should be part of #ARG_PASS_ENVIRONMENT for correct GPU context
* selection for animation player. */
BLI_args_add(ba, nullptr, "--gpu-backend", CB_ALL(arg_handle_gpu_backend_set), nullptr);
BLI_args_add(ba, nullptr, "--gpu-vsync", CB(arg_handle_gpu_vsync_set), nullptr);
if (defs.with_opengl_backend) {
BLI_args_add(ba,
nullptr,
"--gpu-compilation-subprocesses",
CB(arg_handle_gpu_compilation_subprocesses_set),
nullptr);
}
BLI_args_add(ba, nullptr, "--profile-gpu", CB(arg_handle_profile_gpu_set), nullptr);
/* Pass: Background Mode & Settings
*
* Also and commands that exit after usage. */
BLI_args_pass_set(ba, ARG_PASS_SETTINGS);
BLI_args_add(ba, "-h", "--help", CB(arg_handle_print_help), ba);
/* MS-Windows only. */
BLI_args_add(ba, "/?", nullptr, CB_EX(arg_handle_print_help, win32), ba);
BLI_args_add(ba, "-v", "--version", CB(arg_handle_print_version), nullptr);
BLI_args_add(ba, "-y", "--enable-autoexec", CB_EX(arg_handle_python_set, enable), (void *)true);
BLI_args_add(
ba, "-Y", "--disable-autoexec", CB_EX(arg_handle_python_set, disable), (void *)false);
BLI_args_add(
ba, nullptr, "--offline-mode", CB_EX(arg_handle_internet_allow_set, offline), (void *)false);
BLI_args_add(
ba, nullptr, "--online-mode", CB_EX(arg_handle_internet_allow_set, online), (void *)true);
BLI_args_add(
ba, nullptr, "--disable-crash-handler", CB(arg_handle_crash_handler_disable), nullptr);
BLI_args_add(
ba, nullptr, "--disable-abort-handler", CB(arg_handle_abort_handler_disable), nullptr);
BLI_args_add(ba, "-q", "--quiet", CB(arg_handle_quiet_set), nullptr);
BLI_args_add(ba, "-b", "--background", CB(arg_handle_background_mode_set), nullptr);
/* Command implies background mode (defers execution). */
BLI_args_add(ba, "-c", "--command", CB(arg_handle_command_set), C);
BLI_args_add(ba, nullptr, "--qos", CB(arg_handle_qos_set), nullptr);
BLI_args_add(ba,
nullptr,
"--disable-depsgraph-on-file-load",
CB(arg_handle_disable_depsgraph_on_file_load),
nullptr);
BLI_args_add(ba,
nullptr,
"--disable-liboverride-auto-resync",
CB(arg_handle_disable_liboverride_auto_resync),
nullptr);
BLI_args_add(ba, "-a", nullptr, CB(arg_handle_playback_mode), nullptr);
BLI_args_add(ba, "-d", "--debug", CB(arg_handle_debug_mode_set), ba);
if (defs.with_ffmpeg) {
BLI_args_add(ba, nullptr, "--debug-ffmpeg", CB(arg_handle_debug_mode_ffmpeg), nullptr);
}
if (defs.with_freestyle) {
BLI_args_add(ba,
nullptr,
"--debug-freestyle",
CB_EX(arg_handle_debug_mode_generic_set, freestyle),
(void *)G_DEBUG_FREESTYLE);
}
BLI_args_add(ba,
nullptr,
"--debug-python",
CB_EX(arg_handle_debug_mode_generic_set, python),
(void *)G_DEBUG_PYTHON);
BLI_args_add(ba,
nullptr,
"--debug-events",
CB_EX(arg_handle_debug_mode_generic_set, events),
(void *)G_DEBUG_EVENTS);
BLI_args_add(ba,
nullptr,
"--debug-handlers",
CB_EX(arg_handle_debug_mode_generic_set, handlers),
(void *)G_DEBUG_HANDLERS);
BLI_args_add(
ba, nullptr, "--debug-wm", CB_EX(arg_handle_debug_mode_generic_set, wm), (void *)G_DEBUG_WM);
if (defs.with_xr_openxr) {
BLI_args_add(ba,
nullptr,
"--debug-xr",
CB_EX(arg_handle_debug_mode_generic_set, xr),
(void *)G_DEBUG_XR);
BLI_args_add(ba,
nullptr,
"--debug-xr-time",
CB_EX(arg_handle_debug_mode_generic_set, xr_time),
(void *)G_DEBUG_XR_TIME);
}
BLI_args_add(ba,
nullptr,
"--debug-ghost",
CB_EX(arg_handle_debug_mode_generic_set, ghost),
(void *)G_DEBUG_GHOST);
BLI_args_add(ba,
nullptr,
"--debug-wintab",
CB_EX(arg_handle_debug_mode_generic_set, wintab),
(void *)G_DEBUG_WINTAB);
BLI_args_add(ba, nullptr, "--debug-all", CB(arg_handle_debug_mode_all), nullptr);
BLI_args_add(ba, nullptr, "--debug-io", CB(arg_handle_debug_mode_io), nullptr);
BLI_args_add(ba, nullptr, "--debug-fpe", CB(arg_handle_debug_fpe_set), nullptr);
if (defs.with_libmv) {
BLI_args_add(ba, nullptr, "--debug-libmv", CB(arg_handle_debug_mode_libmv), nullptr);
}
if (defs.with_cycles) {
BLI_args_add(ba, nullptr, "--debug-cycles", CB(arg_handle_debug_mode_cycles), nullptr);
}
BLI_args_add(ba, nullptr, "--debug-memory", CB(arg_handle_debug_mode_memory_set), nullptr);
BLI_args_add(ba, nullptr, "--debug-value", CB(arg_handle_debug_value_set), nullptr);
BLI_args_add(ba,
nullptr,
"--debug-jobs",
CB_EX(arg_handle_debug_mode_generic_set, jobs),
(void *)G_DEBUG_JOBS);
BLI_args_add(ba, nullptr, "--debug-gpu", CB(arg_handle_debug_gpu_set), nullptr);
BLI_args_add(ba,
nullptr,
"--debug-gpu-compile-shaders",
CB(arg_handle_debug_gpu_compile_shaders_set),
nullptr);
if (defs.with_renderdoc) {
BLI_args_add(ba,
nullptr,
"--debug-gpu-scope-capture",
CB(arg_handle_debug_gpu_scope_capture_set),
nullptr);
BLI_args_add(
ba, nullptr, "--debug-gpu-renderdoc", CB(arg_handle_debug_gpu_renderdoc_set), nullptr);
}
GPU: Add flag for shader debug info generation This PR proposes to add a new flag `--shader-debug-info` that enables the generation of shader debug information. I created this PR as WIP due to the following reasons: - Currently it only works for the Vulkan backend. I do not know if it makes sense for other backends. For example, OpenGL directly receives the GLSL code, so there no need for this might exist. - So far `--debug-gpu-renderdoc` already turns on the following changes for GLSL shader compilation with shaderc: ``` options.SetOptimizationLevel(shaderc_optimization_level_zero); options.SetGenerateDebugInfo(); ``` - While combining optimization level zero with debug info is a sensible choice for frame debuggers like RenderDoc, my use case for creating this PR is shader profiling. In this case, one does not want compiler optimizations to be turned off. At the current point in time, the only information my profiler uses (which is unfortunately not public at this point in time) is the name of the shader. When turning on debug information, shaderc/glslang store this information in the generated SPIR-V data. Otherwise, it would be impossible for the profiler to tell the user what the name of the shader it is that is profiled. - An alternative solution would be to rename the entry point `main` of a shader to the name of the shader. But this might be an even uglier hack, as it requires editing the source code (and the name of the shader then needs to be a valid GLSL function name). - We should first clarify if there is interest in the Blender side in upstreaming an option like this. While I could just keep this in my local fork of Blender, there is merit in having the possibility to profile arbitrary Blender builds. Pull Request: https://projects.blender.org/blender/blender/pulls/142986
2025-08-13 13:41:41 +02:00
BLI_args_add(ba,
nullptr,
"--debug-gpu-shader-debug-info",
CB(arg_handle_debug_gpu_shader_debug_info_set),
nullptr);
BLI_args_add(ba,
nullptr,
"--debug-depsgraph",
CB_EX(arg_handle_debug_mode_generic_set, depsgraph),
(void *)G_DEBUG_DEPSGRAPH);
BLI_args_add(ba,
nullptr,
"--debug-depsgraph-build",
CB_EX(arg_handle_debug_mode_generic_set, depsgraph_build),
(void *)G_DEBUG_DEPSGRAPH_BUILD);
BLI_args_add(ba,
nullptr,
"--debug-depsgraph-eval",
CB_EX(arg_handle_debug_mode_generic_set, depsgraph_eval),
(void *)G_DEBUG_DEPSGRAPH_EVAL);
BLI_args_add(ba,
nullptr,
"--debug-depsgraph-tag",
CB_EX(arg_handle_debug_mode_generic_set, depsgraph_tag),
(void *)G_DEBUG_DEPSGRAPH_TAG);
BLI_args_add(ba,
nullptr,
"--debug-depsgraph-time",
CB_EX(arg_handle_debug_mode_generic_set, depsgraph_time),
(void *)G_DEBUG_DEPSGRAPH_TIME);
BLI_args_add(ba,
nullptr,
"--debug-depsgraph-no-threads",
CB_EX(arg_handle_debug_mode_generic_set, depsgraph_no_threads),
(void *)G_DEBUG_DEPSGRAPH_NO_THREADS);
BLI_args_add(ba,
nullptr,
"--debug-depsgraph-pretty",
CB_EX(arg_handle_debug_mode_generic_set, depsgraph_pretty),
(void *)G_DEBUG_DEPSGRAPH_PRETTY);
BLI_args_add(ba,
nullptr,
"--debug-depsgraph-uid",
CB_EX(arg_handle_debug_mode_generic_set, depsgraph_uid),
(void *)G_DEBUG_DEPSGRAPH_UID);
BLI_args_add(ba,
nullptr,
"--debug-gpu-force-workarounds",
CB_EX(arg_handle_debug_mode_generic_set, gpu_force_workarounds),
(void *)G_DEBUG_GPU_FORCE_WORKAROUNDS);
if (defs.with_vulkan_backend) {
BLI_args_add(ba,
nullptr,
"--debug-gpu-vulkan-local-read",
CB_EX(arg_handle_debug_mode_generic_set, gpu_force_vulkan_local_read),
(void *)G_DEBUG_GPU_FORCE_VULKAN_LOCAL_READ);
}
BLI_args_add(ba, nullptr, "--debug-exit-on-error", CB(arg_handle_debug_exit_on_error), nullptr);
BLI_args_add(ba, nullptr, "--verbose", CB(arg_handle_verbosity_set), nullptr);
BLI_args_add(ba, nullptr, "--app-template", CB(arg_handle_app_template), nullptr);
BLI_args_add(ba, nullptr, "--factory-startup", CB(arg_handle_factory_startup_set), nullptr);
BLI_args_add(
ba, nullptr, "--enable-event-simulate", CB(arg_handle_enable_event_simulate), nullptr);
/* Pass: Custom Window Stuff. */
BLI_args_pass_set(ba, ARG_PASS_SETTINGS_GUI);
BLI_args_add(ba, "-p", "--window-geometry", CB(arg_handle_window_geometry), nullptr);
BLI_args_add(ba, "-w", "--window-border", CB(arg_handle_with_borders), nullptr);
BLI_args_add(ba, "-W", "--window-fullscreen", CB(arg_handle_without_borders), nullptr);
BLI_args_add(ba, "-M", "--window-maximized", CB(arg_handle_window_maximized), nullptr);
BLI_args_add(ba, nullptr, "--no-window-focus", CB(arg_handle_no_window_focus), nullptr);
BLI_args_add(ba, "-con", "--start-console", CB(arg_handle_start_with_console), nullptr);
BLI_args_add(ba, "-r", "--register", CB(arg_handle_register_extension), nullptr);
BLI_args_add(ba, nullptr, "--register-allusers", CB(arg_handle_register_extension_all), nullptr);
BLI_args_add(ba, nullptr, "--unregister", CB(arg_handle_unregister_extension), nullptr);
BLI_args_add(
ba, nullptr, "--unregister-allusers", CB(arg_handle_unregister_extension_all), nullptr);
BLI_args_add(ba, nullptr, "--no-native-pixels", CB(arg_handle_native_pixels_set), ba);
/* Pass: Disabling Things & Forcing Settings. */
BLI_args_pass_set(ba, ARG_PASS_SETTINGS_FORCE);
BLI_args_add_case(ba, "-noaudio", 1, nullptr, 0, CB(arg_handle_audio_disable), nullptr);
BLI_args_add_case(ba, "-setaudio", 1, nullptr, 0, CB(arg_handle_audio_set), nullptr);
/* Pass: Processing Arguments. */
/* NOTE: Use #WM_exit for these callbacks, not `exit()`
* so temporary files are properly cleaned up. */
BLI_args_pass_set(ba, ARG_PASS_FINAL);
BLI_args_add(ba, "-f", "--render-frame", CB(arg_handle_render_frame), C);
BLI_args_add(ba, "-a", "--render-anim", CB(arg_handle_render_animation), C);
BLI_args_add(ba, "-S", "--scene", CB(arg_handle_scene_set), C);
BLI_args_add(ba, "-s", "--frame-start", CB(arg_handle_frame_start_set), C);
BLI_args_add(ba, "-e", "--frame-end", CB(arg_handle_frame_end_set), C);
BLI_args_add(ba, "-j", "--frame-jump", CB(arg_handle_frame_skip_set), C);
BLI_args_add(ba, "-P", "--python", CB(arg_handle_python_file_run), C);
BLI_args_add(ba, nullptr, "--python-text", CB(arg_handle_python_text_run), C);
BLI_args_add(ba, nullptr, "--python-expr", CB(arg_handle_python_expr_run), C);
BLI_args_add(ba, nullptr, "--python-console", CB(arg_handle_python_console_run), C);
BLI_args_add(ba, nullptr, "--python-exit-code", CB(arg_handle_python_exit_code_set), nullptr);
BLI_args_add(ba, nullptr, "--addons", CB(arg_handle_addons_set), C);
BLI_args_add(ba, "-o", "--render-output", CB(arg_handle_output_set), C);
BLI_args_add(ba, "-E", "--engine", CB(arg_handle_engine_set), C);
BLI_args_add(ba, "-F", "--render-format", CB(arg_handle_image_type_set), C);
BLI_args_add(ba, "-x", "--use-extension", CB(arg_handle_extension_set), C);
BLI_args_add(ba, nullptr, "--open-last", CB(arg_handle_load_last_file), C);
# undef CB
# undef CB_EX
# undef CB_ALL
# ifdef WITH_PYTHON
/* Use for Python to extract help text (Python can't call directly - bad-level call). */
BPY_python_app_help_text_fn = main_args_help_as_string;
2023-10-05 12:57:29 +11:00
# else
/* Quiet unused function warning. */
(void)main_args_help_as_string;
# endif
}
/** \} */
#endif /* !WITH_PYTHON_MODULE */