Blender V4.5
Classes | Macros
creator_args.cc File Reference
#include <cerrno>
#include <cstdlib>
#include <cstring>
#include "MEM_guardedalloc.h"
#include "CLG_log.h"
#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"
#include "BLI_system.h"
#include "BLI_threads.h"
#include "BLI_utildefines.h"
#include "BLI_mempool.h"
#include "BKE_appdir.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"
#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"
#include "RE_engine.h"
#include "RE_pipeline.h"
#include "WM_api.hh"
#include "DEG_depsgraph.hh"
#include "WM_types.hh"
#include "creator_intern.h"

Go to the source code of this file.

Classes

struct  BuildDefs
struct  BA_ArgCallback_Deferred

Macros

#define printf   __ERROR__
#define PRINT(...)
#define CB(a)
#define CB_EX(a, b)
#define CB_ALL(a)

Functions

Build Defines
static void build_defs_init (BuildDefs *build_defs, bool force_all)
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)
static const char * parse_int_range_sep_search (const char *str, const char *str_end_test)
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)
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)
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)
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)
static bool parse_int (const char *str, const char *str_end_test, int *r_value, const char **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)
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]
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.

static bool main_arg_deferred_is_set ()
static void main_arg_deferred_setup (BA_ArgCallback func, int argc, const char **argv, void *data)
void main_arg_deferred_free ()
static void main_arg_deferred_exit_code_set (int exit_code)
int main_arg_deferred_handle ()

Handle Argument Callbacks

Note
Doc strings here are used in differently:
#define PY_ENABLE_AUTO   ", (default, non-standard compilation option)"
#define PY_DISABLE_AUTO   ""
static const char arg_handle_print_version_doc []
static const char arg_handle_print_help_doc []
static const char arg_handle_print_help_doc_win32 []
static const char arg_handle_arguments_end_doc []
static const char arg_handle_python_set_doc_enable []
static const char arg_handle_python_set_doc_disable []
static const char arg_handle_internet_allow_set_doc_online []
static const char arg_handle_internet_allow_set_doc_offline []
static const char arg_handle_crash_handler_disable_doc []
static const char arg_handle_abort_handler_disable_doc []
static const char arg_handle_debug_exit_on_error_doc []
static const char arg_handle_quiet_set_doc []
static const char arg_handle_background_mode_set_doc []
static const char arg_handle_command_set_doc []
static const char arg_handle_disable_depsgraph_on_file_load_doc []
static const char arg_handle_disable_liboverride_auto_resync_doc []
static const char arg_handle_log_level_set_doc []
static const char arg_handle_log_show_basename_set_doc []
static const char arg_handle_log_show_backtrace_set_doc []
static const char arg_handle_log_show_timestamp_set_doc []
static const char arg_handle_log_file_set_doc []
static const char arg_handle_log_set_doc []
static const char arg_handle_debug_mode_set_doc []
static const char arg_handle_debug_mode_generic_set_doc_ffmpeg []
static const char arg_handle_debug_mode_generic_set_doc_freestyle []
static const char arg_handle_debug_mode_generic_set_doc_python []
static const char arg_handle_debug_mode_generic_set_doc_events []
static const char arg_handle_debug_mode_generic_set_doc_handlers []
static const char arg_handle_debug_mode_generic_set_doc_wm []
static const char arg_handle_debug_mode_generic_set_doc_ghost []
static const char arg_handle_debug_mode_generic_set_doc_wintab []
static const char arg_handle_debug_mode_generic_set_doc_xr []
static const char arg_handle_debug_mode_generic_set_doc_xr_time []
static const char arg_handle_debug_mode_generic_set_doc_jobs []
static const char arg_handle_debug_mode_generic_set_doc_depsgraph []
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_build []
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_tag []
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_time []
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_eval []
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_no_threads []
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_pretty []
static const char arg_handle_debug_mode_generic_set_doc_depsgraph_uid []
static const char arg_handle_debug_mode_generic_set_doc_gpu_force_workarounds []
static const char arg_handle_debug_mode_io_doc []
static const char arg_handle_debug_mode_all_doc []
static const char arg_handle_debug_mode_libmv_doc []
static const char arg_handle_debug_mode_cycles_doc []
static const char arg_handle_debug_mode_memory_set_doc []
static const char arg_handle_debug_value_set_doc []
static const char arg_handle_debug_gpu_set_doc []
static const char arg_handle_debug_gpu_compile_shaders_set_doc []
static const char arg_handle_debug_gpu_scope_capture_set_doc []
static const char arg_handle_debug_gpu_renderdoc_set_doc []
static const char arg_handle_gpu_backend_set_doc_all []
static const char arg_handle_gpu_backend_set_doc []
static const char arg_handle_debug_fpe_set_doc []
static const char arg_handle_app_template_doc []
static const char arg_handle_factory_startup_set_doc []
static const char arg_handle_enable_event_simulate_doc []
static const char arg_handle_env_system_set_doc_datafiles []
static const char arg_handle_env_system_set_doc_scripts []
static const char arg_handle_env_system_set_doc_python []
static const char arg_handle_env_system_set_doc_extensions []
static const char arg_handle_playback_mode_doc []
static const char arg_handle_window_geometry_doc []
static const char arg_handle_native_pixels_set_doc []
static const char arg_handle_with_borders_doc []
static const char arg_handle_without_borders_doc []
static const char arg_handle_window_maximized_doc []
static const char arg_handle_no_window_focus_doc []
static const char arg_handle_start_with_console_doc []
static const char arg_handle_register_extension_doc []
static const char arg_handle_register_extension_all_doc []
static const char arg_handle_unregister_extension_doc []
static const char arg_handle_unregister_extension_all_doc []
static const char arg_handle_audio_disable_doc []
static const char arg_handle_audio_set_doc []
static const char arg_handle_output_set_doc []
static const char arg_handle_engine_set_doc []
static const char arg_handle_image_type_set_doc []
static const char arg_handle_threads_set_doc []
static const char arg_handle_verbosity_set_doc []
static const char arg_handle_extension_set_doc []
static const char arg_handle_render_frame_doc []
static const char arg_handle_render_animation_doc []
static const char arg_handle_scene_set_doc []
static const char arg_handle_frame_start_set_doc []
static const char arg_handle_frame_end_set_doc []
static const char arg_handle_frame_skip_set_doc []
static const char arg_handle_python_file_run_doc []
static const char arg_handle_python_text_run_doc []
static const char arg_handle_python_expr_run_doc []
static const char arg_handle_python_console_run_doc []
static const char arg_handle_python_exit_code_set_doc []
static const char arg_handle_python_use_system_env_set_doc []
static const char arg_handle_addons_set_doc []
static const char arg_handle_profile_gpu_set_doc []
static const char arg_handle_load_last_file_doc []
static void print_version_full ()
static void print_version_short ()
static int arg_handle_print_version (int, const char **, void *)
static void print_help (bArgs *ba, bool all)
static void help_print_ds_fn (void *ds_v, const char *format, va_list args)
static char * main_args_help_as_string (bool all)
static int arg_handle_print_help (int, const char **, void *data)
static int arg_handle_arguments_end (int, const char **, void *)
static int arg_handle_python_set (int, const char **, void *data)
static int arg_handle_internet_allow_set (int, const char **, void *data)
static int arg_handle_crash_handler_disable (int, const char **, void *)
static int arg_handle_abort_handler_disable (int, const char **, void *)
static void clog_abort_on_error_callback (void *fp)
static int arg_handle_debug_exit_on_error (int, const char **, void *)
static int arg_handle_quiet_set (int, const char **, void *)
static void background_mode_set ()
static int arg_handle_background_mode_set (int, const char **, void *)
static int arg_handle_command_set (int argc, const char **argv, void *data)
static int arg_handle_disable_depsgraph_on_file_load (int, const char **, void *)
static int arg_handle_disable_liboverride_auto_resync (int, const char **, void *)
static int arg_handle_log_level_set (int argc, const char **argv, void *)
static int arg_handle_log_show_basename_set (int, const char **, void *)
static int arg_handle_log_show_backtrace_set (int, const char **, void *)
static int arg_handle_log_show_timestamp_set (int, const char **, void *)
static int arg_handle_log_file_set (int argc, const char **argv, void *)
static int arg_handle_log_set (int argc, const char **argv, void *)
static int arg_handle_debug_mode_set (int, const char **, void *data)
static int arg_handle_debug_mode_generic_set (int, const char **, void *data)
static int arg_handle_debug_mode_io (int, const char **, void *)
static int arg_handle_debug_mode_all (int, const char **, void *)
static int arg_handle_debug_mode_libmv (int, const char **, void *)
static int arg_handle_debug_mode_cycles (int, const char **, void *)
static int arg_handle_debug_mode_memory_set (int, const char **, void *)
static int arg_handle_debug_value_set (int argc, const char **argv, void *)
static int arg_handle_debug_gpu_set (int, const char **, void *)
static int arg_handle_debug_gpu_compile_shaders_set (int, const char **, void *)
static int arg_handle_debug_gpu_scope_capture_set (int argc, const char **argv, void *)
static int arg_handle_debug_gpu_renderdoc_set (int, const char **, void *)
static int arg_handle_gpu_backend_set (int argc, const char **argv, void *)
static int arg_handle_debug_fpe_set (int, const char **, void *)
static int arg_handle_app_template (int argc, const char **argv, void *)
static int arg_handle_factory_startup_set (int, const char **, void *)
static int arg_handle_enable_event_simulate (int, const char **, void *)
static int arg_handle_env_system_set (int argc, const char **argv, void *)
static int arg_handle_playback_mode (int argc, const char **argv, void *)
static int arg_handle_window_geometry (int argc, const char **argv, void *)
static int arg_handle_native_pixels_set (int, const char **, void *)
static int arg_handle_with_borders (int, const char **, void *)
static int arg_handle_without_borders (int, const char **, void *)
static int arg_handle_window_maximized (int, const char **, void *)
static int arg_handle_no_window_focus (int, const char **, void *)
static int arg_handle_start_with_console (int, const char **, void *)
static bool arg_handle_extension_registration (const bool do_register, const bool all_users)
static int arg_handle_register_extension (int argc, const char **argv, void *data)
static int arg_handle_register_extension_all (int argc, const char **argv, void *data)
static int arg_handle_unregister_extension (int argc, const char **argv, void *data)
static int arg_handle_unregister_extension_all (int argc, const char **argv, void *data)
static int arg_handle_audio_disable (int, const char **, void *)
static int arg_handle_audio_set (int argc, const char **argv, void *)
static int arg_handle_output_set (int argc, const char **argv, void *data)
static int arg_handle_engine_set (int argc, const char **argv, void *data)
static int arg_handle_image_type_set (int argc, const char **argv, void *data)
static int arg_handle_threads_set (int argc, const char **argv, void *)
static int arg_handle_verbosity_set (int argc, const char **argv, void *)
static int arg_handle_extension_set (int argc, const char **argv, void *data)
static int arg_handle_render_frame (int argc, const char **argv, void *data)
static int arg_handle_render_animation (int, const char **, void *data)
static int arg_handle_scene_set (int argc, const char **argv, void *data)
static int arg_handle_frame_start_set (int argc, const char **argv, void *data)
static int arg_handle_frame_end_set (int argc, const char **argv, void *data)
static int arg_handle_frame_skip_set (int argc, const char **argv, void *data)
static int arg_handle_python_file_run (int argc, const char **argv, void *data)
static int arg_handle_python_text_run (int argc, const char **argv, void *data)
static int arg_handle_python_expr_run (int argc, const char **argv, void *data)
static int arg_handle_python_console_run (int, const char **, void *data)
static int arg_handle_python_exit_code_set (int argc, const char **argv, void *)
static int arg_handle_python_use_system_env_set (int, const char **, void *)
static int arg_handle_addons_set (int argc, const char **argv, void *data)
static int arg_handle_profile_gpu_set (int, const char **, void *)
static bool handle_load_file (bContext *C, const char *filepath_arg, const bool load_empty_file)
int main_args_handle_load_file (int, const char **argv, void *data)
static int arg_handle_load_last_file (int, const char **, void *data)
void main_args_setup (bContext *C, bArgs *ba, bool all)

Macro Definition Documentation

◆ CB

#define CB ( a)
Value:
a##_doc, a

Referenced by blender::animrig::ANIM_armature_foreach_bone(), blender::animrig::ANIM_armature_foreach_bone(), and main_args_setup().

◆ CB_ALL

#define CB_ALL ( a)
Value:
(all ? a##_doc_all : a##_doc), a
all
bool all(VecOp< bool, D >) RET

Referenced by main_args_setup().

◆ CB_EX

#define CB_EX ( a,
b )
Value:
a##_doc_##b, a
b
b
Definition compositor_morphological_distance_info.hh:24

Referenced by main_args_setup().

◆ PRINT

#define PRINT ( ...)
Value:
BLI_args_printf(ba, __VA_ARGS__)
BLI_args_printf
void BLI_args_printf(struct bArgs *ba, const char *format,...)
Definition BLI_args.cc:152

Referenced by print_help().

◆ printf

#define printf   __ERROR__

Referenced by arg_handle_debug_mode_set(), arg_handle_engine_set(), handle_load_file(), print_version_full(), and print_version_short().

◆ PY_DISABLE_AUTO

#define PY_DISABLE_AUTO   ""

Definition at line 949 of file creator_args.cc.

◆ PY_ENABLE_AUTO

#define PY_ENABLE_AUTO   ", (default, non-standard compilation option)"

Definition at line 948 of file creator_args.cc.

Function Documentation

◆ arg_handle_abort_handler_disable()

int arg_handle_abort_handler_disable ( int ,
const char ** ,
void *  )
static

Definition at line 1007 of file creator_args.cc.

References app_state.

Referenced by main_args_setup().

◆ arg_handle_addons_set()

int arg_handle_addons_set ( int argc,
const char ** argv,
void * data )
static

Definition at line 2493 of file creator_args.cc.

References BLI_assert, BLI_snprintf(), BPY_run_string_exec(), C, data, free(), str, and UNUSED_VARS.

Referenced by main_args_setup().

◆ arg_handle_app_template()

int arg_handle_app_template ( int argc,
const char ** argv,
void *  )
static

Definition at line 1612 of file creator_args.cc.

References app_template, STREQ, and WM_init_state_app_template_set().

Referenced by main_args_setup().

◆ arg_handle_arguments_end()

int arg_handle_arguments_end ( int ,
const char ** ,
void *  )
static

Definition at line 938 of file creator_args.cc.

Referenced by main_args_setup().

◆ arg_handle_audio_disable()

int arg_handle_audio_disable ( int ,
const char ** ,
void *  )
static

Definition at line 1893 of file creator_args.cc.

References BKE_sound_force_device().

Referenced by main_args_setup().

◆ arg_handle_audio_set()

int arg_handle_audio_set ( int argc,
const char ** argv,
void *  )
static

Definition at line 1903 of file creator_args.cc.

References BKE_sound_force_device(), and STREQ.

Referenced by main_args_setup().

◆ arg_handle_background_mode_set()

int arg_handle_background_mode_set ( int ,
const char ** ,
void *  )
static

Definition at line 1068 of file creator_args.cc.

References background_mode_set(), G, and print_version_short().

Referenced by main_args_setup().

◆ arg_handle_command_set()

int arg_handle_command_set ( int argc,
const char ** argv,
void * data )
static

Definition at line 1084 of file creator_args.cc.

References arg_handle_command_set(), background_mode_set(), BKE_blender_cli_command_exec(), BKE_blender_cli_command_print_help(), BLI_assert_unreachable, C, data, G, main_arg_deferred_exit_code_set(), main_arg_deferred_is_set(), main_arg_deferred_setup(), and STREQ.

Referenced by arg_handle_command_set(), and main_args_setup().

◆ arg_handle_crash_handler_disable()

int arg_handle_crash_handler_disable ( int ,
const char ** ,
void *  )
static

Definition at line 998 of file creator_args.cc.

References app_state.

Referenced by main_args_setup().

◆ arg_handle_debug_exit_on_error()

int arg_handle_debug_exit_on_error ( int ,
const char ** ,
void *  )
static

Definition at line 1023 of file creator_args.cc.

References CLG_error_fn_set(), clog_abort_on_error_callback(), and MEM_enable_fail_on_memleak().

Referenced by main_args_setup().

◆ arg_handle_debug_fpe_set()

int arg_handle_debug_fpe_set ( int ,
const char ** ,
void *  )
static

Definition at line 1603 of file creator_args.cc.

References main_signal_setup_fpe().

Referenced by main_args_setup().

◆ arg_handle_debug_gpu_compile_shaders_set()

int arg_handle_debug_gpu_compile_shaders_set ( int ,
const char ** ,
void *  )
static

Definition at line 1463 of file creator_args.cc.

References G, and G_DEBUG_GPU_COMPILE_SHADERS.

Referenced by main_args_setup().

◆ arg_handle_debug_gpu_renderdoc_set()

int arg_handle_debug_gpu_renderdoc_set ( int ,
const char ** ,
void *  )
static

Definition at line 1487 of file creator_args.cc.

References G, G_DEBUG_GPU, and G_DEBUG_GPU_RENDERDOC.

Referenced by main_args_setup().

◆ arg_handle_debug_gpu_scope_capture_set()

int arg_handle_debug_gpu_scope_capture_set ( int argc,
const char ** argv,
void *  )
static

Definition at line 1474 of file creator_args.cc.

References G, and STRNCPY().

Referenced by main_args_setup().

◆ arg_handle_debug_gpu_set()

int arg_handle_debug_gpu_set ( int ,
const char ** ,
void *  )
static

Definition at line 1451 of file creator_args.cc.

References CLG_type_filter_include(), G, and G_DEBUG_GPU.

Referenced by main_args_setup().

◆ arg_handle_debug_mode_all()

int arg_handle_debug_mode_all ( int ,
const char ** ,
void *  )
static

Definition at line 1383 of file creator_args.cc.

References CCL_start_debug_logging(), G, G_DEBUG_ALL, and libmv_startDebugLogging().

Referenced by main_args_setup().

◆ arg_handle_debug_mode_cycles()

int arg_handle_debug_mode_cycles ( int ,
const char ** ,
void *  )
static

Definition at line 1409 of file creator_args.cc.

References CCL_start_debug_logging().

Referenced by main_args_setup().

◆ arg_handle_debug_mode_generic_set()

int arg_handle_debug_mode_generic_set ( int ,
const char ** ,
void * data )
static

Definition at line 1365 of file creator_args.cc.

References data, G, and POINTER_AS_INT.

Referenced by main_args_setup().

◆ arg_handle_debug_mode_io()

int arg_handle_debug_mode_io ( int ,
const char ** ,
void *  )
static

Definition at line 1374 of file creator_args.cc.

References G, and G_DEBUG_IO.

Referenced by main_args_setup().

◆ arg_handle_debug_mode_libmv()

int arg_handle_debug_mode_libmv ( int ,
const char ** ,
void *  )
static

Definition at line 1398 of file creator_args.cc.

References libmv_startDebugLogging().

Referenced by main_args_setup().

◆ arg_handle_debug_mode_memory_set()

int arg_handle_debug_mode_memory_set ( int ,
const char ** ,
void *  )
static

Definition at line 1420 of file creator_args.cc.

References MEM_set_memory_debug.

Referenced by main_args_setup().

◆ arg_handle_debug_mode_set()

int arg_handle_debug_mode_set ( int ,
const char ** ,
void * data )
static

Definition at line 1279 of file creator_args.cc.

References BKE_blender_version_string(), BLI_args_print(), BLI_mempool_set_memory_debug(), build_date, build_platform, build_time, build_type, data, G, G_DEBUG, MEM_set_memory_debug, and printf.

Referenced by main_args_setup().

◆ arg_handle_debug_value_set()

int arg_handle_debug_value_set ( int argc,
const char ** argv,
void *  )
static

Definition at line 1429 of file creator_args.cc.

References G, and parse_int().

Referenced by main_args_setup().

◆ arg_handle_disable_depsgraph_on_file_load()

int arg_handle_disable_depsgraph_on_file_load ( int ,
const char ** ,
void *  )
static

Definition at line 1128 of file creator_args.cc.

References G, and G_BACKGROUND_NO_DEPSGRAPH.

Referenced by main_args_setup().

◆ arg_handle_disable_liboverride_auto_resync()

int arg_handle_disable_liboverride_auto_resync ( int ,
const char ** ,
void *  )
static

Definition at line 1142 of file creator_args.cc.

References G, and G_LIBOVERRIDE_NO_AUTO_RESYNC.

Referenced by main_args_setup().

◆ arg_handle_enable_event_simulate()

int arg_handle_enable_event_simulate ( int ,
const char ** ,
void *  )
static

Definition at line 1636 of file creator_args.cc.

References G, and G_FLAG_EVENT_SIMULATE.

Referenced by main_args_setup().

◆ arg_handle_engine_set()

int arg_handle_engine_set ( int argc,
const char ** argv,
void * data )
static

Definition at line 1960 of file creator_args.cc.

References BLI_findstring(), C, CTX_data_scene(), data, DEG_id_tag_update(), RenderData::engine, Scene::id, ID_RECALC_SYNC_TO_EVAL, LISTBASE_FOREACH, offsetof, printf, Scene::r, R_engines, STREQ, and STRNCPY_UTF8.

Referenced by main_args_setup().

◆ arg_handle_env_system_set()

int arg_handle_env_system_set ( int argc,
const char ** argv,
void *  )
static

Definition at line 1655 of file creator_args.cc.

References BLI_assert_unreachable, and BLI_setenv().

Referenced by main_args_setup().

◆ arg_handle_extension_registration()

bool arg_handle_extension_registration ( const bool do_register,
const bool all_users )
static

Definition at line 1793 of file creator_args.cc.

References BLI_windows_register_blend_extension(), BLI_windows_unregister_blend_extension(), MEM_freeN(), result, and WM_platform_associate_set().

Referenced by arg_handle_register_extension(), arg_handle_register_extension_all(), arg_handle_unregister_extension(), and arg_handle_unregister_extension_all().

◆ arg_handle_extension_set()

int arg_handle_extension_set ( int argc,
const char ** argv,
void * data )
static

Definition at line 2097 of file creator_args.cc.

References C, CTX_data_scene(), data, DEG_id_tag_update(), Scene::id, ID_RECALC_SYNC_TO_EVAL, Scene::r, R_EXTENSION, and RenderData::scemode.

Referenced by main_args_setup().

◆ arg_handle_factory_startup_set()

int arg_handle_factory_startup_set ( int ,
const char ** ,
void *  )
static

Definition at line 1626 of file creator_args.cc.

References G, and G_FLAG_USERPREF_NO_SAVE_ON_EXIT.

Referenced by main_args_setup().

◆ arg_handle_frame_end_set()

int arg_handle_frame_end_set ( int argc,
const char ** argv,
void * data )
static

Definition at line 2275 of file creator_args.cc.

References C, CTX_data_scene(), data, DEG_id_tag_update(), RenderData::efra, Scene::id, ID_RECALC_SYNC_TO_EVAL, MAXFRAME, MINAFRAME, parse_int_relative_clamp(), and Scene::r.

Referenced by main_args_setup().

◆ arg_handle_frame_skip_set()

int arg_handle_frame_skip_set ( int argc,
const char ** argv,
void * data )
static

Definition at line 2309 of file creator_args.cc.

References C, CTX_data_scene(), data, DEG_id_tag_update(), RenderData::frame_step, Scene::id, ID_RECALC_SYNC_TO_EVAL, MAXFRAME, parse_int_clamp(), and Scene::r.

Referenced by main_args_setup().

◆ arg_handle_frame_start_set()

int arg_handle_frame_start_set ( int argc,
const char ** argv,
void * data )
static

Definition at line 2241 of file creator_args.cc.

References C, CTX_data_scene(), data, DEG_id_tag_update(), Scene::id, ID_RECALC_SYNC_TO_EVAL, MAXFRAME, MINAFRAME, parse_int_relative_clamp(), Scene::r, and RenderData::sfra.

Referenced by main_args_setup().

◆ arg_handle_gpu_backend_set()

int arg_handle_gpu_backend_set ( int argc,
const char ** argv,
void *  )
static

Definition at line 1519 of file creator_args.cc.

References GPU_BACKEND_METAL, GPU_BACKEND_NONE, GPU_BACKEND_OPENGL, GPU_backend_type_selection_set_override(), GPU_BACKEND_VULKAN, i, and STREQ.

Referenced by main_args_setup().

◆ arg_handle_image_type_set()

int arg_handle_image_type_set ( int argc,
const char ** argv,
void * data )
static

Definition at line 2004 of file creator_args.cc.

References BKE_image_format_set(), BKE_imtype_from_arg(), C, CTX_data_scene(), data, DEG_id_tag_update(), Scene::id, ID_RECALC_SYNC_TO_EVAL, RenderData::im_format, Scene::r, and R_IMF_IMTYPE_INVALID.

Referenced by main_args_setup().

◆ arg_handle_internet_allow_set()

int arg_handle_internet_allow_set ( int ,
const char ** ,
void * data )
static

Definition at line 981 of file creator_args.cc.

References data, G, G_FLAG_INTERNET_ALLOW, G_FLAG_INTERNET_OVERRIDE_PREF_ANY, G_FLAG_INTERNET_OVERRIDE_PREF_OFFLINE, and G_FLAG_INTERNET_OVERRIDE_PREF_ONLINE.

Referenced by main_args_setup().

◆ arg_handle_load_last_file()

int arg_handle_load_last_file ( int ,
const char ** ,
void * data )
static

Definition at line 2625 of file creator_args.cc.

References BLI_listbase_is_empty(), C, data, RecentFile::filepath, G, and handle_load_file().

Referenced by main_args_setup().

◆ arg_handle_log_file_set()

int arg_handle_log_file_set ( int argc,
const char ** argv,
void *  )
static

Definition at line 1206 of file creator_args.cc.

References BLI_fopen(), CLG_output_set(), G, and UNLIKELY.

Referenced by main_args_setup().

◆ arg_handle_log_level_set()

int arg_handle_log_level_set ( int argc,
const char ** argv,
void *  )
static

Definition at line 1154 of file creator_args.cc.

References CLG_level_set(), G, and parse_int_clamp().

Referenced by main_args_setup().

◆ arg_handle_log_set()

int arg_handle_log_set ( int argc,
const char ** argv,
void *  )
static

Definition at line 1239 of file creator_args.cc.

References CLG_type_filter_exclude(), and CLG_type_filter_include().

Referenced by main_args_setup().

◆ arg_handle_log_show_backtrace_set()

int arg_handle_log_show_backtrace_set ( int ,
const char ** ,
void *  )
static

Definition at line 1186 of file creator_args.cc.

References BLI_system_backtrace(), and CLG_backtrace_fn_set().

Referenced by main_args_setup().

◆ arg_handle_log_show_basename_set()

int arg_handle_log_show_basename_set ( int ,
const char ** ,
void *  )
static

Definition at line 1177 of file creator_args.cc.

References CLG_output_use_basename_set().

Referenced by main_args_setup().

◆ arg_handle_log_show_timestamp_set()

int arg_handle_log_show_timestamp_set ( int ,
const char ** ,
void *  )
static

Definition at line 1197 of file creator_args.cc.

References CLG_output_use_timestamp_set().

Referenced by main_args_setup().

◆ arg_handle_native_pixels_set()

int arg_handle_native_pixels_set ( int ,
const char ** ,
void *  )
static

Definition at line 1742 of file creator_args.cc.

References WM_init_native_pixels().

Referenced by main_args_setup().

◆ arg_handle_no_window_focus()

int arg_handle_no_window_focus ( int ,
const char ** ,
void *  )
static

Definition at line 1778 of file creator_args.cc.

References WM_init_window_focus_set().

Referenced by main_args_setup().

◆ arg_handle_output_set()

int arg_handle_output_set ( int argc,
const char ** argv,
void * data )
static

Definition at line 1938 of file creator_args.cc.

References C, CTX_data_scene(), data, DEG_id_tag_update(), Scene::id, ID_RECALC_SYNC_TO_EVAL, RenderData::pic, Scene::r, and STRNCPY().

Referenced by main_args_setup().

◆ arg_handle_playback_mode()

int arg_handle_playback_mode ( int argc,
const char ** argv,
void *  )
static

Definition at line 1700 of file creator_args.cc.

References G, and WM_main_playanim().

Referenced by main_args_setup().

◆ arg_handle_print_help()

int arg_handle_print_help ( int ,
const char ** ,
void * data )
static

Definition at line 922 of file creator_args.cc.

References BLI_assert_unreachable, data, and print_help().

Referenced by main_args_setup().

◆ arg_handle_print_version()

int arg_handle_print_version ( int ,
const char ** ,
void *  )
static

Definition at line 627 of file creator_args.cc.

References BLI_assert_unreachable, and print_version_full().

Referenced by main_args_setup().

◆ arg_handle_profile_gpu_set()

int arg_handle_profile_gpu_set ( int ,
const char ** ,
void *  )
static

Definition at line 2522 of file creator_args.cc.

References G.

Referenced by main_args_setup().

◆ arg_handle_python_console_run()

int arg_handle_python_console_run ( int ,
const char ** ,
void * data )
static

Definition at line 2433 of file creator_args.cc.

References BPY_run_string_eval(), C, data, and UNUSED_VARS.

Referenced by main_args_setup().

◆ arg_handle_python_exit_code_set()

int arg_handle_python_exit_code_set ( int argc,
const char ** argv,
void *  )
static

Definition at line 2451 of file creator_args.cc.

References app_state, max, min, and parse_int_strict_range().

Referenced by main_args_setup().

◆ arg_handle_python_expr_run()

int arg_handle_python_expr_run ( int argc,
const char ** argv,
void * data )
static

Definition at line 2406 of file creator_args.cc.

References app_state, BPY_run_string_exec(), C, data, UNUSED_VARS, and WM_exit().

Referenced by main_args_setup().

◆ arg_handle_python_file_run()

int arg_handle_python_file_run ( int argc,
const char ** argv,
void * data )
static

Definition at line 2335 of file creator_args.cc.

References app_state, BLI_path_canonicalize_native(), BPY_run_filepath(), C, data, FILE_MAX, STRNCPY(), UNUSED_VARS, and WM_exit().

Referenced by main_args_setup().

◆ arg_handle_python_set()

int arg_handle_python_set ( int ,
const char ** ,
void * data )
static

Definition at line 962 of file creator_args.cc.

References data, G, G_FLAG_SCRIPT_AUTOEXEC, and G_FLAG_SCRIPT_OVERRIDE_PREF.

Referenced by main_args_setup().

◆ arg_handle_python_text_run()

int arg_handle_python_text_run ( int argc,
const char ** argv,
void * data )
static

Definition at line 2367 of file creator_args.cc.

References app_state, BKE_libblock_find_name(), BPY_run_text(), C, CTX_data_main(), data, ID_TXT, UNUSED_VARS, and WM_exit().

Referenced by main_args_setup().

◆ arg_handle_python_use_system_env_set()

int arg_handle_python_use_system_env_set ( int ,
const char ** ,
void *  )
static

Definition at line 2480 of file creator_args.cc.

References BPY_python_use_system_env().

Referenced by main_args_setup().

◆ arg_handle_quiet_set()

int arg_handle_quiet_set ( int ,
const char ** ,
void *  )
static

Definition at line 1033 of file creator_args.cc.

References G.

Referenced by main_args_setup().

◆ arg_handle_register_extension()

int arg_handle_register_extension ( int argc,
const char ** argv,
void * data )
static

Definition at line 1821 of file creator_args.cc.

References arg_handle_extension_registration(), arg_handle_register_extension(), background_mode_set(), data, G, main_arg_deferred_is_set(), and main_arg_deferred_setup().

Referenced by arg_handle_register_extension(), and main_args_setup().

◆ arg_handle_register_extension_all()

int arg_handle_register_extension_all ( int argc,
const char ** argv,
void * data )
static

Definition at line 1839 of file creator_args.cc.

References arg_handle_extension_registration(), arg_handle_register_extension_all(), background_mode_set(), data, G, main_arg_deferred_is_set(), and main_arg_deferred_setup().

Referenced by arg_handle_register_extension_all(), and main_args_setup().

◆ arg_handle_render_animation()

int arg_handle_render_animation ( int ,
const char ** ,
void * data )
static

Definition at line 2190 of file creator_args.cc.

References BKE_reports_free(), BKE_reports_init(), C, CTX_data_main(), CTX_data_scene(), data, RenderData::efra, RenderData::frame_step, Scene::r, RE_NewSceneRender(), RE_RenderAnim(), RE_SetReports(), reports, RPT_STORE, and RenderData::sfra.

Referenced by main_args_setup().

◆ arg_handle_render_frame()

int arg_handle_render_frame ( int argc,
const char ** argv,
void * data )
static

Definition at line 2135 of file creator_args.cc.

References BKE_reports_free(), BKE_reports_init(), C, CTX_data_main(), CTX_data_scene(), data, RenderData::efra, RenderData::frame_step, i, MAXFRAME, MEM_freeN(), MINAFRAME, parse_int_range_relative_clamp_n(), Scene::r, RE_NewSceneRender(), RE_RenderAnim(), RE_SetReports(), reports, RPT_STORE, and RenderData::sfra.

Referenced by main_args_setup().

◆ arg_handle_scene_set()

int arg_handle_scene_set ( int argc,
const char ** argv,
void * data )
static

Definition at line 2214 of file creator_args.cc.

References BKE_scene_set_name(), C, CTX_data_main(), CTX_data_scene_set(), CTX_wm_manager(), CTX_wm_window(), data, ListBase::first, wmWindowManager::windows, and WM_window_set_active_scene().

Referenced by main_args_setup().

◆ arg_handle_start_with_console()

int arg_handle_start_with_console ( int ,
const char ** ,
void *  )
static

Definition at line 1787 of file creator_args.cc.

References WM_init_state_start_with_console_set().

Referenced by main_args_setup().

◆ arg_handle_threads_set()

int arg_handle_threads_set ( int argc,
const char ** argv,
void *  )
static

Definition at line 2038 of file creator_args.cc.

References BLENDER_MAX_THREADS, BLI_system_num_threads_override_set(), max, min, and parse_int_strict_range().

Referenced by main_args_setup().

◆ arg_handle_unregister_extension()

int arg_handle_unregister_extension ( int argc,
const char ** argv,
void * data )
static

Definition at line 1857 of file creator_args.cc.

References arg_handle_extension_registration(), arg_handle_unregister_extension(), background_mode_set(), data, G, main_arg_deferred_is_set(), and main_arg_deferred_setup().

Referenced by arg_handle_unregister_extension(), and main_args_setup().

◆ arg_handle_unregister_extension_all()

int arg_handle_unregister_extension_all ( int argc,
const char ** argv,
void * data )
static

Definition at line 1875 of file creator_args.cc.

References arg_handle_extension_registration(), arg_handle_unregister_extension_all(), background_mode_set(), data, G, main_arg_deferred_is_set(), and main_arg_deferred_setup().

Referenced by arg_handle_unregister_extension_all(), and main_args_setup().

◆ arg_handle_verbosity_set()

int arg_handle_verbosity_set ( int argc,
const char ** argv,
void *  )
static

Definition at line 2070 of file creator_args.cc.

References CCL_logging_verbosity_set(), libmv_setLoggingVerbosity(), and parse_int().

Referenced by main_args_setup().

◆ arg_handle_window_geometry()

int arg_handle_window_geometry ( int argc,
const char ** argv,
void *  )
static

Definition at line 1716 of file creator_args.cc.

References i, params, parse_int(), UNPACK4, and WM_init_state_size_set().

Referenced by main_args_setup().

◆ arg_handle_window_maximized()

int arg_handle_window_maximized ( int ,
const char ** ,
void *  )
static

Definition at line 1769 of file creator_args.cc.

References WM_init_state_maximized_set().

Referenced by main_args_setup().

◆ arg_handle_with_borders()

int arg_handle_with_borders ( int ,
const char ** ,
void *  )
static

Definition at line 1751 of file creator_args.cc.

References WM_init_state_normal_set().

Referenced by main_args_setup().

◆ arg_handle_without_borders()

int arg_handle_without_borders ( int ,
const char ** ,
void *  )
static

Definition at line 1760 of file creator_args.cc.

References WM_init_state_fullscreen_set().

Referenced by main_args_setup().

◆ background_mode_set()

void background_mode_set ( )
static

Shared by --background & --command.

Definition at line 1040 of file creator_args.cc.

References BKE_sound_force_device(), and G.

Referenced by arg_handle_background_mode_set(), arg_handle_command_set(), arg_handle_register_extension(), arg_handle_register_extension_all(), arg_handle_unregister_extension(), and arg_handle_unregister_extension_all().

◆ build_defs_init()

void build_defs_init ( BuildDefs * build_defs,
bool force_all )
static

Definition at line 101 of file creator_args.cc.

References BuildDefs::win32, BuildDefs::with_cycles, BuildDefs::with_cycles_logging, BuildDefs::with_ffmpeg, BuildDefs::with_freestyle, BuildDefs::with_libmv, BuildDefs::with_opencolorio, BuildDefs::with_renderdoc, and BuildDefs::with_xr_openxr.

Referenced by main_args_setup(), and print_help().

◆ clog_abort_on_error_callback()

void clog_abort_on_error_callback ( void * fp)
static

Definition at line 1013 of file creator_args.cc.

References BLI_system_backtrace().

Referenced by arg_handle_debug_exit_on_error().

◆ handle_load_file()

bool handle_load_file ( bContext * C,
const char * filepath_arg,
const bool load_empty_file )
static

Implementation for arg_handle_load_last_file, also used by --open-last.

Returns
true on success.

Definition at line 2532 of file creator_args.cc.

References BKE_blendfile_extension_check(), BKE_reports_free(), BKE_reports_init(), BLI_exists(), BLI_path_canonicalize_native(), C, CTX_wm_window_set(), FILE_MAX, G, G_MAIN, printf, reports, RPT_PRINT, STRNCPY(), WM_exit(), and WM_file_read().

Referenced by arg_handle_load_last_file(), and main_args_handle_load_file().

◆ help_print_ds_fn()

void help_print_ds_fn ( void * ds_v,
const char * format,
va_list args )
static

Definition at line 895 of file creator_args.cc.

References BLI_dynstr_vappendf(), and help_print_ds_fn().

Referenced by help_print_ds_fn(), and main_args_help_as_string().

◆ main_arg_deferred_exit_code_set()

void main_arg_deferred_exit_code_set ( int exit_code)
static

Definition at line 497 of file creator_args.cc.

References app_state, BLI_assert, and BA_ArgCallback_Deferred::exit_code.

Referenced by arg_handle_command_set().

◆ main_arg_deferred_free()

void main_arg_deferred_free ( )

Definition at line 487 of file creator_args.cc.

References app_state, BA_ArgCallback_Deferred::argc, BA_ArgCallback_Deferred::argv, and MEM_freeN().

Referenced by main().

◆ main_arg_deferred_handle()

int main_arg_deferred_handle ( )

Handle an argument which requested deferred evaluation. Needed when arguments which evaluate early need Python to be initialized for example.

Definition at line 504 of file creator_args.cc.

References app_state, BA_ArgCallback_Deferred::argc, BA_ArgCallback_Deferred::argv, BA_ArgCallback_Deferred::data, BA_ArgCallback_Deferred::exit_code, and BA_ArgCallback_Deferred::func.

Referenced by main().

◆ main_arg_deferred_is_set()

bool main_arg_deferred_is_set ( )
static

Definition at line 467 of file creator_args.cc.

References app_state.

Referenced by arg_handle_command_set(), arg_handle_register_extension(), arg_handle_register_extension_all(), arg_handle_unregister_extension(), and arg_handle_unregister_extension_all().

◆ main_arg_deferred_setup()

void main_arg_deferred_setup ( BA_ArgCallback func,
int argc,
const char ** argv,
void * data )
static

Definition at line 472 of file creator_args.cc.

References app_state, BA_ArgCallback_Deferred::argc, BA_ArgCallback_Deferred::argv, BLI_assert, BA_ArgCallback_Deferred::data, data, BA_ArgCallback_Deferred::exit_code, BA_ArgCallback_Deferred::func, and MEM_callocN().

Referenced by arg_handle_command_set(), arg_handle_register_extension(), arg_handle_register_extension_all(), arg_handle_unregister_extension(), and arg_handle_unregister_extension_all().

◆ main_args_handle_load_file()

int main_args_handle_load_file ( int argc,
const char ** argv,
void * data )

Handler for loading blend files.

Note
arguments that cannot be parsed are assumed to be blend files.

Definition at line 2606 of file creator_args.cc.

References C, data, and handle_load_file().

Referenced by main().

◆ main_args_help_as_string()

char * main_args_help_as_string ( bool all)
static

Definition at line 901 of file creator_args.cc.

References all(), BLI_args_create(), BLI_args_destroy(), BLI_args_print_fn_set(), BLI_dynstr_free(), BLI_dynstr_get_cstring(), BLI_dynstr_new(), help_print_ds_fn(), main_args_setup(), and print_help().

Referenced by main_args_setup().

◆ main_args_setup()

void main_args_setup ( struct bContext * C,
struct bArgs * ba,
bool all )
Parameters
allWhen enabled, all arguments are initialized even for configurations that don't apply to the current system. Used for documentation (see Python API: bpy.app.help_text(all=True)).

Expand the doc-string from the function.

A version of CB that expands an additional suffix.

A version of CB that uses all, needed when the doc-string depends on build options.

Definition at line 2640 of file creator_args.cc.

References all(), arg_handle_abort_handler_disable(), arg_handle_addons_set(), arg_handle_app_template(), arg_handle_arguments_end(), arg_handle_audio_disable(), arg_handle_audio_set(), arg_handle_background_mode_set(), arg_handle_command_set(), arg_handle_crash_handler_disable(), arg_handle_debug_exit_on_error(), arg_handle_debug_fpe_set(), arg_handle_debug_gpu_compile_shaders_set(), arg_handle_debug_gpu_renderdoc_set(), arg_handle_debug_gpu_scope_capture_set(), arg_handle_debug_gpu_set(), arg_handle_debug_mode_all(), arg_handle_debug_mode_cycles(), arg_handle_debug_mode_generic_set(), arg_handle_debug_mode_io(), arg_handle_debug_mode_libmv(), arg_handle_debug_mode_memory_set(), arg_handle_debug_mode_set(), arg_handle_debug_value_set(), arg_handle_disable_depsgraph_on_file_load(), arg_handle_disable_liboverride_auto_resync(), arg_handle_enable_event_simulate(), arg_handle_engine_set(), arg_handle_env_system_set(), arg_handle_extension_set(), arg_handle_factory_startup_set(), arg_handle_frame_end_set(), arg_handle_frame_skip_set(), arg_handle_frame_start_set(), arg_handle_gpu_backend_set(), arg_handle_image_type_set(), arg_handle_internet_allow_set(), arg_handle_load_last_file(), arg_handle_log_file_set(), arg_handle_log_level_set(), arg_handle_log_set(), arg_handle_log_show_backtrace_set(), arg_handle_log_show_basename_set(), arg_handle_log_show_timestamp_set(), arg_handle_native_pixels_set(), arg_handle_no_window_focus(), arg_handle_output_set(), arg_handle_playback_mode(), arg_handle_print_help(), arg_handle_print_version(), arg_handle_profile_gpu_set(), arg_handle_python_console_run(), arg_handle_python_exit_code_set(), arg_handle_python_expr_run(), arg_handle_python_file_run(), arg_handle_python_set(), arg_handle_python_text_run(), arg_handle_python_use_system_env_set(), arg_handle_quiet_set(), arg_handle_register_extension(), arg_handle_register_extension_all(), arg_handle_render_animation(), arg_handle_render_frame(), arg_handle_scene_set(), arg_handle_start_with_console(), arg_handle_threads_set(), arg_handle_unregister_extension(), arg_handle_unregister_extension_all(), arg_handle_verbosity_set(), arg_handle_window_geometry(), arg_handle_window_maximized(), arg_handle_with_borders(), arg_handle_without_borders(), ARG_PASS_ENVIRONMENT, ARG_PASS_FINAL, ARG_PASS_SETTINGS, ARG_PASS_SETTINGS_FORCE, ARG_PASS_SETTINGS_GUI, BLI_args_add(), BLI_args_add_case(), BLI_args_pass_set(), BPY_python_app_help_text_fn, build_defs_init(), C, CB, CB_ALL, CB_EX, depsgraph, G_DEBUG_DEPSGRAPH, G_DEBUG_DEPSGRAPH_BUILD, G_DEBUG_DEPSGRAPH_EVAL, G_DEBUG_DEPSGRAPH_NO_THREADS, G_DEBUG_DEPSGRAPH_PRETTY, G_DEBUG_DEPSGRAPH_TAG, G_DEBUG_DEPSGRAPH_TIME, G_DEBUG_DEPSGRAPH_UID, G_DEBUG_EVENTS, G_DEBUG_FFMPEG, G_DEBUG_FREESTYLE, G_DEBUG_GHOST, G_DEBUG_GPU_FORCE_VULKAN_LOCAL_READ, G_DEBUG_GPU_FORCE_WORKAROUNDS, G_DEBUG_HANDLERS, G_DEBUG_JOBS, G_DEBUG_PYTHON, G_DEBUG_WINTAB, G_DEBUG_WM, G_DEBUG_XR, G_DEBUG_XR_TIME, main_args_help_as_string(), BuildDefs::with_cycles_logging, BuildDefs::with_ffmpeg, BuildDefs::with_freestyle, BuildDefs::with_libmv, BuildDefs::with_renderdoc, and BuildDefs::with_xr_openxr.

Referenced by main(), and main_args_help_as_string().

◆ parse_int()

bool parse_int ( const char * str,
const char * str_end_test,
int * r_value,
const char ** r_err_msg )
static

Definition at line 291 of file creator_args.cc.

References parse_int_strict_range(), and str.

Referenced by arg_handle_debug_value_set(), arg_handle_verbosity_set(), arg_handle_window_geometry(), and parse_int_clamp().

◆ parse_int_clamp()

bool parse_int_clamp ( const char * str,
const char * str_end_test,
int min,
int max,
int * r_value,
const char ** r_err_msg )
static

Definition at line 299 of file creator_args.cc.

References CLAMP, max, min, parse_int(), and str.

Referenced by arg_handle_frame_skip_set(), and arg_handle_log_level_set().

◆ parse_int_range_relative()

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 )
static

Parse a number as a range, eg: 1..4.

The str_end_range argument is a result of parse_int_range_sep_search.

Definition at line 209 of file creator_args.cc.

References parse_int_relative(), pos, and str.

Referenced by parse_int_range_relative_clamp().

◆ parse_int_range_relative_clamp()

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 )
static

Definition at line 241 of file creator_args.cc.

References CLAMP, max, min, parse_int_range_relative(), pos, and str.

Referenced by parse_int_range_relative_clamp_n().

◆ parse_int_range_relative_clamp_n()

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]
static

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.

Definition at line 369 of file creator_args.cc.

References ELEM, i, len, max, MEM_freeN(), MEM_malloc_arrayN(), min, parse_int_range_relative_clamp(), parse_int_range_sep_search(), parse_int_relative_clamp(), pos, and str.

Referenced by arg_handle_render_frame().

◆ parse_int_range_sep_search()

const char * parse_int_range_sep_search ( const char * str,
const char * str_end_test )
static

Definition at line 186 of file creator_args.cc.

References str.

Referenced by parse_int_range_relative_clamp_n().

◆ parse_int_relative()

bool parse_int_relative ( const char * str,
const char * str_end_test,
int pos,
int neg,
int * r_value,
const char ** r_err_msg )
static

Definition at line 148 of file creator_args.cc.

References pos, and str.

Referenced by parse_int_range_relative(), and parse_int_relative_clamp().

◆ parse_int_relative_clamp()

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 )
static

Definition at line 225 of file creator_args.cc.

References CLAMP, max, min, parse_int_relative(), pos, and str.

Referenced by arg_handle_frame_end_set(), arg_handle_frame_start_set(), and parse_int_range_relative_clamp_n().

◆ parse_int_strict_range()

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 )
static

No clamping, fails with any number outside the range.

Definition at line 264 of file creator_args.cc.

References max, min, and str.

Referenced by arg_handle_python_exit_code_set(), arg_handle_threads_set(), and parse_int().

◆ print_help()

void print_help ( bArgs * ba,
bool all )
static

Definition at line 635 of file creator_args.cc.

References all(), BKE_blender_version_string(), BLI_args_has_other_doc(), BLI_args_print_arg_doc(), BLI_args_print_other_doc(), build_defs_init(), PRINT, BuildDefs::win32, BuildDefs::with_cycles, BuildDefs::with_cycles_logging, BuildDefs::with_ffmpeg, BuildDefs::with_freestyle, BuildDefs::with_libmv, BuildDefs::with_opencolorio, BuildDefs::with_renderdoc, and BuildDefs::with_xr_openxr.

Referenced by arg_handle_print_help(), and main_args_help_as_string().

◆ print_version_full()

void print_version_full ( )
static

Definition at line 590 of file creator_args.cc.

References BKE_blender_version_string(), build_branch, build_cflags, build_commit_date, build_commit_time, build_cxxflags, build_date, build_hash, build_linkflags, build_platform, build_system, build_time, build_type, and printf.

Referenced by arg_handle_print_version().

◆ print_version_short()

void print_version_short ( )
static

Definition at line 609 of file creator_args.cc.

References BKE_blender_version_string(), build_date, build_hash, build_time, and printf.

Referenced by arg_handle_background_mode_set().

Variable Documentation

◆ arg_handle_abort_handler_disable_doc

const char arg_handle_abort_handler_disable_doc[]
static
Initial value:
=
"\n\t"
"Disable the abort handler."

Definition at line 1004 of file creator_args.cc.

◆ arg_handle_addons_set_doc

const char arg_handle_addons_set_doc[]
static
Initial value:
=
"<addon(s)>\n"
"\tComma separated list (no spaces) of add-ons to enable in addition to any default add-ons."

Definition at line 2490 of file creator_args.cc.

◆ arg_handle_app_template_doc

const char arg_handle_app_template_doc[]
static
Initial value:
=
"<template>\n"
"\tSet the application template (matching the directory name), use 'default' for none."

Definition at line 1609 of file creator_args.cc.

◆ arg_handle_arguments_end_doc

const char arg_handle_arguments_end_doc[]
static
Initial value:
=
"\n\t"
"End option processing, following arguments passed unchanged. Access via Python's "
"'sys.argv'."

Definition at line 934 of file creator_args.cc.

◆ arg_handle_audio_disable_doc

const char arg_handle_audio_disable_doc[]
static
Initial value:
=
"\n\t"
"Force sound system to None."

Definition at line 1890 of file creator_args.cc.

◆ arg_handle_audio_set_doc

const char arg_handle_audio_set_doc[]
static
Initial value:
=
"\n\t"
"Force sound system to a specific device.\n"
"\t'None' 'Default' 'SDL' 'OpenAL' 'CoreAudio' 'JACK' 'PulseAudio' 'WASAPI'."

Definition at line 1899 of file creator_args.cc.

◆ arg_handle_background_mode_set_doc

const char arg_handle_background_mode_set_doc[]
static
Initial value:
=
"\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."

Definition at line 1062 of file creator_args.cc.

◆ arg_handle_command_set_doc

const char arg_handle_command_set_doc[]
static
Initial value:
=
"<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."

Definition at line 1077 of file creator_args.cc.

◆ arg_handle_crash_handler_disable_doc

const char arg_handle_crash_handler_disable_doc[]
static
Initial value:
=
"\n\t"
"Disable the crash handler."

Definition at line 995 of file creator_args.cc.

◆ arg_handle_debug_exit_on_error_doc

const char arg_handle_debug_exit_on_error_doc[]
static
Initial value:
=
"\n\t"
"Immediately exit when internal errors are detected."

Definition at line 1020 of file creator_args.cc.

◆ arg_handle_debug_fpe_set_doc

const char arg_handle_debug_fpe_set_doc[]
static
Initial value:
=
"\n\t"
"Enable floating-point exceptions."

Definition at line 1600 of file creator_args.cc.

◆ arg_handle_debug_gpu_compile_shaders_set_doc

const char arg_handle_debug_gpu_compile_shaders_set_doc[]
static
Initial value:
=
"\n"
"\tCompile all statically defined shaders to test platform compatibility."

Definition at line 1460 of file creator_args.cc.

◆ arg_handle_debug_gpu_renderdoc_set_doc

const char arg_handle_debug_gpu_renderdoc_set_doc[]
static
Initial value:
=
"\n"
"\tEnable RenderDoc integration for GPU frame grabbing and debugging."

Definition at line 1484 of file creator_args.cc.

◆ arg_handle_debug_gpu_scope_capture_set_doc

const char arg_handle_debug_gpu_scope_capture_set_doc[]
static
Initial value:
=
"\n"
"\tCapture the GPU commands issued inside the give scope name."

Definition at line 1471 of file creator_args.cc.

◆ arg_handle_debug_gpu_set_doc

const char arg_handle_debug_gpu_set_doc[]
static
Initial value:
=
"\n"
"\tEnable GPU debug context and information for OpenGL 4.3+."

Definition at line 1448 of file creator_args.cc.

◆ arg_handle_debug_mode_all_doc

const char arg_handle_debug_mode_all_doc[]
static
Initial value:
=
"\n\t"
"Enable all debug messages."

Definition at line 1380 of file creator_args.cc.

◆ arg_handle_debug_mode_cycles_doc

const char arg_handle_debug_mode_cycles_doc[]
static
Initial value:
=
"\n\t"
"Enable debug messages from Cycles."

Definition at line 1406 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_depsgraph

const char arg_handle_debug_mode_generic_set_doc_depsgraph[]
static
Initial value:
=
"\n\t"
"Enable all debug messages from dependency graph."

Definition at line 1332 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_depsgraph_build

const char arg_handle_debug_mode_generic_set_doc_depsgraph_build[]
static
Initial value:
=
"\n\t"
"Enable debug messages from dependency graph related on graph construction."

Definition at line 1335 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_depsgraph_eval

const char arg_handle_debug_mode_generic_set_doc_depsgraph_eval[]
static
Initial value:
=
"\n\t"
"Enable debug messages from dependency graph related on evaluation."

Definition at line 1344 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_depsgraph_no_threads

const char arg_handle_debug_mode_generic_set_doc_depsgraph_no_threads[]
static
Initial value:
=
"\n\t"
"Switch dependency graph to a single threaded evaluation."

Definition at line 1347 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_depsgraph_pretty

const char arg_handle_debug_mode_generic_set_doc_depsgraph_pretty[]
static
Initial value:
=
"\n\t"
"Enable colors for dependency graph debug messages."

Definition at line 1350 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_depsgraph_tag

const char arg_handle_debug_mode_generic_set_doc_depsgraph_tag[]
static
Initial value:
=
"\n\t"
"Enable debug messages from dependency graph related on tagging."

Definition at line 1338 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_depsgraph_time

const char arg_handle_debug_mode_generic_set_doc_depsgraph_time[]
static
Initial value:
=
"\n\t"
"Enable debug messages from dependency graph related on timing."

Definition at line 1341 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_depsgraph_uid

const char arg_handle_debug_mode_generic_set_doc_depsgraph_uid[]
static
Initial value:
=
"\n\t"
"Verify validness of session-wide identifiers assigned to ID data-blocks."

Definition at line 1353 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_events

const char arg_handle_debug_mode_generic_set_doc_events[]
static
Initial value:
=
"\n\t"
"Enable debug messages for the event system."

Definition at line 1305 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_ffmpeg

const char arg_handle_debug_mode_generic_set_doc_ffmpeg[]
static
Initial value:
=
"\n\t"
"Enable debug messages from FFmpeg library."

Definition at line 1296 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_freestyle

const char arg_handle_debug_mode_generic_set_doc_freestyle[]
static
Initial value:
=
"\n\t"
"Enable debug messages for Freestyle."

Definition at line 1299 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_ghost

const char arg_handle_debug_mode_generic_set_doc_ghost[]
static
Initial value:
=
"\n\t"
"Enable debug messages for Ghost (Linux only)."

Definition at line 1315 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_gpu_force_workarounds

const char arg_handle_debug_mode_generic_set_doc_gpu_force_workarounds[]
static
Initial value:
=
"\n\t"
"Enable workarounds for typical GPU issues and disable all GPU extensions."

Definition at line 1356 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_handlers

const char arg_handle_debug_mode_generic_set_doc_handlers[]
static
Initial value:
=
"\n\t"
"Enable debug messages for event handling."

Definition at line 1308 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_jobs

const char arg_handle_debug_mode_generic_set_doc_jobs[]
static
Initial value:
=
"\n\t"
"Enable time profiling for background jobs."

Definition at line 1329 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_python

const char arg_handle_debug_mode_generic_set_doc_python[]
static
Initial value:
=
"\n\t"
"Enable debug messages for Python."

Definition at line 1302 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_wintab

const char arg_handle_debug_mode_generic_set_doc_wintab[]
static
Initial value:
=
"\n\t"
"Enable debug messages for Wintab."

Definition at line 1318 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_wm

const char arg_handle_debug_mode_generic_set_doc_wm[]
static
Initial value:
=
"\n\t"
"Enable debug messages for the window manager, shows all operators in search, shows "
"keymap errors."

Definition at line 1311 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_xr

const char arg_handle_debug_mode_generic_set_doc_xr[]
static
Initial value:
=
"\n\t"
"Enable debug messages for virtual reality contexts.\n"
"\tEnables the OpenXR API validation layer, (OpenXR) debug messages and general information "
"prints."

Definition at line 1321 of file creator_args.cc.

◆ arg_handle_debug_mode_generic_set_doc_xr_time

const char arg_handle_debug_mode_generic_set_doc_xr_time[]
static
Initial value:
=
"\n\t"
"Enable debug messages for virtual reality frame rendering times."

Definition at line 1326 of file creator_args.cc.

◆ arg_handle_debug_mode_io_doc

const char arg_handle_debug_mode_io_doc[]
static
Initial value:
=
"\n\t"
"Enable debug messages for I/O (Collada, ...)."

Definition at line 1371 of file creator_args.cc.

◆ arg_handle_debug_mode_libmv_doc

const char arg_handle_debug_mode_libmv_doc[]
static
Initial value:
=
"\n\t"
"Enable debug messages from libmv library."

Definition at line 1395 of file creator_args.cc.

◆ arg_handle_debug_mode_memory_set_doc

const char arg_handle_debug_mode_memory_set_doc[]
static
Initial value:
=
"\n\t"
"Enable fully guarded memory allocation and debugging."

Definition at line 1417 of file creator_args.cc.

◆ arg_handle_debug_mode_set_doc

const char arg_handle_debug_mode_set_doc[]
static
Initial value:
=
"\n"
"\tTurn debugging on.\n"
"\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"

Definition at line 1272 of file creator_args.cc.

◆ arg_handle_debug_value_set_doc

const char arg_handle_debug_value_set_doc[]
static
Initial value:
=
"<value>\n"
"\tSet debug value of <value> on startup."

Definition at line 1426 of file creator_args.cc.

◆ arg_handle_disable_depsgraph_on_file_load_doc

const char arg_handle_disable_depsgraph_on_file_load_doc[]
static
Initial value:
=
"\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"
"\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."

Definition at line 1117 of file creator_args.cc.

◆ arg_handle_disable_liboverride_auto_resync_doc

const char arg_handle_disable_liboverride_auto_resync_doc[]
static
Initial value:
=
"\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."

Definition at line 1136 of file creator_args.cc.

◆ arg_handle_enable_event_simulate_doc

const char arg_handle_enable_event_simulate_doc[]
static
Initial value:
=
"\n\t"
"Enable event simulation testing feature 'bpy.types.Window.event_simulate'."

Definition at line 1633 of file creator_args.cc.

◆ arg_handle_engine_set_doc

const char arg_handle_engine_set_doc[]
static
Initial value:
=
"<engine>\n"
"\tSpecify the render engine.\n"
"\tUse '-E help' to list available engines."

Definition at line 1956 of file creator_args.cc.

◆ arg_handle_env_system_set_doc_datafiles

const char arg_handle_env_system_set_doc_datafiles[]
static
Initial value:
=
"\n\t"
"Set the " STRINGIFY_ARG(BLENDER_SYSTEM_DATAFILES) " environment variable."
BLENDER_SYSTEM_DATAFILES
@ BLENDER_SYSTEM_DATAFILES
Definition BKE_appdir.hh:167
STRINGIFY_ARG
#define STRINGIFY_ARG(x)
Definition BLI_utildefines.h:412

Definition at line 1642 of file creator_args.cc.

◆ arg_handle_env_system_set_doc_extensions

const char arg_handle_env_system_set_doc_extensions[]
static
Initial value:
=
"\n\t"
"Set the " STRINGIFY_ARG(BLENDER_SYSTEM_EXTENSIONS) " environment variable."
BLENDER_SYSTEM_EXTENSIONS
@ BLENDER_SYSTEM_EXTENSIONS
Definition BKE_appdir.hh:169

Definition at line 1651 of file creator_args.cc.

◆ arg_handle_env_system_set_doc_python

const char arg_handle_env_system_set_doc_python[]
static
Initial value:
=
"\n\t"
"Set the " STRINGIFY_ARG(BLENDER_SYSTEM_PYTHON) " environment variable."
BLENDER_SYSTEM_PYTHON
@ BLENDER_SYSTEM_PYTHON
Definition BKE_appdir.hh:170

Definition at line 1648 of file creator_args.cc.

◆ arg_handle_env_system_set_doc_scripts

const char arg_handle_env_system_set_doc_scripts[]
static
Initial value:
=
"\n\t"
"Set the " STRINGIFY_ARG(BLENDER_SYSTEM_SCRIPTS) " environment variable."
BLENDER_SYSTEM_SCRIPTS
@ BLENDER_SYSTEM_SCRIPTS
Definition BKE_appdir.hh:168

Definition at line 1645 of file creator_args.cc.

◆ arg_handle_extension_set_doc

const char arg_handle_extension_set_doc[]
static
Initial value:
=
"<bool>\n"
"\tSet option to add the file extension to the end of the file."

Definition at line 2094 of file creator_args.cc.

◆ arg_handle_factory_startup_set_doc

const char arg_handle_factory_startup_set_doc[]
static
Initial value:
=
"\n\t"
"Skip reading the '" BLENDER_STARTUP_FILE "' in the users home directory."
BLENDER_STARTUP_FILE
#define BLENDER_STARTUP_FILE
Definition BKE_appdir.hh:180

Definition at line 1623 of file creator_args.cc.

◆ arg_handle_frame_end_set_doc

const char arg_handle_frame_end_set_doc[]
static
Initial value:
=
"<frame>\n"
"\tSet end to frame <frame>, supports +/- for relative frames too."

Definition at line 2272 of file creator_args.cc.

◆ arg_handle_frame_skip_set_doc

const char arg_handle_frame_skip_set_doc[]
static
Initial value:
=
"<frames>\n"
"\tSet number of frames to step forward after each rendered frame."

Definition at line 2306 of file creator_args.cc.

◆ arg_handle_frame_start_set_doc

const char arg_handle_frame_start_set_doc[]
static
Initial value:
=
"<frame>\n"
"\tSet start to frame <frame>, supports +/- for relative frames too."

Definition at line 2238 of file creator_args.cc.

◆ arg_handle_gpu_backend_set_doc

const char arg_handle_gpu_backend_set_doc[]
static
Initial value:
=
"\n"
"\tForce to use a specific GPU backend. Valid options: "
"."

Definition at line 1503 of file creator_args.cc.

◆ arg_handle_gpu_backend_set_doc_all

const char arg_handle_gpu_backend_set_doc_all[]
static
Initial value:
=
"\n"
"\tForce to use a specific GPU backend. Valid options: "
"'vulkan', "
"'metal', "
"'opengl'."

Definition at line 1497 of file creator_args.cc.

◆ arg_handle_image_type_set_doc

const char arg_handle_image_type_set_doc[]
static
Initial value:
=
"<format>\n"
"\tSet the render format.\n"
"\tValid options are:\n"
"\t'TGA' 'RAWTGA' 'JPEG' 'IRIS' 'AVIRAW' 'AVIJPEG' 'PNG' 'BMP' 'HDR' 'TIFF'.\n"
"\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'."

Definition at line 1996 of file creator_args.cc.

◆ arg_handle_internet_allow_set_doc_offline

const char arg_handle_internet_allow_set_doc_offline[]
static
Initial value:
=
"\n\t"
"Disallow internet access, overriding the preference."

Definition at line 977 of file creator_args.cc.

◆ arg_handle_internet_allow_set_doc_online

const char arg_handle_internet_allow_set_doc_online[]
static
Initial value:
=
"\n\t"
"Allow internet access, overriding the preference."

Definition at line 974 of file creator_args.cc.

◆ arg_handle_load_last_file_doc

const char arg_handle_load_last_file_doc[]
static
Initial value:
=
"\n\t"
"Open the most recently opened blend file, instead of the default startup file."

Definition at line 2622 of file creator_args.cc.

◆ arg_handle_log_file_set_doc

const char arg_handle_log_file_set_doc[]
static
Initial value:
=
"<filepath>\n"
"\tSet a file to output the log to."

Definition at line 1203 of file creator_args.cc.

◆ arg_handle_log_level_set_doc

const char arg_handle_log_level_set_doc[]
static
Initial value:
=
"<level>\n"
"\tSet the logging verbosity level (higher for more details) defaults to 1,\n"
"\tuse -1 to log all levels."

Definition at line 1150 of file creator_args.cc.

◆ arg_handle_log_set_doc

const char arg_handle_log_set_doc[]
static
Initial value:
=
"<match>\n"
"\tEnable logging categories, taking a single comma separated argument.\n"
"\tMultiple categories can be matched using a '.*' suffix,\n"
"\tso '--log \"wm.*\"' logs every kind of window-manager message.\n"
"\tSub-string can be matched using a '*' prefix and suffix,\n"
"\tso '--log \"*undo*\"' logs every kind of undo-related message.\n"
"\tUse \"^\" prefix to ignore, so '--log \"*,^wm.operator.*\"' logs all except for "
"'wm.operators.*'\n"
"\tUse \"*\" to log everything."

Definition at line 1229 of file creator_args.cc.

◆ arg_handle_log_show_backtrace_set_doc

const char arg_handle_log_show_backtrace_set_doc[]
static
Initial value:
=
"\n\t"
"Show a back trace for each log message (debug builds only)."

Definition at line 1183 of file creator_args.cc.

◆ arg_handle_log_show_basename_set_doc

const char arg_handle_log_show_basename_set_doc[]
static
Initial value:
=
"\n\t"
"Only show file name in output (not the leading path)."

Definition at line 1174 of file creator_args.cc.

◆ arg_handle_log_show_timestamp_set_doc

const char arg_handle_log_show_timestamp_set_doc[]
static
Initial value:
=
"\n\t"
"Show a timestamp for each log message in seconds since start."

Definition at line 1194 of file creator_args.cc.

◆ arg_handle_native_pixels_set_doc

const char arg_handle_native_pixels_set_doc[]
static
Initial value:
=
"\n\t"
"Do not use native pixel size, for high resolution displays (MacBook 'Retina')."

Definition at line 1739 of file creator_args.cc.

◆ arg_handle_no_window_focus_doc

const char arg_handle_no_window_focus_doc[]
static
Initial value:
=
"\n\t"
"Open behind other windows and without taking focus."

Definition at line 1775 of file creator_args.cc.

◆ arg_handle_output_set_doc

const char arg_handle_output_set_doc[]
static
Initial value:
=
"<path>\n"
"\tSet the render path and file name.\n"
"\tUse '//' at the start of the path to render relative to the blend-file.\n"
"\n"
"\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"
"\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'"

Definition at line 1920 of file creator_args.cc.

◆ arg_handle_playback_mode_doc

const char arg_handle_playback_mode_doc[]
static
Initial value:
=
"<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"
"\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"
"\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)."

Definition at line 1678 of file creator_args.cc.

◆ arg_handle_print_help_doc

const char arg_handle_print_help_doc[]
static
Initial value:
=
"\n\t"
"Print this help text and exit."

Definition at line 916 of file creator_args.cc.

◆ arg_handle_print_help_doc_win32

const char arg_handle_print_help_doc_win32[]
static
Initial value:
=
"\n\t"
"Print this help text and exit (Windows only)."

Definition at line 919 of file creator_args.cc.

◆ arg_handle_print_version_doc

const char arg_handle_print_version_doc[]
static
Initial value:
=
"\n\t"
"Print Blender version and exit."

Definition at line 624 of file creator_args.cc.

◆ arg_handle_profile_gpu_set_doc

const char arg_handle_profile_gpu_set_doc[]
static
Initial value:
=
"\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)"

Definition at line 2518 of file creator_args.cc.

◆ arg_handle_python_console_run_doc

const char arg_handle_python_console_run_doc[]
static
Initial value:
=
"\n\t"
"Run Blender with an interactive console."

Definition at line 2430 of file creator_args.cc.

◆ arg_handle_python_exit_code_set_doc

const char arg_handle_python_exit_code_set_doc[]
static
Initial value:
=
"<code>\n"
"\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."

Definition at line 2447 of file creator_args.cc.

◆ arg_handle_python_expr_run_doc

const char arg_handle_python_expr_run_doc[]
static
Initial value:
=
"<expression>\n"
"\tRun the given expression as a Python script."

Definition at line 2403 of file creator_args.cc.

◆ arg_handle_python_file_run_doc

const char arg_handle_python_file_run_doc[]
static
Initial value:
=
"<filepath>\n"
"\tRun the given Python script file."

Definition at line 2332 of file creator_args.cc.

◆ arg_handle_python_set_doc_disable

const char arg_handle_python_set_doc_disable[]
static
Initial value:
=
"\n\t"
"Disable automatic Python script execution "
"(Python-drivers & startup scripts)" PY_DISABLE_AUTO "."
PY_DISABLE_AUTO
#define PY_DISABLE_AUTO
Definition creator_args.cc:949

Definition at line 955 of file creator_args.cc.

◆ arg_handle_python_set_doc_enable

const char arg_handle_python_set_doc_enable[]
static
Initial value:
=
"\n\t"
"Enable automatic Python script execution" PY_ENABLE_AUTO "."
PY_ENABLE_AUTO
#define PY_ENABLE_AUTO
Definition creator_args.cc:948

Definition at line 952 of file creator_args.cc.

◆ arg_handle_python_text_run_doc

const char arg_handle_python_text_run_doc[]
static
Initial value:
=
"<name>\n"
"\tRun the given Python script text block."

Definition at line 2364 of file creator_args.cc.

◆ arg_handle_python_use_system_env_set_doc

const char arg_handle_python_use_system_env_set_doc[]
static
Initial value:
=
"\n\t"
"Allow Python to use system environment variables such as 'PYTHONPATH' and the user "
"site-packages directory."

Definition at line 2476 of file creator_args.cc.

◆ arg_handle_quiet_set_doc

const char arg_handle_quiet_set_doc[]
static
Initial value:
=
"\n\t"
"Suppress status printing (warnings & errors are still printed)."

Definition at line 1030 of file creator_args.cc.

◆ arg_handle_register_extension_all_doc

const char arg_handle_register_extension_all_doc[]
static
Initial value:
=
"\n\t"
"Register blend-file extension for all users, then exit (Windows & Linux only)."

Definition at line 1836 of file creator_args.cc.

◆ arg_handle_register_extension_doc

const char arg_handle_register_extension_doc[]
static
Initial value:
=
"\n\t"
"Register blend-file extension for current user, then exit (Windows & Linux only)."

Definition at line 1818 of file creator_args.cc.

◆ arg_handle_render_animation_doc

const char arg_handle_render_animation_doc[]
static
Initial value:
=
"\n\t"
"Render frames from start to end (inclusive)."

Definition at line 2187 of file creator_args.cc.

◆ arg_handle_render_frame_doc

const char arg_handle_render_frame_doc[]
static
Initial value:
=
"<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"
"\t* A range of frames can be expressed using '..' separator between the first and last "
"frames (inclusive).\n"

Definition at line 2127 of file creator_args.cc.

◆ arg_handle_scene_set_doc

const char arg_handle_scene_set_doc[]
static
Initial value:
=
"<name>\n"
"\tSet the active scene <name> for rendering."

Definition at line 2211 of file creator_args.cc.

◆ arg_handle_start_with_console_doc

const char arg_handle_start_with_console_doc[]
static
Initial value:
=
"\n\t"
"Start with the console window open (ignored if '-b' is set), (Windows only)."

Definition at line 1784 of file creator_args.cc.

◆ arg_handle_threads_set_doc

const char arg_handle_threads_set_doc[]
static
Initial value:
=
"<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."
BLENDER_MAX_THREADS
#define BLENDER_MAX_THREADS
Definition BLI_threads.h:16
STRINGIFY
#define STRINGIFY(x)
Definition BLI_utildefines.h:414

Definition at line 2034 of file creator_args.cc.

◆ arg_handle_unregister_extension_all_doc

const char arg_handle_unregister_extension_all_doc[]
static
Initial value:
=
"\n\t"
"Unregister blend-file extension for all users, then exit (Windows & Linux only)."

Definition at line 1872 of file creator_args.cc.

◆ arg_handle_unregister_extension_doc

const char arg_handle_unregister_extension_doc[]
static
Initial value:
=
"\n\t"
"Unregister blend-file extension for current user, then exit (Windows & Linux only)."

Definition at line 1854 of file creator_args.cc.

◆ arg_handle_verbosity_set_doc

const char arg_handle_verbosity_set_doc[]
static
Initial value:
=
"<verbose>\n"
"\tSet the logging verbosity level for debug messages that support it."

Definition at line 2067 of file creator_args.cc.

◆ arg_handle_window_geometry_doc

const char arg_handle_window_geometry_doc[]
static
Initial value:
=
"<sx> <sy> <w> <h>\n"
"\tOpen with lower left corner at <sx>, <sy> and width and height as <w>, <h>."

Definition at line 1713 of file creator_args.cc.

◆ arg_handle_window_maximized_doc

const char arg_handle_window_maximized_doc[]
static
Initial value:
=
"\n\t"
"Force opening maximized."

Definition at line 1766 of file creator_args.cc.

◆ arg_handle_with_borders_doc

const char arg_handle_with_borders_doc[]
static
Initial value:
=
"\n\t"
"Force opening with borders."

Definition at line 1748 of file creator_args.cc.

◆ arg_handle_without_borders_doc

const char arg_handle_without_borders_doc[]
static
Initial value:
=
"\n\t"
"Force opening in full-screen mode."

Definition at line 1757 of file creator_args.cc.

Generated on for Blender by  doxygen 1.16.1