tornavis/source/blender/makesdna/DNA_userdef_types.h

1404 lines
39 KiB
C

/* SPDX-License-Identifier: GPL-2.0-or-later
* Copyright 2001-2002 NaN Holding BV. All rights reserved. */
/** \file
* \ingroup DNA
*/
#pragma once
#include "DNA_listBase.h"
#include "DNA_texture_types.h" /* ColorBand */
#include "DNA_userdef_enums.h"
#ifdef __cplusplus
extern "C" {
#endif
/* Themes; defines in `BIF_resource.h`. */
struct ColorBand;
/* ************************ style definitions ******************** */
#define MAX_STYLE_NAME 64
/**
* Default offered by Blender.
* #uiFont.uifont_id
*/
typedef enum eUIFont_ID {
UIFONT_DEFAULT = 0,
/* UIFONT_BITMAP = 1 */ /* UNUSED */
/* free slots */
UIFONT_CUSTOM1 = 2,
/* UIFONT_CUSTOM2 = 3, */ /* UNUSED */
} eUIFont_ID;
/**
* Default fonts to load/initialize.
* First font is the default (index 0), others optional.
*/
#
#
typedef struct uiFont {
struct uiFont *next, *prev;
/** 1024 = FILE_MAX. */
char filepath[1024];
/** From blfont lib. */
short blf_id;
/** Own id (eUIFont_ID). */
short uifont_id;
} uiFont;
/** This state defines appearance of text. */
typedef struct uiFontStyle {
/** Saved in file, 0 is default. */
short uifont_id;
char _pad1[2];
/** Actual size depends on 'global' DPI. */
float points;
/** Style hint. */
short italic, bold;
/** Value is amount of pixels blur. */
short shadow;
/** Shadow offset in pixels. */
short shadx, shady;
char _pad0[2];
/** Total alpha. */
float shadowalpha;
/** 1 value, typically white or black anyway. */
float shadowcolor;
char _pad2[4];
} uiFontStyle;
/* this is fed to the layout engine and widget code */
typedef struct uiStyle {
struct uiStyle *next, *prev;
/** MAX_STYLE_NAME. */
char name[64];
uiFontStyle paneltitle;
uiFontStyle grouplabel;
uiFontStyle widgetlabel;
uiFontStyle widget;
float panelzoom;
/** In characters. */
short minlabelchars;
/** In characters. */
short minwidgetchars;
short columnspace;
short templatespace;
short boxspace;
short buttonspacex;
short buttonspacey;
short panelspace;
short panelouter;
char _pad0[2];
} uiStyle;
typedef struct uiWidgetColors {
unsigned char outline[4];
unsigned char inner[4];
unsigned char inner_sel[4];
unsigned char item[4];
unsigned char text[4];
unsigned char text_sel[4];
unsigned char shaded;
char _pad0[7];
short shadetop, shadedown;
float roundness;
} uiWidgetColors;
typedef struct uiWidgetStateColors {
unsigned char inner_anim[4];
unsigned char inner_anim_sel[4];
unsigned char inner_key[4];
unsigned char inner_key_sel[4];
unsigned char inner_driven[4];
unsigned char inner_driven_sel[4];
unsigned char inner_overridden[4];
unsigned char inner_overridden_sel[4];
unsigned char inner_changed[4];
unsigned char inner_changed_sel[4];
float blend;
char _pad0[4];
} uiWidgetStateColors;
typedef struct uiPanelColors {
unsigned char header[4];
unsigned char back[4];
unsigned char sub_back[4];
char _pad0[4];
} uiPanelColors;
typedef struct ThemeUI {
/* Interface Elements (buttons, menus, icons) */
uiWidgetColors wcol_regular, wcol_tool, wcol_toolbar_item, wcol_text;
uiWidgetColors wcol_radio, wcol_option, wcol_toggle;
uiWidgetColors wcol_num, wcol_numslider, wcol_tab;
uiWidgetColors wcol_menu, wcol_pulldown, wcol_menu_back, wcol_menu_item, wcol_tooltip;
uiWidgetColors wcol_box, wcol_scroll, wcol_progress, wcol_list_item, wcol_pie_menu;
uiWidgetStateColors wcol_state;
unsigned char widget_emboss[4];
/* fac: 0 - 1 for blend factor, width in pixels */
float menu_shadow_fac;
short menu_shadow_width;
unsigned char editor_outline[4];
/* Transparent Grid */
unsigned char transparent_checker_primary[4], transparent_checker_secondary[4];
unsigned char transparent_checker_size;
char _pad1[1];
float icon_alpha;
float icon_saturation;
unsigned char widget_text_cursor[4];
/* Axis Colors */
unsigned char xaxis[4], yaxis[4], zaxis[4];
/* Gizmo Colors. */
unsigned char gizmo_hi[4];
unsigned char gizmo_primary[4];
unsigned char gizmo_secondary[4];
unsigned char gizmo_view_align[4];
unsigned char gizmo_a[4];
unsigned char gizmo_b[4];
/* Icon Colors. */
/** Scene items. */
unsigned char icon_scene[4];
/** Collection items. */
unsigned char icon_collection[4];
/** Object items. */
unsigned char icon_object[4];
/** Object data items. */
unsigned char icon_object_data[4];
/** Modifier and constraint items. */
unsigned char icon_modifier[4];
/** Shading related items. */
unsigned char icon_shading[4];
/** File folders. */
unsigned char icon_folder[4];
/** Intensity of the border icons. >0 will render an border around themed
* icons. */
float icon_border_intensity;
float panel_roundness;
char _pad2[4];
} ThemeUI;
/* try to put them all in one, if needed a special struct can be created as well
* for example later on, when we introduce wire colors for ob types or so...
*/
typedef struct ThemeSpace {
/* main window colors */
unsigned char back[4];
unsigned char back_grad[4];
char background_type;
char _pad0[3];
/** Panel title. */
unsigned char title[4];
unsigned char text[4];
unsigned char text_hi[4];
/* header colors */
/** Region background. */
unsigned char header[4];
/** Unused. */
unsigned char header_title[4];
unsigned char header_text[4];
unsigned char header_text_hi[4];
/* region tabs */
unsigned char tab_active[4];
unsigned char tab_inactive[4];
unsigned char tab_back[4];
unsigned char tab_outline[4];
/* button/tool regions */
/** Region background. */
unsigned char button[4];
/** Panel title. */
unsigned char button_title[4];
unsigned char button_text[4];
unsigned char button_text_hi[4];
/* listview regions */
/** Region background. */
unsigned char list[4];
/** Panel title. */
unsigned char list_title[4];
unsigned char list_text[4];
unsigned char list_text_hi[4];
/* navigation bar regions */
/** Region background. */
unsigned char navigation_bar[4];
/** Region background. */
unsigned char execution_buts[4];
/* NOTE: cannot use name 'panel' because of DNA mapping old files. */
uiPanelColors panelcolors;
unsigned char shade1[4];
unsigned char shade2[4];
unsigned char hilite[4];
unsigned char grid[4];
unsigned char view_overlay[4];
unsigned char wire[4], wire_edit[4], select[4];
unsigned char lamp[4], speaker[4], empty[4], camera[4];
unsigned char active[4], group[4], group_active[4], transform[4];
unsigned char vertex[4], vertex_select[4], vertex_active[4], vertex_bevel[4],
vertex_unreferenced[4];
unsigned char edge[4], edge_select[4];
unsigned char edge_seam[4], edge_sharp[4], edge_facesel[4], edge_crease[4], edge_bevel[4];
/** Solid faces. */
unsigned char face[4], face_select[4], face_back[4], face_front[4];
/** Selected color. */
unsigned char face_dot[4];
unsigned char extra_edge_len[4], extra_edge_angle[4], extra_face_angle[4], extra_face_area[4];
unsigned char normal[4];
unsigned char vertex_normal[4];
unsigned char loop_normal[4];
unsigned char bone_solid[4], bone_pose[4], bone_pose_active[4], bone_locked_weight[4];
unsigned char strip[4], strip_select[4];
unsigned char cframe[4];
unsigned char time_keyframe[4], time_gp_keyframe[4];
unsigned char freestyle_edge_mark[4], freestyle_face_mark[4];
unsigned char time_scrub_background[4];
unsigned char time_marker_line[4], time_marker_line_selected[4];
unsigned char nurb_uline[4], nurb_vline[4];
unsigned char act_spline[4], nurb_sel_uline[4], nurb_sel_vline[4], lastsel_point[4];
unsigned char handle_free[4], handle_auto[4], handle_vect[4], handle_align[4],
handle_auto_clamped[4];
unsigned char handle_sel_free[4], handle_sel_auto[4], handle_sel_vect[4], handle_sel_align[4],
handle_sel_auto_clamped[4];
/** Dopesheet. */
unsigned char ds_channel[4], ds_subchannel[4], ds_ipoline[4];
/** Keytypes. */
unsigned char keytype_keyframe[4], keytype_extreme[4], keytype_breakdown[4], keytype_jitter[4],
keytype_movehold[4];
/** Keytypes. */
unsigned char keytype_keyframe_select[4], keytype_extreme_select[4], keytype_breakdown_select[4],
keytype_jitter_select[4], keytype_movehold_select[4];
unsigned char keyborder[4], keyborder_select[4];
char _pad4[3];
unsigned char console_output[4], console_input[4], console_info[4], console_error[4];
unsigned char console_cursor[4], console_select[4];
unsigned char vertex_size, outline_width, obcenter_dia, facedot_size;
unsigned char noodle_curving;
unsigned char grid_levels;
char _pad5[3];
float dash_alpha;
/* syntax for textwindow and nodes */
unsigned char syntaxl[4], syntaxs[4]; /* in nodespace used for backdrop matte */
unsigned char syntaxb[4], syntaxn[4]; /* in nodespace used for color input */
unsigned char syntaxv[4], syntaxc[4]; /* in nodespace used for converter group */
unsigned char syntaxd[4], syntaxr[4]; /* in nodespace used for distort */
unsigned char line_numbers[4];
char _pad6[3];
unsigned char nodeclass_output[4], nodeclass_filter[4];
unsigned char nodeclass_vector[4], nodeclass_texture[4];
unsigned char nodeclass_shader[4], nodeclass_script[4];
unsigned char nodeclass_pattern[4], nodeclass_layout[4];
unsigned char nodeclass_geometry[4], nodeclass_attribute[4];
/** For sequence editor. */
unsigned char movie[4], movieclip[4], mask[4], image[4], scene[4], audio[4];
unsigned char effect[4], transition[4], meta[4], text_strip[4], color_strip[4];
unsigned char active_strip[4], selected_strip[4];
/** For dopesheet - scale factor for size of keyframes (i.e. height of channels). */
char _pad7[1];
float keyframe_scale_fac;
unsigned char editmesh_active[4];
unsigned char handle_vertex[4];
unsigned char handle_vertex_select[4];
unsigned char handle_vertex_size;
unsigned char clipping_border_3d[4];
unsigned char marker_outline[4], marker[4], act_marker[4], sel_marker[4], dis_marker[4],
lock_marker[4];
unsigned char bundle_solid[4];
unsigned char path_before[4], path_after[4];
unsigned char path_keyframe_before[4], path_keyframe_after[4];
unsigned char camera_path[4];
unsigned char _pad1[6];
unsigned char gp_vertex_size;
unsigned char gp_vertex[4], gp_vertex_select[4];
unsigned char preview_back[4];
unsigned char preview_stitch_face[4];
unsigned char preview_stitch_edge[4];
unsigned char preview_stitch_vert[4];
unsigned char preview_stitch_stitchable[4];
unsigned char preview_stitch_unstitchable[4];
unsigned char preview_stitch_active[4];
/** Two uses, for uvs with modifier applied on mesh and uvs during painting. */
unsigned char uv_shadow[4];
/** Search filter match, used for property search and in the outliner. */
unsigned char match[4];
/** Outliner - selected item. */
unsigned char selected_highlight[4];
/** Outliner - selected object. */
unsigned char selected_object[4];
/** Outliner - active object. */
unsigned char active_object[4];
/** Outliner - edited object. */
unsigned char edited_object[4];
/** Outliner - row color difference. */
unsigned char row_alternate[4];
/** Skin modifier root color. */
unsigned char skin_root[4];
/* NLA */
/** Active Action + Summary Channel. */
unsigned char anim_active[4];
/** Active Action = NULL. */
unsigned char anim_non_active[4];
/** Preview range overlay. */
unsigned char anim_preview_range[4];
/** NLA 'Tweaking' action/strip. */
unsigned char nla_tweaking[4];
/** NLA - warning color for duplicate instances of tweaking strip. */
unsigned char nla_tweakdupli[4];
/** NLA "Track" */
unsigned char nla_track[4];
/** NLA "Transition" strips. */
unsigned char nla_transition[4], nla_transition_sel[4];
/** NLA "Meta" strips. */
unsigned char nla_meta[4], nla_meta_sel[4];
/** NLA "Sound" strips. */
unsigned char nla_sound[4], nla_sound_sel[4];
/* info */
unsigned char info_selected[4], info_selected_text[4];
unsigned char info_error[4], info_error_text[4];
unsigned char info_warning[4], info_warning_text[4];
unsigned char info_info[4], info_info_text[4];
unsigned char info_debug[4], info_debug_text[4];
unsigned char info_property[4], info_property_text[4];
unsigned char info_operator[4], info_operator_text[4];
unsigned char paint_curve_pivot[4];
unsigned char paint_curve_handle[4];
unsigned char metadatabg[4];
unsigned char metadatatext[4];
} ThemeSpace;
/* Viewport Background Gradient Types. */
typedef enum eBackgroundGradientTypes {
TH_BACKGROUND_SINGLE_COLOR = 0,
TH_BACKGROUND_GRADIENT_LINEAR = 1,
TH_BACKGROUND_GRADIENT_RADIAL = 2,
} eBackgroundGradientTypes;
/** Set of colors for use as a custom color set for Objects/Bones wire drawing. */
typedef struct ThemeWireColor {
unsigned char solid[4];
unsigned char select[4];
unsigned char active[4];
/** #eWireColor_Flags. */
short flag;
char _pad0[2];
} ThemeWireColor;
/** #ThemeWireColor.flag */
typedef enum eWireColor_Flags {
TH_WIRECOLOR_CONSTCOLS = (1 << 0),
/* TH_WIRECOLOR_TEXTCOLS = (1 << 1), */ /* UNUSED */
} eWireColor_Flags;
typedef struct ThemeCollectionColor {
unsigned char color[4];
} ThemeCollectionColor;
typedef struct ThemeStripColor {
unsigned char color[4];
} ThemeStripColor;
/**
* A theme.
*
* \note Currently only a single theme is ever used at once.
* Different theme presets are stored as external files now.
*/
typedef struct bTheme {
struct bTheme *next, *prev;
char name[32];
ThemeUI tui;
/**
* Individual Spacetypes:
* \note Ensure #UI_THEMESPACE_END is updated when adding.
*/
ThemeSpace space_properties;
ThemeSpace space_view3d;
ThemeSpace space_file;
ThemeSpace space_graph;
ThemeSpace space_info;
ThemeSpace space_action;
ThemeSpace space_nla;
ThemeSpace space_sequencer;
ThemeSpace space_image;
ThemeSpace space_text;
ThemeSpace space_outliner;
ThemeSpace space_node;
ThemeSpace space_preferences;
ThemeSpace space_console;
ThemeSpace space_clip;
ThemeSpace space_topbar;
ThemeSpace space_statusbar;
ThemeSpace space_spreadsheet;
/* 20 sets of bone colors for this theme */
ThemeWireColor tarm[20];
// ThemeWireColor tobj[20];
/* See COLLECTION_COLOR_TOT for the number of collection colors. */
ThemeCollectionColor collection_color[8];
/* See SEQUENCE_COLOR_TOT for the total number of strip colors. */
ThemeStripColor strip_color[9];
int active_theme_area;
} bTheme;
#define UI_THEMESPACE_START(btheme) \
(CHECK_TYPE_INLINE(btheme, bTheme *), &((btheme)->space_properties))
#define UI_THEMESPACE_END(btheme) \
(CHECK_TYPE_INLINE(btheme, bTheme *), (&((btheme)->space_spreadsheet) + 1))
typedef struct bAddon {
struct bAddon *next, *prev;
char module[64];
/** User-Defined Properties on this add-on (for storing preferences). */
IDProperty *prop;
} bAddon;
typedef struct bPathCompare {
struct bPathCompare *next, *prev;
/** FILE_MAXDIR. */
char path[768];
char flag;
char _pad0[7];
} bPathCompare;
typedef struct bUserMenu {
struct bUserMenu *next, *prev;
char space_type;
char _pad0[7];
char context[64];
/* bUserMenuItem */
ListBase items;
} bUserMenu;
/** May be part of #bUserMenu or other list. */
typedef struct bUserMenuItem {
struct bUserMenuItem *next, *prev;
char ui_name[64];
char type;
char _pad0[7];
} bUserMenuItem;
typedef struct bUserMenuItem_Op {
bUserMenuItem item;
char op_idname[64];
struct IDProperty *prop;
char opcontext; /* #wmOperatorCallContext */
char _pad0[7];
} bUserMenuItem_Op;
typedef struct bUserMenuItem_Menu {
bUserMenuItem item;
char mt_idname[64];
} bUserMenuItem_Menu;
typedef struct bUserMenuItem_Prop {
bUserMenuItem item;
char context_data_path[256];
char prop_id[64];
int prop_index;
char _pad0[4];
} bUserMenuItem_Prop;
enum {
USER_MENU_TYPE_SEP = 1,
USER_MENU_TYPE_OPERATOR = 2,
USER_MENU_TYPE_MENU = 3,
USER_MENU_TYPE_PROP = 4,
};
typedef struct bUserAssetLibrary {
struct bUserAssetLibrary *next, *prev;
char name[64]; /* MAX_NAME */
char path[1024]; /* FILE_MAX */
} bUserAssetLibrary;
typedef struct SolidLight {
int flag;
float smooth;
char _pad0[8];
float col[4], spec[4], vec[4];
} SolidLight;
typedef struct WalkNavigation {
/** Speed factor for look around. */
float mouse_speed;
float walk_speed;
float walk_speed_factor;
float view_height;
float jump_height;
/** Duration to use for teleporting. */
float teleport_time;
short flag;
char _pad0[6];
} WalkNavigation;
typedef struct UserDef_Runtime {
/** Mark as changed so the preferences are saved on exit. */
char is_dirty;
char _pad0[7];
} UserDef_Runtime;
/**
* Store UI data here instead of the space
* since the space is typically a window which is freed.
*/
typedef struct UserDef_SpaceData {
char section_active;
/** #eUserPref_SpaceData_Flag UI options. */
char flag;
char _pad0[6];
} UserDef_SpaceData;
/**
* Storage for UI data that to keep it even after the window was closed. (Similar to
* #UserDef_SpaceData.)
*/
typedef struct UserDef_FileSpaceData {
int display_type; /* FileSelectParams.display */
int thumbnail_size; /* FileSelectParams.thumbnail_size */
int sort_type; /* FileSelectParams.sort */
int details_flags; /* FileSelectParams.details_flags */
int flag; /* FileSelectParams.flag */
int _pad0;
uint64_t filter_id; /* FileSelectParams.filter_id */
/** Info used when creating the file browser in a temporary window. */
int temp_win_sizex;
int temp_win_sizey;
} UserDef_FileSpaceData;
typedef struct UserDef_Experimental {
/* Debug options, always available. */
char use_undo_legacy;
char no_override_auto_resync;
char use_cycles_debug;
char show_asset_debug_info;
char no_asset_indexing;
char SANITIZE_AFTER_HERE;
/* The following options are automatically sanitized (set to 0)
* when the release cycle is not alpha. */
char use_new_curves_type;
/** Only available when #use_new_curves_type is enabled. */
char use_new_curves_tools;
char use_new_point_cloud_type;
char use_full_frame_compositor;
char use_sculpt_tools_tilt;
char use_extended_asset_browser;
char use_override_templates;
char enable_eevee_next;
char use_sculpt_texture_paint;
char use_draw_manager_acquire_lock;
/** `makesdna` does not allow empty structs. */
} UserDef_Experimental;
#define USER_EXPERIMENTAL_TEST(userdef, member) \
(((userdef)->flag & USER_DEVELOPER_UI) && ((userdef)->experimental).member)
typedef struct UserDef {
/** UserDef has separate do-version handling, and can be read from other files. */
int versionfile, subversionfile;
/** #eUserPref_Flag. */
int flag;
/** #eDupli_ID_Flags. */
unsigned int dupflag;
/** #eUserPref_PrefFlag preferences for the preferences. */
char pref_flag;
char savetime;
char mouse_emulate_3_button_modifier;
char _pad4[1];
/** FILE_MAXDIR length. */
char tempdir[768];
char fontdir[768];
/** FILE_MAX length. */
char renderdir[1024];
/* EXR cache path */
/** 768 = FILE_MAXDIR. */
char render_cachedir[768];
char textudir[768];
/**
* Optional user location for scripts.
*
* This supports the same layout as Blender's scripts directory `release/scripts`.
*
* \note Unlike most paths, changing this is not fully supported at run-time,
* requiring a restart to properly take effect. Supporting this would cause complications as
* the script path can contain `startup`, `addons` & `modules` etc. properly unwinding the
* Python environment to the state it _would_ have been in gets complicated.
*
* Although this is partially supported as the `sys.path` is refreshed when loading preferences.
* This is done to support #PREFERENCES_OT_copy_prev which is available to the user when they
* launch with a new version of Blender. In this case setting the script path on top of
* factory settings will work without problems.
*/
char pythondir[768];
char sounddir[768];
char i18ndir[768];
/** 1024 = FILE_MAX. */
char image_editor[1024];
/** 1024 = FILE_MAX. */
char anim_player[1024];
int anim_player_preset;
/** Minimum spacing between grid-lines in View2D grids. */
short v2d_min_gridsize;
/** #eTimecodeStyles, style of time-code display. */
short timecode_style;
short versions;
short dbl_click_time;
char _pad0[3];
char mini_axis_type;
/** #eUserpref_UI_Flag. */
int uiflag;
/** #eUserpref_UI_Flag2. */
char uiflag2;
char gpu_flag;
char _pad8[6];
/* Experimental flag for app-templates to make changes to behavior
* which are outside the scope of typical preferences. */
char app_flag;
char viewzoom;
short language;
int mixbufsize;
int audiodevice;
int audiorate;
int audioformat;
int audiochannels;
/** Setting for UI scale (fractional), before screen DPI has been applied. */
float ui_scale;
/** Setting for UI line width. */
int ui_line_width;
/** Runtime, full DPI divided by `pixelsize`. */
int dpi;
/** Runtime, multiplier to scale UI elements based on DPI (fractional). */
float dpi_fac;
/** Runtime, `1.0 / dpi_fac` */
float inv_dpi_fac;
/** Runtime, calculated from line-width and point-size based on DPI (rounded to int). */
float pixelsize;
/** Deprecated, for forward compatibility. */
int virtual_pixel;
/** Console scroll-back limit. */
int scrollback;
/** Node insert offset (aka auto-offset) margin, but might be useful for later stuff as well. */
char node_margin;
char _pad2[1];
/** #eUserpref_Translation_Flags. */
short transopts;
short menuthreshold1, menuthreshold2;
/** Startup application template. */
char app_template[64];
struct ListBase themes;
struct ListBase uifonts;
struct ListBase uistyles;
struct ListBase user_keymaps;
/** #wmKeyConfigPref. */
struct ListBase user_keyconfig_prefs;
struct ListBase addons;
struct ListBase autoexec_paths;
/** #bUserMenu. */
struct ListBase user_menus;
/** #bUserAssetLibrary */
struct ListBase asset_libraries;
char keyconfigstr[64];
short undosteps;
char _pad1[2];
int undomemory;
float gpu_viewport_quality DNA_DEPRECATED;
short gp_manhattandist, gp_euclideandist, gp_eraser;
/** #eGP_UserdefSettings. */
short gp_settings;
char _pad13[4];
struct SolidLight light_param[4];
float light_ambient[3];
char gizmo_flag;
/** Generic gizmo size. */
char gizmo_size;
/** Navigate gizmo size. */
char gizmo_size_navigate_v3d;
char _pad3[5];
short edit_studio_light;
short lookdev_sphere_size;
short vbotimeout, vbocollectrate;
short textimeout, texcollectrate;
int memcachelimit;
/** Unused. */
int prefetchframes;
/** Control the rotation step of the view when PAD2, PAD4, PAD6&PAD8 is use. */
float pad_rot_angle;
char _pad12[4];
/** Rotating view icon size. */
short rvisize;
/** Rotating view icon brightness. */
short rvibright;
/** Maximum number of recently used files to remember. */
short recent_files;
/** Milliseconds to spend spinning the view. */
short smooth_viewtx;
short glreslimit;
/** #eColorPicker_Types. */
short color_picker_type;
/** Curve smoothing type for newly added F-Curves. */
char auto_smoothing_new;
/** Interpolation mode for newly added F-Curves. */
char ipo_new;
/** Handle types for newly added keyframes. */
char keyhandles_new;
char _pad11[4];
/** #eZoomFrame_Mode. */
char view_frame_type;
/** Number of keyframes to zoom around current frame. */
int view_frame_keyframes;
/** Seconds to zoom around current frame. */
float view_frame_seconds;
char _pad7[6];
/** Private, defaults to 20 for 72 DPI setting. */
short widget_unit;
short anisotropic_filter;
/** Tablet API to use (Windows only). */
short tablet_api;
/** Raw tablet pressure that maps to 100%. */
float pressure_threshold_max;
/** Curve non-linearity parameter. */
float pressure_softness;
/** Overall sensitivity of 3D mouse. */
float ndof_sensitivity;
float ndof_orbit_sensitivity;
/** Dead-zone of 3D mouse. */
float ndof_deadzone;
/** #eNdof_Flag, flags for 3D mouse. */
int ndof_flag;
/** #eMultiSample_Type, amount of samples for OpenGL FSA, if zero no FSA. */
short ogl_multisamples;
/** eImageDrawMethod, Method to be used to draw the images
* (AUTO, GLSL, Textures or DrawPixels) */
short image_draw_method;
float glalphaclip;
/** #eAutokey_Mode, autokeying mode. */
short autokey_mode;
/** Flags for autokeying. */
short autokey_flag;
/** Flags for animation. */
short animation_flag;
/** Options for text rendering. */
char text_render;
char navigation_mode;
/** Turn-table rotation amount per-pixel in radians. Scaled with DPI. */
float view_rotate_sensitivity_turntable;
/** Track-ball rotation scale. */
float view_rotate_sensitivity_trackball;
/** From texture.h. */
struct ColorBand coba_weight;
float sculpt_paint_overlay_col[3];
/** Default color for newly created Grease Pencil layers. */
float gpencil_new_layer_col[4];
/** Drag pixels (scaled by DPI). */
char drag_threshold_mouse;
char drag_threshold_tablet;
char drag_threshold;
char move_threshold;
char font_path_ui[1024];
char font_path_ui_mono[1024];
/** Legacy, for backwards compatibility only. */
int compute_device_type;
/** Opacity of inactive F-Curves in F-Curve Editor. */
float fcu_inactive_alpha;
/**
* If keeping a pie menu spawn button pressed after this time,
* it turns into a drag/release pie menu.
*/
short pie_tap_timeout;
/**
* Direction in the pie menu will always be calculated from the
* initial position within this time limit.
*/
short pie_initial_timeout;
short pie_animation_timeout;
short pie_menu_confirm;
/** Pie menu radius. */
short pie_menu_radius;
/** Pie menu distance from center before a direction is set. */
short pie_menu_threshold;
short opensubdiv_compute_type;
short _pad6;
char factor_display_type;
char viewport_aa;
char render_display_type; /* eUserpref_RenderDisplayType */
char filebrowser_display_type; /* eUserpref_TempSpaceDisplayType */
char sequencer_disk_cache_dir[1024];
int sequencer_disk_cache_compression; /* eUserpref_DiskCacheCompression */
int sequencer_disk_cache_size_limit;
short sequencer_disk_cache_flag;
short sequencer_proxy_setup; /* eUserpref_SeqProxySetup */
float collection_instance_empty_size;
char text_flag;
char _pad10[1];
char file_preview_type; /* eUserpref_File_Preview_Type */
char statusbar_flag; /* eUserpref_StatusBar_Flag */
struct WalkNavigation walk_navigation;
/** The UI for the user preferences. */
UserDef_SpaceData space_data;
UserDef_FileSpaceData file_space_data;
UserDef_Experimental experimental;
/** Runtime data (keep last). */
UserDef_Runtime runtime;
} UserDef;
/** From blenkernel `blender.c`. */
extern UserDef U;
/* ***************** USERDEF ****************** */
/* Toggles for unfinished 2.8 UserPref design. */
//#define WITH_USERDEF_WORKSPACES
/** #UserDef_SpaceData.section_active (UI active_section) */
typedef enum eUserPref_Section {
USER_SECTION_INTERFACE = 0,
USER_SECTION_EDITING = 1,
USER_SECTION_SAVE_LOAD = 2,
USER_SECTION_SYSTEM = 3,
USER_SECTION_THEME = 4,
USER_SECTION_INPUT = 5,
USER_SECTION_ADDONS = 6,
USER_SECTION_LIGHT = 7,
USER_SECTION_KEYMAP = 8,
#ifdef WITH_USERDEF_WORKSPACES
USER_SECTION_WORKSPACE_CONFIG = 9,
USER_SECTION_WORKSPACE_ADDONS = 10,
USER_SECTION_WORKSPACE_KEYMAPS = 11,
#endif
USER_SECTION_VIEWPORT = 12,
USER_SECTION_ANIMATION = 13,
USER_SECTION_NAVIGATION = 14,
USER_SECTION_FILE_PATHS = 15,
USER_SECTION_EXPERIMENTAL = 16,
} eUserPref_Section;
/** #UserDef_SpaceData.flag (State of the user preferences UI). */
typedef enum eUserPref_SpaceData_Flag {
/** Hide/expand key-map preferences. */
USER_SPACEDATA_INPUT_HIDE_UI_KEYCONFIG = (1 << 0),
USER_SPACEDATA_ADDONS_SHOW_ONLY_ENABLED = (1 << 1),
} eUserPref_SpaceData_Flag;
/** #UserDef.flag */
typedef enum eUserPref_Flag {
USER_AUTOSAVE = (1 << 0),
USER_FLAG_NUMINPUT_ADVANCED = (1 << 1),
USER_FLAG_UNUSED_2 = (1 << 2), /* cleared */
USER_FLAG_UNUSED_3 = (1 << 3), /* cleared */
USER_FLAG_UNUSED_4 = (1 << 4), /* cleared */
USER_TRACKBALL = (1 << 5),
USER_FLAG_UNUSED_6 = (1 << 6), /* cleared */
USER_FLAG_UNUSED_7 = (1 << 7), /* cleared */
USER_MAT_ON_OB = (1 << 8),
USER_FLAG_UNUSED_9 = (1 << 9), /* cleared */
USER_DEVELOPER_UI = (1 << 10),
USER_TOOLTIPS = (1 << 11),
USER_TWOBUTTONMOUSE = (1 << 12),
USER_NONUMPAD = (1 << 13),
USER_ADD_CURSORALIGNED = (1 << 14),
USER_FILECOMPRESS = (1 << 15),
USER_FLAG_UNUSED_5 = (1 << 16), /* dirty */
USER_CUSTOM_RANGE = (1 << 17),
USER_ADD_EDITMODE = (1 << 18),
USER_ADD_VIEWALIGNED = (1 << 19),
USER_RELPATHS = (1 << 20),
USER_RELEASECONFIRM = (1 << 21),
USER_SCRIPT_AUTOEXEC_DISABLE = (1 << 22),
USER_FILENOUI = (1 << 23),
USER_NONEGFRAMES = (1 << 24),
USER_TXT_TABSTOSPACES_DISABLE = (1 << 25),
USER_TOOLTIPS_PYTHON = (1 << 26),
USER_FLAG_UNUSED_27 = (1 << 27), /* dirty */
} eUserPref_Flag;
/** #UserDef.file_preview_type */
typedef enum eUserpref_File_Preview_Type {
USER_FILE_PREVIEW_NONE = 0,
USER_FILE_PREVIEW_AUTO,
USER_FILE_PREVIEW_SCREENSHOT,
USER_FILE_PREVIEW_CAMERA,
} eUserpref_File_Preview_Type;
typedef enum eUserPref_PrefFlag {
USER_PREF_FLAG_SAVE = (1 << 0),
} eUserPref_PrefFlag;
/** #bPathCompare.flag */
typedef enum ePathCompare_Flag {
USER_PATHCMP_GLOB = (1 << 0),
} ePathCompare_Flag;
/* Helper macro for checking frame clamping */
#define FRAMENUMBER_MIN_CLAMP(cfra) \
{ \
if ((U.flag & USER_NONEGFRAMES) && (cfra < 0)) { \
cfra = 0; \
} \
} \
(void)0
/** #UserDef.viewzoom */
typedef enum eViewZoom_Style {
/** Update zoom continuously with a timer while dragging the cursor. */
USER_ZOOM_CONTINUE = 0,
/** Map changes in distance from the view center to zoom. */
USER_ZOOM_SCALE = 1,
/** Map horizontal/vertical motion to zoom. */
USER_ZOOM_DOLLY = 2,
} eViewZoom_Style;
/** #UserDef.navigation_mode */
typedef enum eViewNavigation_Method {
VIEW_NAVIGATION_WALK = 0,
VIEW_NAVIGATION_FLY = 1,
} eViewNavigation_Method;
/** #UserDef.uiflag */
typedef enum eUserpref_MiniAxisType {
USER_MINI_AXIS_TYPE_GIZMO = 0,
USER_MINI_AXIS_TYPE_MINIMAL = 1,
USER_MINI_AXIS_TYPE_NONE = 2,
} eUserpref_MiniAxisType;
/** #UserDef.flag */
typedef enum eWalkNavigation_Flag {
USER_WALK_GRAVITY = (1 << 0),
USER_WALK_MOUSE_REVERSE = (1 << 1),
} eWalkNavigation_Flag;
/** #UserDef.uiflag */
typedef enum eUserpref_UI_Flag {
USER_UIFLAG_UNUSED_0 = (1 << 0), /* cleared */
USER_UIFLAG_UNUSED_1 = (1 << 1), /* cleared */
USER_WHEELZOOMDIR = (1 << 2),
USER_FILTERFILEEXTS = (1 << 3),
USER_DRAWVIEWINFO = (1 << 4),
USER_PLAINMENUS = (1 << 5),
USER_LOCK_CURSOR_ADJUST = (1 << 6),
USER_HEADER_BOTTOM = (1 << 7),
/** Otherwise use header alignment from the file. */
USER_HEADER_FROM_PREF = (1 << 8),
USER_MENUOPENAUTO = (1 << 9),
USER_DEPTH_CURSOR = (1 << 10),
USER_AUTOPERSP = (1 << 11),
USER_UIFLAG_UNUSED_12 = (1 << 12), /* cleared */
USER_GLOBALUNDO = (1 << 13),
USER_ORBIT_SELECTION = (1 << 14),
USER_DEPTH_NAVIGATE = (1 << 15),
USER_HIDE_DOT = (1 << 16),
USER_SHOW_GIZMO_NAVIGATE = (1 << 17),
USER_SHOW_VIEWPORTNAME = (1 << 18),
USER_UIFLAG_UNUSED_3 = (1 << 19), /* Cleared. */
USER_ZOOM_TO_MOUSEPOS = (1 << 20),
USER_SHOW_FPS = (1 << 21),
USER_UIFLAG_UNUSED_22 = (1 << 22), /* cleared */
USER_MENUFIXEDORDER = (1 << 23),
USER_CONTINUOUS_MOUSE = (1 << 24),
USER_ZOOM_INVERT = (1 << 25),
USER_ZOOM_HORIZ = (1 << 26), /* for CONTINUE and DOLLY zoom */
USER_SPLASH_DISABLE = (1 << 27),
USER_HIDE_RECENT = (1 << 28),
#ifdef DNA_DEPRECATED_ALLOW
/* Deprecated: We're just trying if there's much desire for this feature,
* or if we can make it go for good. Should be cleared if so - Julian, Oct. 2019. */
USER_SHOW_THUMBNAILS = (1 << 29),
#endif
USER_SAVE_PROMPT = (1 << 30),
USER_HIDE_SYSTEM_BOOKMARKS = (1u << 31),
} eUserpref_UI_Flag;
/**
* #UserDef.uiflag2
*
* \note don't add new flags here, use 'uiflag' which has flags free.
*/
typedef enum eUserpref_UI_Flag2 {
USER_UIFLAG2_UNUSED_0 = (1 << 0), /* cleared */
USER_REGION_OVERLAP = (1 << 1),
USER_UIFLAG2_UNUSED_2 = (1 << 2),
USER_UIFLAG2_UNUSED_3 = (1 << 3), /* dirty */
} eUserpref_UI_Flag2;
/** #UserDef.gpu_flag */
typedef enum eUserpref_GPU_Flag {
USER_GPU_FLAG_NO_DEPT_PICK = (1 << 0),
USER_GPU_FLAG_NO_EDIT_MODE_SMOOTH_WIRE = (1 << 1),
USER_GPU_FLAG_OVERLAY_SMOOTH_WIRE = (1 << 2),
USER_GPU_FLAG_SUBDIVISION_EVALUATION = (1 << 3),
} eUserpref_GPU_Flag;
/** #UserDef.tablet_api */
typedef enum eUserpref_TableAPI {
USER_TABLET_AUTOMATIC = 0,
USER_TABLET_NATIVE = 1,
USER_TABLET_WINTAB = 2,
} eUserpref_TabletAPI;
/** #UserDef.app_flag */
typedef enum eUserpref_APP_Flag {
USER_APP_LOCK_CORNER_SPLIT = (1 << 0),
USER_APP_HIDE_REGION_TOGGLE = (1 << 1),
USER_APP_LOCK_EDGE_RESIZE = (1 << 2),
} eUserpref_APP_Flag;
/** #UserDef.statusbar_flag */
typedef enum eUserpref_StatusBar_Flag {
STATUSBAR_SHOW_MEMORY = (1 << 0),
STATUSBAR_SHOW_VRAM = (1 << 1),
STATUSBAR_SHOW_STATS = (1 << 2),
STATUSBAR_SHOW_VERSION = (1 << 3),
} eUserpref_StatusBar_Flag;
/**
* Auto-Keying mode.
* #UserDef.autokey_mode
*/
typedef enum eAutokey_Mode {
/* AUTOKEY_ON is a bitflag */
AUTOKEY_ON = 1,
/**
* AUTOKEY_ON + 2**n... (i.e. AUTOKEY_MODE_NORMAL = AUTOKEY_ON + 2)
* to preserve setting, even when auto-key turned off.
*/
AUTOKEY_MODE_NORMAL = 3,
AUTOKEY_MODE_EDITKEYS = 5,
} eAutokey_Mode;
/**
* Zoom to frame mode.
* #UserDef.view_frame_type
*/
typedef enum eZoomFrame_Mode {
ZOOM_FRAME_MODE_KEEP_RANGE = 0,
ZOOM_FRAME_MODE_SECONDS = 1,
ZOOM_FRAME_MODE_KEYFRAMES = 2,
} eZoomFrame_Mode;
/**
* Auto-Keying flag
* #UserDef.autokey_flag (not strictly used when autokeying only -
* is also used when keyframing these days).
* \note #eAutokey_Flag is used with a macro, search for lines like IS_AUTOKEY_FLAG(INSERTAVAIL).
*/
typedef enum eAutokey_Flag {
AUTOKEY_FLAG_INSERTAVAIL = (1 << 0),
AUTOKEY_FLAG_INSERTNEEDED = (1 << 1),
AUTOKEY_FLAG_AUTOMATKEY = (1 << 2),
AUTOKEY_FLAG_XYZ2RGB = (1 << 3),
/* toolsettings->autokey_flag */
AUTOKEY_FLAG_ONLYKEYINGSET = (1 << 6),
AUTOKEY_FLAG_NOWARNING = (1 << 7),
AUTOKEY_FLAG_CYCLEAWARE = (1 << 8),
ANIMRECORD_FLAG_WITHNLA = (1 << 10),
} eAutokey_Flag;
/**
* Animation flags
* #UserDef.animation_flag, used for animation flags that aren't covered by more specific flags
* (like eAutokey_Flag).
*/
typedef enum eUserpref_Anim_Flags {
USER_ANIM_SHOW_CHANNEL_GROUP_COLORS = (1 << 0),
} eUserpref_Anim_Flags;
/** #UserDef.transopts */
typedef enum eUserpref_Translation_Flags {
USER_TR_TOOLTIPS = (1 << 0),
USER_TR_IFACE = (1 << 1),
USER_TR_UNUSED_2 = (1 << 2), /* cleared */
USER_TR_UNUSED_3 = (1 << 3), /* cleared */
USER_TR_UNUSED_4 = (1 << 4), /* cleared */
USER_DOTRANSLATE_DEPRECATED = (1 << 5), /* Deprecated in 2.83. */
USER_TR_UNUSED_6 = (1 << 6), /* cleared */
USER_TR_UNUSED_7 = (1 << 7), /* cleared */
USER_TR_NEWDATANAME = (1 << 8),
} eUserpref_Translation_Flags;
/**
* Text Editor options
* #UserDef.text_flag
*/
typedef enum eTextEdit_Flags {
USER_TEXT_EDIT_AUTO_CLOSE = (1 << 0),
} eTextEdit_Flags;
/**
* Text draw options
* #UserDef.text_render
*/
typedef enum eText_Draw_Options {
USER_TEXT_DISABLE_AA = (1 << 0),
USER_TEXT_HINTING_NONE = (1 << 1),
USER_TEXT_HINTING_SLIGHT = (1 << 2),
USER_TEXT_HINTING_FULL = (1 << 3),
} eText_Draw_Options;
/**
* Grease Pencil Settings.
* #UserDef.gp_settings
*/
typedef enum eGP_UserdefSettings {
GP_PAINT_UNUSED_0 = (1 << 0),
} eGP_UserdefSettings;
enum {
USER_GIZMO_DRAW = (1 << 0),
};
/**
* Color Picker Types.
* #UserDef.color_picker_type
*/
typedef enum eColorPicker_Types {
USER_CP_CIRCLE_HSV = 0,
USER_CP_SQUARE_SV = 1,
USER_CP_SQUARE_HS = 2,
USER_CP_SQUARE_HV = 3,
USER_CP_CIRCLE_HSL = 4,
} eColorPicker_Types;
/**
* Time-code display styles.
* #UserDef.timecode_style
*/
typedef enum eTimecodeStyles {
/**
* As little info as is necessary to show relevant info with '+' to denote the frames
* i.e. HH:MM:SS+FF, MM:SS+FF, SS+FF, or MM:SS.
*/
USER_TIMECODE_MINIMAL = 0,
/** Reduced SMPTE - (HH:)MM:SS:FF */
USER_TIMECODE_SMPTE_MSF = 1,
/** Full SMPTE - HH:MM:SS:FF */
USER_TIMECODE_SMPTE_FULL = 2,
/** Milliseconds for sub-frames - HH:MM:SS.sss. */
USER_TIMECODE_MILLISECONDS = 3,
/** Seconds only. */
USER_TIMECODE_SECONDS_ONLY = 4,
/**
* Private (not exposed as generic choices) options.
* milliseconds for sub-frames, SubRip format- HH:MM:SS,sss.
*/
USER_TIMECODE_SUBRIP = 100,
} eTimecodeStyles;
/** #UserDef.ndof_flag (3D mouse options) */
typedef enum eNdof_Flag {
NDOF_SHOW_GUIDE = (1 << 0),
NDOF_FLY_HELICOPTER = (1 << 1),
NDOF_LOCK_HORIZON = (1 << 2),
/* The following might not need to be saved between sessions,
* but they do need to live somewhere accessible. */
NDOF_SHOULD_PAN = (1 << 3),
NDOF_SHOULD_ZOOM = (1 << 4),
NDOF_SHOULD_ROTATE = (1 << 5),
/* Orbit navigation modes. */
NDOF_MODE_ORBIT = (1 << 6),
/* actually... users probably don't care about what the mode
* is called, just that it feels right */
/* zoom is up/down if this flag is set (otherwise forward/backward) */
NDOF_PAN_YZ_SWAP_AXIS = (1 << 7),
NDOF_ZOOM_INVERT = (1 << 8),
NDOF_ROTX_INVERT_AXIS = (1 << 9),
NDOF_ROTY_INVERT_AXIS = (1 << 10),
NDOF_ROTZ_INVERT_AXIS = (1 << 11),
NDOF_PANX_INVERT_AXIS = (1 << 12),
NDOF_PANY_INVERT_AXIS = (1 << 13),
NDOF_PANZ_INVERT_AXIS = (1 << 14),
NDOF_TURNTABLE = (1 << 15),
NDOF_CAMERA_PAN_ZOOM = (1 << 16),
} eNdof_Flag;
#define NDOF_PIXELS_PER_SECOND 600.0f
/** UserDef.ogl_multisamples */
typedef enum eMultiSample_Type {
USER_MULTISAMPLE_NONE = 0,
USER_MULTISAMPLE_2 = 2,
USER_MULTISAMPLE_4 = 4,
USER_MULTISAMPLE_8 = 8,
USER_MULTISAMPLE_16 = 16,
} eMultiSample_Type;
/** #UserDef.image_draw_method */
typedef enum eImageDrawMethod {
IMAGE_DRAW_METHOD_AUTO = 0,
IMAGE_DRAW_METHOD_GLSL = 1,
IMAGE_DRAW_METHOD_2DTEXTURE = 2,
} eImageDrawMethod;
/** #UserDef.virtual_pixel */
typedef enum eUserpref_VirtualPixel {
VIRTUAL_PIXEL_NATIVE = 0,
VIRTUAL_PIXEL_DOUBLE = 1,
} eUserpref_VirtualPixel;
typedef enum eOpensubdiv_Computee_Type {
USER_OPENSUBDIV_COMPUTE_NONE = 0,
USER_OPENSUBDIV_COMPUTE_CPU = 1,
USER_OPENSUBDIV_COMPUTE_OPENMP = 2,
USER_OPENSUBDIV_COMPUTE_OPENCL = 3,
USER_OPENSUBDIV_COMPUTE_CUDA = 4,
USER_OPENSUBDIV_COMPUTE_GLSL_TRANSFORM_FEEDBACK = 5,
USER_OPENSUBDIV_COMPUTE_GLSL_COMPUTE = 6,
} eOpensubdiv_Computee_Type;
/** #UserDef.factor_display_type */
typedef enum eUserpref_FactorDisplay {
USER_FACTOR_AS_FACTOR = 0,
USER_FACTOR_AS_PERCENTAGE = 1,
} eUserpref_FactorDisplay;
typedef enum eUserpref_RenderDisplayType {
USER_RENDER_DISPLAY_NONE = 0,
USER_RENDER_DISPLAY_SCREEN = 1,
USER_RENDER_DISPLAY_AREA = 2,
USER_RENDER_DISPLAY_WINDOW = 3
} eUserpref_RenderDisplayType;
typedef enum eUserpref_TempSpaceDisplayType {
USER_TEMP_SPACE_DISPLAY_FULLSCREEN = 0,
USER_TEMP_SPACE_DISPLAY_WINDOW = 1,
} eUserpref_TempSpaceDisplayType;
typedef enum eUserpref_EmulateMMBMod {
USER_EMU_MMB_MOD_ALT = 0,
USER_EMU_MMB_MOD_OSKEY = 1,
} eUserpref_EmulateMMBMod;
typedef enum eUserpref_DiskCacheCompression {
USER_SEQ_DISK_CACHE_COMPRESSION_NONE = 0,
USER_SEQ_DISK_CACHE_COMPRESSION_LOW = 1,
USER_SEQ_DISK_CACHE_COMPRESSION_HIGH = 2,
} eUserpref_DiskCacheCompression;
typedef enum eUserpref_SeqProxySetup {
USER_SEQ_PROXY_SETUP_MANUAL = 0,
USER_SEQ_PROXY_SETUP_AUTOMATIC = 1,
} eUserpref_SeqProxySetup;
/* Locale Ids. Auto will try to get local from OS. Our default is English though. */
/** #UserDef.language */
enum {
ULANGUAGE_AUTO = 0,
ULANGUAGE_ENGLISH = 1,
};
#ifdef __cplusplus
}
#endif