#include <optional>
#include <string>
#include "DNA_windowmanager_types.h"
#include "BLI_array.hh"
#include "BLI_bounds_types.hh"
#include "BLI_compiler_attrs.h"
#include "BLI_function_ref.hh"
#include "BLI_math_vector_types.hh"
#include "BLI_sys_types.h"
#include "WM_keymap.hh"
#include "WM_types.hh"

Classes
struct	wmEventHandler_KeymapResult
struct	CheckerIntervalParams

Namespaces
namespace	blender
namespace	blender::bke
namespace	blender::bke::id
namespace	blender::asset_system

Macros
#define	WM_CURSOR_DEFAULT_LOGICAL_SIZE 24
#define	WM_operatortype_prop_tag(property, tags)

Typedefs
using	EventHandlerPoll
using	wmEventHandler_KeymapDynamicFn
using	wmUIHandlerFunc = int ()(bContext C, const wmEvent event, void userdata)
using	wmUIHandlerRemoveFunc = void ()(bContext C, void *userdata)
using	wm_jobs_start_callback = void ()(void custom_data, wmJobWorkerStatus *worker_status)
using	wmTooltipInitFn

Enumerations
enum	eWM_CapabilitiesFlag { WM_CAPABILITY_CURSOR_WARP = (1 << 0) , WM_CAPABILITY_WINDOW_POSITION = (1 << 1) , WM_CAPABILITY_CLIPBOARD_PRIMARY = (1 << 2) , WM_CAPABILITY_GPU_FRONT_BUFFER_READ = (1 << 3) , WM_CAPABILITY_CLIPBOARD_IMAGE = (1 << 4) , WM_CAPABILITY_DESKTOP_SAMPLE = (1 << 5) , WM_CAPABILITY_INPUT_IME = (1 << 6) , WM_CAPABILITY_TRACKPAD_PHYSICAL_DIRECTION = (1 << 7) , WM_CAPABILITY_WINDOW_DECORATION_STYLES = (1 << 8) , WM_CAPABILITY_KEYBOARD_HYPER_KEY = (1 << 9) , WM_CAPABILITY_CURSOR_RGBA = (1 << 10) , WM_CAPABILITY_CURSOR_GENERATOR = (1 << 11) , WM_CAPABILITY_MULTIMONITOR_PLACEMENT = (1 << 12) , WM_CAPABILITY_INITIALIZED = (1u << 31) }
enum	eWindowAlignment { WIN_ALIGN_ABSOLUTE = 0 , WIN_ALIGN_LOCATION_CENTER , WIN_ALIGN_PARENT_CENTER }
enum	eWM_WindowDecorationStyleFlag { WM_WINDOW_DECORATION_STYLE_NONE = 0 , WM_WINDOW_DECORATION_STYLE_COLORED_TITLEBAR = (1 << 0) }
enum	eWM_EventHandlerFlag { WM_HANDLER_BLOCKING = (1 << 0) , WM_HANDLER_ACCEPT_DBL_CLICK = (1 << 1) , WM_HANDLER_DO_FREE = (1 << 7) }
enum	eFileSel_Flag { WM_FILESEL_RELPATH = 1 << 0 , WM_FILESEL_DIRECTORY = 1 << 1 , WM_FILESEL_FILENAME = 1 << 2 , WM_FILESEL_FILEPATH = 1 << 3 , WM_FILESEL_FILES = 1 << 4 , WM_FILESEL_SHOW_PROPS = 1 << 5 }
enum	eFileSel_Action { FILE_OPENFILE = 0 , FILE_SAVE = 1 }
enum	eWM_JobFlag { WM_JOB_PRIORITY = (1 << 0) , WM_JOB_EXCL_RENDER = (1 << 1) , WM_JOB_PROGRESS = (1 << 2) }
enum	eWM_JobType { WM_JOB_TYPE_ANY = 0 , WM_JOB_TYPE_COMPOSITE , WM_JOB_TYPE_RENDER , WM_JOB_TYPE_RENDER_PREVIEW , WM_JOB_TYPE_LOAD_PREVIEW , WM_JOB_TYPE_OBJECT_SIM_OCEAN , WM_JOB_TYPE_OBJECT_SIM_FLUID , WM_JOB_TYPE_OBJECT_BAKE_TEXTURE , WM_JOB_TYPE_OBJECT_BAKE , WM_JOB_TYPE_FILESEL_READDIR , WM_JOB_TYPE_ASSET_LIBRARY_LOAD , WM_JOB_TYPE_CLIP_BUILD_PROXY , WM_JOB_TYPE_CLIP_TRACK_MARKERS , WM_JOB_TYPE_CLIP_SOLVE_CAMERA , WM_JOB_TYPE_CLIP_PREFETCH , WM_JOB_TYPE_SEQ_BUILD_PROXY , WM_JOB_TYPE_SEQ_BUILD_PREVIEW , WM_JOB_TYPE_POINTCACHE , WM_JOB_TYPE_DPAINT_BAKE , WM_JOB_TYPE_ALEMBIC_IMPORT , WM_JOB_TYPE_ALEMBIC_EXPORT , WM_JOB_TYPE_USD_IMPORT , WM_JOB_TYPE_USD_EXPORT , WM_JOB_TYPE_SHADER_COMPILATION , WM_JOB_TYPE_STUDIOLIGHT , WM_JOB_TYPE_LIGHT_BAKE , WM_JOB_TYPE_FSMENU_BOOKMARK_VALIDATE , WM_JOB_TYPE_QUADRIFLOW_REMESH , WM_JOB_TYPE_TRACE_IMAGE , WM_JOB_TYPE_LINEART , WM_JOB_TYPE_SEQ_DRAW_THUMBNAIL , WM_JOB_TYPE_SEQ_DRAG_DROP_PREVIEW , WM_JOB_TYPE_CALCULATE_SIMULATION_NODES , WM_JOB_TYPE_BAKE_GEOMETRY_NODES , WM_JOB_TYPE_UV_PACK }

Functions
void	WM_init_state_app_template_set (const char *app_template)
const char *	WM_init_state_app_template_get ()
void	WM_init_state_size_set (int stax, int stay, int sizx, int sizy)
void	WM_init_state_fullscreen_set ()
void	WM_init_state_normal_set ()
void	WM_init_state_maximized_set ()
void	WM_init_state_start_with_console_set (bool value)
void	WM_init_window_focus_set (bool do_it)
bool	WM_init_window_frame_get ()
void	WM_init_window_frame_set (bool do_it)
void	WM_init_native_pixels (bool do_it)
void	WM_init_input_devices ()
void	WM_init (bContext C, int argc, const char *argv)
void	WM_exit_ex (bContext *C, bool do_python_exit, bool do_user_exit_actions)
void	WM_exit (bContext *C, int exit_code) ATTR_NORETURN
void	WM_main (bContext *C) ATTR_NORETURN
void	WM_init_splash_on_startup (bContext *C)
void	WM_init_splash (bContext *C)
void	WM_init_gpu ()
const char *	WM_ghost_backend ()
eWM_CapabilitiesFlag	WM_capabilities_flag ()
void	WM_check (bContext *C)
void	WM_reinit_gizmomap_all (Main *bmain)
void	WM_script_tag_reload ()
wmWindow *	WM_window_find_under_cursor (wmWindow *win, const int event_xy[2], int r_event_xy_other[2])
wmWindow *	WM_window_find_by_area (wmWindowManager wm, const ScrArea area)
bool	WM_desktop_cursor_sample_read (float r_col[3])
uint8_t *	WM_window_pixels_read_from_frontbuffer (const wmWindowManager wm, const wmWindow win, int r_size[2])
void	WM_window_pixels_read_sample_from_frontbuffer (const wmWindowManager wm, const wmWindow win, const int pos[2], float r_col[3])
uint8_t *	WM_window_pixels_read_from_offscreen (bContext C, wmWindow win, int r_size[2])
bool	WM_window_pixels_read_sample_from_offscreen (bContext C, wmWindow win, const int pos[2], float r_col[3])
uint8_t *	WM_window_pixels_read (bContext C, wmWindow win, int r_size[2])
bool	WM_window_pixels_read_sample (bContext C, wmWindow win, const int pos[2], float r_col[3])
int	WM_window_native_pixel_x (const wmWindow *win)
int	WM_window_native_pixel_y (const wmWindow *win)
blender::int2	WM_window_native_pixel_size (const wmWindow *win)
void	WM_window_native_pixel_coords (const wmWindow win, int x, int *y)
void	WM_window_rect_calc (const wmWindow win, rcti r_rect)
void	WM_window_screen_rect_calc (const wmWindow win, rcti r_rect)
bool	WM_window_is_main_top_level (const wmWindow *win)
bool	WM_window_is_fullscreen (const wmWindow *win)
bool	WM_window_is_maximized (const wmWindow *win)
bool	WM_window_support_hdr_color (const wmWindow *win)
void	WM_windows_scene_data_sync (const ListBase win_lb, Scene scene) ATTR_NONNULL()
Scene *	WM_windows_scene_get_from_screen (const wmWindowManager wm, const bScreen screen) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT
ViewLayer *	WM_windows_view_layer_get_from_screen (const wmWindowManager wm, const bScreen screen) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT
WorkSpace *	WM_windows_workspace_get_from_screen (const wmWindowManager wm, const bScreen screen) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT
Scene *	WM_window_get_active_scene (const wmWindow *win) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT
void	WM_window_set_active_scene (Main bmain, bContext C, wmWindow win, Scene scene) ATTR_NONNULL()
WorkSpace *	WM_window_get_active_workspace (const wmWindow *win) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT
void	WM_window_set_active_workspace (bContext C, wmWindow win, WorkSpace *workspace) ATTR_NONNULL(1)
WorkSpaceLayout *	WM_window_get_active_layout (const wmWindow *win) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT
void	WM_window_set_active_layout (wmWindow win, WorkSpace workspace, WorkSpaceLayout *layout) ATTR_NONNULL(1)
bScreen *	WM_window_get_active_screen (const wmWindow *win) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT
void	WM_window_set_active_screen (wmWindow win, WorkSpace workspace, bScreen *screen) ATTR_NONNULL(1)
ViewLayer *	WM_window_get_active_view_layer (const wmWindow *win) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT
void	WM_window_set_active_view_layer (wmWindow win, ViewLayer view_layer) ATTR_NONNULL(1)
void	WM_window_ensure_active_view_layer (wmWindow *win) ATTR_NONNULL(1)
bool	WM_window_is_temp_screen (const wmWindow *win) ATTR_WARN_UNUSED_RESULT
void *	WM_system_gpu_context_create ()
void	WM_system_gpu_context_dispose (void *context)
void	WM_system_gpu_context_activate (void *context)
void	WM_system_gpu_context_release (void *context)
wmWindow *	WM_window_open (bContext C, const char title, const rcti rect_unscaled, int space_type, bool toplevel, bool dialog, bool temp, eWindowAlignment alignment, void(area_setup_fn)(bScreen screen, ScrArea area, void user_data), void area_setup_user_data) ATTR_NONNULL(1
wmWindow wmWindow *	WM_window_open_temp (bContext C, const char title, int space_type, bool dialog)
void	WM_window_dpi_set_userdef (const wmWindow *win)
float	WM_window_dpi_get_scale (const wmWindow *win)
void	WM_window_title (wmWindowManager wm, wmWindow win, const char *title=nullptr)
bool	WM_stereo3d_enabled (wmWindow *win, bool skip_stereo3d_check)
eWM_WindowDecorationStyleFlag	WM_window_decoration_style_flags_get (const wmWindow *win)
void	WM_window_decoration_style_flags_set (const wmWindow *win, eWM_WindowDecorationStyleFlag style_flags)
void	WM_window_decoration_style_apply (const wmWindow win, const bScreen screen=nullptr)
void	WM_file_autoexec_init (const char *filepath)
bool	WM_file_read (bContext C, const char filepath, const bool use_scripts_autoexec_check, ReportList *reports)
void	WM_file_autosave_init (wmWindowManager *wm)
bool	WM_file_recover_last_session (bContext C, const bool use_scripts_autoexec_check, ReportList reports)
void	WM_file_tag_modified ()
ID *	WM_file_link_datablock (Main bmain, Scene scene, ViewLayer view_layer, View3D v3d, const char filepath, short id_code, const char id_name, int flag)
ID *	WM_file_append_datablock (Main bmain, Scene scene, ViewLayer view_layer, View3D v3d, const char filepath, short id_code, const char id_name, int flag)
void	WM_lib_reload (Library lib, bContext C, ReportList *reports)
void	WM_cursor_set (wmWindow *win, int curs)
bool	WM_cursor_set_from_tool (wmWindow win, const ScrArea area, const ARegion *region)
bool	WM_cursor_modal_is_set_ok (const wmWindow *win)
void	WM_cursor_modal_set (wmWindow *win, int val)
void	WM_cursor_modal_restore (wmWindow *win)
void	WM_cursor_wait (bool val)
void	WM_cursor_grab_enable (wmWindow win, eWM_CursorWrapAxis wrap, const rcti wrap_region, bool hide)
void	WM_cursor_grab_disable (wmWindow *win, const int mouse_ungrab_xy[2])
void	WM_cursor_time (wmWindow *win, int nr)
void	WM_cursor_progress (wmWindow *win, float progress_factor)
wmPaintCursor *	WM_paint_cursor_activate (short space_type, short region_type, bool(poll)(bContext C), wmPaintCursorDraw draw, void *customdata)
bool	WM_paint_cursor_end (wmPaintCursor *handle)
void	WM_paint_cursor_remove_by_type (wmWindowManager wm, void draw_fn, void(free)(void ))
void	WM_paint_cursor_tag_redraw (wmWindow win, ARegion region)
void	WM_cursor_warp (wmWindow *win, int x, int y)
uint	WM_cursor_preferred_logical_size ()
wmEventHandler_Keymap *	WM_event_add_keymap_handler (ListBase handlers, wmKeyMap keymap)
wmEventHandler_Keymap *	WM_event_add_keymap_handler_poll (ListBase handlers, wmKeyMap keymap, EventHandlerPoll poll)
bool	WM_event_handler_region_v2d_mask_poll (const wmWindow win, const ScrArea area, const ARegion region, const wmEvent event)
bool	WM_event_handler_region_marker_poll (const wmWindow win, const ScrArea area, const ARegion region, const wmEvent event)
bool	WM_event_handler_region_v2d_mask_no_marker_poll (const wmWindow win, const ScrArea area, const ARegion region, const wmEvent event)
wmEventHandler_Keymap *	WM_event_add_keymap_handler_v2d_mask (ListBase handlers, wmKeyMap keymap)
wmEventHandler_Keymap *	WM_event_add_keymap_handler_priority (ListBase handlers, wmKeyMap keymap, int priority)
void	WM_event_get_keymap_from_toolsystem_with_gizmos (wmWindowManager wm, wmWindow win, wmEventHandler_Keymap handler, wmEventHandler_KeymapResult km_result)
void	WM_event_get_keymap_from_toolsystem (wmWindowManager wm, wmWindow win, wmEventHandler_Keymap handler, wmEventHandler_KeymapResult km_result)
wmEventHandler_Keymap *	WM_event_add_keymap_handler_dynamic (ListBase handlers, wmEventHandler_KeymapDynamicFn keymap_fn, void user_data)
void	WM_event_remove_keymap_handler (ListBase handlers, wmKeyMap keymap)
void	WM_event_set_keymap_handler_post_callback (wmEventHandler_Keymap handler, void(keymap_tag)(wmKeyMap keymap, wmKeyMapItem kmi, void user_data), void *user_data)
void	WM_event_get_keymaps_from_handler (wmWindowManager wm, wmWindow win, wmEventHandler_Keymap handler, wmEventHandler_KeymapResult km_result)
wmKeyMapItem *	WM_event_match_keymap_item (bContext C, wmKeyMap keymap, const wmEvent *event)
wmKeyMapItem *	WM_event_match_keymap_item_from_handlers (bContext C, wmWindowManager wm, wmWindow win, ListBase handlers, const wmEvent *event)
bool	WM_event_match (const wmEvent winevent, const wmKeyMapItem kmi)
wmEventHandler_UI *	WM_event_add_ui_handler (const bContext C, ListBase handlers, wmUIHandlerFunc handle_fn, wmUIHandlerRemoveFunc remove_fn, void *user_data, eWM_EventHandlerFlag flag)
wmOperator *	WM_operator_find_modal_by_type (wmWindow win, const wmOperatorType ot)
void	WM_event_remove_ui_handler (ListBase handlers, wmUIHandlerFunc handle_fn, wmUIHandlerRemoveFunc remove_fn, void user_data, bool postpone)
void	WM_event_remove_handlers_by_area (ListBase handlers, const ScrArea area)
void	WM_event_free_ui_handler_all (bContext C, ListBase handlers, wmUIHandlerFunc handle_fn, wmUIHandlerRemoveFunc remove_fn)
wmEventHandler_Op *	WM_event_add_modal_handler_ex (wmWindow win, ScrArea area, ARegion region, wmOperator op) ATTR_NONNULL(1
wmEventHandler_Op wmEventHandler_Op *	WM_event_add_modal_handler (bContext C, wmOperator op) ATTR_NONNULL(1
wmEventHandler_Op wmEventHandler_Op void	WM_event_remove_model_handler (ListBase handlers, const wmOperator op, bool postpone) ATTR_NONNULL(1
wmEventHandler_Op wmEventHandler_Op void void	WM_event_remove_modal_handler_all (const wmOperator *op, bool postpone) ATTR_NONNULL(1)
void	WM_event_modal_handler_area_replace (wmWindow win, const ScrArea old_area, ScrArea *new_area)
void	WM_event_modal_handler_region_replace (wmWindow win, const ARegion old_region, ARegion *new_region)
void	WM_event_ui_handler_region_popup_replace (wmWindow win, const ARegion old_region, ARegion *new_region)
void	WM_event_remove_handlers (bContext C, ListBase handlers)
wmEventHandler_Dropbox *	WM_event_add_dropbox_handler (ListBase handlers, ListBase dropboxes)
void	WM_event_add_mousemove (wmWindow *win)
void	WM_event_add_notifier_ex (wmWindowManager wm, const wmWindow win, unsigned int type, void *reference)
void	WM_event_add_notifier (const bContext C, unsigned int type, void reference)
void	WM_main_add_notifier (unsigned int type, void *reference)
void	WM_main_remove_notifier_reference (const void *reference)
void	WM_main_remap_editor_id_reference (const blender::bke::id::IDRemapper &mappings)
void	WM_report_banner_show (wmWindowManager wm, wmWindow win) ATTR_NONNULL(1)
void	WM_report_banners_cancel (Main *bmain)
void	WM_reports_from_reports_move (wmWindowManager wm, ReportList reports)
void	WM_global_report (eReportType type, const char *message)
void	WM_global_reportf (eReportType type, const char *format,...) ATTR_PRINTF_FORMAT(2
void wmEvent *	WM_event_add (wmWindow win, const wmEvent event_to_add) ATTR_NONNULL(1
void wmEvent void	wm_event_init_from_window (wmWindow win, wmEvent event)
wmTimer *	WM_event_timer_add (wmWindowManager wm, wmWindow win, wmEventType event_type, double time_step)
wmTimer *	WM_event_timer_add_notifier (wmWindowManager wm, wmWindow win, unsigned int type, double time_step)
void	WM_event_timer_free_data (wmTimer *timer)
void	WM_event_timer_remove (wmWindowManager wm, wmWindow win, wmTimer *timer)
void	WM_event_timer_remove_notifier (wmWindowManager wm, wmWindow win, wmTimer *timer)
void	WM_event_timer_sleep (wmWindowManager wm, wmWindow win, wmTimer *timer, bool do_sleep)
wmOperatorStatus	WM_generic_select_modal (bContext C, wmOperator op, const wmEvent *event)
wmOperatorStatus	WM_generic_select_invoke (bContext C, wmOperator op, const wmEvent *event)
void	WM_operator_view3d_unit_defaults (bContext C, wmOperator op)
int	WM_operator_smooth_viewtx_get (const wmOperator *op)
wmOperatorStatus	WM_menu_invoke_ex (bContext C, wmOperator op, blender::wm::OpCallContext opcontext)
wmOperatorStatus	WM_menu_invoke (bContext C, wmOperator op, const wmEvent *event)
void	WM_menu_name_call (bContext C, const char menu_name, blender::wm::OpCallContext context)
wmOperatorStatus	WM_enum_search_invoke (bContext C, wmOperator op, const wmEvent *event)
wmOperatorStatus	WM_operator_confirm (bContext C, wmOperator op, const wmEvent *event)
wmOperatorStatus	WM_operator_confirm_or_exec (bContext C, wmOperator op, const wmEvent *event)
wmOperatorStatus	WM_operator_confirm_ex (bContext C, wmOperator op, const char title=nullptr, const char message=nullptr, const char *confirm_text=nullptr, int icon=0, bool cancel_default=false)
wmOperatorStatus	WM_operator_filesel (bContext C, wmOperator op, const wmEvent *event)
bool	WM_operator_filesel_ensure_ext_imtype (wmOperator op, const ImageFormatData im_format)
bool	WM_operator_winactive (bContext *C)
wmOperatorStatus	WM_operator_props_popup_confirm (bContext C, wmOperator op, const wmEvent *event)
wmOperatorStatus	WM_operator_props_popup_confirm_ex (bContext C, wmOperator op, const wmEvent *event, std::optional< std::string > title=std::nullopt, std::optional< std::string > confirm_text=std::nullopt, bool cancel_default=false, std::optional< std::string > message=std::nullopt)
wmOperatorStatus	WM_operator_props_popup_call (bContext C, wmOperator op, const wmEvent *event)
wmOperatorStatus	WM_operator_props_popup (bContext C, wmOperator op, const wmEvent *event)
wmOperatorStatus	WM_operator_props_dialog_popup (bContext C, wmOperator op, int width, std::optional< std::string > title=std::nullopt, std::optional< std::string > confirm_text=std::nullopt, bool cancel_default=false, std::optional< std::string > message=std::nullopt)
wmOperatorStatus	WM_operator_redo_popup (bContext C, wmOperator op)
wmOperatorStatus	WM_operator_ui_popup (bContext C, wmOperator op, int width)
wmOperatorStatus	WM_operator_confirm_message_ex (bContext C, wmOperator op, const char title, int icon, const char message, blender::wm::OpCallContext opcontext)
wmOperatorStatus	WM_operator_confirm_message (bContext C, wmOperator op, const char *message)
void	WM_operator_free (wmOperator *op)
void	WM_operator_free_all_after (wmWindowManager wm, wmOperator op)
void	WM_operator_type_set (wmOperator op, wmOperatorType ot)
void	WM_operator_stack_clear (wmWindowManager *wm)
void	WM_operator_handlers_clear (wmWindowManager wm, wmOperatorType ot)
bool	WM_operator_poll (bContext C, wmOperatorType ot)
bool	WM_operator_poll_context (bContext C, wmOperatorType ot, blender::wm::OpCallContext context)
bool	WM_operator_poll_or_report_error (bContext C, wmOperatorType ot, ReportList *reports)
wmOperatorStatus	WM_operator_call_ex (bContext C, wmOperator op, bool store)
wmOperatorStatus	WM_operator_call (bContext C, wmOperator op)
wmOperatorStatus	WM_operator_call_notest (bContext C, wmOperator op)
wmOperatorStatus	WM_operator_repeat (bContext C, wmOperator op)
wmOperatorStatus	WM_operator_repeat_last (bContext C, wmOperator op)
bool	WM_operator_repeat_check (const bContext C, wmOperator op)
bool	WM_operator_is_repeat (const bContext C, const wmOperator op)
bool	WM_operator_name_poll (bContext C, const char opstring)
wmOperatorStatus	WM_operator_name_call_ptr (bContext C, wmOperatorType ot, blender::wm::OpCallContext context, PointerRNA properties, const wmEvent event)
wmOperatorStatus	WM_operator_name_call (bContext C, const char opstring, blender::wm::OpCallContext context, PointerRNA properties, const wmEvent event)
wmOperatorStatus	WM_operator_name_call_with_properties (bContext C, const char opstring, blender::wm::OpCallContext context, IDProperty properties, const wmEvent event)
wmOperatorStatus	WM_operator_call_py (bContext C, wmOperatorType ot, blender::wm::OpCallContext context, PointerRNA properties, ReportList reports, bool is_undo)
void	WM_operator_name_call_ptr_with_depends_on_cursor (bContext C, wmOperatorType ot, blender::wm::OpCallContext opcontext, PointerRNA properties, const wmEvent event, blender::StringRef drawstr)
void	WM_operator_properties_alloc (PointerRNA ptr, IDProperty properties, const char *opstring)
void	WM_operator_properties_sanitize (PointerRNA *ptr, bool no_context)
bool	WM_operator_properties_default (PointerRNA *ptr, bool do_update)
void	WM_operator_properties_reset (wmOperator *op)
void	WM_operator_properties_create (PointerRNA ptr, const char opstring)
void	WM_operator_properties_create_ptr (PointerRNA ptr, wmOperatorType ot)
void	WM_operator_properties_clear (PointerRNA *ptr)
void	WM_operator_properties_free (PointerRNA *ptr)
bool	WM_operator_ui_poll (wmOperatorType ot, PointerRNA ptr)
bool	WM_operator_check_ui_enabled (const bContext C, const char idname)
IDProperty *	WM_operator_last_properties_ensure_idprops (wmOperatorType *ot)
void	WM_operator_last_properties_ensure (wmOperatorType ot, PointerRNA ptr)
wmOperator *	WM_operator_last_redo (const bContext *C)
ID *	WM_operator_drop_load_path (bContext C, wmOperator op, short idcode)
bool	WM_operator_last_properties_init (wmOperator *op)
bool	WM_operator_last_properties_store (wmOperator *op)
void	WM_operator_properties_confirm_or_exec (wmOperatorType *ot)
void	WM_operator_properties_filesel (wmOperatorType *ot, int filter, short type, eFileSel_Action action, eFileSel_Flag flag, short display, short sort)
void	WM_operator_properties_id_lookup_set_from_id (PointerRNA ptr, const ID id)
ID *	WM_operator_properties_id_lookup_from_name_or_session_uid (Main bmain, PointerRNA ptr, enum ID_Type type)
bool	WM_operator_properties_id_lookup_is_set (PointerRNA *ptr)
void	WM_operator_properties_id_lookup (wmOperatorType *ot, const bool add_name_prop)
void	WM_operator_properties_use_cursor_init (wmOperatorType *ot)
void	WM_operator_properties_border (wmOperatorType *ot)
void	WM_operator_properties_border_to_rcti (wmOperator op, rcti r_rect)
void	WM_operator_properties_border_to_rctf (wmOperator op, rctf r_rect)
blender::Bounds< blender::int2 >	WM_operator_properties_border_to_bounds (wmOperator *op)
void	WM_operator_properties_gesture_box_ex (wmOperatorType *ot, bool deselect, bool extend)
void	WM_operator_properties_gesture_box (wmOperatorType *ot)
void	WM_operator_properties_gesture_box_select (wmOperatorType *ot)
void	WM_operator_properties_gesture_box_zoom (wmOperatorType *ot)
void	WM_operator_properties_gesture_lasso (wmOperatorType *ot)
void	WM_operator_properties_gesture_polyline (wmOperatorType *ot)
void	WM_operator_properties_gesture_straightline (wmOperatorType *ot, int cursor)
void	WM_operator_properties_gesture_circle (wmOperatorType *ot)
void	WM_operator_properties_mouse_select (wmOperatorType *ot)
void	WM_operator_properties_select_all (wmOperatorType *ot)
void	WM_operator_properties_select_action (wmOperatorType *ot, int default_action, bool hide_gui)
void	WM_operator_properties_select_action_simple (wmOperatorType *ot, int default_action, bool hide_gui)
void	WM_operator_properties_select_random (wmOperatorType *ot)
int	WM_operator_properties_select_random_seed_increment_get (wmOperator *op)
void	WM_operator_properties_select_operation (wmOperatorType *ot)
void	WM_operator_properties_select_operation_simple (wmOperatorType *ot)
void	WM_operator_properties_select_walk_direction (wmOperatorType *ot)
void	WM_operator_properties_generic_select (wmOperatorType *ot)
void	WM_operator_properties_checker_interval (wmOperatorType *ot, bool nth_can_disable)
void	WM_operator_properties_checker_interval_from_op (wmOperator op, CheckerIntervalParams op_params)
bool	WM_operator_properties_checker_interval_test (const CheckerIntervalParams *op_params, int depth)
std::string	WM_operator_pystring_ex (bContext C, wmOperator op, bool all_args, bool macro_args, wmOperatorType ot, PointerRNA opptr)
std::string	WM_operator_pystring (bContext C, wmOperator op, bool all_args, bool macro_args)
std::string	WM_operator_pystring_abbreviate (std::string str, int str_len_max)
std::optional< std::string >	WM_prop_pystring_assign (bContext C, PointerRNA ptr, PropertyRNA *prop, int index)
size_t	WM_operator_bl_idname (char dst, const char src) ATTR_NONNULL(1
size_t size_t	WM_operator_py_idname (char dst, const char src) ATTR_NONNULL(1
size_t size_t bool	WM_operator_py_idname_ok_or_report (ReportList reports, const char classname, const char *idname)
bool	WM_operator_bl_idname_is_valid (const char *idname)
std::optional< std::string >	WM_context_path_resolve_property_full (const bContext C, const PointerRNA ptr, PropertyRNA *prop, int index)
std::optional< std::string >	WM_context_path_resolve_full (bContext C, const PointerRNA ptr)
wmOperatorType *	WM_operatortype_find (const char *idname, bool quiet)
blender::Span< wmOperatorType * >	WM_operatortypes_registered_get ()
void	WM_operatortype_append (void(opfunc)(wmOperatorType ot))
void	WM_operatortype_append_ptr (void(opfunc)(wmOperatorType ot, void userdata), void userdata)
void	WM_operatortype_append_macro_ptr (void(opfunc)(wmOperatorType ot, void userdata), void userdata)
void	WM_operatortype_remove_ptr (wmOperatorType *ot)
bool	WM_operatortype_remove (const char *idname)
void	WM_operatortype_last_properties_clear_all ()
void	WM_operatortype_idname_visit_for_search (const bContext C, PointerRNA ptr, PropertyRNA prop, const char edit_text, blender::FunctionRef< void(StringPropertySearchVisitParams)> visit_fn)
void	WM_operatortype_props_advanced_begin (wmOperatorType *ot)
void	WM_operatortype_props_advanced_end (wmOperatorType *ot)
wmOperatorType *	WM_operatortype_append_macro (const char idname, const char name, const char *description, int flag)
wmOperatorTypeMacro *	WM_operatortype_macro_define (wmOperatorType ot, const char idname)
std::string	WM_operatortype_name (wmOperatorType ot, PointerRNA properties)
std::string	WM_operatortype_description (bContext C, wmOperatorType ot, PointerRNA *properties)
std::string	WM_operatortype_description_or_name (bContext C, wmOperatorType ot, PointerRNA *properties)
bool	WM_operator_depends_on_cursor (bContext &C, wmOperatorType &ot, PointerRNA *properties)
void	WM_operator_type_modal_from_exec_for_object_edit_coords (wmOperatorType *ot)
void	WM_uilisttype_init ()
uiListType *	WM_uilisttype_find (blender::StringRef idname, bool quiet)
bool	WM_uilisttype_add (uiListType *ult)
void	WM_uilisttype_remove_ptr (Main bmain, uiListType ult)
void	WM_uilisttype_free ()
void	WM_uilisttype_to_full_list_id (const uiListType ult, const char list_id, char r_full_list_id[])
const char *	WM_uilisttype_list_id_get (const uiListType ult, uiList list)
void	WM_menutype_init ()
MenuType *	WM_menutype_find (blender::StringRef idname, bool quiet)
blender::Span< MenuType * >	WM_menutypes_registered_get ()
bool	WM_menutype_add (MenuType *mt)
void	WM_menutype_freelink (MenuType *mt)
void	WM_menutype_free ()
bool	WM_menutype_poll (bContext C, MenuType mt)
void	WM_menutype_idname_visit_for_search (const bContext C, PointerRNA ptr, PropertyRNA prop, const char edit_text, blender::FunctionRef< void(StringPropertySearchVisitParams)> visit_fn)
void	WM_paneltype_init ()
void	WM_paneltype_clear ()
PanelType *	WM_paneltype_find (blender::StringRef idname, bool quiet)
bool	WM_paneltype_add (PanelType *pt)
void	WM_paneltype_remove (PanelType *pt)
void	WM_paneltype_idname_visit_for_search (const bContext C, PointerRNA ptr, PropertyRNA prop, const char edit_text, blender::FunctionRef< void(StringPropertySearchVisitParams)> visit_fn)
wmOperatorStatus	WM_gesture_box_invoke (bContext C, wmOperator op, const wmEvent *event)
wmOperatorStatus	WM_gesture_box_modal (bContext C, wmOperator op, const wmEvent *event)
void	WM_gesture_box_cancel (bContext C, wmOperator op)
wmOperatorStatus	WM_gesture_circle_invoke (bContext C, wmOperator op, const wmEvent *event)
wmOperatorStatus	WM_gesture_circle_modal (bContext C, wmOperator op, const wmEvent *event)
void	WM_gesture_circle_cancel (bContext C, wmOperator op)
wmOperatorStatus	WM_gesture_lines_invoke (bContext C, wmOperator op, const wmEvent *event)
wmOperatorStatus	WM_gesture_lines_modal (bContext C, wmOperator op, const wmEvent *event)
void	WM_gesture_lines_cancel (bContext C, wmOperator op)
wmOperatorStatus	WM_gesture_lasso_invoke (bContext C, wmOperator op, const wmEvent *event)
wmOperatorStatus	WM_gesture_lasso_modal (bContext C, wmOperator op, const wmEvent *event)
void	WM_gesture_lasso_cancel (bContext C, wmOperator op)
wmOperatorStatus	WM_gesture_polyline_invoke (bContext C, wmOperator op, const wmEvent *event)
wmOperatorStatus	WM_gesture_polyline_modal (bContext C, wmOperator op, const wmEvent *event)
void	WM_gesture_polyline_cancel (bContext C, wmOperator op)
blender::Array< blender::int2 >	WM_gesture_lasso_path_to_array (bContext C, wmOperator op)
wmOperatorStatus	WM_gesture_straightline_invoke (bContext C, wmOperator op, const wmEvent *event)
wmOperatorStatus	WM_gesture_straightline_active_side_invoke (bContext C, wmOperator op, const wmEvent *event)
wmOperatorStatus	WM_gesture_straightline_modal (bContext C, wmOperator op, const wmEvent *event)
wmOperatorStatus	WM_gesture_straightline_oneshot_modal (bContext C, wmOperator op, const wmEvent *event)
void	WM_gesture_straightline_cancel (bContext C, wmOperator op)
wmGesture *	WM_gesture_new (wmWindow window, const ARegion region, const wmEvent *event, int type)
void	WM_gesture_end (wmWindow win, wmGesture gesture)
void	WM_gestures_remove (wmWindow *win)
void	WM_gestures_free_all (wmWindow *win)
bool	WM_gesture_is_modal_first (const wmGesture *gesture)
void	WM_event_add_fileselect (bContext C, wmOperator op)
void	WM_event_fileselect_event (wmWindowManager wm, void ophandle, int eventval)
void *	WM_event_consecutive_data_get (wmWindow win, const char id)
void	WM_event_consecutive_data_set (wmWindow win, const char id, void *custom_data)
void	WM_event_consecutive_data_free (wmWindow *win)
void	WM_operator_region_active_win_set (bContext *C)
wmOperatorStatus	WM_operator_flag_only_pass_through_on_press (wmOperatorStatus retval, const wmEvent *event)
void	WM_event_start_drag (bContext C, int icon, eWM_DragDataType type, void poin, unsigned int flags)
wmDrag *	WM_drag_data_create (bContext C, int icon, eWM_DragDataType type, void poin, unsigned int flags)
void	WM_event_start_prepared_drag (bContext C, wmDrag drag)
void	WM_event_drag_image (wmDrag drag, const ImBuf imb, float scale)
void	WM_event_drag_path_override_poin_data_with_space_file_paths (const bContext , wmDrag drag)
void	WM_event_drag_preview_icon (wmDrag *drag, int icon_id)
void	WM_drag_free (wmDrag *drag)
void	WM_drag_data_free (eWM_DragDataType dragtype, void *poin)
void	WM_drag_free_list (ListBase *lb)
wmDropBox *	WM_dropbox_add (ListBase lb, const char idname, bool(poll)(bContext C, wmDrag drag, const wmEvent event), void(copy)(bContext C, wmDrag drag, wmDropBox drop), void(cancel)(Main bmain, wmDrag drag, wmDropBox drop), WMDropboxTooltipFunc tooltip)
void	WM_dropbox_update_ot ()
void	WM_drag_draw_item_name_fn (bContext C, wmWindow win, wmDrag *drag, const int xy[2])
void	WM_drag_draw_default_fn (bContext C, wmWindow win, wmDrag *drag, const int xy[2])
ListBase *	WM_dropboxmap_find (const char *idname, int spaceid, int regionid)
ID *	WM_drag_asset_id_import (const bContext C, wmDragAsset asset_drag, int flag_extra)
bool	WM_drag_asset_will_import_linked (const wmDrag *drag)
bool	WM_drag_asset_will_import_packed (const wmDrag *drag)
void	WM_drag_add_local_ID (wmDrag drag, ID id, ID *from_parent)
ID *	WM_drag_get_local_ID (const wmDrag *drag, short idcode)
ID *	WM_drag_get_local_ID_from_event (const wmEvent *event, short idcode)
bool	WM_drag_is_ID_type (const wmDrag *drag, int idcode)
wmDragAsset *	WM_drag_create_asset_data (const blender::asset_system::AssetRepresentation *asset, const AssetImportSettings &import_settings)
wmDragAsset *	WM_drag_get_asset_data (const wmDrag *drag, int idcode)
AssetMetaData *	WM_drag_get_asset_meta_data (const wmDrag *drag, int idcode)
ID *	WM_drag_get_local_ID_or_import_from_asset (const bContext C, const wmDrag drag, int idcode)
void	WM_drag_add_asset_list_item (wmDrag drag, const blender::asset_system::AssetRepresentation asset)
	Free asset ID imported for canceled drop.
const ListBase *	WM_drag_asset_list_get (const wmDrag *drag)
const char *	WM_drag_get_item_name (wmDrag *drag)
wmDragPath *	WM_drag_create_path_data (blender::Span< const char * > paths)
const char *	WM_drag_get_single_path (const wmDrag *drag)
const char *	WM_drag_get_single_path (const wmDrag *drag, int file_type)
blender::Span< std::string >	WM_drag_get_paths (const wmDrag *drag)
bool	WM_drag_has_path_file_type (const wmDrag *drag, int file_type)
int	WM_drag_get_path_file_type (const wmDrag *drag)
const std::string &	WM_drag_get_string (const wmDrag *drag)
std::string	WM_drag_get_string_firstline (const wmDrag *drag)
void	wmViewport (const rcti *winrct)
void	wmPartialViewport (rcti drawrct, const rcti winrct, const rcti *partialrct)
void	wmWindowViewport (const wmWindow *win)
void	wmWindowViewport_ex (const wmWindow *win, float offset)
void	wmOrtho2 (float x1, float x2, float y1, float y2)
void	wmOrtho2_region_pixelspace (const ARegion *region)
void	wmOrtho2_pixelspace (float x, float y)
void	wmGetProjectionMatrix (float mat[4][4], const rcti *winrct)
	ENUM_OPERATORS (eWM_JobFlag, WM_JOB_PROGRESS)
wmJob *	WM_jobs_get (wmWindowManager wm, wmWindow win, const void owner, const char name, eWM_JobFlag flag, eWM_JobType job_type)
bool	WM_jobs_test (const wmWindowManager wm, const void owner, int job_type)
float	WM_jobs_progress (const wmWindowManager wm, const void owner)
const char *	WM_jobs_name (const wmWindowManager wm, const void owner)
double	WM_jobs_starttime (const wmWindowManager wm, const void owner)
void *	WM_jobs_customdata_from_type (wmWindowManager wm, const void owner, int job_type)
bool	WM_jobs_is_running (const wmJob *wm_job)
bool	WM_jobs_is_stopped (const wmWindowManager wm, const void owner)
void *	WM_jobs_customdata_get (wmJob *wm_job)
void	WM_jobs_customdata_set (wmJob wm_job, void customdata, void(free)(void ))
void	WM_jobs_timer (wmJob *wm_job, double time_step, unsigned int note, unsigned int endnote)
void	WM_jobs_delay_start (wmJob *wm_job, double delay_time)
void	WM_jobs_callbacks (wmJob wm_job, wm_jobs_start_callback startjob, void(initjob)(void ), void(update)(void ), void(endjob)(void *))
void	WM_jobs_callbacks_ex (wmJob wm_job, wm_jobs_start_callback startjob, void(initjob)(void ), void(update)(void ), void(endjob)(void ), void(completed)(void ), void(canceled)(void *))
void	WM_jobs_start (wmWindowManager wm, wmJob wm_job)
void	WM_jobs_stop_type (wmWindowManager wm, const void owner, eWM_JobType job_type)
void	WM_jobs_stop_all_from_owner (wmWindowManager wm, const void owner) ATTR_NONNULL()
void	WM_jobs_kill_all (wmWindowManager *wm)
void	WM_jobs_kill_all_except (wmWindowManager wm, const void owner)
void	WM_jobs_kill_type (wmWindowManager wm, const void owner, int job_type)
void	WM_jobs_kill_all_from_owner (wmWindowManager wm, const void owner) ATTR_NONNULL()
bool	WM_jobs_has_running (const wmWindowManager *wm)
bool	WM_jobs_has_running_type (const wmWindowManager *wm, int job_type)
void	WM_job_main_thread_lock_acquire (wmJob *wm_job)
void	WM_job_main_thread_lock_release (wmJob *wm_job)
char *	WM_clipboard_text_get (bool selection, bool ensure_utf8, int *r_len)
char *	WM_clipboard_text_get_firstline (bool selection, bool ensure_utf8, int *r_len)
void	WM_clipboard_text_set (const char *buf, bool selection)
bool	WM_clipboard_image_available ()
ImBuf *	WM_clipboard_image_get ()
bool	WM_clipboard_image_set_byte_buffer (ImBuf *ibuf) ATTR_NONNULL(1)
void	WM_progress_set (wmWindow *win, float progress)
void	WM_progress_clear (wmWindow *win)
void *	WM_draw_cb_activate (wmWindow win, void(draw)(const wmWindow win, void customdata), void *customdata)
void	WM_draw_cb_exit (wmWindow win, void handle)
void	WM_redraw_windows (bContext *C)
void	WM_draw_region_viewport_ensure (Scene scene, ARegion region, short space_type)
void	WM_draw_region_viewport_bind (ARegion *region)
void	WM_draw_region_viewport_unbind (ARegion *region)
void	WM_draw_region_free (ARegion *region)
GPUViewport *	WM_draw_region_get_viewport (ARegion *region)
GPUViewport *	WM_draw_region_get_bound_viewport (ARegion *region)
int	WM_main_playanim (int argc, const char **argv)
bool	write_crash_blend ()
bool	WM_autosave_is_scheduled (wmWindowManager *wm)
void	WM_autosave_write (wmWindowManager wm, Main bmain)
void	WM_locked_interface_set (wmWindowManager *wm, bool lock)
void	WM_locked_interface_set_with_flags (wmWindowManager *wm, short lock_flags)
void	WM_event_tablet_data_default_set (wmTabletData *tablet_data)
wmEvent *	WM_event_add_simulate (wmWindow win, const wmEvent event_to_add)
const char *	WM_window_cursor_keymap_status_get (const wmWindow *win, int button_index, int type_index)
void	WM_window_cursor_keymap_status_refresh (bContext C, wmWindow win)
void	WM_window_status_area_tag_redraw (wmWindow *win)
ScrArea *	WM_window_status_area_find (wmWindow win, bScreen screen)
bool	WM_window_modal_keymap_status_draw (bContext C, wmWindow win, uiLayout *layout)
void	WM_event_print (const wmEvent *event)
bool	WM_event_is_modal_drag_exit (const wmEvent *event, short init_event_type, short init_event_val)
bool	WM_event_is_mouse_drag (const wmEvent *event)
bool	WM_event_is_mouse_drag_or_press (const wmEvent *event)
int	WM_event_drag_direction (const wmEvent *event)
char	WM_event_utf8_to_ascii (const wmEvent *event) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT
bool	WM_cursor_test_motion_and_update (const int mval[2]) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT
bool	WM_event_consecutive_gesture_test (const wmEvent *event)
bool	WM_event_consecutive_gesture_test_break (const wmWindow win, const wmEvent event)
int	WM_event_drag_threshold (const wmEvent *event)
bool	WM_event_drag_test (const wmEvent *event, const int prev_xy[2])
bool	WM_event_drag_test_with_delta (const wmEvent *event, const int drag_delta[2])
void	WM_event_drag_start_mval (const wmEvent event, const ARegion region, int r_mval[2])
void	WM_event_drag_start_mval_fl (const wmEvent event, const ARegion region, float r_mval[2])
void	WM_event_drag_start_xy (const wmEvent *event, int r_xy[2])
int	WM_userdef_event_map (int kmitype)
int	WM_userdef_event_type_from_keymap_type (int kmitype)
float	WM_event_tablet_data (const wmEvent event, bool r_pen_flip, float r_tilt[2])
bool	WM_event_is_tablet (const wmEvent *event)
int	WM_event_absolute_delta_x (const wmEvent *event)
int	WM_event_absolute_delta_y (const wmEvent *event)
void	WM_tooltip_immediate_init (bContext C, wmWindow win, ScrArea area, ARegion region, wmTooltipInitFn init)
void	WM_tooltip_timer_init_ex (bContext C, wmWindow win, ScrArea area, ARegion region, wmTooltipInitFn init, double delay)
void	WM_tooltip_timer_init (bContext C, wmWindow win, ScrArea area, ARegion region, wmTooltipInitFn init)
void	WM_tooltip_timer_clear (bContext C, wmWindow win)
void	WM_tooltip_clear (bContext C, wmWindow win)
void	WM_tooltip_init (bContext C, wmWindow win)
void	WM_tooltip_refresh (bContext C, wmWindow win)
double	WM_tooltip_time_closed ()
wmGenericCallback *	WM_generic_callback_steal (wmGenericCallback *callback)
void	WM_generic_callback_free (wmGenericCallback *callback)
void	WM_generic_user_data_free (wmGenericUserData *wm_userdata)
bool	WM_region_use_viewport (ScrArea area, ARegion region)
bool	WM_platform_associate_set (bool do_register, bool all_users, char **r_error_msg)

Macro Definition Documentation

◆ WM_CURSOR_DEFAULT_LOGICAL_SIZE

#define WM_CURSOR_DEFAULT_LOGICAL_SIZE 24

The default size of a cursor without any DPI scaling.

Definition at line 567 of file WM_api.hh.

Referenced by wm_software_cursor_draw_crosshair().

◆ WM_operatortype_prop_tag

#define WM_operatortype_prop_tag	(		property,
			tags )

Value:

{ \
  CHECK_TYPE(tags, eOperatorPropTags); \
  RNA_def_property_tags(prop, tags); \
} \
(void)0

Definition at line 1385 of file WM_api.hh.

Referenced by WM_operatortype_props_advanced_end().

Typedef Documentation

◆ EventHandlerPoll

using EventHandlerPoll

Initial value:

bool (*)(const wmWindow *win,
                                 const ScrArea *area,
                                 const ARegion *region,
                                 const wmEvent *event)

Definition at line 589 of file WM_api.hh.

◆ wm_jobs_start_callback

using wm_jobs_start_callback = void (*)(void *custom_data, wmJobWorkerStatus *worker_status)

Definition at line 1848 of file WM_api.hh.

◆ wmEventHandler_KeymapDynamicFn

using wmEventHandler_KeymapDynamicFn

Initial value:

void (*)(wmWindowManager *wm,
                                               wmWindow *win,
                                               wmEventHandler_Keymap *handler,
                                               wmEventHandler_KeymapResult *km_result)

Definition at line 641 of file WM_api.hh.

◆ wmTooltipInitFn

using wmTooltipInitFn

Initial value:

ARegion *(*)(bContext * C,
                                    ARegion *region,
                                    int *pass,
                                    double *r_pass_delay,
                                    bool *r_exit_on_event)

Definition at line 2124 of file WM_api.hh.

◆ wmUIHandlerFunc

using wmUIHandlerFunc = int (*)(bContext *C, const wmEvent *event, void *userdata)

Definition at line 677 of file WM_api.hh.

◆ wmUIHandlerRemoveFunc

using wmUIHandlerRemoveFunc = void (*)(bContext *C, void *userdata)

Definition at line 678 of file WM_api.hh.

Enumeration Type Documentation

◆ eFileSel_Action

enum eFileSel_Action

Action for WM_operator_properties_filesel.

Enumerator
FILE_OPENFILE
FILE_SAVE

Definition at line 1132 of file WM_api.hh.

◆ eFileSel_Flag

enum eFileSel_Flag

Flags for WM_operator_properties_filesel.

Enumerator
WM_FILESEL_RELPATH
WM_FILESEL_DIRECTORY
WM_FILESEL_FILENAME
WM_FILESEL_FILEPATH
WM_FILESEL_FILES
WM_FILESEL_SHOW_PROPS	Show the properties sidebar by default.

Definition at line 1120 of file WM_api.hh.

◆ eWindowAlignment

enum eWindowAlignment

WM_window_open alignment.

Enumerator
WIN_ALIGN_ABSOLUTE
WIN_ALIGN_LOCATION_CENTER
WIN_ALIGN_PARENT_CENTER

Definition at line 373 of file WM_api.hh.

◆ eWM_CapabilitiesFlag

enum eWM_CapabilitiesFlag

Enumerator
WM_CAPABILITY_CURSOR_WARP	Ability to warp the cursor (set its location).
WM_CAPABILITY_WINDOW_POSITION	Window position access, support for the following. Getting window positions. Setting window positions. Setting positions for new windows. Currently there is no need to distinguish between these different cases so a single flag is used. When omitted, it isn't possible to know where windows are located in relation to each other. Operations such as applying events from one window to another or detecting the non-active window under the cursor are not supported.
WM_CAPABILITY_CLIPBOARD_PRIMARY	The windowing system supports a separate primary clipboard (typically set when interactively selecting text).
WM_CAPABILITY_GPU_FRONT_BUFFER_READ	Reading from the back-buffer is supported.
WM_CAPABILITY_CLIPBOARD_IMAGE	Ability to copy/paste system clipboard images.
WM_CAPABILITY_DESKTOP_SAMPLE	Ability to sample a color outside of Blender windows.
WM_CAPABILITY_INPUT_IME	Support for IME input methods.
WM_CAPABILITY_TRACKPAD_PHYSICAL_DIRECTION	Trackpad physical scroll detection.
WM_CAPABILITY_WINDOW_DECORATION_STYLES	Support for window decoration styles.
WM_CAPABILITY_KEYBOARD_HYPER_KEY	Support for the "Hyper" modifier key.
WM_CAPABILITY_CURSOR_RGBA	Support for RGBA Cursors.
WM_CAPABILITY_CURSOR_GENERATOR	Support on demand cursor generation.
WM_CAPABILITY_MULTIMONITOR_PLACEMENT	Ability to save/restore windows among multiple monitors.
WM_CAPABILITY_INITIALIZED	The initial value, indicates the value needs to be set by inspecting GHOST.

Definition at line 168 of file WM_api.hh.

◆ eWM_EventHandlerFlag

enum eWM_EventHandlerFlag

Enumerator
WM_HANDLER_BLOCKING	After this handler all others are ignored.
WM_HANDLER_ACCEPT_DBL_CLICK	Handler accepts double key press events.
WM_HANDLER_DO_FREE	Handler tagged to be freed in wm_handlers_do().

Definition at line 577 of file WM_api.hh.

◆ eWM_JobFlag

enum eWM_JobFlag

Enumerator
WM_JOB_PRIORITY
WM_JOB_EXCL_RENDER	Only one render job can run at a time, this tags them a such. New jobs with this flag will wait on previous ones to finish then.
WM_JOB_PROGRESS

Definition at line 1759 of file WM_api.hh.

◆ eWM_JobType

enum eWM_JobType

Identifying jobs by owner alone is unreliable, this isn't saved, order can change.

Enumerator
WM_JOB_TYPE_ANY	Not a real type, use for querying any type.
WM_JOB_TYPE_COMPOSITE
WM_JOB_TYPE_RENDER
WM_JOB_TYPE_RENDER_PREVIEW
WM_JOB_TYPE_LOAD_PREVIEW	Job for the UI to load previews from the file system (uses OS thumbnail cache).
WM_JOB_TYPE_OBJECT_SIM_OCEAN
WM_JOB_TYPE_OBJECT_SIM_FLUID
WM_JOB_TYPE_OBJECT_BAKE_TEXTURE
WM_JOB_TYPE_OBJECT_BAKE
WM_JOB_TYPE_FILESEL_READDIR
WM_JOB_TYPE_ASSET_LIBRARY_LOAD
WM_JOB_TYPE_CLIP_BUILD_PROXY
WM_JOB_TYPE_CLIP_TRACK_MARKERS
WM_JOB_TYPE_CLIP_SOLVE_CAMERA
WM_JOB_TYPE_CLIP_PREFETCH
WM_JOB_TYPE_SEQ_BUILD_PROXY
WM_JOB_TYPE_SEQ_BUILD_PREVIEW
WM_JOB_TYPE_POINTCACHE
WM_JOB_TYPE_DPAINT_BAKE
WM_JOB_TYPE_ALEMBIC_IMPORT
WM_JOB_TYPE_ALEMBIC_EXPORT
WM_JOB_TYPE_USD_IMPORT
WM_JOB_TYPE_USD_EXPORT
WM_JOB_TYPE_SHADER_COMPILATION
WM_JOB_TYPE_STUDIOLIGHT
WM_JOB_TYPE_LIGHT_BAKE
WM_JOB_TYPE_FSMENU_BOOKMARK_VALIDATE
WM_JOB_TYPE_QUADRIFLOW_REMESH
WM_JOB_TYPE_TRACE_IMAGE
WM_JOB_TYPE_LINEART
WM_JOB_TYPE_SEQ_DRAW_THUMBNAIL
WM_JOB_TYPE_SEQ_DRAG_DROP_PREVIEW
WM_JOB_TYPE_CALCULATE_SIMULATION_NODES
WM_JOB_TYPE_BAKE_GEOMETRY_NODES
WM_JOB_TYPE_UV_PACK

Definition at line 1773 of file WM_api.hh.

◆ eWM_WindowDecorationStyleFlag

enum eWM_WindowDecorationStyleFlag

Flags for #WM_window_decoration_set_style().

Note: To be kept in sync with #GHOST_TWindowDecorationFlags.

Enumerator
WM_WINDOW_DECORATION_STYLE_NONE	No decoration styling.
WM_WINDOW_DECORATION_STYLE_COLORED_TITLEBAR	Colored TitleBar.

Definition at line 428 of file WM_api.hh.

Function Documentation

◆ ENUM_OPERATORS()

ENUM_OPERATORS	(	eWM_JobFlag	,
		WM_JOB_PROGRESS	)

References WM_JOB_PROGRESS.

◆ WM_autosave_is_scheduled()

bool WM_autosave_is_scheduled ( wmWindowManager * wm )

Definition at line 2346 of file wm_files.cc.

Referenced by blender::ed::object::object_mode_set_exec().

◆ WM_autosave_write()

void WM_autosave_write	(	wmWindowManager *	wm,
		Main *	bmain )

Flushes all changes from edit modes and stores the auto-save file.

Definition at line 2351 of file wm_files.cc.

References BLO_write_file(), ED_editors_flush_edits(), FILE_MAX, G, G_FILE_COMPRESS, G_FILE_RECOVER_WRITE, params, wm_autosave_location(), wm_autosave_timer_begin(), and wm_autosave_timer_end().

Referenced by blender::ed::object::object_mode_set_exec(), and wm_autosave_write_try().

◆ WM_capabilities_flag()

eWM_CapabilitiesFlag WM_capabilities_flag ( )

Return the capabilities of the windowing system.

Note: Some callers need to check G.background == false before this function. See inline code-comments for details.

Definition at line 2261 of file wm_window.cc.

References flag, GHOST_GetCapabilities(), GHOST_kCapabilityClipboardImage, GHOST_kCapabilityClipboardPrimary, GHOST_kCapabilityCursorGenerator, GHOST_kCapabilityCursorRGBA, GHOST_kCapabilityCursorWarp, GHOST_kCapabilityDesktopSample, GHOST_kCapabilityGPUReadFrontBuffer, GHOST_kCapabilityInputIME, GHOST_kCapabilityKeyboardHyperKey, GHOST_kCapabilityMultiMonitorPlacement, GHOST_kCapabilityTrackpadPhysicalDirection, GHOST_kCapabilityWindowDecorationStyles, GHOST_kCapabilityWindowPosition, WM_CAPABILITY_CLIPBOARD_IMAGE, WM_CAPABILITY_CLIPBOARD_PRIMARY, WM_CAPABILITY_CURSOR_GENERATOR, WM_CAPABILITY_CURSOR_RGBA, WM_CAPABILITY_CURSOR_WARP, WM_CAPABILITY_DESKTOP_SAMPLE, WM_CAPABILITY_GPU_FRONT_BUFFER_READ, WM_CAPABILITY_INITIALIZED, WM_CAPABILITY_INPUT_IME, WM_CAPABILITY_KEYBOARD_HYPER_KEY, WM_CAPABILITY_MULTIMONITOR_PLACEMENT, WM_CAPABILITY_TRACKPAD_PHYSICAL_DIRECTION, WM_CAPABILITY_WINDOW_DECORATION_STYLES, and WM_CAPABILITY_WINDOW_POSITION.

Referenced by bpy_wm_capabilities(), console_select_update_primary_clipboard(), ED_area_newspace(), ED_screen_do_listen(), eyedropper_color_sample_fl(), font_select_update_primary_clipboard(), render_view_open(), text_select_update_primary_clipboard(), window_set_custom_cursor(), window_set_custom_cursor_pixmap(), wm_cursor_number_impl(), wm_cursor_text(), wm_event_add_ghostevent(), wm_event_cursor_other_windows(), wm_paintcursor_draw(), wm_software_cursor_draw_bitmap(), wm_software_cursor_needed(), WM_window_decoration_style_apply(), WM_window_decoration_style_flags_set(), WM_window_find_under_cursor(), wm_window_ghostwindow_add(), wm_window_ghostwindow_ensure(), WM_window_open_temp(), WM_window_pixels_read(), WM_window_pixels_read_sample(), WM_window_pixels_read_sample_from_frontbuffer(), and wm_window_update_size_position().

◆ WM_check()

void WM_check ( bContext * C )

Definition at line 455 of file wm.cc.

References BLI_listbase_is_empty(), C, CTX_data_main(), CTX_wm_manager(), CTX_wm_manager_set(), ED_screens_init(), ListBase::first, G, wmWindowManager::init_flag, wmWindowManager::runtime, wmWindowManager::windows, Main::wm, WM_file_autosave_init(), WM_INIT_FLAG_WINDOW, WM_keyconfig_init(), WM_msgbus_create(), and wm_window_ghostwindows_ensure().

Referenced by WM_file_read(), wm_homefile_read_ex(), wm_window_copy_test(), and WM_window_open().

◆ WM_clipboard_image_available()

bool WM_clipboard_image_available ( )

Returns true if the clipboard contains an image.

Definition at line 2618 of file wm_window.cc.

References G, and GHOST_hasClipboardImage().

Referenced by image_clipboard_paste_poll().

◆ WM_clipboard_image_get()

ImBuf * WM_clipboard_image_get ( )

Get image data from the clipboard.

Returns: The image or null when not found. Caller must free.

Definition at line 2626 of file wm_window.cc.

References free(), G, GHOST_getClipboardImage(), and IMB_allocFromBuffer().

Referenced by image_clipboard_paste_exec().

◆ WM_clipboard_image_set_byte_buffer()

bool WM_clipboard_image_set_byte_buffer ( ImBuf * ibuf )

Put image data to the clipboard.

Parameters

ibuf	the image to set the clipboard to.

Definition at line 2645 of file wm_window.cc.

References ImBuf::byte_buffer, ImBufByteBuffer::data, G, GHOST_putClipboardImage(), ImBuf::x, and ImBuf::y.

Referenced by image_clipboard_copy_exec().

◆ WM_clipboard_text_get()

char * WM_clipboard_text_get	(	bool	selection,
		bool	ensure_utf8,
		int *	r_len )

Return text from the clipboard.

Parameters

selection	Use the "primary" clipboard, see: WM_CAPABILITY_CLIPBOARD_PRIMARY.
ensure_utf8	Ensure the resulting string does not contain invalid UTF8 encoding.

Definition at line 2569 of file wm_window.cc.

References wm_clipboard_text_get_ex().

Referenced by console_paste_exec(), paste_text_exec(), pyrna_WindowManager_clipboard_get(), blender::ed::vse::sequencer_text_edit_paste_exec(), and text_paste_exec().

◆ WM_clipboard_text_get_firstline()

char * WM_clipboard_text_get_firstline	(	bool	selection,
		bool	ensure_utf8,
		int *	r_len )

Convenience function for pasting to areas of Blender which don't support newlines.

Definition at line 2574 of file wm_window.cc.

References wm_clipboard_text_get_ex().

Referenced by handleNumInput(), ui_but_get_pasted_text_from_clipboard(), and ui_textedit_copypaste().

◆ WM_clipboard_text_set()

void WM_clipboard_text_set	(	const char *	buf,
		bool	selection )

◆ WM_context_path_resolve_full()

std::optional< std::string > WM_context_path_resolve_full	(	bContext *	C,
		const PointerRNA *	ptr )

Definition at line 695 of file wm_operators.cc.

References C, ptr, and WM_context_path_resolve_property_full().

Referenced by ui_but_is_user_menu_compatible(), ui_but_user_menu_add(), and ui_but_user_menu_find().

◆ WM_context_path_resolve_property_full()

std::optional< std::string > WM_context_path_resolve_property_full	(	const bContext *	C,
		const PointerRNA *	ptr,
		PropertyRNA *	prop,
		int	index )

Calculate the path to ptr from context C, or return NULL if it can't be calculated.

Definition at line 649 of file wm_operators.cc.

References C, ptr, RNA_path_from_ID_to_struct(), RNA_path_property_py(), RNA_struct_is_ID(), and wm_context_member_from_ptr().

Referenced by shortcut_property_from_rna(), ui_but_event_property_operator_string(), WM_context_path_resolve_full(), and wm_prop_pystring_from_context().

◆ WM_cursor_grab_disable()

void WM_cursor_grab_disable	(	wmWindow *	win,
		const int	mouse_ungrab_xy[2] )

Definition at line 560 of file wm_cursors.cc.

References G, G_DEBUG, GHOST_kAxisNone, GHOST_kGrabDisable, GHOST_SetCursorGrab(), wmWindow::ghostwin, wmWindow::grabcursor, and wm_cursor_position_to_ghost_screen_coords().

Referenced by button_activate_state(), walkEnd(), WM_event_remove_handlers(), wm_gizmomap_modal_set(), and wm_handler_operator_call().

◆ WM_cursor_grab_enable()

void WM_cursor_grab_enable	(	wmWindow *	win,
		eWM_CursorWrapAxis	wrap,
		const rcti *	wrap_region,
		bool	hide )

Enable cursor grabbing, optionally hiding the cursor and wrapping cursor-motion within a sub-region of the window.

Parameters

wrap	an enum (WM_CURSOR_WRAP_NONE, WM_CURSOR_WRAP_XY... etc).
wrap_region	Window-relative region for cursor wrapping (when wrap is WM_CURSOR_WRAP_XY). When NULL, the window bounds are used for wrapping.

Note: The current grab state can be accessed by #wmWindowManager.grabcursor although.

Definition at line 508 of file wm_cursors.cc.

References wmWindow::eventstate, G, G_DEBUG, GHOST_kAxisX, GHOST_kAxisY, GHOST_kGrabHide, GHOST_kGrabNormal, GHOST_kGrabWrap, GHOST_SetCursorGrab(), wmWindow::ghostwin, wmWindow::grabcursor, wmTabletData::is_motion_absolute, wmEvent::tablet, wm_cursor_position_to_ghost_screen_coords(), WM_CURSOR_WRAP_NONE, WM_CURSOR_WRAP_X, WM_CURSOR_WRAP_Y, wrap(), rcti::xmax, rcti::xmin, rcti::ymax, and rcti::ymin.

Referenced by button_activate_state(), initWalkInfo(), wm_gizmomap_modal_set(), wm_macro_modal(), and wm_operator_invoke().

◆ WM_cursor_modal_is_set_ok()

bool WM_cursor_modal_is_set_ok ( const wmWindow * win )

Check the cursor isn't set elsewhere. When false setting the modal cursor can be done but may overwrite an existing cursor.

Use this check for modal navigation operators that may be activated while other modal operators are running.

Note: A cursor "stack" would remove the need for this.

Definition at line 468 of file wm_cursors.cc.

References wmWindow::grabcursor, and wmWindow::modalcursor.

Referenced by image_view_pan_init(), image_view_zoom_init(), view_pan_init(), view_pan_invoke(), view_zoom_init(), and view_zoomdrag_invoke().

◆ WM_cursor_modal_restore()

void WM_cursor_modal_restore ( wmWindow * win )

Definition at line 482 of file wm_cursors.cc.

References wmWindow::lastcursor, wmWindow::modalcursor, and WM_cursor_set().

Referenced by annotation_draw_exit(), area_split_exit(), area_swap_exit(), blender::ui::bonedropper_exit(), button_activate_exit(), blender::ed::curves::curve_draw_exit(), curve_draw_exit(), blender::ed::curves::pen_tool::curves_pen_exit(), datadropper_exit(), depthdropper_exit(), driverdropper_exit(), blender::ui::eyedropper_colorband_exit(), eyedropper_exit(), gesture_modal_end(), graph_slider_exit(), blender::ed::sculpt_paint::grease_pencil_apply_fill(), blender::ed::sculpt_paint::grease_pencil_fill_exit(), blender::ed::sculpt_paint::greasepencil::grease_pencil_interpolate_modal(), blender::ed::greasepencil::grease_pencil_pen_exit(), blender::ed::greasepencil::grease_pencil_primitive_exit(), image_view_pan_exit(), image_view_zoom_exit(), knifetool_exit_ex(), blender::ed::space_node::node_resize_exit(), pose_slide_modal(), poselib_blend_exit(), blender::ed::transform::postTrans(), sample_color_modal(), screen_opengl_render_end(), blender::ed::asset::screenshot_preview_exit(), blender::ed::sculpt_paint::filter::sculpt_mesh_filter_modal(), blender::ed::sculpt_paint::dyntopo::sculpt_sample_detail_size_modal(), ui_do_button(), ui_handler_wait_for_input(), ui_numedit_set_active(), ui_textedit_end(), view_pan_exit(), view_pan_modal(), view_zoom_exit(), view_zoomdrag_modal(), WM_cursor_wait(), and wm_drags_exit().

◆ WM_cursor_modal_set()

void WM_cursor_modal_set	(	wmWindow *	win,
		int	val )

Definition at line 473 of file wm_cursors.cc.

References wmWindow::cursor, wmWindow::lastcursor, wmWindow::modalcursor, and WM_cursor_set().

Referenced by annotation_draw_cursor_set(), area_swap_invoke(), blender::ui::bonedropper_invoke(), button_activate_init(), curve_draw_invoke(), blender::ed::curves::curves_draw_invoke(), datadropper_invoke(), depthdropper_invoke(), driverdropper_invoke(), blender::ui::eyedropper_colorband_invoke(), eyedropper_invoke(), graph_slider_invoke(), blender::ed::sculpt_paint::grease_pencil_fill_event_modal_map(), blender::ed::sculpt_paint::grease_pencil_fill_invoke(), blender::ed::sculpt_paint::greasepencil::grease_pencil_interpolate_invoke(), blender::ed::greasepencil::grease_pencil_primitive_cursor_update(), blender::ed::greasepencil::grease_pencil_primitive_invoke(), image_view_pan_init(), image_view_zoom_init(), blender::ed::transform::initMouseInputMode(), blender::ed::curves::pen_tool::PenToolOperation::invoke(), knifetool_invoke(), blender::ed::space_node::node_resize_init(), pose_slide_invoke_common(), poselib_blend_invoke(), sample_color_invoke(), blender::ed::asset::screenshot_preview_invoke(), blender::ed::sculpt_paint::filter::sculpt_mesh_filter_modal(), blender::ed::sculpt_paint::dyntopo::sculpt_sample_detail_size_invoke(), ui_numedit_set_active(), ui_textedit_begin(), view_pan_init(), view_pan_invoke(), view_zoom_init(), view_zoomdrag_invoke(), WM_cursor_wait(), wm_drags_check_ops(), WM_gesture_lasso_invoke(), WM_gesture_lines_invoke(), WM_gesture_polyline_invoke(), WM_gesture_straightline_invoke(), and WM_operator_name_call_ptr_with_depends_on_cursor().

◆ WM_cursor_preferred_logical_size()

uint WM_cursor_preferred_logical_size ( )

Returns: the preferred logical size for the cursor (before DPI/Hi-DPI scaling is applied).

Definition at line 2887 of file wm_window.cc.

References g_system, and GHOST_GetCursorPreferredLogicalSize().

Referenced by wm_cursor_size(), and wm_software_cursor_draw_crosshair().

◆ WM_cursor_progress()

void WM_cursor_progress	(	wmWindow *	win,
		float	progress_factor )

Show progress in the cursor (0.0..1.0 when complete).

Definition at line 958 of file wm_cursors.cc.

References wm_cursor_number_impl().

◆ WM_cursor_set()

void WM_cursor_set	(	wmWindow *	win,
		int	curs )

Definition at line 397 of file wm_cursors.cc.

References BLI_assert_msg, convert_to_ghost_standard_cursor(), wmWindow::cursor, G, g_cursors, GHOST_HasCursorShape(), GHOST_kStandardCursorCustom, GHOST_kStandardCursorDefault, GHOST_SetCursorShape(), GHOST_SetCursorVisibility(), wmWindow::ghostwin, wmWindow::modalcursor, BCursor::svg_source, window_set_custom_cursor(), WM_CURSOR_DEFAULT, WM_CURSOR_NONE, and WM_CURSOR_NUM.

Referenced by actionzone_modal(), area_join_cancel(), area_join_invoke(), area_join_modal(), area_split_preview_update_cursor(), area_swap_modal(), clip_tracking_hide_cursor(), clip_tracking_show_cursor(), console_cursor(), ED_region_cursor_set(), file_external_operation_exec(), blender::ed::sculpt_paint::grease_pencil_fill_event_modal_map(), blender::ed::space_node::node_set_cursor(), blender::ed::sculpt_paint::paint_draw_cursor(), blender::ed::sculpt_paint::paint_update_mouse_cursor(), region_scale_modal(), blender::ed::spreadsheet::reorder_columns_invoke(), blender::ed::spreadsheet::reorder_columns_modal(), screen_cursor_set(), blender::ed::vse::sequencer_main_cursor(), blender::ed::spreadsheet::spreadsheet_cursor(), text_cursor(), ui_handle_menu_event(), ui_popup_block_create(), view3d_main_region_cursor(), WM_cursor_modal_restore(), WM_cursor_modal_set(), WM_cursor_set_from_tool(), WM_gizmomap_cursor_set(), and wm_gizmomap_highlight_set().

◆ WM_cursor_set_from_tool()

bool WM_cursor_set_from_tool	(	wmWindow *	win,
		const ScrArea *	area,
		const ARegion *	region )

Definition at line 451 of file wm_cursors.cc.

References bToolRef_Runtime::cursor, wmWindow::cursor, ELEM, wmWindow::modalcursor, ARegion::regiontype, RGN_TYPE_PREVIEW, RGN_TYPE_WINDOW, bToolRef::runtime, ScrArea::runtime, ScrArea_Runtime::tool, WM_CURSOR_DEFAULT, and WM_cursor_set().

Referenced by ED_region_cursor_set(), and view3d_main_region_cursor().

◆ WM_cursor_test_motion_and_update()

bool WM_cursor_test_motion_and_update ( const int mval[2] )

Detect motion between selection (callers should only use this for selection picking), typically mouse press/click events.

Parameters

mval	Region relative coordinates, call with (-1, -1) resets the last cursor location.

Returns: True when there was motion since last called.

NOTE(@ideasman42): The logic used here isn't foolproof. It's possible that users move the cursor past WM_EVENT_CURSOR_MOTION_THRESHOLD then back to a position within the threshold (between mouse clicks). In practice users never reported this since the threshold is very small (a few pixels). To prevent the unlikely case of values matching from another region, changing regions resets this value to (-1, -1).

Definition at line 351 of file wm_event_query.cc.

References copy_v2_v2_int(), len_manhattan_v2v2_int(), and WM_EVENT_CURSOR_MOTION_THRESHOLD.

Referenced by ED_screen_set_active_region(), get_nearest_editbonepoint(), mixed_bones_object_selectbuffer_extended(), blender::ed::vse::strip_select_from_preview(), and unified_findnearest().

◆ WM_cursor_time()

void WM_cursor_time	(	wmWindow *	win,
		int	nr )

After this you can call restore too.

Definition at line 953 of file wm_cursors.cc.

References wm_cursor_number_impl().

Referenced by screen_opengl_render_anim_step().

◆ WM_cursor_wait()

void WM_cursor_wait ( bool val )

To allow usage all over, we do entire WM.

Definition at line 491 of file wm_cursors.cc.

References ListBase::first, G, G_MAIN, wmWindow::next, wmWindowManager::windows, WM_cursor_modal_restore(), WM_cursor_modal_set(), and WM_CURSOR_WAIT.

Referenced by blender::ed::object::apply_grease_pencil_for_modifier_all_keyframes(), blender::ed::asset::asset_bundle_install_exec(), associate_blend_exec(), blender::ed::greasepencil::bake_grease_pencil_animation_exec(), blender::ed::object::bake_invoke(), edbm_duplicate_invoke(), blender::ed::greasepencil::grease_pencil_separate_exec(), image_clipboard_copy_exec(), image_clipboard_paste_exec(), lightprobe_cache_bake_invoke(), blender::ed::object::multiresbake_image_exec(), pack_islands_exec(), pack_islands_freejob(), blender::ed::object::parent_set_with_depsgraph(), redraw_timer_exec(), save_image_op(), screen_render_invoke(), script_reload_exec(), blender::ed::sculpt_paint::dyntopo::sculpt_dynamic_topology_toggle_exec(), separate_armature_exec(), separate_exec(), solve_camera_invoke(), track_markers(), unassociate_blend_exec(), unpack_all_exec(), unpack_item_exec(), unpack_libraries_exec(), WM_file_read(), and wm_file_write().

◆ WM_cursor_warp()

void WM_cursor_warp	(	wmWindow *	win,
		int	x,
		int	y )

Set the cursor location in window coordinates (compatible with wmEvent.xy).

Note: Some platforms don't support this, check: WM_CAPABILITY_WINDOW_POSITION before relying on this functionality.

Definition at line 2867 of file wm_window.cc.

References wmWindow::eventstate, g_system, GHOST_SetCursorPosition(), wmWindow::ghostwin, wmEvent::prev_xy, wm_cursor_position_to_ghost_client_coords(), x, wmEvent::xy, and y.

Referenced by initFlyInfo(), wm_cursor_warp_relative(), and wm_gizmomap_modal_set().

◆ WM_desktop_cursor_sample_read()

bool WM_desktop_cursor_sample_read ( float r_col[3] )

Return the color of the pixel at the current mouse cursor position on the desktop, whether in a Blender window or not. Returns false on failure or if not supported by the platform.

Definition at line 1501 of file wm_draw.cc.

References GHOST_GetPixelAtCursor().

Referenced by eyedropper_color_sample_fl().

◆ WM_drag_add_asset_list_item()

void WM_drag_add_asset_list_item	(	wmDrag *	drag,
		const blender::asset_system::AssetRepresentation *	asset )

Free asset ID imported for canceled drop.

If the asset was imported (linked/appended) using WM_drag_get_local_ID_or_import_from_asset()` (typically via a wmDropBox.copy() callback), we want the ID to be removed again if the drop operator cancels. This is for use as wmDropBox.cancel() callback. */ void WM_drag_free_imported_drag_ID(Main *bmain, wmDrag *drag, wmDropBox *drop);

wmDragAssetCatalog *WM_drag_get_asset_catalog_data(const wmDrag *drag);

/**

Note: Does not store asset in any way, so it's fine to pass a temporary.

Definition at line 866 of file wm_dragdrop.cc.

References wmDragAssetListItem::asset_data, ASSET_IMPORT_APPEND, wmDrag::asset_items, BLI_addtail(), BLI_assert, wmDragAssetListItem::external_info, wmDragAssetListItem::is_external, blender::asset_system::AssetRepresentation::local_id(), wmDragAssetListItem::local_id, MEM_callocN(), AssetImportSettings::method, wmDrag::type, AssetImportSettings::use_instance_collections, WM_DRAG_ASSET_LIST, and WM_drag_create_asset_data().

Referenced by WM_drag_data_create().

◆ WM_drag_add_local_ID()

void WM_drag_add_local_ID	(	wmDrag *	drag,
		ID *	id,
		ID *	from_parent )

Definition at line 624 of file wm_dragdrop.cc.

References BLI_addtail(), BLI_assert_msg, wmDragID::from_parent, GS, wmDragID::id, wmDrag::ids, LISTBASE_FOREACH, MEM_callocN(), and ID::name.

Referenced by blender::ed::outliner::outliner_item_drag_drop_invoke(), and WM_drag_data_create().

◆ WM_drag_asset_id_import()

ID * WM_drag_asset_id_import	(	const bContext *	C,
		wmDragAsset *	asset_drag,
		int	flag_extra )

Parameters

flag_extra Additional linking flags (from eFileSel_Params_Flag).

Definition at line 722 of file wm_dragdrop.cc.

References wmDragAsset::asset, ASSET_IMPORT_APPEND, ASSET_IMPORT_APPEND_REUSE, ASSET_IMPORT_LINK, ASSET_IMPORT_PACK, BLI_assert, BLI_assert_unreachable, BLO_LIBLINK_APPEND_ASSET_DATA_CLEAR, BLO_LIBLINK_APPEND_LOCAL_ID_REUSE, BLO_LIBLINK_APPEND_RECURSIVE, BLO_LIBLINK_COLLECTION_INSTANCE, BLO_LIBLINK_PACK, C, blender::StringRefNull::c_str(), CTX_data_main(), CTX_data_scene(), CTX_data_view_layer(), CTX_wm_view3d(), FILE_ACTIVE_COLLECTION, FILE_AUTOSELECT, FILE_RELPATH, flag, blender::asset_system::AssetRepresentation::full_library_path(), G_MAIN, blender::asset_system::AssetRepresentation::get_id_type(), blender::asset_system::AssetRepresentation::get_name(), blender::asset_system::AssetRepresentation::get_use_relative_path(), wmDragAsset::import_settings, AssetImportSettings::method, name, AssetImportSettings::use_instance_collections, WM_file_append_datablock(), and WM_file_link_datablock().

Referenced by view3d_collection_drop_copy_external_asset(), view3d_ob_drop_copy_external_asset(), and WM_drag_get_local_ID_or_import_from_asset().

◆ WM_drag_asset_list_get()

const ListBase * WM_drag_asset_list_get ( const wmDrag * drag )

Definition at line 892 of file wm_dragdrop.cc.

References wmDrag::asset_items, wmDrag::type, and WM_DRAG_ASSET_LIST.

Referenced by blender::ed::asset_browser::AssetCatalogDropTarget::drop_assets_into_catalog(), and blender::ed::asset_browser::AssetCatalogDropTarget::has_droppable_asset().

◆ WM_drag_asset_will_import_linked()

bool WM_drag_asset_will_import_linked ( const wmDrag * drag )

Definition at line 793 of file wm_dragdrop.cc.

References ASSET_IMPORT_LINK, wmDragAsset::import_settings, AssetImportSettings::method, wmDrag::type, WM_DRAG_ASSET, and WM_drag_get_asset_data().

Referenced by view3d_collection_drop_on_enter(), and view3d_ob_drop_on_enter().

◆ WM_drag_asset_will_import_packed()

bool WM_drag_asset_will_import_packed ( const wmDrag * drag )

Definition at line 803 of file wm_dragdrop.cc.

References ASSET_IMPORT_PACK, wmDragAsset::import_settings, AssetImportSettings::method, wmDrag::type, WM_DRAG_ASSET, and WM_drag_get_asset_data().

Referenced by view3d_collection_drop_copy_external_asset(), and view3d_ob_drop_copy_external_asset().

◆ WM_drag_create_asset_data()

wmDragAsset * WM_drag_create_asset_data	(	const blender::asset_system::AssetRepresentation *	asset,
		const AssetImportSettings &	import_settings )

Note: Does not store asset in any way, so it's fine to pass a temporary.

Definition at line 677 of file wm_dragdrop.cc.

References wmDragAsset::asset, and wmDragAsset::import_settings.

Referenced by blender::ed::asset::shelf::AssetDragController::create_drag_data(), UI_but_drag_set_asset(), and WM_drag_add_asset_list_item().

◆ WM_drag_create_path_data()

wmDragPath * WM_drag_create_path_data ( blender::Span< const char * > paths )

Parameters

paths The paths to drag. Values will be copied into the drag data so the passed strings may be destructed.

Definition at line 901 of file wm_dragdrop.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), Vector< T, InlineBufferCapacity, Allocator >::append(), BLI_assert, ED_path_extension_type(), wmDragPath::file_types, wmDragPath::file_types_bit_flag, blender::Span< T >::is_empty(), wmDragPath::paths, Vector< T, InlineBufferCapacity, Allocator >::size(), TIP_, and wmDragPath::tooltip.

Referenced by ghost_event_proc(), blender::tests::TEST(), UI_but_drag_set_path(), and WM_event_drag_path_override_poin_data_with_space_file_paths().

◆ WM_drag_data_create()

wmDrag * WM_drag_data_create	(	bContext *	C,
		int	icon,
		eWM_DragDataType	type,
		void *	poin,
		unsigned int	flags )

Create and fill the dragging data, but don't start dragging just yet (unlike WM_event_start_drag()). Must be followed up by WM_event_start_prepared_drag(), otherwise the returned pointer will leak memory.

Note that poin should be valid allocated and not on stack.

Definition at line 263 of file wm_dragdrop.cc.

References C, CTX_data_collection_get(), wmDrag::flags, wmDrag::icon, wmDrag::poin, ptr, wmDrag::type, WM_drag_add_asset_list_item(), WM_drag_add_local_ID(), WM_DRAG_ASSET, WM_DRAG_ASSET_CATALOG, WM_DRAG_ASSET_LIST, WM_DRAG_FREE_DATA, WM_DRAG_GREASE_PENCIL_LAYER, WM_DRAG_ID, and WM_DRAG_PATH.

Referenced by blender::ed::outliner::outliner_item_drag_drop_invoke(), ui_but_drag_start(), and WM_event_start_drag().

◆ WM_drag_data_free()

void WM_drag_data_free	(	eWM_DragDataType	dragtype,
		void *	poin )

Definition at line 390 of file wm_dragdrop.cc.

References MEM_freeN(), str, WM_DRAG_ASSET, wm_drag_free_asset_data(), wm_drag_free_path_data(), WM_DRAG_PATH, and WM_DRAG_STRING.

Referenced by ui_but_drag_free(), UI_but_drag_set_asset(), UI_but_drag_set_id(), UI_but_drag_set_name(), UI_but_drag_set_path(), UI_but_drag_set_rna(), WM_drag_free(), and WM_event_drag_path_override_poin_data_with_space_file_paths().

◆ WM_drag_draw_default_fn()

void WM_drag_draw_default_fn	(	bContext *	C,
		wmWindow *	win,
		wmDrag *	drag,
		const int	xy[2] )

Definition at line 1259 of file wm_dragdrop.cc.

References C, wm_drag_draw_default(), and xy.

◆ WM_drag_draw_item_name_fn()

void WM_drag_draw_item_name_fn	(	bContext *	C,
		wmWindow *	win,
		wmDrag *	drag,
		const int	xy[2] )

Definition at line 1147 of file wm_dragdrop.cc.

References UI_SCALE_FAC, wm_drag_draw_item_name(), wmWindowViewport_ex(), x, xy, and y.

Referenced by view3d_dropboxes().

◆ WM_drag_free()

void WM_drag_free ( wmDrag * drag )

◆ WM_drag_free_list()

void WM_drag_free_list ( ListBase * lb )

Definition at line 442 of file wm_dragdrop.cc.

References BLI_pophead(), and WM_drag_free().

Referenced by wm_event_custom_free(), wm_event_drag_and_drop_test(), wm_handlers_do_intern(), and blender::bke::WindowManagerRuntime::~WindowManagerRuntime().

◆ WM_drag_get_asset_data()

wmDragAsset * WM_drag_get_asset_data	(	const wmDrag *	drag,
		int	idcode )

◆ WM_drag_get_asset_meta_data()

AssetMetaData * WM_drag_get_asset_meta_data	(	const wmDrag *	drag,
		int	idcode )

Definition at line 707 of file wm_dragdrop.cc.

References wmDragAsset::asset, ID::asset_data, blender::asset_system::AssetRepresentation::get_metadata(), WM_drag_get_asset_data(), and WM_drag_get_local_ID().

Referenced by view3d_ob_drop_on_enter().

◆ WM_drag_get_item_name()

const char * WM_drag_get_item_name ( wmDrag * drag )

◆ WM_drag_get_local_ID()

ID * WM_drag_get_local_ID	(	const wmDrag *	drag,
		short	idcode )

◆ WM_drag_get_local_ID_from_event()

ID * WM_drag_get_local_ID_from_event	(	const wmEvent *	event,
		short	idcode )

Definition at line 662 of file wm_dragdrop.cc.

References wmEvent::custom, EVT_DATA_DRAGDROP, ListBase::first, and WM_drag_get_local_ID().

Referenced by blender::ed::outliner::material_drop_invoke(), blender::ed::outliner::parent_drop_invoke(), and blender::ed::outliner::scene_drop_invoke().

◆ WM_drag_get_local_ID_or_import_from_asset()

ID * WM_drag_get_local_ID_or_import_from_asset	(	const bContext *	C,
		const wmDrag *	drag,
		int	idcode )

When dragging a local ID, return that. Otherwise, if dragging an asset-handle, link or append that depending on what was chosen by the drag-box (currently append only in fact).

Use WM_drag_free_imported_drag_ID() as cancel callback of the drop-box, so that the asset import is rolled back if the drop operator fails.

Definition at line 813 of file wm_dragdrop.cc.

References C, ELEM, wmDrag::type, WM_DRAG_ASSET, WM_drag_asset_id_import(), WM_drag_get_asset_data(), WM_drag_get_local_ID(), and WM_DRAG_ID.

Referenced by blender::ed::vse::get_drag_path(), blender::ed::space_node::node_group_drop_copy(), blender::ed::space_node::node_id_drop_copy(), blender::ed::space_node::node_id_im_drop_copy(), screen_drop_scene_copy(), blender::ed::vse::sequencer_drop_copy(), ui_drop_material_copy(), ui_drop_name_copy(), view3d_id_drop_copy(), view3d_id_drop_copy_with_type(), and view3d_id_path_drop_copy().

◆ WM_drag_get_path_file_type()

int WM_drag_get_path_file_type ( const wmDrag * drag )

Note that even though the enum return type uses bit-flags, this should never have multiple type-bits set, so ELEM() like comparison is possible. To check all paths or to do a bit-flag check use WM_drag_has_path_file_type(drag, file_type) instead.

Definition at line 978 of file wm_dragdrop.cc.

References wmDragPath::file_types, wmDrag::poin, wmDrag::type, and WM_DRAG_PATH.

Referenced by blend_file_drop_poll(), clip_drop_poll(), blender::ed::vse::image_drop_poll(), blender::ed::vse::image_drop_preview_poll(), blender::ed::vse::is_movie(), blender::ed::vse::is_sound(), blender::ed::vse::movie_drop_preview_poll(), blender::ed::vse::sound_drop_preview_poll(), blender::tests::TEST(), and text_drop_path_poll().

◆ WM_drag_get_paths()

blender::Span< std::string > WM_drag_get_paths ( const wmDrag * drag )

Definition at line 968 of file wm_dragdrop.cc.

References Vector< T, InlineBufferCapacity, Allocator >::as_span(), wmDragPath::paths, wmDrag::poin, wmDrag::type, and WM_DRAG_PATH.

Referenced by drop_import_file_copy(), drop_import_file_poll(), drop_import_file_tooltip(), blender::ed::space_node::node_import_file_drop_copy(), blender::ed::space_node::node_import_file_drop_poll(), blender::tests::TEST(), blender::ed::vse::test_single_file_handler_poll(), wm_drag_draw_default(), wm_drag_draw_icon(), and wm_drag_draw_tooltip().

◆ WM_drag_get_single_path() [1/2]

const char * WM_drag_get_single_path ( const wmDrag * drag )

If drag contains path data, returns the first path int he path list.

Definition at line 929 of file wm_dragdrop.cc.

References wmDragPath::paths, wmDrag::poin, wmDrag::type, and WM_DRAG_PATH.

Referenced by blend_file_drop_copy(), clip_drop_copy(), console_drop_path_copy(), drop_extension_path_copy(), drop_extension_path_poll(), filepath_drop_copy(), blender::ed::vse::get_drag_path(), blender::ed::vse::sequencer_drop_copy(), blender::tests::TEST(), and text_drop_path_copy().

◆ WM_drag_get_single_path() [2/2]

const char * WM_drag_get_single_path	(	const wmDrag *	drag,
		int	file_type )

If drag contains path data, returns the first path in the path list that matches a a file_type.

Parameters

drag	The drag that could contain drag path data.
file_type	eFileSel_File_Types bit flag.

Definition at line 939 of file wm_dragdrop.cc.

References blender::Span< T >::begin(), blender::Span< T >::end(), wmDragPath::file_types, wmDragPath::paths, wmDrag::poin, wmDrag::type, and WM_DRAG_PATH.

◆ WM_drag_get_string()

const std::string & WM_drag_get_string ( const wmDrag * drag )

Definition at line 988 of file wm_dragdrop.cc.

References BLI_assert, wmDrag::poin, str, wmDrag::type, and WM_DRAG_STRING.

Referenced by drop_extension_url_copy(), drop_extension_url_poll(), and text_drop_string_copy().

◆ WM_drag_get_string_firstline()

std::string WM_drag_get_string_firstline ( const wmDrag * drag )

Definition at line 995 of file wm_dragdrop.cc.

References BLI_assert, wmDrag::poin, str, wmDrag::type, and WM_DRAG_STRING.

Referenced by console_drop_string_copy().

◆ WM_drag_has_path_file_type()

bool WM_drag_has_path_file_type	(	const wmDrag *	drag,
		int	file_type )

If drag contains path data, returns if any file path match a file_type.

Parameters

drag	The drag that could contain drag path data.
file_type	eFileSel_File_Types bit flag.

Definition at line 959 of file wm_dragdrop.cc.

References wmDragPath::file_types_bit_flag, wmDrag::poin, wmDrag::type, and WM_DRAG_PATH.

Referenced by blender::tests::TEST().

◆ WM_drag_is_ID_type()

bool WM_drag_is_ID_type	(	const wmDrag *	drag,
		int	idcode )

Check if the drag data is either a local ID or an external ID asset of type idcode.

Definition at line 672 of file wm_dragdrop.cc.

References WM_drag_get_asset_data(), and WM_drag_get_local_ID().

Referenced by blender::ed::vse::image_drop_poll(), blender::ed::vse::image_drop_preview_poll(), blender::ed::vse::is_movie(), blender::ed::vse::is_sound(), blender::ed::vse::movie_drop_preview_poll(), blender::ed::space_node::node_collection_drop_poll(), blender::ed::space_node::node_group_drop_poll(), blender::ed::space_node::node_id_im_drop_poll(), blender::ed::space_node::node_mask_drop_poll(), blender::ed::space_node::node_material_drop_poll(), blender::ed::space_node::node_object_drop_poll(), screen_drop_scene_poll(), blender::ed::vse::sound_drop_preview_poll(), ui_drop_material_poll(), view3d_drop_id_in_main_region_poll(), and view3d_ima_drop_poll().

◆ WM_draw_cb_activate()

void * WM_draw_cb_activate	(	wmWindow *	win,
		void(*	draw )(const wmWindow win, void customdata),
		void *	customdata )

Definition at line 635 of file wm_draw.cc.

References BLI_addtail(), WindowDrawCB::customdata, WindowDrawCB::draw, wmWindow::drawcalls, and MEM_callocN().

Referenced by area_join_dock_cb_window(), area_join_invoke(), area_move_exit(), area_move_init(), area_split_invoke(), eyedropper_cryptomatte_sample_fl(), eyedropper_init(), region_scale_invoke(), screen_animate_area_highlight(), and blender::ed::asset::screenshot_preview_invoke().

◆ WM_draw_cb_exit()

void WM_draw_cb_exit	(	wmWindow *	win,
		void *	handle )

Definition at line 648 of file wm_draw.cc.

References BLI_remlink(), wmWindow::drawcalls, LISTBASE_FOREACH, and MEM_freeN().

Referenced by area_animate_highlight_cb(), area_join_dock_cb_window(), area_join_exit(), area_move_exit(), area_move_out_draw_cb(), area_split_exit(), eyedropper_cryptomatte_sample_fl(), eyedropper_exit(), region_scale_exit(), and blender::ed::asset::screenshot_preview_exit().

◆ WM_draw_region_free()

void WM_draw_region_free ( ARegion * region )

Definition at line 1677 of file wm_draw.cc.

References wm_draw_region_buffer_free().

Referenced by area_offscreen_exit(), ED_region_exit(), and ED_view3d_stop_render_preview().

◆ WM_draw_region_get_bound_viewport()

GPUViewport * WM_draw_region_get_bound_viewport ( ARegion * region )

Definition at line 950 of file wm_draw.cc.

References ARegion::runtime.

Referenced by blender::ed::vse::draw_registered_callbacks(), drw_draw_render_loop_2d(), drw_draw_render_loop_3d(), DRW_draw_view(), blender::ed::vse::preview_draw_begin(), blender::ed::vse::preview_draw_color_render_begin(), blender::ed::vse::preview_draw_overlay_begin(), blender::ed::vse::sequencer_ibuf_get(), and blender::ed::vse::sequencer_preview_draw_empty().

◆ WM_draw_region_get_viewport()

GPUViewport * WM_draw_region_get_viewport ( ARegion * region )

Definition at line 940 of file wm_draw.cc.

References ARegion::runtime.

Referenced by DRW_draw_select_id(), ED_view3d_depth_override(), gizmo_find_intersected_3d(), ViewportColorSampleSession::init(), blender::ed::space_node::node_draw_space(), blender::ed::vse::timeline_draw_context_get(), view3d_depths_create(), view3d_depths_rect_create(), and wm_region_test_render_do_draw().

◆ WM_draw_region_viewport_bind()

void WM_draw_region_viewport_bind ( ARegion * region )

Definition at line 1726 of file wm_draw.cc.

References wm_draw_region_bind().

Referenced by ED_view3d_depth_override(), and ui_region_redraw_immediately().

◆ WM_draw_region_viewport_ensure()

void WM_draw_region_viewport_ensure	(	Scene *	scene,
		ARegion *	region,
		short	space_type )

Definition at line 1720 of file wm_draw.cc.

References ARegion::regiontype, wm_draw_region_buffer_create(), and wm_region_use_viewport_by_type().

Referenced by ED_view3d_depth_override().

◆ WM_draw_region_viewport_unbind()

void WM_draw_region_viewport_unbind ( ARegion * region )

Definition at line 1731 of file wm_draw.cc.

References wm_draw_region_unbind().

Referenced by ED_view3d_depth_override(), and ui_region_redraw_immediately().

◆ WM_dropbox_add()

wmDropBox * WM_dropbox_add	(	ListBase *	lb,
		const char *	idname,
		bool(*	poll )(bContext C, wmDrag drag, const wmEvent *event),
		void(*	copy )(bContext C, wmDrag drag, wmDropBox *drop),
		void(*	cancel )(Main bmain, wmDrag drag, wmDropBox *drop),
		WMDropboxTooltipFunc	tooltip )

◆ WM_dropbox_update_ot()

void WM_dropbox_update_ot ( )

Ensure operator pointers & properties are valid after operators have been added/removed.

Definition at line 176 of file wm_dragdrop.cc.

References dropboxes, LISTBASE_FOREACH, and wm_dropbox_item_update_ot().

Referenced by WM_keyconfig_update_ex().

◆ WM_dropboxmap_find()

ListBase * WM_dropboxmap_find	(	const char *	idname,
		int	spaceid,
		int	regionid )

spaceid / regionid are zero for window drop maps.

Definition at line 91 of file wm_dragdrop.cc.

References BLI_addtail(), dropboxes, wmDropBoxMap::dropboxes, wmDropBoxMap::idname, KMAP_MAX_NAME, LISTBASE_FOREACH, MEM_callocN(), wmDropBoxMap::regionid, wmDropBoxMap::spaceid, STREQLEN, and STRNCPY_UTF8.

Referenced by clip_dropboxes(), clip_init(), console_dropboxes(), console_main_region_init(), ed_default_handlers(), ED_dropbox_drop_extension(), ED_dropbox_drop_import_file(), ED_dropboxes_ui(), ED_keymap_screen(), file_dropboxes(), image_init(), blender::ed::space_node::node_dropboxes(), blender::ed::space_node::node_main_region_init(), blender::ed::outliner::outliner_dropboxes(), blender::ed::outliner::outliner_main_region_init(), blender::ed::vse::sequencer_dropboxes(), blender::ed::vse::sequencer_main_region_init(), blender::ed::vse::sequencer_preview_region_init(), text_dropboxes(), text_main_region_init(), view3d_dropboxes(), view3d_main_region_init(), and wm_window_ghostwindow_ensure().

◆ WM_enum_search_invoke()

wmOperatorStatus WM_enum_search_invoke	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

Definition at line 1201 of file wm_operators.cc.

References C, EnumSearchMenu::op, OPERATOR_INTERFACE, UI_popup_block_invoke_ex(), and wm_enum_search_menu().

Referenced by nlaedit_add_actionclip_invoke(), blender::ed::object::object_instance_add_invoke(), blender::ed::object::OBJECT_OT_collection_link(), blender::ed::object::OBJECT_OT_make_links_scene(), blender::ed::outliner::OUTLINER_OT_action_set(), PAINT_OT_project_image(), blender::ed::vse::sequencer_add_mask_strip_invoke(), blender::ed::vse::sequencer_add_movieclip_strip_invoke(), blender::ed::vse::sequencer_add_scene_strip_invoke(), blender::ed::vse::sequencer_change_scene_invoke(), and WM_event_add().

◆ WM_event_absolute_delta_x()

int WM_event_absolute_delta_x ( const wmEvent * event )

Definition at line 655 of file wm_event_query.cc.

References wmEvent::flag, and WM_EVENT_SCROLL_INVERT.

Referenced by view_zoomdrag_invoke().

◆ WM_event_absolute_delta_y()

int WM_event_absolute_delta_y ( const wmEvent * event )

Definition at line 666 of file wm_event_query.cc.

References wmEvent::flag, and WM_EVENT_SCROLL_INVERT.

Referenced by ui_colorpicker_wheel_cb(), ui_pan_to_scroll(), and view_zoomdrag_invoke().

◆ WM_event_add()

void wmEvent * WM_event_add	(	wmWindow *	win,
		const wmEvent *	event_to_add )

◆ WM_event_add_dropbox_handler()

wmEventHandler_Dropbox * WM_event_add_dropbox_handler	(	ListBase *	handlers,
		ListBase *	dropboxes )

◆ WM_event_add_fileselect()

void WM_event_add_fileselect	(	bContext *	C,
		wmOperator *	op )

The idea here is to keep a handler alive on window queue, owning the operator. The file window can send event to make it execute, thus ensuring executing happens outside of lower level queues, with UI refreshed. Should also allow multi-window solutions.

Definition at line 4441 of file wm_event_system.cc.

References wmEventHandler_Op::area, BLI_assert, C, wmOperatorType::check, CLG_quiet_get(), CLOG_WARN, wmEventHandler_Op::context, CTX_wm_area(), CTX_wm_area_set(), CTX_wm_manager(), CTX_wm_region(), CTX_wm_window(), CTX_wm_window_set(), ED_fileselect_handler_area_find(), wmWindow::eventstate, EVT_FILESELECT_CANCEL, EVT_FILESELECT_EXTERNAL_CANCEL, EVT_FILESELECT_FULL_OPEN, wmEventHandler_Op::head, wmEventHandler_Op::is_fileselect, LISTBASE_FOREACH_MUTABLE, MEM_callocN(), wmWindow::modalhandlers, wmEventHandler_Op::op, PROP_DIRPATH, PROP_FILENAME, PROP_FILEPATH, PROP_STRING, wmOperator::ptr, wmEventHandler_Op::region, RNA_property_subtype(), RNA_property_type(), RNA_struct_find_property(), wmEventHandler::type, wmOperator::type, wmEventHandler_Op::win, WM_event_fileselect_event(), wm_event_find_fileselect_root_window_from_context(), wm_handler_fileselect_do(), wm_handler_op_context_get_if_valid(), wm_handler_operator_insert(), WM_HANDLER_TYPE_OP, and WM_LOG_OPERATORS.

◆ WM_event_add_keymap_handler()

wmEventHandler_Keymap * WM_event_add_keymap_handler	(	ListBase *	handlers,
		wmKeyMap *	keymap )

Definition at line 4752 of file wm_event_system.cc.

References BLI_addtail(), CLOG_WARN, wmEventHandler_Keymap::head, wmEventHandler_Keymap::keymap, LISTBASE_FOREACH, MEM_callocN(), wmEventHandler::type, WM_HANDLER_TYPE_KEYMAP, and WM_LOG_EVENTS.

Referenced by action_buttons_area_init(), action_channel_region_init(), action_main_region_init(), buttons_main_region_init(), clip_properties_region_init(), clip_tools_region_init(), console_main_region_init(), ed_default_handlers(), ED_region_panels_init(), graph_channel_region_init(), graph_main_region_init(), image_asset_shelf_region_init(), image_buttons_region_init(), image_main_region_init(), image_tools_region_init(), info_main_region_init(), nla_main_region_init(), blender::ed::space_node::node_asset_shelf_region_init(), blender::ed::space_node::node_buttons_region_init(), blender::ed::space_node::node_main_region_init(), blender::ed::space_node::node_toolbar_region_init(), blender::ed::asset::shelf::region_init(), blender::ed::spreadsheet::spreadsheet_main_region_init(), blender::ed::spreadsheet::spreadsheet_sidebar_init(), topbar_main_region_init(), view3d_asset_shelf_region_init(), view3d_buttons_region_init(), view3d_header_region_init(), view3d_main_region_init(), view3d_tools_region_init(), WM_event_add_keymap_handler_poll(), and wm_window_ghostwindow_ensure().

◆ WM_event_add_keymap_handler_dynamic()

wmEventHandler_Keymap * WM_event_add_keymap_handler_dynamic	(	ListBase *	handlers,
		wmEventHandler_KeymapDynamicFn	keymap_fn,
		void *	user_data )

Definition at line 4897 of file wm_event_system.cc.

References BLI_addtail(), CLOG_WARN, wmEventHandler_Keymap::dynamic, wmEventHandler_Keymap::head, wmEventHandler_KeymapDynamic::keymap_fn, LISTBASE_FOREACH, MEM_callocN(), wmEventHandler::type, wmEventHandler_KeymapDynamic::user_data, WM_HANDLER_TYPE_KEYMAP, and WM_LOG_EVENTS.

Referenced by ed_default_handlers().

◆ WM_event_add_keymap_handler_poll()

wmEventHandler_Keymap * WM_event_add_keymap_handler_poll	(	ListBase *	handlers,
		wmKeyMap *	keymap,
		EventHandlerPoll	poll )

Definition at line 5014 of file wm_event_system.cc.

References wmEventHandler_Keymap::head, wmEventHandler::poll, and WM_event_add_keymap_handler().

Referenced by action_main_region_init(), clip_preview_region_init(), ed_default_handlers(), graph_main_region_init(), nla_track_region_init(), blender::ed::vse::sequencer_main_region_init(), and WM_event_add_keymap_handler_v2d_mask().

◆ WM_event_add_keymap_handler_priority()

wmEventHandler_Keymap * WM_event_add_keymap_handler_priority	(	ListBase *	handlers,
		wmKeyMap *	keymap,
		int	priority )

Note: Priorities not implemented yet, for time being just insert in begin of list.

Definition at line 4926 of file wm_event_system.cc.

References BLI_addhead(), wmEventHandler_Keymap::head, wmEventHandler_Keymap::keymap, MEM_callocN(), wmEventHandler::type, WM_event_remove_keymap_handler(), and WM_HANDLER_TYPE_KEYMAP.

Referenced by UI_popover_end().

◆ WM_event_add_keymap_handler_v2d_mask()

wmEventHandler_Keymap * WM_event_add_keymap_handler_v2d_mask	(	ListBase *	handlers,
		wmKeyMap *	keymap )

Definition at line 5027 of file wm_event_system.cc.

References WM_event_add_keymap_handler_poll(), and WM_event_handler_region_v2d_mask_poll().

Referenced by action_channel_region_init(), clip_channels_region_init(), clip_main_region_init(), clip_preview_region_init(), console_main_region_init(), file_execution_region_init(), file_header_region_init(), file_main_region_init(), file_tools_region_init(), file_ui_region_init(), graph_buttons_region_init(), graph_channel_region_init(), image_main_region_init(), nla_buttons_region_init(), nla_main_region_init(), nla_track_region_init(), blender::ed::space_node::node_main_region_init(), blender::ed::outliner::outliner_main_region_init(), script_main_region_init(), blender::ed::vse::sequencer_buttons_region_init(), blender::ed::vse::sequencer_channel_region_init(), blender::ed::vse::sequencer_main_region_init(), blender::ed::vse::sequencer_preview_region_init(), blender::ed::vse::sequencer_tools_region_init(), text_main_region_init(), and text_properties_region_init().

◆ WM_event_add_modal_handler()

wmEventHandler_Op wmEventHandler_Op * WM_event_add_modal_handler	(	bContext *	C,
		wmOperator *	op )

References C.

◆ WM_event_add_modal_handler_ex()

wmEventHandler_Op * WM_event_add_modal_handler_ex	(	wmWindow *	win,
		ScrArea *	area,
		ARegion *	region,
		wmOperator *	op )

Add a modal handler to win, area and region may optionally be NULL.

◆ WM_event_add_mousemove()

void WM_event_add_mousemove ( wmWindow * win )

Definition at line 5189 of file wm_event_system.cc.

References wmWindow::addmousemove.

Referenced by blender::ui::bonedropper_exit(), button_activate_exit(), datadropper_exit(), ED_area_newspace(), ED_area_swapspace(), ed_undo_redo_exec(), ed_undo_refresh_for_op(), ED_view3d_smooth_view_ex(), edbm_polybuild_delete_at_cursor_invoke(), edbm_polybuild_dissolve_at_cursor_invoke(), edbm_polybuild_face_at_cursor_invoke(), edbm_polybuild_split_at_cursor_invoke(), edbm_polybuild_transform_at_cursor_invoke(), edge_pan_apply_delta(), file_select_all_exec(), file_select_exec(), file_view_selected_exec(), file_walk_select_selection_set(), blender::ed::space_node::node_socket_toggle_exec(), poselib_blend_cleanup(), region_flip_exec(), screen_change_update(), ui_block_open_begin(), ui_but_extra_operator_icon_apply(), ui_button_press_invoke(), ui_do_but_BLOCK(), ui_handle_menu_event(), ui_handler_region_drag_toggle(), UI_pie_menu_end(), UI_popover_end(), ui_popover_panel_create(), UI_popup_block_ex(), UI_popup_block_invoke_ex(), ui_popup_handler(), ui_popup_menu_create_impl(), UI_popup_menu_end(), UI_view2d_edge_pan_cancel(), view2d_smoothview_invoke(), view3d_smoothview_apply_and_finish_ex(), view_pan_apply_ex(), wm_drags_exit(), wm_exit_schedule_delayed(), wm_gizmomap_modal_set(), and WM_gizmomap_select_all().

◆ WM_event_add_notifier()

void WM_event_add_notifier	(	const bContext *	C,
		unsigned int	type,
		void *	reference )

Definition at line 397 of file wm_event_system.cc.

References C, CTX_wm_manager(), CTX_wm_window(), and WM_event_add_notifier_ex().

◆ WM_event_add_notifier_ex()

void WM_event_add_notifier_ex	(	wmWindowManager *	wm,
		const wmWindow *	win,
		unsigned int	type,
		void *	reference )

Definition at line 383 of file wm_event_system.cc.

References wm_event_add_notifier_intern().

Referenced by blender::ed::asset::asset_catalog_delete_exec(), blender::ed::asset::asset_catalog_new_exec(), blender::ed::asset::asset_catalogs_save_exec(), file_draw_list(), ghost_event_proc(), WM_event_add_notifier(), wm_jobs_timer(), WM_main_add_notifier(), and wm_window_copy_test().

◆ WM_event_add_simulate()

wmEvent * WM_event_add_simulate	(	wmWindow *	win,
		const wmEvent *	event_to_add )

For testing only, see G_FLAG_EVENT_SIMULATE.

Definition at line 197 of file wm_event_system.cc.

References BLI_assert_unreachable, copy_v2_v2_int(), wmWindow::eventstate, G, G_FLAG_EVENT_SIMULATE, ISKEYBOARD, ISKEYBOARD_OR_BUTTON, MOUSEMOVE, wmEvent::prev_xy, UINT64_MAX, WM_event_add(), wm_event_state_update_and_click_set_ex(), and wmEvent::xy.

◆ WM_event_add_ui_handler()

wmEventHandler_UI * WM_event_add_ui_handler	(	const bContext *	C,
		ListBase *	handlers,
		wmUIHandlerFunc	handle_fn,
		wmUIHandlerRemoveFunc	remove_fn,
		void *	user_data,
		eWM_EventHandlerFlag	flag )

◆ WM_event_consecutive_data_free()

void WM_event_consecutive_data_free ( wmWindow * win )

Clear and free the consecutive custom-data.

Definition at line 4609 of file wm_event_system.cc.

References wmEvent_ConsecutiveData::custom_data, wmWindow::event_queue_consecutive_gesture_data, and MEM_freeN().

Referenced by ED_view3d_autodist_last_clear(), WM_event_consecutive_data_set(), wm_event_do_handlers(), and wm_window_free().

◆ WM_event_consecutive_data_get()

void * WM_event_consecutive_data_get	(	wmWindow *	win,
		const char *	id )

Return a borrowed reference to the custom-data.

Definition at line 4586 of file wm_event_system.cc.

References wmEvent_ConsecutiveData::custom_data, wmWindow::event_queue_consecutive_gesture_data, wmEvent_ConsecutiveData::id, and STREQ.

Referenced by ED_view3d_autodist_last_check(), and ED_view3d_autodist_last_get().

◆ WM_event_consecutive_data_set()

void WM_event_consecutive_data_set	(	wmWindow *	win,
		const char *	id,
		void *	custom_data )

Set the custom-data (and own the pointer), free with MEM_freeN.

Definition at line 4595 of file wm_event_system.cc.

References wmEvent_ConsecutiveData::custom_data, wmWindow::event_queue_consecutive_gesture_data, MEM_mallocN(), and WM_event_consecutive_data_free().

Referenced by ED_view3d_autodist_last_set().

◆ WM_event_consecutive_gesture_test()

bool WM_event_consecutive_gesture_test ( const wmEvent * event )

Return true if this event type is a candidate for being flagged as consecutive.

See: WM_EVENT_IS_CONSECUTIVE doc-string.

Definition at line 365 of file wm_event_query.cc.

References ISMOUSE_GESTURE, NDOF_MOTION, and wmEvent::type.

Referenced by ED_view3d_autodist_last_set(), and wm_event_do_handlers().

◆ WM_event_consecutive_gesture_test_break()

bool WM_event_consecutive_gesture_test_break	(	const wmWindow *	win,
		const wmEvent *	event )

Return true if this event should break the chain of consecutive gestures. Practically all intentional user input should, key presses or button clicks.

Definition at line 370 of file wm_event_query.cc.

References wmWindow::event_queue_consecutive_gesture_xy, ISKEYBOARD_OR_BUTTON, ISKEYMODIFIER, ISMOUSE_MOTION, len_manhattan_v2v2_int(), wmEvent::type, WINDEACTIVATE, WM_EVENT_CURSOR_MOTION_THRESHOLD, and wmEvent::xy.

Referenced by wm_event_do_handlers().

◆ WM_event_drag_direction()

int WM_event_drag_direction ( const wmEvent * event )

Definition at line 289 of file wm_event_query.cc.

References atan2f, KM_DIRECTION_E, KM_DIRECTION_N, KM_DIRECTION_NE, KM_DIRECTION_NW, KM_DIRECTION_S, KM_DIRECTION_SE, KM_DIRECTION_SW, KM_DIRECTION_W, M_PI, printf, and round_fl_to_int().

Referenced by wm_handlers_do().

◆ WM_event_drag_image()

void WM_event_drag_image	(	wmDrag *	drag,
		const ImBuf *	imb,
		float	scale )

Definition at line 358 of file wm_dragdrop.cc.

References wmDrag::imb, and wmDrag::imbuf_scale.

Referenced by ui_but_drag_start().

◆ WM_event_drag_path_override_poin_data_with_space_file_paths()

void WM_event_drag_path_override_poin_data_with_space_file_paths	(	const bContext *	C,
		wmDrag *	drag )

Overrides the drag.poin event to include all selected files in the space file where the event started.

Definition at line 364 of file wm_dragdrop.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), BLI_assert, C, CTX_wm_space_file(), ED_fileselect_selected_files_full_paths(), blender::Vector< T, InlineBufferCapacity, Allocator >::is_empty(), wmDrag::poin, wmDrag::type, WM_drag_create_path_data(), WM_drag_data_free(), and WM_DRAG_PATH.

Referenced by ui_but_drag_start().

◆ WM_event_drag_preview_icon()

void WM_event_drag_preview_icon	(	wmDrag *	drag,
		int	icon_id )

Definition at line 384 of file wm_dragdrop.cc.

References BLI_assert_msg, wmDrag::imb, and wmDrag::preview_icon_id.

Referenced by ui_but_drag_start().

◆ WM_event_drag_start_mval()

void WM_event_drag_start_mval	(	const wmEvent *	event,
		const ARegion *	region,
		int	r_mval[2] )

Definition at line 440 of file wm_event_query.cc.

References KM_PRESS_DRAG, wmEvent::prev_press_xy, ARegion::winrct, rcti::xmin, xy, and rcti::ymin.

◆ WM_event_drag_start_mval_fl()

void WM_event_drag_start_mval_fl	(	const wmEvent *	event,
		const ARegion *	region,
		float	r_mval[2] )

Definition at line 447 of file wm_event_query.cc.

References KM_PRESS_DRAG, wmEvent::prev_press_xy, ARegion::winrct, rcti::xmin, xy, and rcti::ymin.

Referenced by annotation_draw_apply_event(), gizmo_ruler_invoke(), blender::ed::transform::initTransInfo(), and view3d_interactive_add_modal().

◆ WM_event_drag_start_xy()

void WM_event_drag_start_xy	(	const wmEvent *	event,
		int	r_xy[2] )

Definition at line 454 of file wm_event_query.cc.

References copy_v2_v2_int(), KM_PRESS_DRAG, wmEvent::prev_press_xy, wmEvent::val, and wmEvent::xy.

Referenced by WM_gesture_new().

◆ WM_event_drag_test()

bool WM_event_drag_test	(	const wmEvent *	event,
		const int	prev_xy[2] )

Definition at line 433 of file wm_event_query.cc.

References sub_v2_v2v2_int(), WM_event_drag_test_with_delta(), and wmEvent::xy.

Referenced by curve_pen_modal(), wm_event_is_double_click(), and wm_handlers_do().

◆ WM_event_drag_test_with_delta()

bool WM_event_drag_test_with_delta	(	const wmEvent *	event,
		const int	drag_delta[2] )

Definition at line 427 of file wm_event_query.cc.

References abs, and WM_event_drag_threshold().

Referenced by WM_event_drag_test(), and WM_generic_select_modal().

◆ WM_event_drag_threshold()

int WM_event_drag_threshold ( const wmEvent * event )

Definition at line 405 of file wm_event_query.cc.

References BLI_assert, ISMOUSE_BUTTON, MOUSEMOVE, wmEvent::prev_press_type, U, UI_SCALE_FAC, and WM_event_is_tablet().

Referenced by region_scale_modal(), ui_but_drag_init(), ui_do_but_NUM(), ui_do_but_SCROLL(), ui_do_but_SLI(), ui_handle_button_event(), and WM_event_drag_test_with_delta().

◆ WM_event_fileselect_event()

void WM_event_fileselect_event	(	wmWindowManager *	wm,
		void *	ophandle,
		int	eventval )

Definition at line 4380 of file wm_event_system.cc.

References wmWindow::eventstate, EVT_FILESELECT, LISTBASE_FOREACH, wmEvent::type, wmWindowManager::windows, and WM_event_add().

Referenced by ED_fileselect_exit(), file_cancel_exec(), file_execute(), and WM_event_add_fileselect().

◆ WM_event_free_ui_handler_all()

void WM_event_free_ui_handler_all	(	bContext *	C,
		ListBase *	handlers,
		wmUIHandlerFunc	handle_fn,
		wmUIHandlerRemoveFunc	remove_fn )

Definition at line 5113 of file wm_event_system.cc.

References BLI_remlink(), C, wmEventHandler_UI::handle_fn, wmEventHandler_UI::head, LISTBASE_FOREACH_MUTABLE, wmEventHandler_UI::remove_fn, wmEventHandler_UI::user_data, wm_event_free_handler(), and WM_HANDLER_TYPE_UI.

Referenced by ui_popup_handler(), and UI_popup_handlers_remove_all().

◆ WM_event_get_keymap_from_toolsystem()

void WM_event_get_keymap_from_toolsystem	(	wmWindowManager *	wm,
		wmWindow *	win,
		wmEventHandler_Keymap *	handler,
		wmEventHandler_KeymapResult *	km_result )

Definition at line 4889 of file wm_event_system.cc.

References wm_event_get_keymap_from_toolsystem_ex().

Referenced by ed_default_handlers().

◆ WM_event_get_keymap_from_toolsystem_with_gizmos()

void WM_event_get_keymap_from_toolsystem_with_gizmos	(	wmWindowManager *	wm,
		wmWindow *	win,
		wmEventHandler_Keymap *	handler,
		wmEventHandler_KeymapResult *	km_result )

Definition at line 4881 of file wm_event_system.cc.

References wm_event_get_keymap_from_toolsystem_ex().

Referenced by ed_default_handlers().

◆ WM_event_get_keymaps_from_handler()

void WM_event_get_keymaps_from_handler	(	wmWindowManager *	wm,
		wmWindow *	win,
		wmEventHandler_Keymap *	handler,
		wmEventHandler_KeymapResult *	km_result )

Definition at line 6498 of file wm_event_system.cc.

References BLI_assert, wmEventHandler_Keymap::dynamic, wmEventHandler_Keymap::keymap, wmEventHandler_KeymapDynamic::keymap_fn, wmEventHandler_KeymapResult::keymaps, wmEventHandler_KeymapResult::keymaps_len, and WM_keymap_active().

Referenced by menu_types_add_from_keymap_items(), WM_event_match_keymap_item_from_handlers(), wm_handlers_do_intern(), and wm_keymap_item_find_handlers().

◆ WM_event_handler_region_marker_poll()

bool WM_event_handler_region_marker_poll	(	const wmWindow *	win,
		const ScrArea *	area,
		const ARegion *	region,
		const wmEvent *	event )

Returns: true when the event is inside the marker region.

Note: There are no checks that markers are displayed.

Definition at line 4962 of file wm_event_system.cc.

References BLI_listbase_is_empty(), BLI_rcti_isect_pt_v(), ED_markers_region_visible(), ED_scene_markers_get_from_area(), WorkSpace::sequencer_scene, SPACE_SEQ, ScrArea::spacetype, UI_MARKER_MARGIN_Y, ARegion::winrct, WM_window_get_active_scene(), WM_window_get_active_view_layer(), WM_window_get_active_workspace(), wmEvent::xy, rcti::ymax, and rcti::ymin.

Referenced by ed_default_handlers(), and WM_event_handler_region_v2d_mask_no_marker_poll().

◆ WM_event_handler_region_v2d_mask_no_marker_poll()

bool WM_event_handler_region_v2d_mask_no_marker_poll	(	const wmWindow *	win,
		const ScrArea *	area,
		const ARegion *	region,
		const wmEvent *	event )

A version of WM_event_handler_region_v2d_mask_poll which excludes events (returning false) in the marker region.

Note: uses the EventHandlerPoll signature.

Definition at line 4997 of file wm_event_system.cc.

References BLI_listbase_is_empty(), ED_scene_markers_get_from_area(), WM_event_handler_region_marker_poll(), WM_event_handler_region_v2d_mask_poll(), WM_window_get_active_scene(), and WM_window_get_active_view_layer().

Referenced by action_main_region_init(), graph_main_region_init(), nla_track_region_init(), and blender::ed::vse::sequencer_main_region_init().

◆ WM_event_handler_region_v2d_mask_poll()

bool WM_event_handler_region_v2d_mask_poll	(	const wmWindow *	win,
		const ScrArea *	area,
		const ARegion *	region,
		const wmEvent *	event )

Returns: true when the event should be handled by the 2D views masked region.

Note: uses the EventHandlerPoll signature.

Definition at line 4952 of file wm_event_system.cc.

References BLI_rcti_translate(), event_or_prev_in_rect(), View2D::mask, ARegion::v2d, ARegion::winrct, rcti::xmin, and rcti::ymin.

Referenced by WM_event_add_keymap_handler_v2d_mask(), and WM_event_handler_region_v2d_mask_no_marker_poll().

◆ wm_event_init_from_window()

void wmEvent void wm_event_init_from_window	(	wmWindow *	win,
		wmEvent *	event )

Definition at line 314 of file wm_event_system.cc.

References wmWindow::eventstate.

Referenced by actionzone_apply(), ghost_event_proc(), ui_but_activate_event(), UI_but_focus_on_enter_event(), WM_event_add(), wm_event_handler_ui_cancel_ex(), and wm_window_timers_process().

◆ WM_event_is_modal_drag_exit()

bool WM_event_is_modal_drag_exit	(	const wmEvent *	event,
		short	init_event_type,
		short	init_event_val )

For modal callbacks, check configuration for how to interpret exit when dragging.

Definition at line 246 of file wm_event_query.cc.

References KM_PRESS_DRAG, KM_RELEASE, wmEvent::type, U, USER_RELEASECONFIRM, and wmEvent::val.

Referenced by ed_marker_move_modal().

◆ WM_event_is_mouse_drag()

bool WM_event_is_mouse_drag ( const wmEvent * event )

Definition at line 278 of file wm_event_query.cc.

References ISMOUSE_BUTTON, KM_PRESS_DRAG, wmEvent::type, and wmEvent::val.

Referenced by gizmo_tweak_invoke(), and WM_event_is_mouse_drag_or_press().

◆ WM_event_is_mouse_drag_or_press()

bool WM_event_is_mouse_drag_or_press ( const wmEvent * event )

Definition at line 283 of file wm_event_query.cc.

References ISMOUSE_BUTTON, KM_PRESS, wmEvent::type, and WM_event_is_mouse_drag().

Referenced by WM_gesture_box_invoke(), WM_gesture_circle_invoke(), and WM_gesture_straightline_invoke().

◆ WM_event_is_tablet()

bool WM_event_is_tablet ( const wmEvent * event )

Definition at line 640 of file wm_event_query.cc.

References wmTabletData::active, EVT_TABLET_NONE, and wmEvent::tablet.

Referenced by blender::ed::sculpt_paint::paint_stroke_modal(), and WM_event_drag_threshold().

◆ WM_event_match()

bool WM_event_match	(	const wmEvent *	winevent,
		const wmKeyMapItem *	kmi )

Definition at line 6560 of file wm_event_system.cc.

References wm_eventmatch().

Referenced by ED_view3d_navigation_do().

◆ WM_event_match_keymap_item()

wmKeyMapItem * WM_event_match_keymap_item	(	bContext *	C,
		wmKeyMap *	keymap,
		const wmEvent *	event )

Definition at line 6517 of file wm_event_system.cc.

References C, blender::wm::InvokeDefault, wmKeyMap::items, LISTBASE_FOREACH, ot, wm_eventmatch(), WM_operator_poll_context(), and WM_operatortype_find().

Referenced by WM_event_match_keymap_item_from_handlers().

◆ WM_event_match_keymap_item_from_handlers()

wmKeyMapItem * WM_event_match_keymap_item_from_handlers	(	bContext *	C,
		wmWindowManager *	wm,
		wmWindow *	win,
		ListBase *	handlers,
		const wmEvent *	event )

Definition at line 6530 of file wm_event_system.cc.

References C, CTX_wm_area(), CTX_wm_region(), wmEventHandler_KeymapResult::keymaps, wmEventHandler_KeymapResult::keymaps_len, LISTBASE_FOREACH, WM_event_get_keymaps_from_handler(), WM_event_match_keymap_item(), WM_HANDLER_DO_FREE, WM_HANDLER_TYPE_KEYMAP, and WM_keymap_poll().

Referenced by WM_window_cursor_keymap_status_refresh().

◆ WM_event_modal_handler_area_replace()

void WM_event_modal_handler_area_replace	(	wmWindow *	win,
		const ScrArea *	old_area,
		ScrArea *	new_area )

Modal handlers store a pointer to an area which might be freed while the handler runs. Use this function to NULL all handler pointers to old_area.

Definition at line 4707 of file wm_event_system.cc.

References wmEventHandler_Op::area, wmEventHandler_Op::context, wmEventHandler_Op::is_fileselect, LISTBASE_FOREACH, wmWindow::modalhandlers, and WM_HANDLER_TYPE_OP.

Referenced by area_offscreen_exit(), and ED_area_exit().

◆ WM_event_modal_handler_region_replace()

void WM_event_modal_handler_region_replace	(	wmWindow *	win,
		const ARegion *	old_region,
		ARegion *	new_region )

Modal handlers store a pointer to a region which might be freed while the handler runs. Use this function to NULL all handler pointers to old_region.

Definition at line 4721 of file wm_event_system.cc.

References wmEventHandler_Op::context, wmEventHandler_Op::is_fileselect, LISTBASE_FOREACH, wmWindow::modalhandlers, wmEventHandler_Op::region, wmEventHandler_Op::region_type, ARegion::regiontype, RGN_TYPE_WINDOW, and WM_HANDLER_TYPE_OP.

Referenced by area_join_modal(), area_offscreen_exit(), and ED_region_exit().

◆ WM_event_print()

void WM_event_print ( const wmEvent * event )

For debugging only, getting inspecting events manually is tedious.

Definition at line 75 of file wm_event_query.cc.

References wmTabletData::active, ARRAY_SIZE, BLI_str_utf8_size_or_error(), event_ids_from_flag(), event_ids_from_type_and_value(), EVT_TABLET_NONE, wmEvent::flag, ISNDOF, wmEvent::keymodifier, KM_ALT, KM_CTRL, KM_HYPER, KM_OSKEY, KM_SHIFT, wmEvent::modifier, NDOF_MOTION, wmTabletData::pressure, wmEvent::prev_type, wmEvent::prev_val, printf, wmTabletData::tilt, wmEvent::type, UNPACK3, wmEvent::utf8_buf, wmEvent::val, WM_EVENT_FORCE_DRAG_THRESHOLD, WM_EVENT_IS_CONSECUTIVE, WM_EVENT_IS_REPEAT, WM_EVENT_SCROLL_INVERT, and wmEvent::xy.

Referenced by wm_event_add_ghostevent(), wm_event_do_handlers(), and wm_event_free().

◆ WM_event_remove_handlers()

void WM_event_remove_handlers	(	bContext *	C,
		ListBase *	handlers )

Called on exit or remove area, only here call cancel callback.

Definition at line 2277 of file wm_event_system.cc.

References wmEventHandler_UI::area, BLI_assert, BLI_pophead(), C, wmOperatorType::cancel, wmEventHandler_UI::context, CTX_wm_area(), CTX_wm_area_set(), CTX_wm_manager(), CTX_wm_region(), CTX_wm_region_popup(), CTX_wm_region_popup_set(), CTX_wm_region_set(), CTX_wm_window(), ED_area_exit(), ED_fileselect_handler_area_find(), wmWindow::eventstate, wmOperatorType::flag, wmEventHandler_Op::is_fileselect, LISTBASE_FOREACH, wmEventHandler_Op::op, wmWindowManager::op_undo_depth, OPTYPE_UNDO, wmEventHandler_UI::region, wmEventHandler_UI::region_popup, wmEventHandler_UI::remove_fn, screen_temp_region_exists(), wmOperator::type, wmEventHandler_UI::user_data, wmWindowManager::windows, WM_cursor_grab_disable(), wm_event_free_handler(), wm_handler_op_context(), WM_HANDLER_TYPE_OP, WM_HANDLER_TYPE_UI, WM_operator_free(), and wm_operator_free_for_fileselect().

Referenced by ED_area_exit(), ED_region_exit(), ED_region_visibility_change_update_ex(), WM_exit_ex(), wm_file_read_setup_wm_init(), wm_window_close(), and wm_window_free().

◆ WM_event_remove_handlers_by_area()

void WM_event_remove_handlers_by_area	(	ListBase *	handlers,
		const ScrArea *	area )

Definition at line 5152 of file wm_event_system.cc.

References wmEventHandler_UI::area, BLI_remlink(), wmEventHandler_UI::context, LISTBASE_FOREACH_MUTABLE, wm_event_free_handler(), and WM_HANDLER_TYPE_UI.

Referenced by screen_change_prepare(), and wm_xr_runtime_data_free().

◆ WM_event_remove_keymap_handler()

void WM_event_remove_keymap_handler	(	ListBase *	handlers,
		wmKeyMap *	keymap )

Definition at line 5032 of file wm_event_system.cc.

References BLI_remlink(), wmEventHandler_Keymap::head, wmEventHandler_Keymap::keymap, LISTBASE_FOREACH, wm_event_free_handler(), and WM_HANDLER_TYPE_KEYMAP.

Referenced by ui_block_free_func_POPOVER(), and WM_event_add_keymap_handler_priority().

◆ WM_event_remove_modal_handler_all()

wmEventHandler_Op wmEventHandler_Op void void WM_event_remove_modal_handler_all	(	const wmOperator *	op,
		bool	postpone )

Definition at line 4698 of file wm_event_system.cc.

References ListBase::first, G_MAIN, LISTBASE_FOREACH, wmWindow::modalhandlers, wmWindowManager::windows, Main::wm, and WM_event_remove_model_handler().

◆ WM_event_remove_model_handler()

wmEventHandler_Op wmEventHandler_Op void WM_event_remove_model_handler	(	ListBase *	handlers,
		const wmOperator *	op,
		bool	postpone )

References C, and dropboxes.

◆ WM_event_remove_ui_handler()

void WM_event_remove_ui_handler	(	ListBase *	handlers,
		wmUIHandlerFunc	handle_fn,
		wmUIHandlerRemoveFunc	remove_fn,
		void *	user_data,
		bool	postpone )

Parameters

postpone Enable for win->modalhandlers, this is in a running for () loop in wm_handlers_do().

Definition at line 5087 of file wm_event_system.cc.

References BLI_remlink(), wmEventHandler::flag, wmEventHandler_UI::handle_fn, wmEventHandler_UI::head, LISTBASE_FOREACH, wmEventHandler_UI::remove_fn, wmEventHandler_UI::user_data, wm_event_free_handler(), WM_HANDLER_DO_FREE, and WM_HANDLER_TYPE_UI.

Referenced by button_activate_state(), panel_activate_state(), ui_handler_region_drag_toggle(), ui_handler_wait_for_input(), ui_panel_drag_collapse_handler(), UI_popup_handlers_remove(), and UI_region_handlers_add().

◆ WM_event_set_keymap_handler_post_callback()

void WM_event_set_keymap_handler_post_callback	(	wmEventHandler_Keymap *	handler,
		void(keymap_tag)(wmKeyMap keymap, wmKeyMapItem kmi, void *user_data)	,
		void *	user_data )

Definition at line 5046 of file wm_event_system.cc.

References wmEventHandler_Keymap::post, wmEventHandler_KeymapPost::post_fn, and wmEventHandler_KeymapPost::user_data.

Referenced by UI_popover_end().

◆ WM_event_start_drag()

void WM_event_start_drag	(	bContext *	C,
		int	icon,
		eWM_DragDataType	type,
		void *	poin,
		unsigned int	flags )

Start dragging immediately with the given data. Note that poin should be valid allocated and not on stack.

Definition at line 317 of file wm_dragdrop.cc.

References C, WM_drag_data_create(), and WM_event_start_prepared_drag().

Referenced by ghost_event_proc(), ui_but_drag_init(), ui_but_drag_start(), and UI_view_item_drag_start().

◆ WM_event_start_prepared_drag()

void WM_event_start_prepared_drag	(	bContext *	C,
		wmDrag *	drag )

Invoke dragging using the given drag data.

Definition at line 309 of file wm_dragdrop.cc.

References BLI_addtail(), C, CTX_wm_manager(), wmWindowManager::runtime, and wm_dropbox_invoke().

Referenced by blender::ed::outliner::outliner_item_drag_drop_invoke(), ui_but_drag_start(), and WM_event_start_drag().

◆ WM_event_tablet_data()

float WM_event_tablet_data	(	const wmEvent *	event,
		bool *	r_pen_flip,
		float	r_tilt[2] )

If this is a tablet event, return tablet pressure and set *pen_flip to 1 if the eraser tool is being used, 0 otherwise.

Definition at line 627 of file wm_event_query.cc.

References copy_v2_v2(), EVT_TABLET_ERASER, wmEvent::tablet, and wmTabletData::tilt.

Referenced by blender::ed::sculpt_paint::paint_stroke_modal(), and blender::ed::sculpt_paint::filter::sculpt_mesh_filter_modal().

◆ WM_event_tablet_data_default_set()

void WM_event_tablet_data_default_set ( wmTabletData * tablet_data )

Definition at line 5598 of file wm_event_system.cc.

References wm_event_tablet_data_default().

◆ WM_event_timer_add()

wmTimer * WM_event_timer_add	(	wmWindowManager *	wm,
		wmWindow *	win,
		wmEventType	event_type,
		double	time_step )

At maximum, every time_step seconds it triggers event_type events.

Definition at line 2342 of file wm_window.cc.

References BLI_addtail(), BLI_assert, BLI_time_now_seconds(), wmTimer::event_type, ISTIMER, MEM_callocN(), wmWindowManager::runtime, wmTimer::time_last, wmTimer::time_next, wmTimer::time_start, wmTimer::time_step, and wmTimer::win.

Referenced by button_activate_state(), ED_region_visibility_change_update_animated(), ED_screen_animation_timer(), ED_uvedit_live_unwrap_begin(), ED_view3d_smooth_view_ex(), file_params_invoke_rename_postscroll(), image_view_zoom_init(), initFlyInfo(), initWalkInfo(), minimize_stretch_invoke(), blender::ed::space_node::node_add_image_exec(), blender::ed::space_node::node_add_import_node_exec(), blender::ed::space_node::node_insert_offset_invoke(), blender::ed::sculpt_paint::paint_stroke_modal(), panel_handle_data_ensure(), text_cursor_timer_ensure(), ui_handle_button_event(), ui_handle_menu_event(), ui_pie_handler(), UI_view2d_smooth_view(), uv_sculpt_stroke_invoke(), view_zoom_init(), view_zoomdrag_invoke(), viewzoom_invoke_impl(), wm_autosave_timer_begin_ex(), WM_event_add(), WM_jobs_start(), WM_report_banner_show(), WM_tooltip_init(), and WM_tooltip_timer_init_ex().

◆ WM_event_timer_add_notifier()

wmTimer * WM_event_timer_add_notifier	(	wmWindowManager *	wm,
		wmWindow *	win,
		unsigned int	type,
		double	time_step )

Definition at line 2364 of file wm_window.cc.

References BLI_addtail(), BLI_assert, BLI_time_now_seconds(), wmTimer::customdata, wmTimer::event_type, wmTimer::flags, MEM_callocN(), POINTER_FROM_UINT, wmWindowManager::runtime, wmTimer::time_last, wmTimer::time_next, wmTimer::time_start, wmTimer::time_step, TIMERNOTIFIER, wmTimer::win, and WM_TIMER_NO_FREE_CUSTOM_DATA.

Referenced by file_draw_list(), and WM_event_add().

◆ WM_event_timer_free_data()

void WM_event_timer_free_data ( wmTimer * timer )

Definition at line 2399 of file wm_window.cc.

References MEM_freeN(), timer, and WM_TIMER_NO_FREE_CUSTOM_DATA.

Referenced by WM_event_add(), WM_event_timer_remove(), and blender::bke::WindowManagerRuntime::~WindowManagerRuntime().

◆ WM_event_timer_remove()

void WM_event_timer_remove	(	wmWindowManager *	wm,
		wmWindow *	win,
		wmTimer *	timer )

Mark the given timer to be removed, actual removal and deletion is deferred and handled internally by the window manager code.

Definition at line 2407 of file wm_window.cc.

References BLI_findindex(), EVENT_NONE, LISTBASE_FOREACH, wmWindowManager::runtime, timer, wmWindowManager::windows, WM_event_timer_free_data(), and WM_TIMER_TAGGED_FOR_REMOVAL.

Referenced by area_offscreen_exit(), button_activate_state(), ED_editors_init_for_undo(), ED_region_exit(), ED_screen_animation_timer(), ED_screen_exit(), ED_screen_state_toggle(), ED_uvedit_live_unwrap_end(), ED_view3d_smooth_view_ex(), ViewOpsData::end_navigation(), file_params_smoothscroll_timer_clear(), flyEnd(), image_view_zoom_exit(), minimize_stretch_exit(), blender::ed::space_node::node_add_nodes_modal(), blender::ed::space_node::node_insert_offset_modal(), blender::ed::sculpt_paint::paint_stroke_free(), panel_activate_state(), region_blend_end(), text_cursor_timer_remove(), UI_but_tooltip_timer_remove(), ui_handle_button_event(), ui_popup_block_remove(), UI_view2d_smooth_view(), update_reports_display_invoke(), uv_sculpt_stroke_exit(), view2d_smoothview_invoke(), view3d_smoothview_apply_and_finish_ex(), view_zoom_exit(), view_zoomdrag_exit(), walkEnd(), wm_autosave_timer_end(), WM_event_add(), WM_event_timer_remove_notifier(), wm_jobs_kill_job(), WM_jobs_start(), wm_jobs_timer(), WM_report_banner_show(), WM_report_banners_cancel(), wm_reports_free(), WM_tooltip_timer_clear(), and wm_window_free().

◆ WM_event_timer_remove_notifier()

void WM_event_timer_remove_notifier	(	wmWindowManager *	wm,
		wmWindow *	win,
		wmTimer *	timer )

Definition at line 2435 of file wm_window.cc.

References timer, and WM_event_timer_remove().

Referenced by file_draw_list(), file_exit(), file_refresh(), and WM_event_add().

◆ WM_event_timer_sleep()

void WM_event_timer_sleep	(	wmWindowManager *	wm,
		wmWindow *	win,
		wmTimer *	timer,
		bool	do_sleep )

To (de)activate running timers temporary.

Definition at line 2328 of file wm_window.cc.

References BLI_findindex(), wmWindowManager::runtime, timer, and WM_TIMER_TAGGED_FOR_REMOVAL.

Referenced by screen_change_prepare(), screen_refresh_if_needed(), and WM_event_add().

◆ WM_event_ui_handler_region_popup_replace()

void WM_event_ui_handler_region_popup_replace	(	wmWindow *	win,
		const ARegion *	old_region,
		ARegion *	new_region )

Definition at line 4738 of file wm_event_system.cc.

References wmEventHandler_UI::context, LISTBASE_FOREACH, wmWindow::modalhandlers, wmEventHandler_UI::region_popup, and WM_HANDLER_TYPE_UI.

Referenced by ED_region_exit().

◆ WM_event_utf8_to_ascii()

char WM_event_utf8_to_ascii ( const wmEvent * event )

Definition at line 465 of file wm_event_query.cc.

References BLI_str_utf8_size_or_error(), and wmEvent::utf8_buf.

Referenced by handleNumInput(), and text_line_number_invoke().

◆ WM_exit()

void WM_exit	(	bContext *	C,
		int	exit_code )

Main exit function to close Blender ordinarily.

Note: Use wm_exit_schedule_delayed() to close Blender from an operator. Might leak memory otherwise.

Parameters

exit_code Passed to #exit, typically #EXIT_SUCCESS or #EXIT_FAILURE should be used. With failure being used for an early exit when parsing command line arguments fails. Note that any exit-code besides #EXIT_SUCCESS calls WM_exit_ex with its do_user_exit_actions argument set to false.

Definition at line 691 of file wm_init_exit.cc.

References C, CLG_quiet_get(), false, G, printf, and WM_exit_ex().

Referenced by CocoaAppDelegate::applicationWillTerminate:, arg_handle_python_expr_run(), arg_handle_python_file_run(), arg_handle_python_text_run(), handle_load_file(), main(), wm_exit_handler(), and WM_init().

◆ WM_exit_ex()

void WM_exit_ex	(	bContext *	C,
		bool	do_python_exit,
		bool	do_user_exit_actions )

Main exit function (implementation).

Note: Unlike WM_exit this does not call exit(), the caller is responsible for this.

Parameters

C	The context or null, a null context implies do_user_exit_actions == false & prevents some editor-exit operations from running.
do_python_exit	Exit the Python interpreter (unless WITH_PYTHON_MODULE is enabled).
do_user_exit_actions	When enabled perform actions associated with a user having been using Blender then exiting. Actions such as writing the auto-save and writing any changes to preferences. Set to false in background mode or when exiting because of failed command line argument parsing. In general automated actions where the user isn't making changes should pass in false too.

Definition at line 451 of file wm_init_exit.cc.

References ANIM_driver_vars_copybuf_free(), ANIM_drivers_copybuf_free(), ANIM_fcurves_copybuf_free(), ANIM_fmodifiers_copybuf_free(), BKE_addon_pref_type_free(), BKE_appdir_exit(), BKE_blender_atexit(), BKE_blender_cli_command_free_all(), BKE_blender_free(), BKE_blender_userdef_data_free(), BKE_blendfile_userdef_write_all(), BKE_image_free_unused_gpu_textures(), BKE_keyconfig_pref_type_free(), BKE_mask_clipboard_free(), BKE_materials_exit(), BKE_mball_cubeTable_free(), BKE_sound_exit_once(), BKE_tempdir_base(), BKE_tempdir_session_purge(), BKE_tracking_clipboard_free(), BKE_vfont_clipboard_free(), BLENDER_QUIT_FILE, BLF_exit(), BLI_assert, BLI_path_join, BLI_task_scheduler_exit(), BLI_threadapi_exit(), BLI_timer_free(), BLO_write_file(), BLT_lang_free(), BPY_python_end(), BPY_run_string_eval(), C, blender::memory_cache::clear(), CLG_exit(), blender::ed::greasepencil::clipboard_free(), CLOG_INFO_NOCHECK, COM_deinitialize(), CTX_data_main(), CTX_free(), CTX_py_init_get(), CTX_wm_manager(), CTX_wm_window_set(), DNA_sdna_current_free(), blender::draw::DRW_cache_free_old_subdiv(), DRW_gpu_context_destroy(), DRW_gpu_context_disable_ex(), DRW_gpu_context_enable_ex(), ED_editors_exit(), ED_editors_flush_edits(), ED_file_exit(), ED_gpencil_anim_copybuf_free(), ED_node_clipboard_free(), ED_preview_free_dbase(), ED_preview_restart_queue_free(), ED_screen_exit(), ED_undosys_type_free(), blender::bke::subdiv::exit(), FILE_MAX, free_openrecent(), G, G_FILE_COMPRESS, G_FILE_RECOVER_WRITE, G_FLAG_USERPREF_NO_SAVE_ON_EXIT, GPU_exit(), gpu_is_init, GPU_shader_cache_dir_clear_old(), blender::animrig::keyingset_infos_exit(), LISTBASE_FOREACH, LOG_BLEND, RE_engines_exit(), RE_FreeAllRender(), RNA_exit(), blender::ed::asset::list::storage_exit(), U, UI_exit(), USER_PREF_FLAG_SAVE, UV_clipboard_free(), wm_autosave_delete(), wm_clipboard_free(), wm_dropbox_free(), WM_event_remove_handlers(), wm_ghost_exit(), wm_gizmogrouptype_free(), wm_gizmomaptypes_free(), wm_gizmotype_free(), WM_jobs_kill_all(), WM_menutype_free(), wm_operatortype_free(), WM_paneltype_clear(), wm_surfaces_free(), wm_test_autorun_revert_action_set(), WM_uilisttype_free(), WM_window_get_active_screen(), and blender::ui::string_search::write_recent_searches_file().

Referenced by arg_handle_engine_set(), bpy_atexit(), and WM_exit().

◆ WM_file_append_datablock()

ID * WM_file_append_datablock	(	Main *	bmain,
		Scene *	scene,
		ViewLayer *	view_layer,
		View3D *	v3d,
		const char *	filepath,
		short	id_code,
		const char *	id_name,
		int	flag )

Note: scene (and related view_layer and v3d) pointers may be NULL, in which case no instantiation of appended objects, collections etc. will be performed.

Definition at line 792 of file wm_files_link.cc.

References BLI_assert, FILE_LINK, flag, and wm_file_link_append_datablock_ex().

Referenced by blender::ed::asset::asset_local_id_ensure_imported(), WM_drag_asset_id_import(), and workspace_append_activate_exec().

◆ WM_file_autoexec_init()

void WM_file_autoexec_init ( const char * filepath )

Definition at line 641 of file wm_files.cc.

References BKE_autoexec_match(), BLI_path_split_dir_part(), FILE_MAX, G, G_FLAG_SCRIPT_AUTOEXEC, and G_FLAG_SCRIPT_OVERRIDE_PREF.

Referenced by WM_file_read().

◆ WM_file_autosave_init()

void WM_file_autosave_init ( wmWindowManager * wm )

Definition at line 2394 of file wm_files.cc.

References wm_autosave_timer_begin().

Referenced by WM_check().

◆ WM_file_link_datablock()

ID * WM_file_link_datablock	(	Main *	bmain,
		Scene *	scene,
		ViewLayer *	view_layer,
		View3D *	v3d,
		const char *	filepath,
		short	id_code,
		const char *	id_name,
		int	flag )

Note: scene (and related view_layer and v3d) pointers may be NULL, in which case no instantiation of linked objects, collections etc. will be performed.

Definition at line 778 of file wm_files_link.cc.

References FILE_LINK, flag, and wm_file_link_append_datablock_ex().

Referenced by blender::ed::asset::asset_local_id_ensure_imported(), and WM_drag_asset_id_import().

◆ WM_file_read()

bool WM_file_read	(	bContext *	C,
		const char *	filepath,
		const bool	use_scripts_autoexec_check,
		ReportList *	reports )

Parameters

use_scripts_autoexec_check When true, script auto-execution checks excluded directories. Note that this is passed in as an argument because filepath may reference a path to recover. In this case the file-path used for exclusion is the recovery path which is only known once the file has been loaded.

Definition at line 1054 of file wm_files.cc.

References BKE_blendfile_read(), BKE_blendfile_read_setup_readfile(), BKE_main_namemap_validate(), BKE_READ_EXOTIC_FAIL_FORMAT, BKE_READ_EXOTIC_FAIL_OPEN, BKE_READ_EXOTIC_FAIL_PATH, BKE_READ_EXOTIC_OK_BLEND, BKE_reportf(), BLF_reset_fonts(), BLI_assert, BLI_assert_msg, BLI_time_now_seconds(), BLO_READ_SKIP_USERDEF, C, CTX_data_main(), CTX_wm_manager(), BlendFileReadReport::duration, file_read_reports_finalize(), Main::filepath, G, G_FLAG_ALL_READFILE, G_FLAG_ALL_RUNTIME, wmFileReadPost_Params::is_alloc, wmFileReadPost_Params::is_factory_startup, wmFileReadPost_Params::is_startup_file, params, BlendFileReadReport::reports, wmFileReadPost_Params::reset_app_template, RPT_, RPT_ERROR, wmFileReadPost_Params::success, wmFileReadPost_Params::use_data, wmFileReadPost_Params::use_userdef, BlendFileReadReport::whole, WM_check(), WM_cursor_wait(), WM_file_autoexec_init(), wm_file_read_post(), wm_file_read_pre(), wm_file_read_setup_wm_finalize(), wm_file_read_setup_wm_init(), wm_history_file_update(), wm_read_callback_post_wrapper(), wm_read_callback_pre_wrapper(), and wm_read_exotic().

Referenced by handle_load_file(), and wm_file_read_opwrap().

◆ WM_file_recover_last_session()

bool WM_file_recover_last_session	(	bContext *	C,
		const bool	use_scripts_autoexec_check,
		ReportList *	reports )

Definition at line 3475 of file wm_files.cc.

References BKE_tempdir_base(), BLENDER_QUIT_FILE, BLI_path_join, C, FILE_MAX, G, G_FILE_RECOVER_READ, and wm_file_read_opwrap().

Referenced by wm_recover_last_session_impl().

◆ WM_file_tag_modified()

void WM_file_tag_modified ( )

Definition at line 177 of file wm_files.cc.

References wmWindowManager::file_saved, G_MAIN, NC_WM, ND_DATACHANGED, and WM_main_add_notifier().

Referenced by blender::ed::sculpt_paint::brush_asset_save_as_exec(), ED_image_undo_push_end(), ED_paintcurve_undo_push_end(), ED_undo_push(), and blender::ed::sculpt_paint::undo::geometry_end().

◆ WM_generic_callback_free()

void WM_generic_callback_free ( wmGenericCallback * callback )

Definition at line 20 of file wm_utils.cc.

References wmGenericCallback::free_user_data, MEM_freeN(), and wmGenericCallback::user_data.

Referenced by free_post_file_close_action(), save_file_overwrite_confirm(), wm_block_file_close_discard(), wm_block_file_close_save(), and wm_close_file_dialog().

◆ WM_generic_callback_steal()

wmGenericCallback * WM_generic_callback_steal ( wmGenericCallback * callback )

Definition at line 30 of file wm_utils.cc.

References do_nothing(), wmGenericCallback::exec, wmGenericCallback::free_user_data, MEM_dupallocN(), and wmGenericCallback::user_data.

Referenced by save_file_overwrite_confirm(), wm_block_file_close_discard(), and wm_block_file_close_save().

◆ WM_generic_select_invoke()

wmOperatorStatus WM_generic_select_invoke	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

Helper to get select and tweak-transform to work conflict free and as desired. See WM_operator_properties_generic_select() for details.

To be used together with WM_generic_select_modal() and WM_operator_properties_generic_select().

Definition at line 1048 of file wm_operators.cc.

References C, CTX_wm_region(), wmOperator::customdata, wmOperatorType::modal, OPERATOR_RETVAL_CHECK, POINTER_FROM_INT, wmOperator::ptr, RNA_int_set(), wmOperator::type, and WM_event_drag_start_mval().

Referenced by ACTION_OT_clickselect(), FILE_OT_select(), GRAPH_OT_clickselect(), MARKER_OT_select(), NLA_OT_click_select(), blender::ed::vse::sequencer_select_invoke(), ui_view_item_select_invoke(), and WM_event_add().

◆ WM_generic_select_modal()

wmOperatorStatus WM_generic_select_modal	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

Helper to get select and tweak-transform to work conflict free and as desired. See WM_operator_properties_generic_select() for details.

To be used together with WM_generic_select_invoke() and WM_operator_properties_generic_select().

Definition at line 981 of file wm_operators.cc.

References C, wmOperator::customdata, wmOperatorType::exec, ISMOUSE_MOTION, KM_PRESS, KM_RELEASE, OPERATOR_FINISHED, OPERATOR_PASS_THROUGH, OPERATOR_RETVAL_CHECK, OPERATOR_RUNNING_MODAL, POINTER_AS_INT, POINTER_FROM_INT, wmOperator::ptr, RNA_int_get(), RNA_property_boolean_set(), RNA_struct_find_property(), RNA_struct_property_is_set(), wmEvent::type, wmOperator::type, wmEvent::val, WM_event_add_modal_handler(), and WM_event_drag_test_with_delta().

Referenced by ACTION_OT_clickselect(), FILE_OT_select(), GRAPH_OT_clickselect(), MARKER_OT_select(), NLA_OT_click_select(), blender::ed::vse::SEQUENCER_OT_select(), UI_OT_view_item_select(), and WM_event_add().

◆ WM_generic_user_data_free()

void WM_generic_user_data_free ( wmGenericUserData * wm_userdata )

Definition at line 45 of file wm_utils.cc.

References wmGenericUserData::data, wmGenericUserData::free_fn, MEM_freeN(), and wmGenericUserData::use_free.

Referenced by view3d_box_select_exec(), view3d_circle_select_exec(), view3d_lasso_select(), and WM_gesture_end().

◆ WM_gesture_box_cancel()

void WM_gesture_box_cancel	(	bContext *	C,
		wmOperator *	op )

◆ WM_gesture_box_invoke()

wmOperatorStatus WM_gesture_box_invoke	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

Definition at line 169 of file wm_gesture_ops.cc.

References C, CTX_wm_region(), CTX_wm_window(), wmOperator::customdata, OPERATOR_RUNNING_MODAL, wmOperator::ptr, RNA_boolean_get(), wmGesture::wait_for_input, WM_event_add_modal_handler(), WM_event_is_mouse_drag_or_press(), WM_GESTURE_CROSS_RECT, WM_gesture_new(), WM_GESTURE_RECT, and wm_gesture_tag_redraw().

Referenced by actkeys_box_select_invoke(), ANIM_OT_channels_select_box(), ANIM_OT_previewrange_set(), CLIP_OT_graph_select_box(), CLIP_OT_select_box(), ed_marker_box_select_invoke(), FILE_OT_select_box(), blender::ed::sculpt_paint::face_set::gesture_box_invoke(), blender::ed::sculpt_paint::trim::gesture_box_invoke(), graphkeys_box_select_invoke(), blender::ed::sculpt_paint::GREASE_PENCIL_OT_erase_box(), IMAGE_OT_render_border(), IMAGE_OT_view_zoom_border(), INFO_OT_select_box(), MASK_OT_select_box(), nlaedit_box_select_invoke(), blender::ed::space_node::node_box_select_invoke(), blender::ed::space_node::NODE_OT_viewer_border(), blender::ed::outliner::outliner_box_select_invoke(), blender::ed::sculpt_paint::hide::PAINT_OT_hide_show(), blender::ed::sculpt_paint::mask::PAINT_OT_mask_box_gesture(), blender::ed::vse::sequencer_box_select_invoke(), blender::ed::vse::SEQUENCER_OT_view_ghost_border(), uv_box_select_invoke(), UV_OT_custom_region_set(), VIEW2D_OT_zoom_border(), view3d_clipping_invoke(), VIEW3D_OT_render_border(), VIEW3D_OT_select_box(), and VIEW3D_OT_zoom_border().

◆ WM_gesture_box_modal()

wmOperatorStatus WM_gesture_box_modal	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

Definition at line 196 of file wm_gesture_ops.cc.

References BLI_rcti_translate(), C, CTX_wm_window(), wmGesture::customdata, wmOperator::customdata, EVT_MODAL_MAP, gesture_box_apply(), gesture_box_apply_rect(), GESTURE_MODAL_BEGIN, GESTURE_MODAL_CANCEL, GESTURE_MODAL_DESELECT, gesture_modal_end(), GESTURE_MODAL_IN, GESTURE_MODAL_MOVE, GESTURE_MODAL_OUT, GESTURE_MODAL_SELECT, wmGesture::is_active, wmGesture::is_active_prev, wmGesture::modal_state, MOUSEMOVE, wmGesture::move, NDOF_MOTION, OPERATOR_CANCELLED, OPERATOR_FINISHED, OPERATOR_PASS_THROUGH, OPERATOR_RUNNING_MODAL, wmEvent::type, wmGesture::type, wmEvent::val, wmGesture::wait_for_input, wmGesture::winrct, WM_GESTURE_CROSS_RECT, wm_gesture_tag_redraw(), rcti::xmax, rcti::xmin, wmEvent::xy, rcti::ymax, and rcti::ymin.

Referenced by ACTION_OT_select_box(), ANIM_OT_channels_select_box(), ANIM_OT_previewrange_set(), CLIP_OT_graph_select_box(), CLIP_OT_select_box(), file_box_select_modal(), GRAPH_OT_select_box(), blender::ed::sculpt_paint::GREASE_PENCIL_OT_erase_box(), IMAGE_OT_render_border(), IMAGE_OT_view_zoom_border(), INFO_OT_select_box(), MARKER_OT_select_box(), MASK_OT_select_box(), NLA_OT_select_box(), blender::ed::space_node::NODE_OT_select_box(), blender::ed::space_node::NODE_OT_viewer_border(), blender::ed::outliner::OUTLINER_OT_select_box(), blender::ed::sculpt_paint::hide::PAINT_OT_hide_show(), blender::ed::sculpt_paint::mask::PAINT_OT_mask_box_gesture(), blender::ed::sculpt_paint::face_set::SCULPT_OT_face_set_box_gesture(), blender::ed::sculpt_paint::trim::SCULPT_OT_trim_box_gesture(), blender::ed::vse::SEQUENCER_OT_select_box(), blender::ed::vse::SEQUENCER_OT_view_ghost_border(), UV_OT_custom_region_set(), UV_OT_select_box(), VIEW2D_OT_zoom_border(), VIEW3D_OT_clip_border(), VIEW3D_OT_render_border(), VIEW3D_OT_select_box(), and VIEW3D_OT_zoom_border().

◆ WM_gesture_circle_cancel()

void WM_gesture_circle_cancel	(	bContext *	C,
		wmOperator *	op )

Definition at line 451 of file wm_gesture_ops.cc.

References C, and gesture_modal_end().

Referenced by ACTION_OT_select_circle(), GRAPH_OT_select_circle(), UV_OT_select_circle(), and view3d_circle_select_cancel().

◆ WM_gesture_circle_invoke()

wmOperatorStatus WM_gesture_circle_invoke	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

◆ WM_gesture_circle_modal()

wmOperatorStatus WM_gesture_circle_modal	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

Definition at line 351 of file wm_gesture_ops.cc.

References C, ceil, CTX_wm_window(), wmGesture::customdata, wmOperator::customdata, EVT_MODAL_MAP, floor, gesture_circle_apply(), GESTURE_MODAL_CANCEL, GESTURE_MODAL_CIRCLE_ADD, GESTURE_MODAL_CIRCLE_SIZE, GESTURE_MODAL_CIRCLE_SUB, GESTURE_MODAL_CONFIRM, GESTURE_MODAL_DESELECT, gesture_modal_end(), GESTURE_MODAL_NOP, GESTURE_MODAL_SELECT, wmGesture::is_active, wmGesture::is_active_prev, wmGesture::modal_state, MOUSEMOVE, NDOF_MOTION, OPERATOR_FINISHED, OPERATOR_PASS_THROUGH, OPERATOR_RUNNING_MODAL, wmOperator::ptr, RNA_int_set(), wmEvent::type, wmEvent::val, wmGesture::wait_for_input, wmGesture::winrct, wm_gesture_tag_redraw(), rcti::xmax, rcti::xmin, and rcti::ymin.

Referenced by ACTION_OT_select_circle(), CLIP_OT_select_circle(), GRAPH_OT_select_circle(), MASK_OT_select_circle(), blender::ed::space_node::NODE_OT_select_circle(), blender::ed::vse::SEQUENCER_OT_select_circle(), UV_OT_select_circle(), and view3d_circle_select_modal().

◆ WM_gesture_end()

void WM_gesture_end	(	wmWindow *	win,
		wmGesture *	gesture )

Definition at line 99 of file wm_gesture.cc.

References BLI_remlink(), wmGesture::customdata, wmWindow::gesture, MEM_freeN(), wmGesture::user_data, and WM_generic_user_data_free().

Referenced by gesture_modal_end(), WM_gestures_free_all(), and WM_gestures_remove().

◆ WM_gesture_is_modal_first()

bool WM_gesture_is_modal_first ( const wmGesture * gesture )

Definition at line 121 of file wm_gesture.cc.

References wmGesture::is_active_prev.

Referenced by action_circle_select_exec(), circle_select_exec(), circle_select_exec(), graph_circle_select_exec(), blender::ed::space_node::node_circleselect_exec(), uv_circle_select_exec(), view3d_circle_select_exec(), and blender::ed::vse::vse_circle_select_exec().

◆ WM_gesture_lasso_cancel()

void WM_gesture_lasso_cancel	(	bContext *	C,
		wmOperator *	op )

Definition at line 647 of file wm_gesture_ops.cc.

References C, and gesture_modal_end().

Referenced by ACTION_OT_select_lasso(), CLIP_OT_select_lasso(), GRAPH_OT_select_lasso(), blender::ed::sculpt_paint::GREASE_PENCIL_OT_erase_lasso(), GREASE_PENCIL_OT_stroke_trim(), MASK_OT_select_lasso(), blender::ed::space_node::NODE_OT_select_lasso(), blender::ed::vse::SEQUENCER_OT_select_lasso(), UV_OT_select_lasso(), and VIEW3D_OT_select_lasso().

◆ WM_gesture_lasso_invoke()

wmOperatorStatus WM_gesture_lasso_invoke	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

Definition at line 484 of file wm_gesture_ops.cc.

References C, CTX_wm_region(), CTX_wm_window(), wmOperator::customdata, OPERATOR_RUNNING_MODAL, wmOperator::ptr, RNA_boolean_get(), RNA_property_int_get(), RNA_struct_find_property(), wmGesture::use_smooth, WM_cursor_modal_set(), WM_event_add_modal_handler(), WM_GESTURE_LASSO, WM_gesture_new(), and wm_gesture_tag_redraw().

Referenced by ACTION_OT_select_lasso(), CLIP_OT_select_lasso(), blender::ed::sculpt_paint::face_set::gesture_lasso_invoke(), blender::ed::sculpt_paint::trim::gesture_lasso_invoke(), GRAPH_OT_select_lasso(), blender::ed::sculpt_paint::GREASE_PENCIL_OT_erase_lasso(), GREASE_PENCIL_OT_stroke_trim(), MASK_OT_select_lasso(), blender::ed::space_node::node_lasso_select_invoke(), blender::ed::sculpt_paint::hide::PAINT_OT_hide_show_lasso_gesture(), blender::ed::sculpt_paint::mask::PAINT_OT_mask_lasso_gesture(), blender::ed::vse::SEQUENCER_OT_select_lasso(), UV_OT_select_lasso(), and VIEW3D_OT_select_lasso().

◆ WM_gesture_lasso_modal()

wmOperatorStatus WM_gesture_lasso_modal	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

Definition at line 557 of file wm_gesture_ops.cc.

References C, CTX_wm_window(), wmGesture::customdata, wmOperator::customdata, EVT_ESCKEY, EVT_MODAL_MAP, float, gesture_lasso_apply(), gesture_modal_end(), GESTURE_MODAL_MOVE, i, INBETWEEN_MOUSEMOVE, blender::math::interpolate(), wmGesture::is_active, wmGesture::is_active_prev, KM_RELEASE, LEFTMOUSE, blender::math::length_squared(), MEM_reallocN, MIDDLEMOUSE, MOUSEMOVE, wmGesture::move, wmGesture::mval, OPERATOR_CANCELLED, OPERATOR_RUNNING_MODAL, wmGesture::points, wmGesture::points_alloc, pow2f(), wmOperator::ptr, result, RIGHTMOUSE, RNA_float_get(), RNA_int_get(), square_f(), wmEvent::type, UI_SCALE_FAC, wmGesture::use_smooth, wmEvent::val, wmGesture::winrct, wm_gesture_tag_redraw(), float2::x, rcti::xmin, wmEvent::xy, float2::y, and rcti::ymin.

Referenced by ACTION_OT_select_lasso(), CLIP_OT_select_lasso(), GRAPH_OT_select_lasso(), blender::ed::sculpt_paint::GREASE_PENCIL_OT_erase_lasso(), GREASE_PENCIL_OT_stroke_trim(), MASK_OT_select_lasso(), blender::ed::space_node::NODE_OT_select_lasso(), blender::ed::sculpt_paint::hide::PAINT_OT_hide_show_lasso_gesture(), blender::ed::sculpt_paint::mask::PAINT_OT_mask_lasso_gesture(), blender::ed::sculpt_paint::face_set::SCULPT_OT_face_set_lasso_gesture(), blender::ed::sculpt_paint::trim::SCULPT_OT_trim_lasso_gesture(), blender::ed::vse::SEQUENCER_OT_select_lasso(), UV_OT_select_lasso(), VIEW3D_OT_select_lasso(), and WM_gesture_lines_modal().

◆ WM_gesture_lasso_path_to_array()

blender::Array< blender::int2 > WM_gesture_lasso_path_to_array	(	bContext *	C,
		wmOperator *	op )

helper function, we may want to add options for conversion to view space

Definition at line 657 of file wm_gesture_ops.cc.

References BLI_assert, i, len, wmOperator::ptr, RNA_float_get_array(), RNA_PROP_BEGIN, RNA_PROP_END, RNA_property_collection_length(), and RNA_struct_find_property().

Referenced by actkeys_lassoselect_exec(), clip_lasso_select_exec(), clip_lasso_select_exec(), graphkeys_lassoselect_exec(), blender::ed::sculpt_paint::grease_pencil_erase_lasso_exec(), blender::ed::greasepencil::grease_pencil_stroke_trim_exec(), blender::ed::sculpt_paint::gesture::init_from_lasso(), blender::ed::space_node::node_lasso_select_exec(), uv_lasso_select_exec(), view3d_lasso_select_exec(), and blender::ed::vse::vse_lasso_select_exec().

◆ WM_gesture_lines_cancel()

void WM_gesture_lines_cancel	(	bContext *	C,
		wmOperator *	op )

Definition at line 652 of file wm_gesture_ops.cc.

References C, and gesture_modal_end().

Referenced by blender::ed::space_node::NODE_OT_add_reroute(), blender::ed::space_node::NODE_OT_links_cut(), and blender::ed::space_node::NODE_OT_links_mute().

◆ WM_gesture_lines_invoke()

wmOperatorStatus WM_gesture_lines_invoke	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

◆ WM_gesture_lines_modal()

wmOperatorStatus WM_gesture_lines_modal	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

Definition at line 642 of file wm_gesture_ops.cc.

References C, and WM_gesture_lasso_modal().

Referenced by blender::ed::space_node::NODE_OT_add_reroute(), blender::ed::space_node::NODE_OT_links_cut(), and blender::ed::space_node::NODE_OT_links_mute().

◆ WM_gesture_new()

wmGesture * WM_gesture_new	(	wmWindow *	window,
		const ARegion *	region,
		const wmEvent *	event,
		int	type )

Context checked on having screen, window and area.

Definition at line 39 of file wm_gesture.cc.

References BLI_addtail(), wmGesture::customdata, ELEM, wmGesture::event_keymodifier, wmGesture::event_modifier, wmGesture::event_type, wmWindow::gesture, GESTURE_MODAL_NOP, MEM_callocN(), MEM_malloc_arrayN(), wmGesture::modal_state, wmGesture::move, wmGesture::mval, wmGesture::points, wmGesture::points_alloc, wmGesture::type, wmGenericUserData::use_free, wmGesture::user_data, ARegion::winrct, wmGesture::winrct, WM_event_drag_start_xy(), WM_GESTURE_CIRCLE, WM_GESTURE_CROSS_RECT, WM_GESTURE_LASSO, WM_GESTURE_LINES, WM_GESTURE_POLYLINE, WM_GESTURE_RECT, WM_GESTURE_STRAIGHTLINE, rcti::xmax, rcti::xmin, xy, rcti::ymax, and rcti::ymin.

Referenced by WM_gesture_box_invoke(), WM_gesture_circle_invoke(), WM_gesture_lasso_invoke(), WM_gesture_lines_invoke(), WM_gesture_polyline_invoke(), and WM_gesture_straightline_invoke().

◆ WM_gesture_polyline_cancel()

void WM_gesture_polyline_cancel	(	bContext *	C,
		wmOperator *	op )

Definition at line 907 of file wm_gesture_ops.cc.

References C, and gesture_modal_end().

◆ WM_gesture_polyline_invoke()

wmOperatorStatus WM_gesture_polyline_invoke	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

Definition at line 729 of file wm_gesture_ops.cc.

References C, CTX_wm_region(), CTX_wm_window(), wmOperator::customdata, OPERATOR_RUNNING_MODAL, wmOperator::ptr, RNA_property_int_get(), RNA_struct_find_property(), WM_cursor_modal_set(), WM_event_add_modal_handler(), WM_gesture_new(), WM_GESTURE_POLYLINE, and wm_gesture_tag_redraw().

Referenced by blender::ed::sculpt_paint::face_set::gesture_polyline_invoke(), blender::ed::sculpt_paint::trim::gesture_polyline_invoke(), blender::ed::sculpt_paint::hide::PAINT_OT_hide_show_polyline_gesture(), and blender::ed::sculpt_paint::mask::PAINT_OT_mask_polyline_gesture().

◆ WM_gesture_polyline_modal()

wmOperatorStatus WM_gesture_polyline_modal	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

Definition at line 826 of file wm_gesture_ops.cc.

References C, CTX_wm_window(), wmGesture::customdata, wmOperator::customdata, EVT_MODAL_MAP, GESTURE_MODAL_CANCEL, GESTURE_MODAL_CONFIRM, gesture_modal_end(), GESTURE_MODAL_MOVE, GESTURE_MODAL_SELECT, gesture_polyline_apply(), gesture_polyline_can_apply(), INBETWEEN_MOUSEMOVE, len_v2v2(), MEM_reallocN, MOUSEMOVE, wmGesture::move, wmGesture::mval, OPERATOR_CANCELLED, wmGesture::points, wmGesture::points_alloc, blender::wm::gesture::POLYLINE_CLICK_RADIUS, wmEvent::type, UI_SCALE_FAC, wmEvent::val, wmGesture::winrct, wm_gesture_tag_redraw(), rcti::xmin, wmEvent::xy, and rcti::ymin.

Referenced by blender::ed::sculpt_paint::hide::PAINT_OT_hide_show_polyline_gesture(), blender::ed::sculpt_paint::mask::PAINT_OT_mask_polyline_gesture(), blender::ed::sculpt_paint::face_set::SCULPT_OT_face_set_polyline_gesture(), and blender::ed::sculpt_paint::trim::SCULPT_OT_trim_polyline_gesture().

◆ WM_gesture_straightline_active_side_invoke()

wmOperatorStatus WM_gesture_straightline_active_side_invoke	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

This invoke callback starts the straight-line gesture with a viewport preview to the right side of the line.

Definition at line 1027 of file wm_gesture_ops.cc.

References C, wmOperator::customdata, wmGesture::draw_active_side, OPERATOR_RUNNING_MODAL, wmGesture::use_flip, and WM_gesture_straightline_invoke().

Referenced by blender::ed::sculpt_paint::face_set::gesture_line_invoke(), blender::ed::sculpt_paint::project::gesture_line_invoke(), blender::ed::sculpt_paint::trim::gesture_line_invoke(), mesh_bisect_invoke(), blender::ed::sculpt_paint::hide::PAINT_OT_hide_show_line_gesture(), and blender::ed::sculpt_paint::mask::PAINT_OT_mask_line_gesture().

◆ WM_gesture_straightline_cancel()

void WM_gesture_straightline_cancel	(	bContext *	C,
		wmOperator *	op )

Definition at line 1255 of file wm_gesture_ops.cc.

References C, and gesture_modal_end().

Referenced by blender::ed::greasepencil::GREASE_PENCIL_OT_texture_gradient(), blender::ed::greasepencil::grease_pencil_texture_gradient_modal(), IMAGE_OT_sample_line(), MESH_OT_bisect(), PAINT_OT_weight_gradient(), and paint_weight_gradient_modal().

◆ WM_gesture_straightline_invoke()

wmOperatorStatus WM_gesture_straightline_invoke	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

◆ WM_gesture_straightline_modal()

wmOperatorStatus WM_gesture_straightline_modal	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

This modal callback calls exec once per mouse move event while the gesture is active with the updated line start and end values, so it can be used for tools that have a real time preview (like a gradient updating in real time over the mesh).

Definition at line 1077 of file wm_gesture_ops.cc.

References BLI_rcti_translate(), C, CTX_data_scene(), CTX_wm_area(), CTX_wm_window(), wmGesture::customdata, wmOperator::customdata, EVT_MODAL_MAP, GESTURE_MODAL_BEGIN, GESTURE_MODAL_CANCEL, gesture_modal_end(), GESTURE_MODAL_FLIP, GESTURE_MODAL_MOVE, GESTURE_MODAL_SELECT, GESTURE_MODAL_SNAP, gesture_straightline_apply(), get_snap_angle(), SnapAngle::increment, wmGesture::is_active, wmGesture::is_active_prev, MOUSEMOVE, wmGesture::move, OPERATOR_CANCELLED, OPERATOR_FINISHED, OPERATOR_RUNNING_MODAL, Scene::toolsettings, wmEvent::type, wmGesture::use_flip, wmGesture::use_snap, wmEvent::val, wmGesture::winrct, wm_gesture_straightline_do_angle_snap(), wm_gesture_tag_redraw(), rcti::xmax, rcti::xmin, wmEvent::xy, rcti::ymax, and rcti::ymin.

Referenced by blender::ed::greasepencil::grease_pencil_texture_gradient_modal(), IMAGE_OT_sample_line(), mesh_bisect_modal(), and paint_weight_gradient_modal().

◆ WM_gesture_straightline_oneshot_modal()

wmOperatorStatus WM_gesture_straightline_oneshot_modal	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

This modal one-shot callback only calls exec once after the gesture finishes without any updates during the gesture execution. Should be used for operations that are intended to be applied once without real time preview (like a trimming tool that only applies the bisect operation once after finishing the gesture as the bisect operation is too heavy to be computed in real time for a preview).

Definition at line 1164 of file wm_gesture_ops.cc.

References BLI_rcti_translate(), C, CTX_data_scene(), CTX_wm_area(), CTX_wm_window(), wmGesture::customdata, wmOperator::customdata, EVT_MODAL_MAP, GESTURE_MODAL_BEGIN, GESTURE_MODAL_CANCEL, GESTURE_MODAL_DESELECT, gesture_modal_end(), GESTURE_MODAL_FLIP, GESTURE_MODAL_IN, GESTURE_MODAL_MOVE, GESTURE_MODAL_OUT, GESTURE_MODAL_SELECT, GESTURE_MODAL_SNAP, gesture_straightline_apply(), get_snap_angle(), SnapAngle::increment, wmGesture::is_active, wmGesture::is_active_prev, wmGesture::modal_state, MOUSEMOVE, wmGesture::move, OPERATOR_CANCELLED, OPERATOR_FINISHED, OPERATOR_RUNNING_MODAL, Scene::toolsettings, wmEvent::type, wmGesture::use_flip, wmGesture::use_snap, wmEvent::val, wmGesture::wait_for_input, wmGesture::winrct, wm_gesture_straightline_do_angle_snap(), wm_gesture_tag_redraw(), rcti::xmax, rcti::xmin, wmEvent::xy, rcti::ymax, and rcti::ymin.

Referenced by blender::ed::sculpt_paint::hide::PAINT_OT_hide_show_line_gesture(), blender::ed::sculpt_paint::mask::PAINT_OT_mask_line_gesture(), blender::ed::sculpt_paint::face_set::SCULPT_OT_face_set_line_gesture(), blender::ed::sculpt_paint::project::SCULPT_OT_project_line_gesture(), and blender::ed::sculpt_paint::trim::SCULPT_OT_trim_line_gesture().

◆ WM_gestures_free_all()

void WM_gestures_free_all ( wmWindow * win )

Definition at line 107 of file wm_gesture.cc.

References ListBase::first, wmWindow::gesture, and WM_gesture_end().

Referenced by wm_window_free().

◆ WM_gestures_remove()

void WM_gestures_remove ( wmWindow * win )

Definition at line 114 of file wm_gesture.cc.

References ListBase::first, wmWindow::gesture, and WM_gesture_end().

Referenced by ui_but_drag_init().

◆ WM_ghost_backend()

const char * WM_ghost_backend ( )

Return an identifier for the underlying GHOST implementation.

Warning: Use of this function should be limited & never for compatibility checks. see: GHOST_ISystem::getSystemBackend for details.

Definition at line 2181 of file wm_window.cc.

References g_system, and g_system_backend_id.

Referenced by bpy_ghost_backend().

◆ WM_global_report()

void WM_global_report	(	eReportType	type,
		const char *	message )

Report directly to the window manager without any context.

Warning: This function should almost always be avoided in favor of BKE_report, if this isn't possible, a code-comment must be included explaining why.

Global reports are bad practice because the caller can't handle or suppress them. This means for example, if an automated tasks/scripts can generate many reports that are shown to the user without any way to control error handling.

When used in operators it prevents the Python script from raising an exception form the error as it should do, showing a popup instead.

Definition at line 1041 of file wm_event_system.cc.

References BKE_report(), BKE_report_print_level_set(), BKE_reports_free(), BKE_reports_init(), RPT_PRINT, RPT_STORE, RPT_WARNING, and WM_reports_from_reports_move().

Referenced by action_preview_render_prepare(), button_activate_state(), cachefile_layer_add_exec(), dpaint_bake_endjob(), blender::io::alembic::export_startjob(), fmodifier_reorder(), import_endjob(), is_compositing_possible(), lineart_bake_common(), blender::ed::sculpt_paint::min_distance_edit::min_distance_edit_invoke(), ui_but_paste_color(), ui_but_paste_normalized_vector(), ui_but_paste_numeric_array(), ui_but_paste_numeric_value(), ui_do_but_HOTKEYEVT(), wm_draw_region_buffer_create(), WM_global_reportf(), wm_xr_disable_passthrough(), and wm_xr_error_handler().

◆ WM_global_reportf()

void WM_global_reportf	(	eReportType	type,
		const char *	format,
			... )

Report directly to the window manager without any context.

Warning: This function should almost always be avoided in favor of BKE_reportf, if this isn't possible, a code-comment must be included explaining why.

See WM_global_report for details.

References ATTR_PRINTF_FORMAT.

◆ WM_init()

void WM_init	(	bContext *	C,
		int	argc,
		const char **	argv )

Initialize Blender and load the startup file & preferences (only called once).

NOTE(@ideasman42): Startup file and order of initialization.

Loading BLENDER_STARTUP_FILE, BLENDER_USERPREF_FILE, starting Python and other sub-systems, have inter-dependencies, for example.

Some sub-systems depend on the preferences (initializing icons depend on the theme).
Add-ons depends on the preferences to know what has been enabled.
Add-ons depends on the window-manger to register their key-maps.
Evaluating the startup file depends on Python for animation-drivers (see #89046).
Starting Python depends on the startup file so key-maps can be added in the window-manger.

Loading preferences early, then application subsystems and finally the startup data would simplify things if it weren't for key-maps being part of the window-manager which is blend file data. Creating a dummy window-manager early, or moving the key-maps into the preferences would resolve this and may be worth looking into long-term, see: D12184 for details.

Definition at line 199 of file wm_init_exit.cc.

References wmHomeFileRead_Params::app_template_override, BIFICONID_LAST_STATIC, BKE_addon_pref_type_init(), BKE_icons_init(), BKE_keyconfig_pref_type_init(), BKE_library_callback_free_notifier_reference_set(), BKE_library_callback_remap_editor_id_reference_set(), BKE_main_blendfile_path_from_global(), BKE_preview_images_init(), BKE_region_callback_free_gizmomap_set(), BKE_region_callback_refresh_tag_gizmomap_set(), BKE_sound_jack_sync_callback_set(), BKE_spacedata_callback_id_remap_set(), BKE_studiolight_init(), BLF_init(), BLI_assert, BLT_lang_init(), BLT_lang_set(), BPY_python_reset(), BPY_python_start(), C, CTX_py_init_set(), DEG_editors_set_update_cb(), ED_file_init(), ED_node_init_butfuncs(), ED_render_clear_mtex_copybuf(), ED_render_id_flush_update(), ED_render_scene_update(), ED_spacedata_id_remap_single(), ED_spacemacros_init(), ED_spacetypes_init(), ED_undosys_type_init(), wmHomeFileRead_Params::filepath_startup_override, G, G_FILE_NO_UI, G_MAIN, GHOST_kConsoleWindowStateHideForNonConsoleLaunch, GHOST_kConsoleWindowStateShow, GHOST_setConsoleWindowState(), GPU_context_active_get(), GPU_context_begin_frame(), GPU_context_end_frame(), GPU_render_begin(), GPU_render_end(), blender::bke::subdiv::init(), wmHomeFileRead_Params::is_first_time, blender::ui::string_search::read_recent_searches_file(), sound_jack_sync_callback(), STRNCPY(), U, UI_init(), UNUSED_VARS, wmHomeFileRead_Params::use_data, wmHomeFileRead_Params::use_empty_data, wmHomeFileRead_Params::use_factory_settings, wmHomeFileRead_Params::use_userdef, WM_exit(), wm_ghost_init(), wm_gizmogrouptype_init(), wm_gizmomap_remove(), WM_gizmomap_tag_refresh(), wm_gizmotype_init(), wm_history_file_read(), wm_homefile_read_ex(), wm_homefile_read_post(), wm_init_cursor_data(), WM_init_gpu(), wm_init_scripts_extensions_once(), WM_init_state_app_template_get(), WM_keyconfig_init(), WM_keyconfig_update_on_startup(), WM_keyconfig_update_postpone_begin(), WM_keyconfig_update_postpone_end(), WM_main_remap_editor_id_reference(), WM_main_remove_notifier_reference(), WM_menutype_init(), WM_msgbus_types_init(), wm_operatortypes_register(), WM_paneltype_init(), WM_platform_support_perform_checks(), wm_start_with_console, and WM_uilisttype_init().

Referenced by main().

◆ WM_init_gpu()

void WM_init_gpu ( )

Definition at line 146 of file wm_init_exit.cc.

References BLI_assert, DRW_gpu_context_create(), DRW_gpu_context_disable_ex(), G, G_DEBUG_GPU_COMPILE_SHADERS, GPU_backend_supported(), GPU_init(), gpu_is_init, GPU_shader_compile_static(), and wm_ghost_init_background().

Referenced by DRW_gpu_context_enable(), DRW_render_context_enable(), and WM_init().

◆ WM_init_input_devices()

void WM_init_input_devices ( )

Definition at line 2845 of file wm_window.cc.

References g_system, GHOST_kTabletAutomatic, GHOST_kTabletWinPointer, GHOST_kTabletWintab, GHOST_SetMultitouchGestures(), GHOST_SetTabletAPI(), U, UNLIKELY, USER_NO_MULTITOUCH_GESTURES, USER_TABLET_AUTOMATIC, USER_TABLET_NATIVE, and USER_TABLET_WINTAB.

Referenced by wm_init_userdef().

◆ WM_init_native_pixels()

void WM_init_native_pixels ( bool do_it )

Definition at line 2834 of file wm_window.cc.

References wm_init_state.

Referenced by arg_handle_native_pixels_set().

◆ WM_init_splash()

void WM_init_splash ( bContext * C )

Show the splash screen.

Definition at line 391 of file wm_init_exit.cc.

References BLI_listbase_is_empty(), C, CTX_wm_manager(), CTX_wm_window(), CTX_wm_window_set(), ListBase::first, blender::wm::InvokeDefault, UNLIKELY, wmWindowManager::windows, and WM_operator_name_call().

Referenced by wm_homefile_read_exec(), and WM_init_splash_on_startup().

◆ WM_init_splash_on_startup()

void WM_init_splash_on_startup ( bContext * C )

Show the splash screen as needed on startup.

The splash may not show depending on a file being loaded and user preferences.

Definition at line 382 of file wm_init_exit.cc.

References C, WM_init_splash(), and wm_init_splash_show_on_startup_check().

Referenced by main().

◆ WM_init_state_app_template_get()

const char * WM_init_state_app_template_get ( )

Definition at line 1207 of file wm_files.cc.

References wm_init_state_app_template.

Referenced by wm_homefile_read_exec(), WM_init(), and wm_userpref_read_exec().

◆ WM_init_state_app_template_set()

void WM_init_state_app_template_set ( const char * app_template )

Used for setting app-template from the command line:

non-empty string: overrides.
empty string: override, using no app template.
NULL: clears override.

Definition at line 1195 of file wm_files.cc.

References app_template, STRNCPY(), and wm_init_state_app_template.

Referenced by arg_handle_app_template(), and wm_homefile_read_exec().

◆ WM_init_state_fullscreen_set()

void WM_init_state_fullscreen_set ( )

For border-less and border windows set from command-line.

Definition at line 2801 of file wm_window.cc.

References GHOST_kWindowStateFullScreen, WIN_OVERRIDE_WINSTATE, and wm_init_state.

Referenced by arg_handle_window_fullscreen().

◆ WM_init_state_maximized_set()

void WM_init_state_maximized_set ( )

Definition at line 2813 of file wm_window.cc.

References GHOST_kWindowStateMaximized, WIN_OVERRIDE_WINSTATE, and wm_init_state.

Referenced by arg_handle_window_maximized().

◆ WM_init_state_normal_set()

void WM_init_state_normal_set ( )

Definition at line 2807 of file wm_window.cc.

References GHOST_kWindowStateNormal, WIN_OVERRIDE_WINSTATE, and wm_init_state.

Referenced by arg_handle_window_border().

◆ WM_init_state_size_set()

void WM_init_state_size_set	(	int	stax,
		int	stay,
		int	sizx,
		int	sizy )

Called when no ghost system was initialized.

Definition at line 2794 of file wm_window.cc.

References WIN_OVERRIDE_GEOM, and wm_init_state.

Referenced by arg_handle_window_geometry().

◆ WM_init_state_start_with_console_set()

void WM_init_state_start_with_console_set ( bool value )

Definition at line 132 of file wm_init_exit.cc.

References wm_start_with_console.

Referenced by arg_handle_start_with_console().

◆ WM_init_window_focus_set()

void WM_init_window_focus_set ( bool do_it )

Definition at line 2829 of file wm_window.cc.

References wm_init_state.

Referenced by arg_handle_no_window_focus().

◆ WM_init_window_frame_get()

bool WM_init_window_frame_get ( )

Definition at line 2819 of file wm_window.cc.

References wm_init_state.

Referenced by wm_main_playanim_intern().

◆ WM_init_window_frame_set()

void WM_init_window_frame_set ( bool do_it )

Definition at line 2824 of file wm_window.cc.

References wm_init_state.

Referenced by arg_handle_no_window_frame().

◆ WM_job_main_thread_lock_acquire()

void WM_job_main_thread_lock_acquire ( wmJob * wm_job )

Definition at line 145 of file wm_jobs.cc.

References BLI_ticket_mutex_lock(), and wmJob::main_thread_mutex.

Referenced by opengl_render_startjob(), WM_jobs_get(), wm_jobs_kill_job(), and wm_jobs_timer().

◆ WM_job_main_thread_lock_release()

void WM_job_main_thread_lock_release ( wmJob * wm_job )

Definition at line 150 of file wm_jobs.cc.

References BLI_ticket_mutex_unlock(), and wmJob::main_thread_mutex.

Referenced by opengl_render_startjob(), wm_job_free(), wm_jobs_kill_job(), and wm_jobs_timer().

◆ WM_jobs_callbacks()

void WM_jobs_callbacks	(	wmJob *	wm_job,
		wm_jobs_start_callback	startjob,
		void(*	initjob )(void *),
		void(*	update )(void *),
		void(*	endjob )(void *) )

Definition at line 388 of file wm_jobs.cc.

References update(), and WM_jobs_callbacks_ex().

Referenced by ABC_export(), ABC_import(), clip_rebuild_proxy_exec(), clip_start_prefetch_job(), dynamicpaint_bake_exec(), ED_preview_icon_job(), ED_preview_shader_job(), blender::seq::ED_seq_proxy_job_get(), EEVEE_lightbake_job_create(), blender::seq::ThumbGenerationJob::ensure_job(), PreviewLoadJob::ensure_job(), blender::ed::space_node::ensure_nodetree_previews(), filelist_readjob_start_ex(), fluid_bake_invoke(), fluid_free_exec(), lineart_bake_common(), blender::ed::object::multiresbake_image_exec(), blender::ed::object::ocean_bake_exec(), pack_islands_exec(), ptcache_bake_invoke(), blender::ed::object::quadriflow_remesh_exec(), screen_opengl_render_invoke(), screen_render_invoke(), blender::ed::vse::sequencer_preview_add_sound(), blender::ed::object::bake_simulation::simulate_to_frame_invoke(), solve_camera_invoke(), blender::ed::vse::start_audio_video_job(), blender::ed::object::bake_simulation::start_bake_job(), track_markers(), ui_icon_ensure_deferred(), blender::io::usd::USD_export(), and blender::io::usd::USD_import().

◆ WM_jobs_callbacks_ex()

void WM_jobs_callbacks_ex	(	wmJob *	wm_job,
		wm_jobs_start_callback	startjob,
		void(*	initjob )(void *),
		void(*	update )(void *),
		void(*	endjob )(void *),
		void(*	completed )(void *),
		void(*	canceled )(void *) )

Definition at line 397 of file wm_jobs.cc.

References wmJob::canceled, wmJob::completed, wmJob::endjob, wmJob::initjob, wmJob::startjob, update(), and wmJob::update.

Referenced by blender::ed::object::bake_invoke(), ED_node_composite_job(), and WM_jobs_callbacks().

◆ WM_jobs_customdata_from_type()

void * WM_jobs_customdata_from_type	(	wmWindowManager *	wm,
		const void *	owner,
		int	job_type )

Definition at line 330 of file wm_jobs.cc.

References wm_job_find(), and WM_jobs_customdata_get().

Referenced by ED_preview_draw(), and render_job_get().

◆ WM_jobs_customdata_get()

void * WM_jobs_customdata_get ( wmJob * wm_job )

Definition at line 352 of file wm_jobs.cc.

References wmJob::customdata, and wmJob::run_customdata.

Referenced by ED_preview_icon_job(), blender::seq::ED_seq_proxy_job_get(), PreviewLoadJob::ensure_job(), blender::ed::vse::sequencer_preview_add_sound(), and WM_jobs_customdata_from_type().

◆ WM_jobs_customdata_set()

void WM_jobs_customdata_set	(	wmJob *	wm_job,
		void *	customdata,
		void(*	free )(void *) )

Definition at line 360 of file wm_jobs.cc.

References wmJob::customdata, free(), wmJob::free, wmJob::running, wmJobWorkerStatus::stop, and wmJob::worker_status.

Referenced by ABC_export(), ABC_import(), blender::ed::object::bake_invoke(), clip_rebuild_proxy_exec(), clip_start_prefetch_job(), dynamicpaint_bake_exec(), ED_node_composite_job(), ED_preview_icon_job(), ED_preview_shader_job(), blender::seq::ED_seq_proxy_job_get(), EEVEE_lightbake_job_create(), blender::seq::ThumbGenerationJob::ensure_job(), PreviewLoadJob::ensure_job(), blender::ed::space_node::ensure_nodetree_previews(), filelist_readjob_start_ex(), fluid_bake_invoke(), fluid_free_exec(), lineart_bake_common(), blender::ed::object::multiresbake_image_exec(), blender::ed::object::ocean_bake_exec(), pack_islands_exec(), ptcache_bake_invoke(), blender::ed::object::quadriflow_remesh_exec(), screen_opengl_render_invoke(), screen_render_invoke(), blender::ed::vse::sequencer_preview_add_sound(), blender::ed::object::bake_simulation::simulate_to_frame_invoke(), solve_camera_invoke(), blender::ed::vse::start_audio_video_job(), blender::ed::object::bake_simulation::start_bake_job(), track_markers(), ui_icon_ensure_deferred(), blender::io::usd::USD_export(), and blender::io::usd::USD_import().

◆ WM_jobs_delay_start()

void WM_jobs_delay_start	(	wmJob *	wm_job,
		double	delay_time )

Definition at line 383 of file wm_jobs.cc.

References wmJob::start_delay_time.

Referenced by ED_preview_icon_job(), and screen_render_invoke().

◆ WM_jobs_get()

wmJob * WM_jobs_get	(	wmWindowManager *	wm,
		wmWindow *	win,
		const void *	owner,
		const char *	name,
		eWM_JobFlag	flag,
		eWM_JobType	job_type )

Returns: current job or adds new job, but doesn't run it.

Note: every owner only gets a single running job of the same job_type (or with the WM_JOB_EXCL_RENDER flag). Adding a new one will wait for the running job to finish.

Definition at line 211 of file wm_jobs.cc.

References BKE_report_print_level_set(), BKE_reports_init(), BLI_addtail(), BLI_assert, BLI_ticket_mutex_alloc(), flag, wmJob::flag, wmJob::job_type, wmJob::main_thread_mutex, MEM_callocN(), name, wmJob::name, wmJob::owner, wmJobWorkerStatus::reports, RPT_PRINT, RPT_STORE, RPT_WARNING, wmWindowManager::runtime, STRNCPY(), wmJob::win, wm_job_find(), WM_job_main_thread_lock_acquire(), WM_JOB_TYPE_ANY, wm_jobs_update_qos(), and wmJob::worker_status.

Referenced by ABC_export(), ABC_import(), blender::ed::object::bake_invoke(), clip_rebuild_proxy_exec(), clip_start_prefetch_job(), dynamicpaint_bake_exec(), ED_node_composite_job(), ED_preview_icon_job(), ED_preview_shader_job(), blender::seq::ED_seq_proxy_wm_job_get(), EEVEE_lightbake_job_create(), blender::seq::ThumbGenerationJob::ensure_job(), PreviewLoadJob::ensure_job(), blender::ed::space_node::ensure_nodetree_previews(), filelist_readjob_start_ex(), fluid_bake_invoke(), fluid_free_exec(), lineart_bake_common(), blender::ed::object::multiresbake_image_exec(), blender::ed::object::ocean_bake_exec(), pack_islands_exec(), ptcache_bake_invoke(), blender::ed::object::quadriflow_remesh_exec(), screen_opengl_render_invoke(), screen_render_invoke(), blender::ed::vse::sequencer_preview_add_sound(), blender::ed::object::bake_simulation::simulate_to_frame_invoke(), solve_camera_invoke(), blender::ed::vse::start_audio_video_job(), blender::ed::object::bake_simulation::start_bake_job(), track_markers(), ui_icon_ensure_deferred(), blender::io::usd::USD_export(), and blender::io::usd::USD_import().

◆ WM_jobs_has_running()

bool WM_jobs_has_running ( const wmWindowManager * wm )

Definition at line 771 of file wm_jobs.cc.

References LISTBASE_FOREACH, wmJob::running, and wmWindowManager::runtime.

◆ WM_jobs_has_running_type()

bool WM_jobs_has_running_type	(	const wmWindowManager *	wm,
		int	job_type )

Definition at line 782 of file wm_jobs.cc.

References wmJob::job_type, LISTBASE_FOREACH, wmJob::running, and wmWindowManager::runtime.

Referenced by bpy_app_is_job_running().

◆ WM_jobs_is_running()

bool WM_jobs_is_running ( const wmJob * wm_job )

Definition at line 341 of file wm_jobs.cc.

References wmJob::running.

Referenced by blender::seq::ThumbGenerationJob::ensure_job(), PreviewLoadJob::ensure_job(), blender::ed::vse::seq_build_proxy(), blender::ed::vse::seq_proxy_build_job(), and blender::ed::vse::sequencer_preview_add_sound().

◆ WM_jobs_is_stopped()

bool WM_jobs_is_stopped	(	const wmWindowManager *	wm,
		const void *	owner )

Definition at line 346 of file wm_jobs.cc.

References wmJobWorkerStatus::stop, wm_job_find(), WM_JOB_TYPE_ANY, and wmJob::worker_status.

Referenced by uiTemplateRunningJobs().

◆ WM_jobs_kill_all()

void WM_jobs_kill_all ( wmWindowManager * wm )

Wait until every job ended.

Definition at line 602 of file wm_jobs.cc.

References blender::seq::prefetch_stop_all(), wmWindowManager::runtime, and wm_jobs_kill_job().

Referenced by ed_undo_step_pre(), WM_exit_ex(), and wm_file_read_setup_wm_init().

◆ WM_jobs_kill_all_except()

void WM_jobs_kill_all_except	(	wmWindowManager *	wm,
		const void *	owner )

Wait until every job ended, except for one owner (used in undo to keep screen job alive).

Definition at line 614 of file wm_jobs.cc.

References LISTBASE_FOREACH_MUTABLE, wmJob::owner, wmWindowManager::runtime, and wm_jobs_kill_job().

Referenced by screen_opengl_render_init(), and screen_render_invoke().

◆ WM_jobs_kill_all_from_owner()

void WM_jobs_kill_all_from_owner	(	wmWindowManager *	wm,
		const void *	owner )

Terminate thread and timer of all jobs from this owner.

Beware of the impact of calling this. For example passing the scene will kill all jobs having the scene as owner, even otherwise unrelated jobs.

Definition at line 638 of file wm_jobs.cc.

References LISTBASE_FOREACH_MUTABLE, wmJob::owner, wmWindowManager::runtime, and wm_jobs_kill_job().

Referenced by ED_scene_delete().

◆ WM_jobs_kill_type()

void WM_jobs_kill_type	(	wmWindowManager *	wm,
		const void *	owner,
		int	job_type )

Terminate thread and timer of all jobs of this type and owner (if non-null).

Don't pass WM_JOB_TYPE_ANY as job_type. Use WM_jobs_kill_all_from_owner() instead.

Definition at line 623 of file wm_jobs.cc.

References BLI_assert, wmJob::job_type, LISTBASE_FOREACH_MUTABLE, wmJob::owner, wmWindowManager::runtime, WM_JOB_TYPE_ANY, and wm_jobs_kill_job().

Referenced by ED_preview_kill_jobs(), ED_preview_kill_jobs_for_id(), ED_view3d_stop_render_preview(), filelist_readjob_stop(), blender::ed::space_node::free_previews(), lightprobe_cache_bake_cancel(), lightprobe_cache_free_exec(), ptcache_bake_cancel(), reload_exec(), screen_opengl_render_cancel(), screen_render_cancel(), blender::ed::vse::sequencer_stop_running_jobs(), and ui_studiolight_kill_icon_preview_job().

◆ WM_jobs_name()

const char * WM_jobs_name	(	const wmWindowManager *	wm,
		const void *	owner )

Definition at line 319 of file wm_jobs.cc.

References wmJob::name, wm_job_find(), and WM_JOB_TYPE_ANY.

Referenced by uiTemplateRunningJobs().

◆ WM_jobs_progress()

float WM_jobs_progress	(	const wmWindowManager *	wm,
		const void *	owner )

Definition at line 267 of file wm_jobs.cc.

References wmJob::flag, wmJobWorkerStatus::progress, wm_job_find(), WM_JOB_PROGRESS, WM_JOB_TYPE_ANY, and wmJob::worker_status.

Referenced by progress_tooltip_func(), and uiTemplateRunningJobs().

◆ WM_jobs_start()

void WM_jobs_start	(	wmWindowManager *	wm,
		wmJob *	wm_job )

Register the given wm_job and try to start it immediately.

The new wm_job will not start immediately and wait for other blocking jobs to end in some way if:

the new job is flagged with WM_JOB_EXCL_RENDER and another job with the same flag is already running (blocks it), or...
the new job is not flagged with WM_JOB_EXCL_RENDER and a job of the same eWM_JobType is already running (blocks it).

If the new wm_job is flagged with WM_JOB_PRIORITY, it will request other blocking jobs to stop (using #WM_jobs_stop(), so this doesn't take immediate effect) rather than finish its work. Additionally, it will hint the operating system to use performance cores on hybrid CPUs.

Definition at line 479 of file wm_jobs.cc.

References BLI_threadpool_init(), BLI_threadpool_insert(), BLI_time_now_seconds(), wmJob::customdata, do_job_thread(), wmJob::free, wmJob::initjob, printf, wmJobWorkerStatus::progress, wmJob::ready, wmJob::run_customdata, wmJob::run_free, wmJob::running, wmJob::start_delay_time, wmJob::start_time, wmJob::startjob, wmJobWorkerStatus::stop, wmJob::suspended, wmJob::threads, wmJob::time_step, wmTimer::time_step, TIMERJOBS, wmJob::win, WM_event_timer_add(), WM_event_timer_remove(), wm_jobs_test_suspend_stop(), wmJob::worker_status, and wmJob::wt.

Referenced by ABC_export(), ABC_import(), blender::ed::object::bake_invoke(), clip_rebuild_proxy_exec(), clip_start_prefetch_job(), dynamicpaint_bake_exec(), ED_node_composite_job(), ED_preview_icon_job(), ED_preview_shader_job(), blender::seq::ThumbGenerationJob::ensure_job(), PreviewLoadJob::ensure_job(), blender::ed::space_node::ensure_nodetree_previews(), filelist_readjob_start_ex(), fluid_bake_invoke(), fluid_free_exec(), lightprobe_cache_bake_invoke(), lineart_bake_common(), blender::ed::object::multiresbake_image_exec(), blender::ed::object::ocean_bake_exec(), pack_islands_exec(), ptcache_bake_invoke(), blender::ed::object::quadriflow_remesh_exec(), screen_opengl_render_invoke(), screen_render_invoke(), blender::ed::vse::seq_build_proxy(), blender::ed::vse::seq_proxy_build_job(), blender::ed::vse::sequencer_preview_add_sound(), blender::ed::object::bake_simulation::simulate_to_frame_invoke(), solve_camera_invoke(), blender::ed::vse::start_audio_video_job(), blender::ed::object::bake_simulation::start_bake_job(), track_markers(), ui_icon_ensure_deferred(), blender::io::usd::USD_export(), blender::io::usd::USD_import(), and wm_jobs_timer().

◆ WM_jobs_starttime()

double WM_jobs_starttime	(	const wmWindowManager *	wm,
		const void *	owner )

Time that job started.

Definition at line 308 of file wm_jobs.cc.

References wmJob::flag, wmJob::start_time, wm_job_find(), WM_JOB_PROGRESS, and WM_JOB_TYPE_ANY.

Referenced by progress_tooltip_func().

◆ WM_jobs_stop_all_from_owner()

void WM_jobs_stop_all_from_owner	(	wmWindowManager *	wm,
		const void *	owner )

Signal all jobs from this owner to stop, timer is required to get handled.

Beware of the impact of calling this. For example passing the scene will stop all jobs having the scene as owner, even otherwise unrelated jobs.

Definition at line 663 of file wm_jobs.cc.

References LISTBASE_FOREACH, wmJob::owner, wmJob::running, wmWindowManager::runtime, wmJobWorkerStatus::stop, and wmJob::worker_status.

Referenced by do_running_jobs().

◆ WM_jobs_stop_type()

void WM_jobs_stop_type	(	wmWindowManager *	wm,
		const void *	owner,
		eWM_JobType	job_type )

Signal all jobs of this type and owner (if non-null) to stop, timer is required to get handled.

Don't pass WM_JOB_TYPE_ANY as job_type. Use WM_jobs_stop_all_from_owner() instead.

Definition at line 647 of file wm_jobs.cc.

References BLI_assert, wmJob::job_type, LISTBASE_FOREACH, wmJob::owner, wmJob::running, wmWindowManager::runtime, wmJobWorkerStatus::stop, WM_JOB_TYPE_ANY, and wmJob::worker_status.

Referenced by EEVEE_lightbake_job_create(), and blender::ed::space_node::ensure_nodetree_previews().

◆ WM_jobs_test()

bool WM_jobs_test	(	const wmWindowManager *	wm,
		const void *	owner,
		int	job_type )

Returns true if job runs, for UI (progress) indicators.

Definition at line 247 of file wm_jobs.cc.

References ELEM, LISTBASE_FOREACH, wmWindowManager::runtime, WM_JOB_PROGRESS, and WM_JOB_TYPE_ANY.

Referenced by blender::ed::object::bake_invoke(), blender::ed::object::bake_modal(), blender::ed::object::bake_simulation::bake_simulation_modal(), blender::ed::object::bake_simulation::bake_single_node_modal(), clip_prefetch_modal(), ED_preview_draw(), ED_undo_operator_repeat(), EEVEE_lightbake_job_create(), filelist_readjob_running(), fluid_bake_modal(), lightprobe_cache_bake_modal(), lineart_bake_strokes_common_modal(), blender::ed::object::objects_bake_render_modal(), ptcache_bake_modal(), RE_FreeUnusedGPUResources(), screen_opengl_render_init(), screen_opengl_render_modal(), screen_render_invoke(), screen_render_modal(), blender::ed::object::bake_simulation::simulate_to_frame_modal(), solve_camera_invoke(), solve_camera_modal(), track_markers(), track_markers_modal(), uiTemplateRunningJobs(), WM_operator_check_ui_enabled(), and wm_set_working_space_check_safe().

◆ WM_jobs_timer()

void WM_jobs_timer	(	wmJob *	wm_job,
		double	time_step,
		unsigned int	note,
		unsigned int	endnote )

Definition at line 376 of file wm_jobs.cc.

References wmJob::endnote, wmJob::note, and wmJob::time_step.

Referenced by ABC_export(), ABC_import(), blender::ed::object::bake_invoke(), clip_rebuild_proxy_exec(), clip_start_prefetch_job(), dynamicpaint_bake_exec(), ED_node_composite_job(), ED_preview_icon_job(), ED_preview_shader_job(), blender::seq::ED_seq_proxy_job_get(), EEVEE_lightbake_job_create(), blender::seq::ThumbGenerationJob::ensure_job(), PreviewLoadJob::ensure_job(), blender::ed::space_node::ensure_nodetree_previews(), filelist_readjob_start_ex(), fluid_bake_invoke(), fluid_free_exec(), lineart_bake_common(), blender::ed::object::multiresbake_image_exec(), blender::ed::object::ocean_bake_exec(), pack_islands_exec(), ptcache_bake_invoke(), blender::ed::object::quadriflow_remesh_exec(), screen_opengl_render_invoke(), screen_render_invoke(), blender::ed::vse::sequencer_preview_add_sound(), blender::ed::object::bake_simulation::simulate_to_frame_invoke(), solve_camera_invoke(), blender::ed::vse::start_audio_video_job(), blender::ed::object::bake_simulation::start_bake_job(), track_markers(), ui_icon_ensure_deferred(), blender::io::usd::USD_export(), and blender::io::usd::USD_import().

◆ WM_lib_reload()

void WM_lib_reload	(	Library *	lib,
		bContext *	C,
		ReportList *	reports )

◆ WM_locked_interface_set()

void WM_locked_interface_set	(	wmWindowManager *	wm,
		bool	lock )

Lock the interface for any communication. For WM_locked_interface_set_with_flags, #lock_flags is ARegionDrawLockFlags

Definition at line 6487 of file wm_event_system.cc.

References lock, REGION_DRAW_LOCK_ALL, and WM_locked_interface_set_with_flags().

Referenced by blender::ed::object::bake_simulation::bake_geometry_nodes_endjob(), dpaint_bake_endjob(), blender::io::alembic::export_endjob(), blender::io::usd::export_endjob(), blender::io::alembic::export_startjob(), blender::io::usd::export_startjob(), flip_pose(), fluid_bake_endjob(), fluid_free_endjob(), blender::io::usd::import_endjob(), import_endjob(), blender::io::usd::import_startjob(), import_startjob(), lineart_bake_endjob(), pack_islands_freejob(), ptcache_bake_invoke(), ptcache_job_endjob(), ptcache_job_startjob(), blender::ed::object::quadriflow_end_job(), blender::ed::object::quadriflow_remesh_exec(), render_endjob(), blender::ed::object::bake_simulation::simulate_to_frame_endjob(), blender::ed::object::bake_simulation::simulate_to_frame_startjob(), solve_camera_freejob(), solve_camera_initjob(), blender::ed::object::bake_simulation::start_bake_job(), track_markers_freejob(), and track_markers_initjob().

◆ WM_locked_interface_set_with_flags()

void WM_locked_interface_set_with_flags	(	wmWindowManager *	wm,
		short	lock_flags )

Definition at line 6473 of file wm_event_system.cc.

References BKE_spacedata_draw_locks(), and wmWindowManager::runtime.

Referenced by dynamicpaint_bake_exec(), fluid_bake_invoke(), fluid_free_exec(), lineart_bake_common(), pack_islands_exec(), screen_render_invoke(), and WM_locked_interface_set().

◆ WM_main()

void WM_main ( bContext * C )

Definition at line 583 of file wm.cc.

References C, wm_draw_update(), wm_event_do_handlers(), wm_event_do_notifiers(), wm_event_do_refresh_wm_and_depsgraph(), and wm_window_events_process().

Referenced by main().

◆ WM_main_add_notifier()

void WM_main_add_notifier	(	unsigned int	type,
		void *	reference )

Definition at line 404 of file wm_event_system.cc.

References ListBase::first, G_MAIN, Main::wm, and WM_event_add_notifier_ex().

◆ WM_main_playanim()

int WM_main_playanim	(	int	argc,
		const char **	argv )

Definition at line 2214 of file wm_playanim.cc.

References PlayArgs::argc, PlayArgs::argv, BKE_blender_atexit(), BLI_assert, i, MEM_freeN(), and wm_main_playanim_intern().

Referenced by arg_handle_playback_mode().

◆ WM_main_remap_editor_id_reference()

void WM_main_remap_editor_id_reference ( const blender::bke::id::IDRemapper & mappings )

Definition at line 449 of file wm_event_system.cc.

References AS_asset_library_remap_ids(), ED_spacedata_id_remap(), ListBase::first, G_MAIN, blender::bke::id::IDRemapper::iter(), LISTBASE_FOREACH, Main::screens, blender::ed::asset::list::storage_id_remap(), Main::wm, WM_msg_id_remove(), and WM_msg_id_update().

Referenced by WM_init().

◆ WM_main_remove_notifier_reference()

void WM_main_remove_notifier_reference ( const void * reference )

Clear notifiers by reference, Used so listeners don't act on freed data.

Definition at line 412 of file wm_event_system.cc.

References BLI_assert, BLI_gset_remove(), BLI_remlink(), ListBase::first, G_MAIN, LISTBASE_FOREACH_MUTABLE, MEM_freeN(), wmWindowManager::runtime, UNUSED_VARS_NDEBUG, Main::wm, WM_msg_id_remove(), and wm_notifier_clear().

Referenced by WM_init().

◆ WM_menu_invoke()

wmOperatorStatus WM_menu_invoke	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

Definition at line 1137 of file wm_operators.cc.

References C, blender::wm::InvokeRegionWin, and WM_menu_invoke_ex().

◆ WM_menu_invoke_ex()

wmOperatorStatus WM_menu_invoke_ex	(	bContext *	C,
		wmOperator *	op,
		blender::wm::OpCallContext	opcontext )

Invoke callback, uses enum property named "type".

Definition at line 1099 of file wm_operators.cc.

References C, CLOG_ERROR, PointerRNA::data, wmOperatorType::exec, wmOperatorType::idname, uiLayout::op_enum(), OPERATOR_CANCELLED, uiLayout::operator_context_set(), OPERATOR_INTERFACE, OPERATOR_RETVAL_CHECK, wmOperatorType::prop, PROP_ENUM, wmOperator::ptr, RNA_property_identifier(), RNA_property_is_set(), RNA_property_type(), wmOperator::type, UI_ITEM_NONE, UI_popup_menu_begin(), UI_popup_menu_end(), UI_popup_menu_layout(), WM_LOG_OPERATORS, and WM_operatortype_name().

Referenced by add_driver_button_menu_invoke(), WM_event_add(), and WM_menu_invoke().

◆ WM_menu_name_call()

void WM_menu_name_call	(	bContext *	C,
		const char *	menu_name,
		blender::wm::OpCallContext	context )

Call an existent menu. The menu can be created in C or Python.

Definition at line 1971 of file wm_event_system.cc.

References C, ot, ptr, RNA_string_set(), WM_operator_name_call_ptr(), WM_operator_properties_create_ptr(), WM_operator_properties_free(), and WM_operatortype_find().

Referenced by blender::ed::outliner::do_outliner_operation_event(), blender::ed::greasepencil::grease_pencil_move_to_layer_invoke(), blender::ed::object::move_to_collection_invoke(), undo_history_invoke(), and WM_event_add().

◆ WM_menutype_add()

bool WM_menutype_add ( MenuType * mt )

Definition at line 61 of file wm_menu_type.cc.

References BLI_assert, MenuType::description, and get_menu_type_map().

Referenced by blender::ed::object::collection_exporter_register(), ED_screen_user_menu_register(), ED_spacetype_node(), blender::ed::vse::ED_spacetype_sequencer(), ED_spacetype_view3d(), file_external_operations_menu_register(), blender::ed::object::link_to_collection_menu_register(), blender::ed::object::move_to_collection_menu_register(), blender::ed::object::object_modifier_add_asset_register(), override_idtemplate_menu(), recent_files_menu_register(), and undo_history_menu_register().

◆ WM_menutype_find()

MenuType * WM_menutype_find	(	blender::StringRef	idname,
		bool	quiet )

◆ WM_menutype_free()

void WM_menutype_free ( )

Definition at line 83 of file wm_menu_type.cc.

References get_menu_type_map(), and MEM_freeN().

Referenced by WM_exit_ex().

◆ WM_menutype_freelink()

void WM_menutype_freelink ( MenuType * mt )

Definition at line 68 of file wm_menu_type.cc.

References BLI_assert, get_menu_type_map(), MEM_freeN(), and UNUSED_VARS_NDEBUG.

◆ WM_menutype_idname_visit_for_search()

void WM_menutype_idname_visit_for_search	(	const bContext *	C,
		PointerRNA *	ptr,
		PropertyRNA *	prop,
		const char *	edit_text,
		blender::FunctionRef< void(StringPropertySearchVisitParams)>	visit_fn )

Definition at line 110 of file wm_menu_type.cc.

References get_menu_type_map(), StringPropertySearchVisitParams::info, and StringPropertySearchVisitParams::text.

Referenced by WM_OT_call_menu(), and WM_OT_call_menu_pie().

◆ WM_menutype_init()

void WM_menutype_init ( )

Note: Called on initialize WM_init().

Definition at line 77 of file wm_menu_type.cc.

References get_menu_type_map().

Referenced by WM_init().

◆ WM_menutype_poll()

bool WM_menutype_poll	(	bContext *	C,
		MenuType *	mt )

Definition at line 94 of file wm_menu_type.cc.

References BKE_workspace_owner_id_check(), C, CTX_wm_workspace(), MenuType::owner_id, and MenuType::poll.

Referenced by uiLayout::menu(), uiLayout::menu_contents(), menu_items_from_ui_create(), UI_pie_menu_invoke(), and UI_popup_menu_invoke().

◆ WM_menutypes_registered_get()

blender::Span< MenuType * > WM_menutypes_registered_get ( )

Definition at line 56 of file wm_menu_type.cc.

References get_menu_type_map().

Referenced by menu_items_from_ui_create().

◆ WM_operator_bl_idname()

size_t WM_operator_bl_idname	(	char *	dst,
		const char *	src )

Convert: some.op -> SOME_OT_op or leave as-is.

Returns: the length of dst.

◆ WM_operator_bl_idname_is_valid()

bool WM_operator_bl_idname_is_valid ( const char * idname )

Return true when an operators name follows the SOME_OT_op naming convention.

Definition at line 174 of file wm_operators.cc.

References OP_BL_SEP_LEN, and OP_BL_SEP_STRING.

Referenced by PYOP_wrap_macro_define(), wm_operatortype_append__end(), WM_operatortype_append_macro(), and WM_operatortype_append_macro_ptr().

◆ WM_operator_call()

wmOperatorStatus WM_operator_call	(	bContext *	C,
		wmOperator *	op )

Definition at line 1437 of file wm_event_system.cc.

References C, and WM_operator_call_ex().

Referenced by WM_event_add().

◆ WM_operator_call_ex()

wmOperatorStatus WM_operator_call_ex	(	bContext *	C,
		wmOperator *	op,
		bool	store )

For running operators with frozen context (modal handlers, menus).

Parameters

store Store properties for re-use when an operator has finished (unless PROP_SKIP_SAVE is set).

Warning: do not use this within an operator to call itself! #29537.

Definition at line 1432 of file wm_event_system.cc.

References C, and wm_operator_exec().

Referenced by dialog_exec_cb(), WM_event_add(), WM_operator_call(), and wm_operator_ui_popup_ok().

◆ WM_operator_call_notest()

wmOperatorStatus WM_operator_call_notest	(	bContext *	C,
		wmOperator *	op )

This is intended to be used when an invoke operator wants to call exec on itself and is basically like running op->type->exec() directly, no poll checks no freeing, since we assume whoever called invoke will take care of that

Definition at line 1442 of file wm_event_system.cc.

References C, and wm_operator_exec_notest().

Referenced by op_generic_value_invoke(), WM_event_add(), and WM_operator_filesel().

◆ WM_operator_call_py()

wmOperatorStatus WM_operator_call_py	(	bContext *	C,
		wmOperatorType *	ot,
		blender::wm::OpCallContext	context,
		PointerRNA *	properties,
		ReportList *	reports,
		bool	is_undo )

Similar to WM_operator_name_call called with blender::wm::OpCallContext::ExecDefault context.

wmOperatorType is used instead of operator name since python already has the operator type.
poll() must be called by python before this runs.
reports can be passed to this function (so python can report them as exceptions).

Definition at line 1982 of file wm_event_system.cc.

References C, CTX_wm_manager(), wmWindowManager::op_undo_depth, OPERATOR_CANCELLED, ot, and wm_operator_call_internal().

Referenced by pyop_call(), and WM_event_add().

◆ WM_operator_check_ui_enabled()

bool WM_operator_check_ui_enabled	(	const bContext *	C,
		const char *	idname )

Return false, if the UI should be disabled.

Definition at line 1295 of file wm_operators.cc.

References C, CTX_data_scene(), CTX_wm_manager(), ED_undo_is_valid(), WM_JOB_TYPE_ANY, and WM_jobs_test().

Referenced by ed_undo_redo_poll(), hud_panel_operator_redo_draw(), wm_block_create_redo(), and WM_event_add().

◆ WM_operator_confirm()

wmOperatorStatus WM_operator_confirm	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

Invoke callback, confirm menu + exec.

Definition at line 1245 of file wm_operators.cc.

References ALERT_ICON_NONE, C, IFACE_, wmOperatorType::name, wmOperator::type, and WM_operator_confirm_ex().

Referenced by WM_event_add(), WM_OT_read_history(), WM_OT_read_userpref(), and WM_OT_save_userpref().

◆ WM_operator_confirm_ex()

wmOperatorStatus WM_operator_confirm_ex	(	bContext *	C,
		wmOperator *	op,
		const char *	title = nullptr,
		const char *	message = nullptr,
		const char *	confirm_text = nullptr,
		int	icon = 0,
		bool	cancel_default = false )

Like WM_operator_confirm, but with more options and can't be used as an invoke directly.

Definition at line 1764 of file wm_operators.cc.

References C, data, IFACE_, OPERATOR_RUNNING_MODAL, wmOperator::ptr, wmOperator::type, UI_DEFAULT_TEXT_POINTS, UI_popup_block_ex(), UI_SCALE_FAC, UI_style_get(), wm_block_dialog_create(), wm_operator_ui_popup_cancel(), wm_operator_ui_popup_ok(), WM_operatortype_name(), WM_POPUP_POSITION_CENTER, WM_POPUP_POSITION_MOUSE, WM_POPUP_SIZE_LARGE, and WM_POPUP_SIZE_SMALL.

◆ WM_operator_confirm_message()

wmOperatorStatus WM_operator_confirm_message	(	bContext *	C,
		wmOperator *	op,
		const char *	message )

Definition at line 1239 of file wm_operators.cc.

References ALERT_ICON_NONE, C, IFACE_, and WM_operator_confirm_ex().

Referenced by WM_event_add().

◆ WM_operator_confirm_message_ex()

wmOperatorStatus WM_operator_confirm_message_ex	(	bContext *	C,
		wmOperator *	op,
		const char *	title,
		int	icon,
		const char *	message,
		blender::wm::OpCallContext	opcontext )

Can't be used as an invoke directly, needs message arg (can be NULL).

Definition at line 1211 of file wm_operators.cc.

References ALERT_ICON_ERROR, ALERT_ICON_INFO, ALERT_ICON_NONE, ALERT_ICON_QUESTION, ALERT_ICON_WARNING, C, IFACE_, and WM_operator_confirm_ex().

Referenced by WM_event_add().

◆ WM_operator_confirm_or_exec()

wmOperatorStatus WM_operator_confirm_or_exec	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

Definition at line 1251 of file wm_operators.cc.

References ALERT_ICON_NONE, C, wmOperatorType::exec, IFACE_, wmOperatorType::name, wmOperator::ptr, RNA_boolean_get(), wmOperator::type, and WM_operator_confirm_ex().

Referenced by WM_event_add().

◆ WM_operator_depends_on_cursor()

bool WM_operator_depends_on_cursor	(	bContext &	C,
		wmOperatorType &	ot,
		PointerRNA *	properties )

Check the OPTYPE_DEPENDS_ON_CURSOR flag and the callback.

Definition at line 633 of file wm_operator_type.cc.

References C, OPTYPE_DEPENDS_ON_CURSOR, and ot.

Referenced by WM_operator_name_call_ptr_with_depends_on_cursor().

◆ WM_operator_drop_load_path()

ID * WM_operator_drop_load_path	(	bContext *	C,
		wmOperator *	op,
		short	idcode )

Use for drag & drop a path or name with operators invoke() function. Returns null if no operator property is set to identify the file or ID to use.

Definition at line 1331 of file wm_operators.cc.

References BKE_idtype_idcode_to_name(), BKE_image_load_exists(), BKE_main_blendfile_path(), BKE_reportf(), BLI_assert_unreachable, BLI_path_rel(), C, CTX_data_main(), FILE_MAX, ID_IM, id_us_plus(), MAX_ID_NAME, name, wmOperator::ptr, wmOperator::reports, RNA_boolean_get(), RNA_string_get(), RNA_struct_property_is_set(), RPT_, RPT_ERROR, WM_operator_properties_id_lookup_from_name_or_session_uid(), and WM_operator_properties_id_lookup_is_set().

Referenced by camera_background_image_add_exec(), blender::ed::space_node::node_add_image_exec(), blender::ed::object::object_image_add_exec(), blender::ed::object::object_image_add_invoke(), and WM_event_add().

◆ WM_operator_filesel()

wmOperatorStatus WM_operator_filesel	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

Invoke callback, file selector "filepath" unset + exec.

wmOperatorType.invoke, opens file-select if path property not set, otherwise executes.

Definition at line 1263 of file wm_operators.cc.

References C, OPERATOR_RUNNING_MODAL, wmOperator::ptr, RNA_struct_property_is_set(), WM_event_add_fileselect(), and WM_operator_call_notest().

Referenced by blender::ed::sculpt_paint::brush_asset_load_preview_invoke(), graphkeys_sound_to_samples_invoke(), lib_id_load_custom_preview_invoke(), blender::ed::space_node::node_add_image_invoke(), sound_mixdown_invoke(), sound_open_invoke(), and WM_event_add().

◆ WM_operator_filesel_ensure_ext_imtype()

bool WM_operator_filesel_ensure_ext_imtype	(	wmOperator *	op,
		const ImageFormatData *	im_format )

Definition at line 1272 of file wm_operators.cc.

References BKE_image_path_ext_from_imformat_ensure(), FILE_MAX, wmOperator::ptr, RNA_property_string_get(), RNA_property_string_set(), and RNA_struct_find_property().

Referenced by image_save_as_check(), screenshot_check(), and WM_event_add().

◆ WM_operator_find_modal_by_type()

wmOperator * WM_operator_find_modal_by_type	(	wmWindow *	win,
		const wmOperatorType *	ot )

Return the first modal operator of type ot or NULL.

Definition at line 5167 of file wm_event_system.cc.

References LISTBASE_FOREACH, wmWindow::modalhandlers, wmEventHandler_Op::op, ot, wmOperator::type, and WM_HANDLER_TYPE_OP.

Referenced by blender::ed::transform::gizmo_modal().

◆ WM_operator_flag_only_pass_through_on_press()

wmOperatorStatus WM_operator_flag_only_pass_through_on_press	(	wmOperatorStatus	retval,
		const wmEvent *	event )

Indented for use in a selection (picking) operators wmOperatorType::invoke callback to implement click-drag, where the initial click selects and the drag action grabs or performs box-select (for example).

In this case, returning OPERATOR_FINISHED causes the PRESS event to be handled and prevents further CLICK (on release) or DRAG (on cursor motion) from being generated & handled.
Returning OPERATOR_FINISHED | OPERATOR_PASS_THROUGH allows for CLICK/DRAG but only makes sense if the event's value is PRESS. If the operator was already mapped to a CLICK/DRAG event, a single CLICK/DRAG could invoke multiple operators.

This function handles the details of checking the operator return value, clearing OPERATOR_PASS_THROUGH when the wmEvent::val is not KM_PRESS.

Note: Combining selection with other actions should only be used in situations where selecting doesn't change the visibility of other items. Since it means for example click-drag to box select could hide-show elements the user intended to box-select. In this case it's preferred to select on CLICK instead of PRESS (see the Outliner use of click-drag).

Definition at line 38 of file wm_operator_utils.cc.

References BLI_assert, KM_PRESS, OPERATOR_CANCELLED, OPERATOR_FINISHED, OPERATOR_PASS_THROUGH, and wmEvent::val.

Referenced by add_vertex_invoke(), animchannels_mouseclick_invoke(), armature_click_extrude_invoke(), edbm_dupli_extrude_cursor_invoke(), blender::ed::space_node::node_select_invoke(), select_invoke(), blender::ed::vse::sequencer_select_invoke(), uv_select_edge_ring_invoke(), uv_select_invoke(), uv_select_loop_invoke(), and view3d_select_invoke().

◆ WM_operator_free()

void WM_operator_free ( wmOperator * op )

◆ WM_operator_free_all_after()

void WM_operator_free_all_after	(	wmWindowManager *	wm,
		wmOperator *	op )

Definition at line 294 of file wm.cc.

References BLI_remlink(), wmOperator::next, wmWindowManager::runtime, and WM_operator_free().

Referenced by ED_undo_operator_repeat(), gizmo_tweak_start_and_finish(), repeat_last_exec(), and WM_event_add().

◆ WM_operator_handlers_clear()

void WM_operator_handlers_clear	(	wmWindowManager *	wm,
		wmOperatorType *	ot )

This function is needed in the case when an addon id disabled while a modal operator it defined is running.

Definition at line 367 of file wm.cc.

References bScreen::areabase, ARRAY_SIZE, wmEventHandler::flag, wmEventHandler_Op::head, i, LISTBASE_FOREACH, SpaceFile::op, wmEventHandler_Op::op, ot, SPACE_FILE, wmOperator::type, wmWindowManager::windows, WM_HANDLER_DO_FREE, WM_HANDLER_TYPE_OP, WM_operator_free(), and WM_window_get_active_screen().

Referenced by WM_event_add().

◆ WM_operator_is_repeat()

bool WM_operator_is_repeat	(	const bContext *	C,
		const wmOperator *	op )

Definition at line 1482 of file wm_event_system.cc.

References C, CTX_wm_manager(), wmOperator::next, wmOperator::prev, wmWindowManager::runtime, and wmOperator::type.

Referenced by WM_event_add().

◆ WM_operator_last_properties_ensure()

void WM_operator_last_properties_ensure	(	wmOperatorType *	ot,
		PointerRNA *	ptr )

Definition at line 1325 of file wm_operators.cc.

References G_MAIN, ot, ptr, RNA_pointer_create_discrete(), and WM_operator_last_properties_ensure_idprops().

Referenced by WM_event_add().

◆ WM_operator_last_properties_ensure_idprops()

IDProperty * WM_operator_last_properties_ensure_idprops ( wmOperatorType * ot )

Definition at line 1317 of file wm_operators.cc.

References blender::bke::idprop::create_group(), and ot.

Referenced by WM_event_add(), and WM_operator_last_properties_ensure().

◆ WM_operator_last_properties_init()

bool WM_operator_last_properties_init ( wmOperator * op )

Definition at line 915 of file wm_operators.cc.

References IDP_GetPropertyFromGroup(), wmOperatorType::last_properties, LISTBASE_FOREACH, wmOperator::macro, operator_last_properties_init_impl(), and wmOperator::type.

Referenced by WM_event_add(), and wm_operator_invoke().

◆ WM_operator_last_properties_store()

bool WM_operator_last_properties_store ( wmOperator * op )

Definition at line 930 of file wm_operators.cc.

References BLI_listbase_is_empty(), CLOG_DEBUG, blender::bke::idprop::create_group(), IDProperty::data, ListBase::first, IDPropertyData::group, wmOperatorType::idname, IDP_CopyProperty(), IDP_FreeProperty(), IDP_ReplaceInGroup(), wmOperatorType::last_properties, LISTBASE_FOREACH, wmOperator::macro, IDProperty::name, wmOperator::properties, STRNCPY(), wmOperator::type, and WM_LOG_OPERATORS.

Referenced by WM_event_add(), wm_handler_fileselect_do(), and wm_operator_finished().

◆ WM_operator_last_redo()

wmOperator * WM_operator_last_redo ( const bContext * C )

Definition at line 1303 of file wm_operators.cc.

References C, CTX_wm_manager(), LISTBASE_FOREACH_BACKWARD, OPTYPE_REGISTER, OPTYPE_UNDO, and wmWindowManager::runtime.

Referenced by ED_gizmo_poll_or_unlink_delayed_from_operator(), ed_undo_redo_exec(), ed_undo_redo_poll(), file_browse_exec(), gizmo_bisect_exec(), gizmo_mesh_bisect_draw_prepare(), gizmo_mesh_bisect_setup(), gizmo_mesh_placement_draw_prepare(), gizmo_mesh_placement_setup(), gizmo_mesh_spin_redo_draw_prepare(), gizmo_mesh_spin_redo_setup(), gizmo_placement_exec(), gizmo_spin_exec(), gizmo_tweak_start_and_finish(), hud_panel_operator_redo_draw(), hud_panel_operator_redo_draw_header(), last_redo_poll(), redo_last_invoke(), screen_ctx_active_operator(), uiTemplateOperatorRedoProperties(), wm_block_create_redo(), wm_block_redo_cancel_cb(), wm_block_redo_cb(), WM_event_add(), and wm_operator_finished().

◆ WM_operator_name_call()

wmOperatorStatus WM_operator_name_call	(	bContext *	C,
		const char *	opstring,
		blender::wm::OpCallContext	context,
		PointerRNA *	properties,
		const wmEvent *	event )

See WM_operator_name_call_ptr.

Definition at line 1935 of file wm_event_system.cc.

References C, ot, WM_operator_name_call_ptr(), and WM_operatortype_find().

Referenced by annotation_draw_modal(), blender::ed::asset::asset_bundle_install_exec(), console_indent_or_autocomplete_exec(), console_main_region_draw(), console_paste_exec(), do_running_jobs(), file_smoothscroll_invoke(), blender::ed::transform::flushTransNodes(), image_save_invoke(), keyframe_jump_exec(), blender::ed::object::mode_compat_set(), mouse_nla_strips(), nlaedit_select_leftright(), blender::ed::space_node::node_render_changed_exec(), blender::ed::space_node::node_toggle_button_cb(), blender::ed::space_node::node_toggle_viewer_exec(), blender::ed::outliner::outliner_animdata_operation_exec(), blender::ed::outliner::outliner_id_operation_exec(), paintcurve_draw_exec(), pyop_call(), report_replay_exec(), save_file_overwrite_confirm(), save_file_overwrite_saveas(), text_indent_or_autocomplete_exec(), text_save_invoke(), ui_but_anim_copy_driver(), ui_but_anim_paste_driver(), view3d_navigate_invoke(), view3d_ruler_add_invoke(), view_pan_modal(), viewdolly_modal(), viewroll_modal(), wm_block_autorun_warning_enable_scripts(), wm_block_autorun_warning_reload_with_scripts(), wm_block_file_close_save(), WM_event_add(), WM_gizmo_modal_set_from_setup(), and WM_init_splash().

◆ WM_operator_name_call_ptr()

wmOperatorStatus WM_operator_name_call_ptr	(	bContext *	C,
		wmOperatorType *	ot,
		blender::wm::OpCallContext	context,
		PointerRNA *	properties,
		const wmEvent *	event )

Invokes operator in context.

Parameters

event Optionally pass in an event to use when context uses one of the WM_OP_INVOKE_* values. When left unset the wmWindow.eventstate will be used, this can cause problems for operators that read the events type - for example, storing the key that was pressed so as to be able to detect its release. In these cases it's necessary to forward the current event being handled.

Definition at line 1926 of file wm_event_system.cc.

References BLI_assert, C, ot, wm_operator_call_internal(), and WM_operatortype_find().

Referenced by add_driver_button_menu_exec(), bone_mouse_select_menu(), blender::ed::object::collection_exporter_export(), constraint_reorder(), doc_view_manual_ui_context_exec(), file_browse_invoke(), file_directory_enter_handle(), file_external_operation_exec(), ghost_event_proc(), blender::ed::outliner::id_remap_fn(), image_file_browse_invoke(), blender::ed::outliner::lib_relocate(), blender::ed::space_node::link_drag_search_exec_fn(), blender::ed::object::mode_set_ex(), blender::seq::modifier_reorder(), modifier_reorder(), blender::ed::vse::move_strips(), blender::ed::space_node::node_add_group_asset_invoke(), blender::ed::space_node::node_swap_group_asset_invoke(), object_mouse_select_menu(), blender::ed::asset::shelf::AssetViewItem::on_activate(), blender::ed::asset::shelf::AssetDragController::on_drag_start(), operator_search_exec_fn(), blender::ed::outliner::outliner_id_relocate_invoke(), blender::ed::outliner::outliner_item_drag_drop_invoke(), preferences_extension_url_drop_invoke(), shaderfx_reorder(), blender::ed::transform::special_aftertrans_update__node(), toolsystem_ref_set_by_brush_type(), blender::ed::transform::transform_from_gizmo_invoke(), blender::ed::space_node::tree_path_handle_func(), ui_but_anim_decorate_cb(), ui_handler_wait_for_input(), view3d_interactive_add_modal(), wm_drop_import_file_exec(), WM_event_add(), WM_gizmo_operator_invoke(), WM_menu_name_call(), WM_operator_name_call(), WM_operator_name_call_ptr_with_depends_on_cursor(), WM_operator_name_call_with_properties(), wm_test_autorun_revert_action_exec(), and WM_toolsystem_ref_set_by_id_ex().

◆ WM_operator_name_call_ptr_with_depends_on_cursor()

void WM_operator_name_call_ptr_with_depends_on_cursor	(	bContext *	C,
		wmOperatorType *	ot,
		blender::wm::OpCallContext	opcontext,
		PointerRNA *	properties,
		const wmEvent *	event,
		blender::StringRef	drawstr )

Definition at line 2109 of file wm_event_system.cc.

References uiOperatorWaitForInput::area, C, uiOperatorWaitForInput::context, CTX_IFACE_, CTX_store_get(), CTX_wm_area(), CTX_wm_window(), PointerRNA::data, ED_area_status_text(), ED_workspace_status_text(), IDP_CopyProperty(), IFACE_, blender::StringRefBase::is_empty(), LISTBASE_FOREACH, wmWindow::modalhandlers, wmOperatorCallParams::opcontext, wmOperatorCallParams::opptr, wmOperatorCallParams::optype, uiOperatorWaitForInput::optype_params, ot, ui_handler_wait_for_input(), ui_handler_wait_for_input_remove(), WM_cursor_modal_set(), WM_event_add_ui_handler(), WM_HANDLER_BLOCKING, WM_OP_CONTEXT_HAS_AREA, WM_operator_depends_on_cursor(), WM_operator_name_call_ptr(), and WM_operatortype_find().

Referenced by menu_search_exec_fn(), ui_apply_but_funcs_after(), ui_but_extra_operator_icon_apply(), and WM_event_add().

◆ WM_operator_name_call_with_properties()

wmOperatorStatus WM_operator_name_call_with_properties	(	bContext *	C,
		const char *	opstring,
		blender::wm::OpCallContext	context,
		IDProperty *	properties,
		const wmEvent *	event )

Definition at line 1959 of file wm_event_system.cc.

References C, G_MAIN, wmWindowManager::id, ot, RNA_pointer_create_discrete(), WM_operator_name_call_ptr(), and WM_operatortype_find().

Referenced by WM_event_add(), wm_homefile_read_after_dialog_callback(), wm_open_mainfile_after_dialog_callback(), and wm_recover_last_session_after_dialog_callback().

◆ WM_operator_name_poll()

bool WM_operator_name_poll	(	bContext *	C,
		const char *	opstring )

Definition at line 1949 of file wm_event_system.cc.

References C, ot, WM_operator_poll(), and WM_operatortype_find().

Referenced by file_panel_asset_catalog_buttons_draw(), and WM_event_add().

◆ WM_operator_poll()

bool WM_operator_poll	(	bContext *	C,
		wmOperatorType *	ot )

Definition at line 1095 of file wm_event_system.cc.

References C, LISTBASE_FOREACH, ot, WM_operator_poll(), and WM_operatortype_find().

Referenced by ED_undo_operator_repeat(), edbm_point_normals_modal(), last_redo_poll(), menu_items_from_all_operators(), operator_search_update_fn(), blender::ed::outliner::outliner_operator_menu(), WM_event_add(), wm_operator_exec(), wm_operator_invoke(), WM_operator_name_poll(), WM_operator_poll(), and WM_operator_poll_or_report_error().

◆ WM_operator_poll_context()

bool WM_operator_poll_context	(	bContext *	C,
		wmOperatorType *	ot,
		blender::wm::OpCallContext	context )

Definition at line 1137 of file wm_event_system.cc.

References C, ot, and wm_operator_call_internal().

Referenced by dropbox_active(), pyop_call(), pyop_poll(), ui_but_context_poll_operator_ex(), wm_drop_prepare(), WM_event_add(), WM_event_match_keymap_item(), and wm_handlers_do_gizmo_handler().

◆ WM_operator_poll_or_report_error()

bool WM_operator_poll_or_report_error	(	bContext *	C,
		wmOperatorType *	ot,
		ReportList *	reports )

Check poll succeeds or returns false & report an error.

This can be used from wmOperatorType::exec for operators that use the file-selector. It's needed in this case because the context can be changed once the file-selector has been activated.

Returns: true or false & report an error.

Note: It's best practice that ot->poll sets the "poll message", otherwise a generic (unhelpful) error will be used.

Definition at line 1117 of file wm_event_system.cc.

References BKE_reportf(), C, CTX_IFACE_, CTX_wm_operator_poll_msg_clear(), CTX_wm_operator_poll_msg_get(), IFACE_, MEM_freeN(), ot, RPT_ERROR, and WM_operator_poll().

Referenced by paste_from_file_exec(), and WM_event_add().

◆ WM_operator_properties_alloc()

void WM_operator_properties_alloc	(	PointerRNA **	ptr,
		IDProperty **	properties,
		const char *	opstring )

Similar to the function above except its uses ID properties used for key-maps and macros.

Definition at line 757 of file wm_operators.cc.

References blender::bke::idprop::create_group(), IDProperty::data, ptr, and WM_operator_properties_create().

Referenced by uiLayout::op_menu_enum(), save_file_overwrite_confirm(), WM_dropbox_add(), wm_dropbox_item_update_ot(), WM_event_add(), wm_keymap_item_properties_set(), WM_operatortype_macro_define(), and wm_xr_actionmap_item_properties_set().

◆ WM_operator_properties_border()

void WM_operator_properties_border ( wmOperatorType * ot )

Definition at line 380 of file wm_operator_props.cc.

References ot, PROP_HIDDEN, PROP_SKIP_SAVE, RNA_def_boolean(), RNA_def_int(), and RNA_def_property_flag().

Referenced by ANIM_OT_previewrange_set(), blender::ed::sculpt_paint::GREASE_PENCIL_OT_erase_box(), IMAGE_OT_render_border(), blender::ed::sculpt_paint::hide::PAINT_OT_hide_show(), blender::ed::sculpt_paint::mask::PAINT_OT_mask_box_gesture(), blender::ed::sculpt_paint::face_set::SCULPT_OT_face_set_box_gesture(), blender::ed::sculpt_paint::trim::SCULPT_OT_trim_box_gesture(), VIEW3D_OT_clip_border(), VIEW3D_OT_render_border(), WM_operator_properties_gesture_box_ex(), and WM_operator_properties_gesture_box_zoom().

◆ WM_operator_properties_border_to_bounds()

blender::Bounds< blender::int2 > WM_operator_properties_border_to_bounds ( wmOperator * op )

Definition at line 412 of file wm_operator_props.cc.

References wmOperator::ptr, and RNA_int_get().

Referenced by blender::ed::sculpt_paint::grease_pencil_erase_box_exec().

◆ WM_operator_properties_border_to_rctf()

void WM_operator_properties_border_to_rctf	(	wmOperator *	op,
		rctf *	r_rect )

Definition at line 405 of file wm_operator_props.cc.

References BLI_rctf_rcti_copy(), and WM_operator_properties_border_to_rcti().

Referenced by box_select_graph_exec(), ed_marker_box_select_exec(), image_view_zoom_border_exec(), blender::ed::space_node::node_box_select_exec(), blender::ed::outliner::outliner_box_select_exec(), render_border_exec(), blender::ed::vse::sequencer_box_select_exec(), blender::ed::vse::sequencer_retiming_box_select_exec(), uv_box_select_exec(), uv_custom_region_set_exec(), view_borderzoom_exec(), and blender::ed::vse::view_ghost_border_exec().

◆ WM_operator_properties_border_to_rcti()

void WM_operator_properties_border_to_rcti	(	wmOperator *	op,
		rcti *	r_rect )

◆ WM_operator_properties_checker_interval()

void WM_operator_properties_checker_interval	(	wmOperatorType *	ot,
		bool	nth_can_disable )

Parameters

nth_can_disable Enable if we want to be able to select no interval at all.

Definition at line 651 of file wm_operator_props.cc.

References min_ii(), ot, and RNA_def_int().

Referenced by CURVE_OT_select_nth(), MESH_OT_select_nth(), path_select_properties(), and path_select_properties().

◆ WM_operator_properties_checker_interval_from_op()

void WM_operator_properties_checker_interval_from_op	(	wmOperator *	op,
		CheckerIntervalParams *	op_params )

Definition at line 684 of file wm_operator_props.cc.

References mod_i(), CheckerIntervalParams::nth, CheckerIntervalParams::offset, wmOperator::ptr, RNA_int_get(), and CheckerIntervalParams::skip.

Referenced by edbm_select_nth_exec(), path_select_params_from_op(), path_select_params_from_op(), and select_nth_exec().

◆ WM_operator_properties_checker_interval_test()

bool WM_operator_properties_checker_interval_test	(	const CheckerIntervalParams *	op_params,
		int	depth )

Definition at line 698 of file wm_operator_props.cc.

References CheckerIntervalParams::nth, CheckerIntervalParams::offset, and CheckerIntervalParams::skip.

Referenced by mouse_mesh_shortest_path_edge(), mouse_mesh_shortest_path_face(), mouse_mesh_shortest_path_vert(), mouse_mesh_uv_shortest_path_edge(), mouse_mesh_uv_shortest_path_face(), mouse_mesh_uv_shortest_path_vert(), select_nth_bezt(), select_nth_bp(), walker_deselect_nth(), walker_deselect_nth_edge_chain(), walker_deselect_nth_face_chain(), and walker_deselect_nth_vertex_chain().

◆ WM_operator_properties_clear()

void WM_operator_properties_clear ( PointerRNA * ptr )

Definition at line 850 of file wm_operators.cc.

References IDP_ClearProperty(), and ptr.

Referenced by WM_event_add(), and wm_macro_modal().

◆ WM_operator_properties_confirm_or_exec()

void WM_operator_properties_confirm_or_exec ( wmOperatorType * ot )

◆ WM_operator_properties_create()

void WM_operator_properties_create	(	PointerRNA *	ptr,
		const char *	opstring )

Definition at line 743 of file wm_operators.cc.

References G_MAIN, ot, ptr, RNA_pointer_create_discrete(), WM_operator_properties_create_ptr(), and WM_operatortype_find().

Referenced by doc_view_manual_ui_context_exec(), file_smoothscroll_invoke(), blender::ed::space_node::node_render_changed_exec(), WM_event_add(), wm_keymap_item_copy(), WM_operator_properties_alloc(), and wm_xr_actionmap_item_copy().

◆ WM_operator_properties_create_ptr()

void WM_operator_properties_create_ptr	(	PointerRNA *	ptr,
		wmOperatorType *	ot )

Definition at line 737 of file wm_operators.cc.

References G_MAIN, ot, ptr, and RNA_pointer_create_discrete().

Referenced by bone_mouse_select_menu(), constraint_reorder(), blender::ed::asset::shelf::create_asset_operator_params(), file_browse_invoke(), file_directory_enter_handle(), file_external_operation_exec(), ghost_event_proc(), blender::ed::outliner::id_remap_fn(), image_file_browse_invoke(), blender::ed::outliner::lib_relocate(), blender::ed::space_node::link_drag_search_exec_fn(), menu_item_enum_opname_menu_active(), blender::seq::modifier_reorder(), modifier_reorder(), blender::ed::vse::move_strips(), blender::ed::space_node::node_add_group_asset_invoke(), blender::ed::space_node::node_swap_group_asset_invoke(), object_mouse_select_menu(), uiLayout::op_enum(), uiLayout::op_menu_enum(), blender::ed::outliner::outliner_id_relocate_invoke(), blender::ed::outliner::outliner_item_drag_drop_invoke(), preferences_extension_url_drop_invoke(), pyop_call(), shaderfx_reorder(), blender::ed::transform::special_aftertrans_update__node(), toolsystem_ref_set_by_brush_type(), blender::ed::transform::transform_from_gizmo_invoke(), blender::ed::space_node::tree_path_handle_func(), ui_but_anim_decorate_cb(), ui_but_extra_operator_icon_add_ptr(), UI_but_operator_ptr_ensure(), ui_handle_menu_letter_press_search(), ui_pie_menu_level_invoke(), ui_tooltip_data_from_tool(), view3d_interactive_add_modal(), wm_drop_import_file_exec(), wm_dropbox_item_update_ot(), WM_event_add(), WM_gizmo_operator_set(), wm_keymap_item_properties_update_ot(), WM_menu_name_call(), WM_operator_properties_create(), WM_operator_pystring_ex(), WM_operator_type_set(), WM_operator_ui_poll(), WM_operatortype_props_advanced_end(), wm_recover_auto_save_exec(), wm_recover_last_session_impl(), wm_test_autorun_revert_action_exec(), WM_toolsystem_ref_set_by_id_ex(), and WM_xr_actionmap_item_properties_update_ot().

◆ WM_operator_properties_default()

bool WM_operator_properties_default	(	PointerRNA *	ptr,
		bool	do_update )

Set all props to their default.

Parameters

do_update Only update un-initialized props.

Note: There's nothing specific to operators here. This could be made a general function.

Definition at line 806 of file wm_operators.cc.

References PROP_POINTER, ptr, RNA_property_is_set(), RNA_property_pointer_get(), RNA_property_pointer_type(), RNA_property_reset(), RNA_property_type(), RNA_STRUCT_BEGIN, RNA_STRUCT_END, and WM_operator_properties_default().

Referenced by WM_event_add(), wm_keymap_item_find(), wm_keymap_item_find_in_keymap(), WM_operator_properties_default(), and WM_operator_type_set().

◆ WM_operator_properties_filesel()

void WM_operator_properties_filesel	(	wmOperatorType *	ot,
		int	filter,
		short	type,
		eFileSel_Action	action,
		eFileSel_Flag	flag,
		short	display,
		short	sort )

Default properties for file-select.

Definition at line 65 of file wm_operator_props.cc.

References FILE_DEFAULTDISPLAY, FILE_HORIZONTALDISPLAY, FILE_IMGDISPLAY, FILE_LOADLIB, FILE_MAX, FILE_SAVE, FILE_SPECIAL, FILE_TYPE_ALEMBIC, FILE_TYPE_ARCHIVE, FILE_TYPE_BLENDER, FILE_TYPE_BLENDER_BACKUP, FILE_TYPE_BLENDERLIB, FILE_TYPE_BTX, FILE_TYPE_FOLDER, FILE_TYPE_FTFONT, FILE_TYPE_IMAGE, FILE_TYPE_MOVIE, FILE_TYPE_OBJECT_IO, FILE_TYPE_PYSCRIPT, FILE_TYPE_SOUND, FILE_TYPE_TEXT, FILE_TYPE_USD, FILE_TYPE_VOLUME, FILE_VERTICALDISPLAY, filter, flag, ot, PROP_HIDDEN, PROP_SKIP_PRESET, PROP_SKIP_SAVE, RNA_def_boolean(), RNA_def_collection_runtime(), RNA_def_enum(), RNA_def_enum_funcs(), RNA_def_int(), RNA_def_property_flag(), RNA_def_string_dir_path(), RNA_def_string_file_name(), RNA_def_string_file_path(), rna_enum_dummy_NULL_items, sort(), WM_FILESEL_DIRECTORY, WM_FILESEL_FILENAME, WM_FILESEL_FILEPATH, WM_FILESEL_FILES, WM_FILESEL_RELPATH, WM_FILESEL_SHOW_PROPS, and wm_operator_properties_filesel_sort_items_itemf().

Referenced by blender::ed::asset::ASSET_OT_bundle_install(), blender::ed::sculpt_paint::BRUSH_OT_asset_load_preview(), BUTTONS_OT_directory_browse(), BUTTONS_OT_file_browse(), CACHEFILE_OT_layer_add(), CACHEFILE_OT_open(), CLIP_OT_open(), ED_OT_lib_id_load_custom_preview(), FILE_OT_find_missing_files(), FONT_OT_open(), FONT_OT_text_paste_from_file(), GRAPH_OT_sound_to_samples(), IMAGE_OT_file_browse(), IMAGE_OT_open(), IMAGE_OT_replace(), IMAGE_OT_save_as(), blender::ed::space_node::NODE_OT_add_image(), blender::ed::object::OBJECT_OT_empty_image_add(), blender::ed::object::OBJECT_OT_multires_external_save(), blender::ed::object::OBJECT_OT_volume_import(), PREFERENCES_OT_asset_library_add(), RIGIDBODY_OT_world_export(), screen_screenshot_impl(), blender::ed::vse::SEQUENCER_OT_change_path(), blender::ed::vse::SEQUENCER_OT_export_subtitles(), blender::ed::vse::SEQUENCER_OT_image_strip_add(), blender::ed::vse::SEQUENCER_OT_movie_strip_add(), blender::ed::vse::SEQUENCER_OT_sound_strip_add(), SOUND_OT_mixdown(), SOUND_OT_open(), SOUND_OT_open_mono(), TEXT_OT_open(), TEXT_OT_save_as(), WM_OT_append(), WM_OT_id_linked_relocate(), WM_OT_lib_reload(), WM_OT_lib_relocate(), WM_OT_link(), WM_OT_open_mainfile(), WM_OT_recover_auto_save(), WM_OT_save_as_mainfile(), and WM_OT_save_mainfile().

◆ WM_operator_properties_free()

void WM_operator_properties_free ( PointerRNA * ptr )

Definition at line 859 of file wm_operators.cc.

References IDP_FreeProperty(), and ptr.

Referenced by bone_mouse_select_menu(), constraint_reorder(), doc_view_manual_ui_context_exec(), file_browse_invoke(), file_directory_enter_handle(), file_external_operation_exec(), file_smoothscroll_invoke(), ghost_event_proc(), blender::ed::outliner::id_remap_fn(), image_file_browse_invoke(), blender::ed::outliner::lib_relocate(), blender::ed::space_node::link_drag_search_exec_fn(), blender::seq::modifier_reorder(), modifier_reorder(), blender::ed::vse::move_strips(), blender::ed::space_node::node_add_group_asset_invoke(), blender::ed::space_node::node_render_changed_exec(), blender::ed::space_node::node_swap_group_asset_invoke(), object_mouse_select_menu(), blender::ed::asset::shelf::AssetViewItem::on_activate(), blender::ed::asset::shelf::AssetDragController::on_drag_start(), blender::ed::outliner::outliner_id_relocate_invoke(), blender::ed::outliner::outliner_item_drag_drop_invoke(), preferences_extension_url_drop_invoke(), pyop_as_string(), pyop_call(), shaderfx_reorder(), blender::ed::transform::special_aftertrans_update__node(), toolsystem_ref_set_by_brush_type(), blender::ed::transform::transform_from_gizmo_invoke(), blender::ed::space_node::tree_path_handle_func(), ui_apply_but_funcs_after(), ui_but_anim_decorate_cb(), ui_but_extra_operator_icon_free(), ui_but_free(), ui_tooltip_data_from_tool(), view3d_interactive_add_modal(), wm_drop_import_file_exec(), wm_drop_item_free_data(), WM_event_add(), WM_gizmo_free(), WM_gizmo_operator_set(), wm_handler_operator_call(), wm_keymap_item_free_data(), WM_keymap_item_properties_reset(), WM_keymap_remove_item(), WM_menu_name_call(), WM_operator_pystring_ex(), WM_operator_type_set(), wm_operatortype_free_macro(), wm_test_autorun_revert_action_set(), WM_toolsystem_ref_set_by_id_ex(), wm_xr_actionmap_item_properties_free(), and MenuSearch_Item::OperatorData::~OperatorData().

◆ WM_operator_properties_generic_select()

void WM_operator_properties_generic_select ( wmOperatorType * ot )

Selecting and tweaking items are overlapping operations. Getting both to work without conflicts requires special care. See https://wiki.blender.org/wiki/Human_Interface_Guidelines/Selection#Select-tweaking for the desired behavior.

For default click selection (with no modifier keys held), the select operators can do the following:

On a mouse press on an unselected item, change selection and finish immediately after. This sends an undo push and allows transform to take over should a click-drag event be caught.
On a mouse press on a selected item, don't change selection state, but start modal execution of the operator. Idea is that we wait with deselecting other items until we know that the intention wasn't to tweak (mouse press+drag) all selected items.
If a click-drag is recognized before the release event happens, cancel the operator, so that transform can take over and no undo-push is sent.
If the release event occurs rather than a click-drag one, deselect all items but the one under the cursor, and finish the modal operator.

This utility, together with WM_generic_select_invoke() and WM_generic_select_modal() should help getting the wanted behavior to work. Most generic logic should be handled in these, so that the select operators only have to care for the case dependent handling.

Every select operator has slightly different requirements, e.g. sequencer strip selection also needs to account for handle selection. This should be the baseline behavior though.

Definition at line 504 of file wm_operator_props.cc.

References ot, PROP_HIDDEN, PROP_SKIP_SAVE, RNA_def_boolean(), RNA_def_int(), and RNA_def_property_flag().

Referenced by ACTION_OT_clickselect(), FILE_OT_select(), GRAPH_OT_clickselect(), MARKER_OT_select(), NLA_OT_click_select(), blender::ed::vse::SEQUENCER_OT_select(), blender::ed::vse::SEQUENCER_OT_select_handle(), and UI_OT_view_item_select().

◆ WM_operator_properties_gesture_box()

void WM_operator_properties_gesture_box ( wmOperatorType * ot )

◆ WM_operator_properties_gesture_box_ex()

void WM_operator_properties_gesture_box_ex	(	wmOperatorType *	ot,
		bool	deselect,
		bool	extend )

Use with WM_gesture_box_invoke

Definition at line 419 of file wm_operator_props.cc.

References ot, PROP_SKIP_SAVE, RNA_def_boolean(), RNA_def_property_flag(), and WM_operator_properties_border().

Referenced by WM_operator_properties_gesture_box(), and WM_operator_properties_gesture_box_select().

◆ WM_operator_properties_gesture_box_select()

void WM_operator_properties_gesture_box_select ( wmOperatorType * ot )

Definition at line 450 of file wm_operator_props.cc.

References ot, and WM_operator_properties_gesture_box_ex().

Referenced by ANIM_OT_channels_select_box(), and CLIP_OT_graph_select_box().

◆ WM_operator_properties_gesture_box_zoom()

void WM_operator_properties_gesture_box_zoom ( wmOperatorType * ot )

Definition at line 529 of file wm_operator_props.cc.

References ot, PROP_HIDDEN, PROP_SKIP_SAVE, RNA_def_boolean(), RNA_def_property_flag(), and WM_operator_properties_border().

Referenced by IMAGE_OT_view_zoom_border(), VIEW2D_OT_zoom_border(), and VIEW3D_OT_zoom_border().

◆ WM_operator_properties_gesture_circle()

void WM_operator_properties_gesture_circle ( wmOperatorType * ot )

Use with WM_gesture_circle_invoke

Definition at line 605 of file wm_operator_props.cc.

References ot, PROP_HIDDEN, PROP_SKIP_SAVE, RNA_def_boolean(), RNA_def_int(), and RNA_def_property_flag().

Referenced by ACTION_OT_select_circle(), CLIP_OT_select_circle(), GRAPH_OT_select_circle(), MASK_OT_select_circle(), blender::ed::space_node::NODE_OT_select_circle(), blender::ed::vse::SEQUENCER_OT_select_circle(), UV_OT_select_circle(), and VIEW3D_OT_select_circle().

◆ WM_operator_properties_gesture_lasso()

void WM_operator_properties_gesture_lasso ( wmOperatorType * ot )

Use with WM_gesture_lasso_invoke

Definition at line 538 of file wm_operator_props.cc.

References ot, PROP_HIDDEN, PROP_PIXEL, PROP_SKIP_SAVE, RNA_def_boolean(), RNA_def_collection_runtime(), RNA_def_float(), RNA_def_int(), RNA_def_property_flag(), and RNA_def_property_subtype().

Referenced by ACTION_OT_select_lasso(), CLIP_OT_select_lasso(), GRAPH_OT_select_lasso(), blender::ed::sculpt_paint::GREASE_PENCIL_OT_erase_lasso(), GREASE_PENCIL_OT_stroke_trim(), MASK_OT_select_lasso(), blender::ed::space_node::NODE_OT_select_lasso(), blender::ed::sculpt_paint::hide::PAINT_OT_hide_show_lasso_gesture(), blender::ed::sculpt_paint::mask::PAINT_OT_mask_lasso_gesture(), blender::ed::sculpt_paint::face_set::SCULPT_OT_face_set_lasso_gesture(), blender::ed::sculpt_paint::trim::SCULPT_OT_trim_lasso_gesture(), blender::ed::vse::SEQUENCER_OT_select_lasso(), UV_OT_select_lasso(), and VIEW3D_OT_select_lasso().

◆ WM_operator_properties_gesture_polyline()

void WM_operator_properties_gesture_polyline ( wmOperatorType * ot )

Use with WM_gesture_polyline_invoke

Definition at line 569 of file wm_operator_props.cc.

References ot, PROP_HIDDEN, PROP_SKIP_SAVE, RNA_def_collection_runtime(), and RNA_def_property_flag().

Referenced by blender::ed::sculpt_paint::hide::PAINT_OT_hide_show_polyline_gesture(), blender::ed::sculpt_paint::mask::PAINT_OT_mask_polyline_gesture(), blender::ed::sculpt_paint::face_set::SCULPT_OT_face_set_polyline_gesture(), and blender::ed::sculpt_paint::trim::SCULPT_OT_trim_polyline_gesture().

◆ WM_operator_properties_gesture_straightline()

void WM_operator_properties_gesture_straightline	(	wmOperatorType *	ot,
		int	cursor )

Use with WM_gesture_straightline_invoke

Definition at line 576 of file wm_operator_props.cc.

References ot, PROP_HIDDEN, PROP_SKIP_SAVE, RNA_def_boolean(), RNA_def_int(), and RNA_def_property_flag().

Referenced by blender::ed::greasepencil::GREASE_PENCIL_OT_texture_gradient(), IMAGE_OT_sample_line(), MESH_OT_bisect(), blender::ed::sculpt_paint::hide::PAINT_OT_hide_show_line_gesture(), blender::ed::sculpt_paint::mask::PAINT_OT_mask_line_gesture(), PAINT_OT_weight_gradient(), blender::ed::sculpt_paint::face_set::SCULPT_OT_face_set_line_gesture(), blender::ed::sculpt_paint::project::SCULPT_OT_project_line_gesture(), and blender::ed::sculpt_paint::trim::SCULPT_OT_trim_line_gesture().

◆ WM_operator_properties_id_lookup()

void WM_operator_properties_id_lookup	(	wmOperatorType *	ot,
		const bool	add_name_prop )

Adds "name" and "session_uid" properties so the caller can tell the operator which ID to act on. See WM_operator_properties_id_lookup_from_name_or_session_uid(). Both properties will be hidden in the UI and not be saved over consecutive operator calls.

Note: New operators should probably use "session_uid" only (set add_name_prop to false), since this works properly with linked data and/or library overrides (in both cases, multiple IDs with the same name and type may be present). The "name" property is only kept to not break compatibility with old scripts using some previously existing operators.

Definition at line 271 of file wm_operator_props.cc.

References INT32_MAX, INT32_MIN, MAX_ID_NAME, ot, PROP_HIDDEN, PROP_SKIP_SAVE, RNA_def_int(), RNA_def_property_flag(), and RNA_def_string().

◆ WM_operator_properties_id_lookup_from_name_or_session_uid()

ID * WM_operator_properties_id_lookup_from_name_or_session_uid	(	Main *	bmain,
		PointerRNA *	ptr,
		enum ID_Type	type )

Tries to find an ID in bmain. There needs to be either a "session_uid" int or "name" string property defined and set. The former has priority. See WM_operator_properties_id_lookup() for a helper to add the properties.

Definition at line 246 of file wm_operator_props.cc.

References BKE_libblock_find_name(), BKE_libblock_find_session_uid(), MAX_ID_NAME, name, ptr, RNA_property_int_get(), RNA_property_is_set(), RNA_property_string_get(), and RNA_struct_find_property().

◆ WM_operator_properties_id_lookup_is_set()

bool WM_operator_properties_id_lookup_is_set ( PointerRNA * ptr )

Check if either the "session_uid" or "name" property is set inside ptr. If this is the case the ID can be looked up by WM_operator_properties_id_lookup_from_name_or_session_uid().

Definition at line 266 of file wm_operator_props.cc.

References ptr, and RNA_struct_property_is_set().

Referenced by blender::ed::space_node::node_add_image_invoke(), blender::ed::object::object_image_add_invoke(), blender::ed::object::object_instance_add_invoke(), and WM_operator_drop_load_path().

◆ WM_operator_properties_id_lookup_set_from_id()

void WM_operator_properties_id_lookup_set_from_id	(	PointerRNA *	ptr,
		const ID *	id )

Tries to pass id to an operator via either a "session_uid" or a "name" property defined in the properties of ptr. The former is preferred, since it works properly with linking and library overrides (which may both result in multiple IDs with the same name and type).

Also see WM_operator_properties_id_lookup() and WM_operator_properties_id_lookup_from_name_or_session_uid()

Definition at line 230 of file wm_operator_props.cc.

References BLI_assert_unreachable, ID::name, ptr, RNA_int_set(), RNA_string_set(), RNA_struct_find_property(), and ID::session_uid.

Referenced by blender::ed::geometry::catalog_assets_draw_unassigned(), blender::nodes::draw_bake_button_row(), blender::ed::object::unassigned_assets_draw(), view3d_id_drop_copy(), view3d_id_drop_copy_with_type(), and view3d_id_path_drop_copy().

◆ WM_operator_properties_mouse_select()

void WM_operator_properties_mouse_select ( wmOperatorType * ot )

See ED_select_pick_params_from_operator to initialize parameters defined here.

Definition at line 620 of file wm_operator_props.cc.

References ot, PROP_SKIP_SAVE, RNA_def_boolean(), and RNA_def_property_flag().

Referenced by CURVE_OT_pen(), GIZMOGROUP_OT_gizmo_select(), MASK_OT_select(), blender::ed::space_node::NODE_OT_select(), blender::ed::curves::pen_tool::pen_tool_common_props(), blender::ed::vse::SEQUENCER_OT_select(), UV_OT_select(), and VIEW3D_OT_select().

◆ WM_operator_properties_reset()

void WM_operator_properties_reset ( wmOperator * op )

Remove all props without PROP_SKIP_SAVE or PROP_SKIP_PRESET.

Definition at line 833 of file wm_operators.cc.

References PointerRNA::data, PROP_SKIP_PRESET, PROP_SKIP_SAVE, wmOperator::ptr, RNA_PROP_BEGIN, RNA_PROP_END, RNA_property_flag(), RNA_property_identifier(), RNA_struct_iterator_property(), RNA_struct_system_idprops_unset(), wmOperatorType::srna, and wmOperator::type.

Referenced by WM_event_add(), and wm_operator_defaults_exec().

◆ WM_operator_properties_sanitize()

void WM_operator_properties_sanitize	(	PointerRNA *	ptr,
		bool	no_context )

Make props context sensitive or not.

Definition at line 777 of file wm_operators.cc.

References PROP_ENUM, PROP_ENUM_NO_CONTEXT, PROP_POINTER, ptr, RNA_def_property_clear_flag(), RNA_def_property_flag(), RNA_property_pointer_get(), RNA_property_pointer_type(), RNA_property_type(), RNA_STRUCT_BEGIN, RNA_STRUCT_END, RNA_struct_is_a(), and WM_operator_properties_sanitize().

Referenced by menu_item_enum_opname_menu_active(), uiLayout::op_enum(), pyop_call(), UI_but_rna_enum_item_get(), ui_pie_menu_level_invoke(), UI_tooltip_uibut_python_add(), uiTemplateKeymapItemProperties(), WM_dropbox_add(), wm_dropbox_item_update_ot(), WM_event_add(), wm_keymap_item_properties_set(), wm_keymap_item_properties_update_ot(), wm_operator_create(), WM_operator_properties_sanitize(), WM_operatortype_macro_define(), wm_xr_actionmap_item_properties_set(), and WM_xr_actionmap_item_properties_update_ot().

◆ WM_operator_properties_select_action()

void WM_operator_properties_select_action	(	wmOperatorType *	ot,
		int	default_action,
		bool	hide_gui )

Definition at line 311 of file wm_operator_props.cc.

References ot, SEL_DESELECT, SEL_INVERT, SEL_SELECT, SEL_TOGGLE, and wm_operator_properties_select_action_ex().

Referenced by INFO_OT_select_all(), PARTICLE_OT_select_roots(), PARTICLE_OT_select_tips(), and WM_operator_properties_select_all().

◆ WM_operator_properties_select_action_simple()

void WM_operator_properties_select_action_simple	(	wmOperatorType *	ot,
		int	default_action,
		bool	hide_gui )

Only for select/de-select.

Definition at line 324 of file wm_operator_props.cc.

References ot, SEL_DESELECT, SEL_SELECT, and wm_operator_properties_select_action_ex().

Referenced by WM_operator_properties_select_random().

◆ WM_operator_properties_select_all()

void WM_operator_properties_select_all ( wmOperatorType * ot )

Definition at line 375 of file wm_operator_props.cc.

References ot, SEL_TOGGLE, and WM_operator_properties_select_action().

Referenced by ACTION_OT_select_all(), ANIM_OT_channels_select_all(), ARMATURE_OT_select_all(), CLIP_OT_graph_select_all_markers(), CLIP_OT_select_all(), CURVE_OT_select_all(), blender::ed::curves::CURVES_OT_select_all(), FILE_OT_select_all(), GRAPH_OT_select_all(), blender::ed::greasepencil::GREASE_PENCIL_OT_select_all(), LATTICE_OT_select_all(), MARKER_OT_select_all(), MASK_OT_select_all(), MBALL_OT_select_all(), MESH_OT_select_all(), NLA_OT_select_all(), blender::ed::space_node::NODE_OT_select_all(), blender::ed::object::OBJECT_OT_select_all(), blender::ed::outliner::OUTLINER_OT_select_all(), PAINT_OT_face_select_all(), PAINT_OT_vert_select_all(), PARTICLE_OT_select_all(), blender::ed::pointcloud::POINTCLOUD_OT_select_all(), POSE_OT_select_all(), blender::ed::vse::SEQUENCER_OT_select_all(), and UV_OT_select_all().

◆ WM_operator_properties_select_operation()

void WM_operator_properties_select_operation ( wmOperatorType * ot )

Definition at line 459 of file wm_operator_props.cc.

References ot, PROP_SKIP_SAVE, RNA_def_enum(), RNA_def_property_flag(), SEL_OP_ADD, SEL_OP_AND, SEL_OP_SET, SEL_OP_SUB, and SEL_OP_XOR.

Referenced by VIEW3D_OT_select_box(), and VIEW3D_OT_select_lasso().

◆ WM_operator_properties_select_operation_simple()

void WM_operator_properties_select_operation_simple ( wmOperatorType * ot )

Note: Some tools don't support XOR/AND.

Definition at line 473 of file wm_operator_props.cc.

References ot, PROP_SKIP_SAVE, RNA_def_enum(), RNA_def_property_flag(), SEL_OP_ADD, SEL_OP_SET, and SEL_OP_SUB.

Referenced by ACTION_OT_select_box(), ACTION_OT_select_circle(), ACTION_OT_select_lasso(), CLIP_OT_select_box(), CLIP_OT_select_circle(), CLIP_OT_select_lasso(), FILE_OT_select_box(), GRAPH_OT_select_box(), GRAPH_OT_select_circle(), GRAPH_OT_select_lasso(), INFO_OT_select_box(), MARKER_OT_select_box(), MASK_OT_select_box(), MASK_OT_select_circle(), MASK_OT_select_lasso(), NLA_OT_select_box(), blender::ed::space_node::NODE_OT_select_box(), blender::ed::space_node::NODE_OT_select_circle(), blender::ed::space_node::NODE_OT_select_lasso(), blender::ed::outliner::OUTLINER_OT_select_box(), blender::ed::vse::SEQUENCER_OT_select_box(), blender::ed::vse::SEQUENCER_OT_select_circle(), blender::ed::vse::SEQUENCER_OT_select_lasso(), UV_OT_select_box(), UV_OT_select_circle(), UV_OT_select_lasso(), and VIEW3D_OT_select_circle().

◆ WM_operator_properties_select_random()

void WM_operator_properties_select_random ( wmOperatorType * ot )

Use for all select random operators. Adds properties: percent, seed, action.

Definition at line 337 of file wm_operator_props.cc.

References ot, RNA_def_float_factor(), RNA_def_int(), SEL_SELECT, and WM_operator_properties_select_action_simple().

Referenced by CURVE_OT_select_random(), blender::ed::greasepencil::GREASE_PENCIL_OT_select_random(), LATTICE_OT_select_random(), MBALL_OT_select_random_metaelems(), MESH_OT_select_random(), blender::ed::object::OBJECT_OT_select_random(), and PARTICLE_OT_select_random().

◆ WM_operator_properties_select_random_seed_increment_get()

int WM_operator_properties_select_random_seed_increment_get ( wmOperator * op )

Definition at line 361 of file wm_operator_props.cc.

References wmOperator::flag, OP_IS_INVOKE, wmOperator::ptr, RNA_property_int_get(), RNA_property_int_set(), RNA_property_is_set(), and RNA_struct_find_property().

Referenced by curve_select_random_exec(), edbm_select_random_exec(), lattice_select_random_exec(), blender::ed::object::object_select_random_exec(), blender::ed::greasepencil::select_random_exec(), select_random_exec(), and select_random_metaelems_exec().

◆ WM_operator_properties_select_walk_direction()

void WM_operator_properties_select_walk_direction ( wmOperatorType * ot )

Definition at line 485 of file wm_operator_props.cc.

References ot, PROP_SKIP_SAVE, RNA_def_enum(), RNA_def_property_flag(), UI_SELECT_WALK_DOWN, UI_SELECT_WALK_LEFT, UI_SELECT_WALK_RIGHT, and UI_SELECT_WALK_UP.

Referenced by FILE_OT_select_walk(), and blender::ed::outliner::OUTLINER_OT_select_walk().

◆ WM_operator_properties_use_cursor_init()

void WM_operator_properties_use_cursor_init ( wmOperatorType * ot )

Disable using cursor position, use when view operators are initialized from buttons.

Definition at line 440 of file wm_operator_props.cc.

References ot, PROP_HIDDEN, PROP_SKIP_SAVE, RNA_def_boolean(), and RNA_def_property_flag().

Referenced by CLIP_OT_view_zoom(), IMAGE_OT_view_zoom(), VIEW2D_OT_zoom(), and view3d_operator_properties_common().

◆ WM_operator_props_dialog_popup()

wmOperatorStatus WM_operator_props_dialog_popup	(	bContext *	C,
		wmOperator *	op,
		int	width,
		std::optional< std::string >	title = std::nullopt,
		std::optional< std::string >	confirm_text = std::nullopt,
		bool	cancel_default = false,
		std::optional< std::string >	message = std::nullopt )

Definition at line 1887 of file wm_operators.cc.

References ALERT_ICON_NONE, C, data, IFACE_, OPERATOR_RUNNING_MODAL, wmOperator::ptr, wmOperator::type, UI_DEFAULT_TEXT_POINTS, UI_popup_block_ex(), UI_SCALE_FAC, UI_style_get(), wm_block_dialog_create(), wm_operator_ui_popup_cancel(), wm_operator_ui_popup_ok(), WM_operatortype_name(), WM_POPUP_POSITION_CENTER, WM_POPUP_POSITION_MOUSE, and WM_POPUP_SIZE_SMALL.

◆ WM_operator_props_popup()

wmOperatorStatus WM_operator_props_popup	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

Definition at line 1882 of file wm_operators.cc.

References C, and wm_operator_props_popup_ex().

Referenced by ANIM_OT_channels_group(), CURVE_OT_radius_set(), CURVE_OT_spline_weight_set(), blender::ed::geometry::geometry_randomization_invoke(), blender::ed::mesh::set_attribute::mesh_set_attribute_invoke(), PARTICLE_OT_rekey(), blender::ed::vse::sequencer_retiming_segment_speed_set_invoke(), blender::ed::curves::set_attribute_invoke(), blender::ed::pointcloud::set_attribute_invoke(), and WM_event_add().

◆ WM_operator_props_popup_call()

wmOperatorStatus WM_operator_props_popup_call	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

Same as WM_operator_props_popup but call the operator first, This way - the button values correspond to the result of the operator. Without this, first access to a button will make the result jump, see #32452.

Definition at line 1875 of file wm_operators.cc.

References C, and wm_operator_props_popup_ex().

Referenced by UV_OT_pack_islands(), and WM_event_add().

◆ WM_operator_props_popup_confirm()

wmOperatorStatus WM_operator_props_popup_confirm	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event )

Invoke callback, exec + redo popup.

Same as WM_operator_props_popup but don't use operator redo. just wraps WM_operator_props_dialog_popup.

Definition at line 1868 of file wm_operators.cc.

References C, and wm_operator_props_popup_ex().

Referenced by WM_event_add().

◆ WM_operator_props_popup_confirm_ex()

wmOperatorStatus WM_operator_props_popup_confirm_ex	(	bContext *	C,
		wmOperator *	op,
		const wmEvent *	event,
		std::optional< std::string >	title = std::nullopt,
		std::optional< std::string >	confirm_text = std::nullopt,
		bool	cancel_default = false,
		std::optional< std::string >	message = std::nullopt )

Definition at line 1856 of file wm_operators.cc.

References C, and wm_operator_props_popup_ex().

◆ WM_operator_py_idname()

size_t size_t WM_operator_py_idname	(	char *	dst,
		const char *	src )

Convert: SOME_OT_op -> some.op or leave as-is.

Returns: the length of dst.

References C, ot, and ptr.

◆ WM_operator_py_idname_ok_or_report()

size_t size_t bool WM_operator_py_idname_ok_or_report	(	ReportList *	reports,
		const char *	classname,
		const char *	idname )

Sanity check to ensure WM_operator_bl_idname won't fail.

Returns: true when there are no problems with idname, otherwise report an error.

Definition at line 198 of file wm_operators.cc.

References BKE_reportf(), dot(), i, OP_MAX_PY_IDNAME, and RPT_ERROR.

◆ WM_operator_pystring()

std::string WM_operator_pystring	(	bContext *	C,
		wmOperator *	op,
		bool	all_args,
		bool	macro_args )

Definition at line 325 of file wm_operators.cc.

References C, wmOperator::ptr, wmOperator::type, and WM_operator_pystring_ex().

Referenced by wm_operator_finished(), wm_operator_invoke(), and wm_operator_reports().

◆ WM_operator_pystring_abbreviate()

std::string WM_operator_pystring_abbreviate	(	std::string	str,
		int	str_len_max )

Definition at line 333 of file wm_operators.cc.

References str.

Referenced by ui_tooltip_text_python_from_op().

◆ WM_operator_pystring_ex()

std::string WM_operator_pystring_ex	(	bContext *	C,
		wmOperator *	op,
		bool	all_args,
		bool	macro_args,
		wmOperatorType *	ot,
		PointerRNA *	opptr )

Operator as a Python command.

Return a string representation of the operator, with the arguments that it runs so Python can run it again.

When calling from an existing wmOperator, better to use simple version: WM_operator_pystring(C, op);

Note: Both op and opptr may be NULL (op is only used for macro operators).

Definition at line 255 of file wm_operators.cc.

References C, ListBase::first, wmOperatorType::idname, wmOperator::macro, wmOperator::next, OP_MAX_TYPENAME, ot, wmOperator::ptr, RNA_pointer_as_string_id(), RNA_pointer_as_string_keywords(), wmOperator::type, WM_operator_properties_create_ptr(), WM_operator_properties_free(), and WM_operator_py_idname().

Referenced by copy_python_command_button_exec(), pyop_as_string(), ui_but_copy_operator(), ui_layout_introspect_button(), ui_tooltip_text_python_from_op(), and WM_operator_pystring().

◆ WM_operator_redo_popup()

wmOperatorStatus WM_operator_redo_popup	(	bContext *	C,
		wmOperator *	op )

Definition at line 1917 of file wm_operators.cc.

References BKE_reportf(), C, CTX_wm_reports(), wmOperatorType::flag, wmOperatorType::idname, OPERATOR_CANCELLED, OPTYPE_REGISTER, wmOperatorType::poll, RPT_ERROR, wmOperator::type, UI_popup_block_invoke(), and wm_block_create_redo().

Referenced by redo_last_invoke(), and WM_event_add().

◆ WM_operator_region_active_win_set()

void WM_operator_region_active_win_set ( bContext * C )

Sets the active region for this space from the context.

See also: BKE_area_find_region_active_win

Definition at line 1177 of file wm_event_system.cc.

References BLI_findindex(), C, CTX_wm_area(), CTX_wm_region(), ScrArea::region_active_win, ScrArea::regionbase, ARegion::regiontype, and RGN_TYPE_WINDOW.

Referenced by wm_operator_finished().

◆ WM_operator_repeat()

wmOperatorStatus WM_operator_repeat	(	bContext *	C,
		wmOperator *	op )

Execute this operator again, put here so it can share above code

Definition at line 1447 of file wm_event_system.cc.

References C, wmOperator::flag, OP_IS_REPEAT, ret, and wm_operator_exec().

Referenced by ED_undo_operator_repeat(), repeat_history_exec(), wm_block_redo_cb(), and WM_event_add().

◆ WM_operator_repeat_check()

bool WM_operator_repeat_check	(	const bContext *	C,
		wmOperator *	op )

Returns: true if WM_operator_repeat can run. Simple check for now but may become more involved. To be sure the operator can run call WM_operator_poll(C, op->type) also, since this call checks if WM_operator_repeat() can run at all, not that it WILL run at any time.

Definition at line 1463 of file wm_event_system.cc.

References wmOperatorType::exec, LISTBASE_FOREACH, wmOperatorType::macro, wmOperator::opm, wmOperator::type, and WM_operatortype_find().

Referenced by ED_undo_operator_repeat(), last_redo_poll(), repeat_history_invoke(), template_operator_property_buts_draw_single(), uiTemplateOperatorRedoProperties(), and WM_event_add().

◆ WM_operator_repeat_last()

wmOperatorStatus WM_operator_repeat_last	(	bContext *	C,
		wmOperator *	op )

Definition at line 1455 of file wm_event_system.cc.

References C, wmOperator::flag, OP_IS_REPEAT_LAST, ret, and wm_operator_exec().

Referenced by repeat_last_exec(), and WM_event_add().

◆ WM_operator_smooth_viewtx_get()

int WM_operator_smooth_viewtx_get ( const wmOperator * op )

Definition at line 1094 of file wm_operators.cc.

References wmOperator::flag, OP_IS_INVOKE, U, and USER_REDUCE_MOTION.

Referenced by actkeys_view_frame_exec(), graphkeys_channel_view_pick_invoke(), graphkeys_view_frame_exec(), graphkeys_view_selected_channels_exec(), graphkeys_view_selected_exec(), graphkeys_viewall_exec(), localview_exec(), localview_remove_from_exec(), nlaedit_viewframe_exec(), blender::ed::space_node::node_select_same_type_step_exec(), blender::ed::space_node::node_view_all_exec(), blender::ed::space_node::node_view_selected_exec(), blender::ed::vse::sequencer_view_all_exec(), blender::ed::vse::sequencer_view_frame_exec(), blender::ed::vse::sequencer_view_selected_exec(), view3d_all_exec(), view3d_setobjectascamera_exec(), view3d_zoom_border_exec(), view_axis_exec(), view_borderzoom_exec(), view_camera_exec(), view_curve_in_graph_editor_exec(), blender::ed::vse::view_frame_preview_scope(), viewcenter_cursor_exec(), viewcenter_pick_invoke(), vieworbit_exec(), viewroll_exec(), viewselected_exec(), and WM_event_add().

◆ WM_operator_stack_clear()

void WM_operator_stack_clear ( wmWindowManager * wm )

Definition at line 358 of file wm.cc.

References BLI_pophead(), NC_WM, ND_HISTORY, wmWindowManager::runtime, WM_main_add_notifier(), and WM_operator_free().

Referenced by ed_undo_exec(), ed_undo_refresh_for_op(), ui_apply_but_funcs_after(), and WM_event_add().

◆ WM_operator_type_modal_from_exec_for_object_edit_coords()

void WM_operator_type_modal_from_exec_for_object_edit_coords ( wmOperatorType * ot )

Allow an operator with only and execute function to run modally, re-doing the action, using vertex coordinate store/restore instead of operator undo.

Definition at line 324 of file wm_operator_utils.cc.

References BLI_assert, op_generic_value_cancel(), op_generic_value_invoke(), op_generic_value_modal(), ot, PROP_HIDDEN, PROP_SKIP_SAVE, RNA_def_boolean(), and RNA_def_property_flag().

Referenced by MESH_OT_vertices_smooth(), and blender::ed::object::TRANSFORM_OT_vertex_random().

◆ WM_operator_type_set()

void WM_operator_type_set	(	wmOperator *	op,
		wmOperatorType *	ot )

Use with extreme care! Properties, custom-data etc - must be compatible.

Parameters

op	Operator to assign the type to.
ot	Operator type to assign.

Definition at line 305 of file wm.cc.

References BLI_assert, IDP_SyncGroupTypes(), ot, wmOperator::properties, ptr, wmOperator::ptr, wmOperator::py_instance, PointerRNA::type, wmOperator::type, WM_operator_properties_create_ptr(), WM_operator_properties_default(), and WM_operator_properties_free().

Referenced by blender::ed::transform::transform_modal(), view3d_navigate_modal_fn(), and WM_event_add().

◆ WM_operator_ui_poll()

bool WM_operator_ui_poll	(	wmOperatorType *	ot,
		PointerRNA *	ptr )

Definition at line 1143 of file wm_event_system.cc.

References flag, LISTBASE_FOREACH, ot, PROP_HIDDEN, ptr, result, RNA_property_flag(), RNA_STRUCT_BEGIN, RNA_STRUCT_END, WM_operator_properties_create_ptr(), WM_operator_ui_poll(), and WM_operatortype_find().

Referenced by last_redo_poll(), WM_event_add(), and WM_operator_ui_poll().

◆ WM_operator_ui_popup()

wmOperatorStatus WM_operator_ui_popup	(	bContext *	C,
		wmOperator *	op,
		int	width )

Definition at line 1797 of file wm_operators.cc.

References C, data, OPERATOR_RUNNING_MODAL, UI_popup_block_ex(), UI_SCALE_FAC, wm_operator_ui_create(), and wm_operator_ui_popup_cancel().

Referenced by WM_event_add().

◆ WM_operator_view3d_unit_defaults()

void WM_operator_view3d_unit_defaults	(	bContext *	C,
		wmOperator *	op )

Definition at line 1065 of file wm_operators.cc.

References BLI_assert, C, CTX_data_scene(), CTX_wm_view3d(), ED_scene_grid_scale(), ED_view3d_grid_scale(), wmOperator::flag, OP_IS_INVOKE, PROP_DISTANCE, PROP_FLOAT, wmOperator::ptr, RNA_property_array_check(), RNA_property_float_get_default(), RNA_property_float_set(), RNA_property_is_set_ex(), RNA_property_subtype(), RNA_property_type(), RNA_STRUCT_BEGIN, and RNA_STRUCT_END.

◆ WM_operator_winactive()

bool WM_operator_winactive ( bContext * C )

Callback for wmOperatorType.poll.

Definition at line 1287 of file wm_operators.cc.

References C, and CTX_wm_window().

Referenced by redraw_timer_poll(), SCENE_OT_new(), SCREEN_OT_new(), SCREEN_OT_spacedata_cleanup(), screenshot_poll(), blender::ed::asset::screenshot_preview_poll(), WM_event_add(), wm_link_append_poll(), WM_OT_call_menu(), WM_OT_call_menu_pie(), WM_OT_call_panel(), WM_OT_debug_menu(), WM_OT_search_menu(), WM_OT_search_operator(), WM_OT_search_single_menu(), WM_OT_splash(), WM_OT_splash_about(), WM_OT_stereo3d_set(), WM_OT_window_close(), and WM_OT_window_fullscreen_toggle().

◆ WM_operatortype_append()

void WM_operatortype_append ( void(* opfunc )(wmOperatorType *ot) )

Definition at line 149 of file wm_operator_type.cc.

References ot, wm_operatortype_append__begin(), and wm_operatortype_append__end().

◆ WM_operatortype_append_macro()

wmOperatorType * WM_operatortype_append_macro	(	const char *	idname,
		const char *	name,
		const char *	description,
		int	flag )

Note: Names have to be static for now.

Definition at line 486 of file wm_operator_type.cc.

References BLENDER_RNA, BLI_assert, BLT_I18NCONTEXT_OPERATOR_DEFAULT, CLOG_ERROR, flag, get_operators_map(), MEM_callocN(), name, OPTYPE_MACRO, ot, RNA_def_struct_identifier(), RNA_def_struct_ptr(), RNA_def_struct_translation_context(), RNA_def_struct_ui_text(), RNA_struct_translation_context(), UNDOCUMENTED_OPERATOR_TIP, WM_LOG_OPERATORS, wm_macro_cancel(), wm_macro_exec(), wm_macro_invoke(), wm_macro_modal(), WM_operator_bl_idname_is_valid(), and WM_operatortype_find().

◆ WM_operatortype_append_macro_ptr()

void WM_operatortype_append_macro_ptr	(	void(*	opfunc )(wmOperatorType ot, void userdata),
		void *	userdata )

Definition at line 531 of file wm_operator_type.cc.

References BLENDER_RNA, BLI_assert, BLT_I18NCONTEXT_OPERATOR_DEFAULT, get_operators_map(), MEM_callocN(), OPTYPE_MACRO, ot, RNA_def_struct_identifier(), RNA_def_struct_ptr(), RNA_def_struct_translation_context(), RNA_def_struct_ui_text(), UNDOCUMENTED_OPERATOR_TIP, wm_macro_cancel(), wm_macro_exec(), wm_macro_invoke(), wm_macro_modal(), and WM_operator_bl_idname_is_valid().

◆ WM_operatortype_append_ptr()

void WM_operatortype_append_ptr	(	void(*	opfunc )(wmOperatorType ot, void userdata),
		void *	userdata )

Definition at line 156 of file wm_operator_type.cc.

References ot, wm_operatortype_append__begin(), and wm_operatortype_append__end().

◆ WM_operatortype_description()

std::string WM_operatortype_description	(	bContext *	C,
		wmOperatorType *	ot,
		PointerRNA *	properties )

Definition at line 603 of file wm_operator_type.cc.

References C, ot, and RNA_struct_ui_description().

Referenced by UI_but_extra_icon_string_get_tooltip(), UI_but_string_get_rna_tooltip(), and WM_operatortype_description_or_name().

◆ WM_operatortype_description_or_name()

std::string WM_operatortype_description_or_name	(	bContext *	C,
		wmOperatorType *	ot,
		PointerRNA *	properties )

Use when we want a label, preferring the description.

Definition at line 619 of file wm_operator_type.cc.

References C, ot, WM_operatortype_description(), and WM_operatortype_name().

Referenced by ui_tooltip_data_from_gizmo().

◆ WM_operatortype_find()

wmOperatorType * WM_operatortype_find	(	const char *	idname,
		bool	quiet )

Definition at line 78 of file wm_operator_type.cc.

References CLOG_INFO, get_operators_map(), OP_MAX_TYPENAME, ot, WM_LOG_OPERATORS, and WM_operator_bl_idname().

◆ WM_operatortype_idname_visit_for_search()

void WM_operatortype_idname_visit_for_search	(	const bContext *	C,
		PointerRNA *	ptr,
		PropertyRNA *	prop,
		const char *	edit_text,
		blender::FunctionRef< void(StringPropertySearchVisitParams)>	visit_fn )

Definition at line 274 of file wm_operator_type.cc.

References get_operators_map(), StringPropertySearchVisitParams::info, OP_MAX_TYPENAME, ot, StringPropertySearchVisitParams::text, and WM_operator_py_idname().

◆ WM_operatortype_last_properties_clear_all()

void WM_operatortype_last_properties_clear_all ( )

Remove memory of all previously executed tools.

Definition at line 264 of file wm_operator_type.cc.

References get_operators_map(), IDP_FreeProperty(), and ot.

Referenced by wm_file_read_post().

◆ WM_operatortype_macro_define()

wmOperatorTypeMacro * WM_operatortype_macro_define	(	wmOperatorType *	ot,
		const char *	idname )

Definition at line 562 of file wm_operator_type.cc.

References BLI_addtail(), wmOperatorTypeMacro::idname, MEM_callocN(), ot, wmOperatorTypeMacro::properties, wmOperatorTypeMacro::ptr, RNA_def_pointer_runtime(), STRNCPY(), WM_operator_properties_alloc(), WM_operator_properties_sanitize(), and WM_operatortype_find().

◆ WM_operatortype_name()

std::string WM_operatortype_name	(	wmOperatorType *	ot,
		PointerRNA *	properties )

Definition at line 593 of file wm_operator_type.cc.

References name, ot, and RNA_struct_ui_name().

Referenced by dropbox_tooltip(), file_draw_invalid_asset_library_hint(), file_panel_operator_header(), blender::ed::io::filesel_drop_import_invoke(), fileselect_ensure_updated_file_params(), graph_slider_modal(), hud_panel_operator_redo_draw_header(), insert_key_menu_invoke(), menu_items_from_ui_create_item_from_button(), uiLayout::op_menu_enum(), blender::ed::outliner::outliner_operator_menu(), repeat_history_invoke(), screen_area_options_invoke(), template_operator_property_buts_draw_single(), UI_but_extra_icon_string_get_label(), UI_but_string_get_rna_label(), ui_but_user_menu_add(), uiItemFullO_ptr_ex(), uiTemplateOperatorRedoProperties(), weight_sample_group_invoke(), wm_block_create_redo(), wm_enum_search_menu(), WM_menu_invoke_ex(), WM_operator_confirm_ex(), WM_operator_props_dialog_popup(), WM_operatortype_description_or_name(), and WM_window_cursor_keymap_status_refresh().

◆ WM_operatortype_props_advanced_begin()

void WM_operatortype_props_advanced_begin ( wmOperatorType * ot )

Tag all operator-properties of ot defined after calling this, until the next WM_operatortype_props_advanced_end call (if available), with OP_PROP_TAG_ADVANCED. Previously defined ones properties not touched.

Calling this multiple times without a call to WM_operatortype_props_advanced_end, all calls after the first one are ignored. Meaning all proprieties defined after the first call are tagged as advanced.

This doesn't do the actual tagging, WM_operatortype_props_advanced_end does which is called for all operators during registration (see wm_operatortype_append__end).

Definition at line 233 of file wm_operator_type.cc.

References ot, ot_prop_basic_count, and RNA_struct_count_properties().

◆ WM_operatortype_props_advanced_end()

void WM_operatortype_props_advanced_end ( wmOperatorType * ot )

Tags all operator-properties of ot defined since the first WM_operatortype_props_advanced_begin call, or the last WM_operatortype_props_advanced_end call, with OP_PROP_TAG_ADVANCED.

Note: This is called for all operators during registration (see wm_operatortype_append__end). So it does not need to be explicitly called in operator-type definition.

Definition at line 241 of file wm_operator_type.cc.

References OP_PROP_TAG_ADVANCED, ot, ot_prop_basic_count, RNA_STRUCT_BEGIN, RNA_STRUCT_END, WM_operator_properties_create_ptr(), and WM_operatortype_prop_tag.

Referenced by wm_operatortype_append__end().

◆ WM_operatortype_remove()

bool WM_operatortype_remove ( const char * idname )

Definition at line 194 of file wm_operator_type.cc.

References ot, WM_operatortype_find(), and WM_operatortype_remove_ptr().

◆ WM_operatortype_remove_ptr()

void WM_operatortype_remove_ptr ( wmOperatorType * ot )

Called on initialize WM_exit().

Definition at line 165 of file wm_operator_type.cc.

References BLENDER_RNA, BLI_assert, BPY_free_srna_pytype(), get_operators_map(), IDP_FreeProperty(), MEM_freeN(), ot, RNA_struct_free(), WM_keyconfig_update_operatortype_tag(), WM_operatortype_find(), and wm_operatortype_free_macro().

Referenced by WM_operatortype_remove().

◆ WM_operatortypes_registered_get()

blender::Span< wmOperatorType * > WM_operatortypes_registered_get ( )

Definition at line 70 of file wm_operator_type.cc.

References get_operators_map().

Referenced by menu_items_from_all_operators(), operator_search_update_fn(), and pyop_dir().

◆ WM_paint_cursor_activate()

wmPaintCursor * WM_paint_cursor_activate	(	short	space_type,
		short	region_type,
		bool(*	poll )(bContext *C),
		wmPaintCursorDraw	draw,
		void *	customdata )

◆ WM_paint_cursor_end()

bool WM_paint_cursor_end ( wmPaintCursor * handle )

Definition at line 2523 of file wm_operators.cc.

References BLI_remlink(), G_MAIN, LISTBASE_FOREACH, MEM_freeN(), and wmWindowManager::runtime.

Referenced by annotation_draw_toggle_eraser_cursor(), annotation_draw_toggle_stabilizer_cursor(), blender::ed::sculpt_paint::min_distance_edit::min_distance_edit_modal(), blender::ed::sculpt_paint::paint_stroke_free(), blender::ed::sculpt_paint::paint_stroke_modal(), blender::ed::transform::postTrans(), pyrna_callback_classmethod_remove(), radial_control_cancel(), toggle_paint_cursor(), toggle_particle_cursor(), v3d_cursor_snap_free(), and blender::ed::sculpt_paint::image::ops::paint::PaintOperation::~PaintOperation().

◆ WM_paint_cursor_remove_by_type()

void WM_paint_cursor_remove_by_type	(	wmWindowManager *	wm,
		void *	draw_fn,
		void(*	free )(void *) )

Definition at line 2536 of file wm_operators.cc.

References BLI_remlink(), free(), LISTBASE_FOREACH_MUTABLE, MEM_freeN(), and wmWindowManager::runtime.

Referenced by BPY_callback_wm_free().

◆ WM_paint_cursor_tag_redraw()

void WM_paint_cursor_tag_redraw	(	wmWindow *	win,
		ARegion *	region )

Definition at line 1606 of file wm_draw.cc.

References bScreen::do_draw_paintcursor, and WM_window_get_active_screen().

Referenced by blender::ed::sculpt_paint::paint_stroke_modal(), paintcurve_delete_point_exec(), paintcurve_point_add(), paintcurve_point_select(), paintcurve_slide_invoke(), paintcurve_slide_modal(), sample_color_exec(), sample_color_invoke(), blender::ed::transform::viewRedrawForce(), and wm_paintcursor_tag().

◆ WM_paneltype_add()

bool WM_paneltype_add ( PanelType * pt )

Definition at line 55 of file wm_panel_type.cc.

References get_panel_type_map().

Referenced by blender::ed::asset::shelf::catalog_selector_panel_register(), graph_buttons_register(), and blender::ed::asset::shelf::popover_panel_register().

◆ WM_paneltype_clear()

void WM_paneltype_clear ( )

Definition at line 74 of file wm_panel_type.cc.

References get_panel_type_map().

Referenced by WM_exit_ex().

◆ WM_paneltype_find()

PanelType * WM_paneltype_find	(	blender::StringRef	idname,
		bool	quiet )

Definition at line 40 of file wm_panel_type.cc.

References get_panel_type_map(), blender::StringRefBase::is_empty(), and printf.

Referenced by blender::ui::asset_shelf_popover_invoke(), blender::ed::asset::shelf::catalog_selector_panel_register(), blender::ed::asset::shelf::popover_panel_register(), ui_block_open_begin(), UI_popover_panel_invoke(), and wm_call_panel_get_name().

◆ WM_paneltype_idname_visit_for_search()

void WM_paneltype_idname_visit_for_search	(	const bContext *	C,
		PointerRNA *	ptr,
		PropertyRNA *	prop,
		const char *	edit_text,
		blender::FunctionRef< void(StringPropertySearchVisitParams)>	visit_fn )

Definition at line 79 of file wm_panel_type.cc.

References get_panel_type_map(), StringPropertySearchVisitParams::info, and StringPropertySearchVisitParams::text.

Referenced by WM_OT_call_panel().

◆ WM_paneltype_init()

void WM_paneltype_init ( )

Called on initialize WM_init().

Definition at line 68 of file wm_panel_type.cc.

References get_panel_type_map().

Referenced by WM_init().

◆ WM_paneltype_remove()

void WM_paneltype_remove ( PanelType * pt )

Definition at line 61 of file wm_panel_type.cc.

References BLI_assert, get_panel_type_map(), and UNUSED_VARS_NDEBUG.

◆ WM_platform_associate_set()

bool WM_platform_associate_set	(	bool	do_register,
		bool	all_users,
		char **	r_error_msg )

Returns: Success.

Definition at line 31 of file wm_platform.cc.

References BLI_windows_execute_self(), BLI_windows_register_blend_extension(), BLI_windows_unregister_blend_extension(), BPY_run_string_as_string_or_none(), CTX_create(), CTX_free(), BPy_RunErrInfo::r_string, result, SNPRINTF, UNUSED_VARS, and BPy_RunErrInfo::use_single_line_error.

Referenced by arg_handle_extension_registration(), and associate_blend().

◆ WM_progress_clear()

void WM_progress_clear ( wmWindow * win )

Definition at line 2673 of file wm_window.cc.

References GHOST_EndProgressBar(), and wmWindow::ghostwin.

Referenced by redraw_timer_exec(), and wm_jobs_update_progress_bars().

◆ WM_progress_set()

void WM_progress_set	(	wmWindow *	win,
		float	progress )

Definition at line 2665 of file wm_window.cc.

References GHOST_SetProgressBar(), and wmWindow::ghostwin.

Referenced by redraw_timer_step(), and wm_jobs_update_progress_bars().

◆ WM_prop_pystring_assign()

std::optional< std::string > WM_prop_pystring_assign	(	bContext *	C,
		PointerRNA *	ptr,
		PropertyRNA *	prop,
		int	index )

Definition at line 713 of file wm_operators.cc.

References C, ptr, ret, rhs, RNA_path_full_property_py(), RNA_property_as_string(), and wm_prop_pystring_from_context().

Referenced by ui_apply_but_autokey().

◆ WM_redraw_windows()

void WM_redraw_windows ( bContext * C )

High level function to redraw windows.

Warning: this should be avoided by operators and low-level IO functionality because drawing relies on the event system & depsgraph preparing data for display. An explicit call to draw is error prone since it may attempt to show stale data.

With some rare exceptions which require a redraw (e.g. screen-shot & sample screen color) explicitly redrawing should be avoided, see: #92704, #93950, #97627 & #98462.

Definition at line 1695 of file wm_draw.cc.

References C, CTX_wm_area(), CTX_wm_area_set(), CTX_wm_region(), CTX_wm_region_set(), CTX_wm_window(), CTX_wm_window_set(), and wm_draw_update().

Referenced by sample_color_exec(), sample_color_invoke(), and screenshot_data_create().

◆ WM_region_use_viewport()

bool WM_region_use_viewport	(	ScrArea *	area,
		ARegion *	region )

Definition at line 582 of file wm_draw.cc.

References ARegion::regiontype, ScrArea::spacetype, and wm_region_use_viewport_by_type().

Referenced by region_draw_azone_tab_arrow(), wm_draw_area_offscreen(), and wm_draw_region_test().

◆ WM_reinit_gizmomap_all()

void WM_reinit_gizmomap_all ( Main * bmain )

Definition at line 1471 of file wm_gizmo_map.cc.

References ED_region_tag_redraw(), ListBase::first, wmGizmoMap::is_init, LISTBASE_FOREACH, Main::screens, and WM_gizmomap_reinit().

Referenced by preferences_reset_default_theme_exec(), WM_gizmoconfig_update(), and wm_userpref_update_when_changed().

◆ WM_report_banner_show()

void WM_report_banner_show	(	wmWindowManager *	wm,
		wmWindow *	win )

Show the report in the info header.

Parameters

win	When NULL, a best-guess is used.

Definition at line 989 of file wm_event_system.cc.

References wmTimer::customdata, ListBase::first, MEM_callocN(), ReportList::reporttimer, wmWindowManager::runtime, TIMERREPORT, wmWindowManager::windows, WM_event_timer_add(), and WM_event_timer_remove().

Referenced by renamebutton_cb(), ui_but_string_set(), ui_textedit_end(), wm_block_file_close_save(), wm_file_read_report(), WM_reports_from_reports_move(), and wm_xr_error_handler().

◆ WM_report_banners_cancel()

void WM_report_banners_cancel ( Main * bmain )

Hide all currently displayed banners and abort their timer.

Definition at line 1010 of file wm_event_system.cc.

References BKE_reports_clear(), ListBase::first, wmWindowManager::runtime, Main::wm, and WM_event_timer_remove().

Referenced by fluid_bake_exec(), fluid_bake_invoke(), and fluid_free_exec().

◆ WM_reports_from_reports_move()

void WM_reports_from_reports_move	(	wmWindowManager *	wm,
		ReportList *	reports )

Move a whole list of reports to the WM ReportList, and show the banner.

Note: In case the given reports is a nullptr, or has its RPT_OP_HOLD flag set, this function does nothing.; The list of reports from given reports is moved into the list of WM's reports, so the given reports will be empty after calling this function. The reports ReportList data itself is not freed or cleared though, and remains fully usable after this call.

\params reports The ReportList from which to move reports to the WM one, may be nullptr. \params wm the WindowManager to add given reports to. If nullptr, the first WM of current G_MAIN will be used.

Definition at line 1024 of file wm_event_system.cc.

References BKE_reports_move_to_reports(), BLI_listbase_is_empty(), ReportList::flag, G_MAIN, ReportList::list, RPT_OP_HOLD, wmWindowManager::runtime, and WM_report_banner_show().

Referenced by handle_load_file(), blender::io::hydra::USDSceneDelegate::populate(), WM_global_report(), wm_handler_fileselect_do(), wm_handler_operator_call(), wm_jobs_reports_update(), and wm_operator_reports().

◆ WM_script_tag_reload()

void WM_script_tag_reload ( )

Needed for cases when operators are re-registered (when operator type pointers are stored).

Definition at line 703 of file wm_init_exit.cc.

References UI_interface_tag_script_reload(), and WM_gizmoconfig_update_tag_reinit_all().

◆ WM_stereo3d_enabled()

bool WM_stereo3d_enabled	(	wmWindow *	win,
		bool	skip_stereo3d_check )

Definition at line 140 of file wm_stereo.cc.

References Stereo3dFormat::display_mode, ED_screen_stereo3d_required(), GHOST_GetWindowState(), GHOST_kWindowStateFullScreen, wmWindow::ghostwin, wmWindow::stereo3d_format, wm_stereo3d_is_fullscreen_required(), WM_window_get_active_scene(), and WM_window_get_active_screen().

Referenced by button_activate_state(), view3d_stereo3d_active(), wm_draw_window(), and wm_stereo3d_mouse_offset_apply().

◆ WM_system_gpu_context_activate()

void WM_system_gpu_context_activate ( void * context )

Definition at line 3263 of file wm_window.cc.

References BLI_assert, GHOST_ActivateGPUContext(), GPU_framebuffer_active_get(), and GPU_framebuffer_back_get().

Referenced by ContextShared::ContextShared(), DRW_gpu_context_activate(), DRW_system_gpu_render_context_enable(), ContextShared::enable(), blender::render::Compositor::execute(), RE_engine_gpu_context_create(), RE_engine_gpu_context_destroy(), RE_engine_gpu_context_enable(), wm_surface_set_drawable(), ContextShared::~ContextShared(), and RenderDisplay::~RenderDisplay().

◆ WM_system_gpu_context_create()

void * WM_system_gpu_context_create ( )

◆ WM_system_gpu_context_dispose()

void WM_system_gpu_context_dispose ( void * context )

Definition at line 3257 of file wm_window.cc.

References BLI_assert, g_system, GHOST_DisposeGPUContext(), GPU_framebuffer_active_get(), and GPU_framebuffer_back_get().

Referenced by RE_engine_gpu_context_destroy(), ContextShared::~ContextShared(), and RenderDisplay::~RenderDisplay().

◆ WM_system_gpu_context_release()

void WM_system_gpu_context_release ( void * context )

Definition at line 3269 of file wm_window.cc.

References BLI_assert, GHOST_ReleaseGPUContext(), GPU_framebuffer_active_get(), and GPU_framebuffer_back_get().

Referenced by ContextShared::disable(), DRW_gpu_context_release(), DRW_system_gpu_render_context_disable(), RenderDisplay::ensure_system_gpu_context(), blender::render::Compositor::execute(), RE_engine_gpu_context_create(), RE_engine_gpu_context_disable(), and wm_surface_clear_drawable().

◆ WM_tooltip_clear()

void WM_tooltip_clear	(	bContext *	C,
		wmWindow *	win )

◆ WM_tooltip_immediate_init()

void WM_tooltip_immediate_init	(	bContext *	C,
		wmWindow *	win,
		ScrArea *	area,
		ARegion *	region,
		wmTooltipInitFn	init )

Definition at line 29 of file wm_tooltip.cc.

References wmTooltipState::area_from, C, init(), wmTooltipState::init, MEM_callocN(), wmTooltipState::region_from, bScreen::tool_tip, WM_tooltip_init(), WM_tooltip_timer_clear(), and WM_window_get_active_screen().

Referenced by button_activate_init().

◆ WM_tooltip_init()

void WM_tooltip_init	(	bContext *	C,
		wmWindow *	win )

◆ WM_tooltip_refresh()

void WM_tooltip_refresh	(	bContext *	C,
		wmWindow *	win )

Definition at line 133 of file wm_tooltip.cc.

References C, wmTooltipState::region, bScreen::tool_tip, UI_tooltip_free(), WM_tooltip_init(), WM_tooltip_timer_clear(), and WM_window_get_active_screen().

Referenced by UI_but_tooltip_refresh().

◆ WM_tooltip_time_closed()

double WM_tooltip_time_closed ( )

Definition at line 24 of file wm_tooltip.cc.

References g_tooltip_time_closed.

Referenced by button_activate_init().

◆ WM_tooltip_timer_clear()

void WM_tooltip_timer_clear	(	bContext *	C,
		wmWindow *	win )

Definition at line 70 of file wm_tooltip.cc.

References C, CTX_wm_manager(), wmTooltipState::timer, bScreen::tool_tip, WM_event_timer_remove(), and WM_window_get_active_screen().

Referenced by button_tooltip_timer_reset(), WM_tooltip_clear(), WM_tooltip_immediate_init(), WM_tooltip_init(), WM_tooltip_refresh(), and WM_tooltip_timer_init_ex().

◆ WM_tooltip_timer_init()

void WM_tooltip_timer_init	(	bContext *	C,
		wmWindow *	win,
		ScrArea *	area,
		ARegion *	region,
		wmTooltipInitFn	init )

Definition at line 64 of file wm_tooltip.cc.

References C, init(), UI_TOOLTIP_DELAY, and WM_tooltip_timer_init_ex().

Referenced by ui_searchbox_event(), and wm_handlers_do_gizmo_handler().

◆ WM_tooltip_timer_init_ex()

void WM_tooltip_timer_init_ex	(	bContext *	C,
		wmWindow *	win,
		ScrArea *	area,
		ARegion *	region,
		wmTooltipInitFn	init,
		double	delay )

Definition at line 44 of file wm_tooltip.cc.

References wmTooltipState::area_from, C, copy_v2_v2_int(), CTX_wm_manager(), wmTooltipState::event_xy, wmWindow::eventstate, init(), wmTooltipState::init, MEM_callocN(), wmTooltipState::region_from, TIMER, wmTooltipState::timer, bScreen::tool_tip, WM_event_timer_add(), WM_tooltip_timer_clear(), WM_window_get_active_screen(), and wmEvent::xy.

Referenced by button_tooltip_timer_reset(), and WM_tooltip_timer_init().

◆ WM_uilisttype_add()

bool WM_uilisttype_add ( uiListType * ult )

Definition at line 62 of file wm_uilist_type.cc.

References get_list_type_map().

Referenced by blender::nodes::draw_data_blocks(), blender::nodes::socket_items::ui::draw_items_list_with_operators(), ED_uilisttypes_ui(), blender::panel_register(), and uiTemplateCollectionExporters().

◆ WM_uilisttype_find()

uiListType * WM_uilisttype_find	(	blender::StringRef	idname,
		bool	quiet )

Definition at line 47 of file wm_uilist_type.cc.

References get_list_type_map(), blender::StringRefBase::is_empty(), and printf.

Referenced by ui_template_list_data_retrieve().

◆ WM_uilisttype_free()

void WM_uilisttype_free ( )

Definition at line 141 of file wm_uilist_type.cc.

References get_list_type_map(), and MEM_freeN().

Referenced by WM_exit_ex().

◆ WM_uilisttype_init()

void WM_uilisttype_init ( )

Called on initialize WM_init()

Definition at line 136 of file wm_uilist_type.cc.

References get_list_type_map().

Referenced by WM_init().

◆ WM_uilisttype_list_id_get()

const char * WM_uilisttype_list_id_get	(	const uiListType *	ult,
		uiList *	list )

Get the "non-full" list-ID, see WM_uilisttype_to_full_list_id() for details.

Note: Assumes uiList.list_id was set using WM_uilisttype_to_full_list_id()!

Definition at line 161 of file wm_uilist_type.cc.

References BLI_assert, uiListType::idname, and uiList::list_id.

◆ WM_uilisttype_remove_ptr()

void WM_uilisttype_remove_ptr	(	Main *	bmain,
		uiListType *	ult )

Definition at line 125 of file wm_uilist_type.cc.

References BLI_assert, get_list_type_map(), MEM_freeN(), UNUSED_VARS_NDEBUG, and wm_uilisttype_unlink().

◆ WM_uilisttype_to_full_list_id()

void WM_uilisttype_to_full_list_id	(	const uiListType *	ult,
		const char *	list_id,
		char	r_full_list_id[] )

The "full" list-ID is an internal name used for storing and identifying a list. It is built like this: {uiListType.idname}_{list_id}, whereby list_id is an optional parameter passed to UILayout.template_list(). If it is not set, the full list-ID is just {uiListType.idname}_.

Note that whenever the Python API refers to the list-ID, it's the short, "non-full" one it passed to UILayout.template_list(). C code can query that through WM_uilisttype_list_id_get().

Definition at line 153 of file wm_uilist_type.cc.

References BLI_snprintf_utf8(), uiListType::idname, and UI_MAX_NAME_STR.

Referenced by ui_list_ensure().

◆ WM_userdef_event_map()

int WM_userdef_event_map ( int kmitype )

Event map that takes preferences into account.

Definition at line 479 of file wm_event_query.cc.

References U, USER_WHEELZOOMDIR, WHEELDOWNMOUSE, WHEELINMOUSE, WHEELOUTMOUSE, and WHEELUPMOUSE.

Referenced by wm_eventmatch(), and WM_keymap_item_compare().

◆ WM_userdef_event_type_from_keymap_type()

int WM_userdef_event_type_from_keymap_type ( int kmitype )

Use so we can check if 'wmEvent.type' is released in modal operators.

An alternative would be to add a 'wmEvent.type_nokeymap'... or similar.

Definition at line 491 of file wm_event_query.cc.

References U, USER_WHEELZOOMDIR, WHEELDOWNMOUSE, WHEELINMOUSE, WHEELOUTMOUSE, and WHEELUPMOUSE.

Referenced by edbm_bevel_invoke(), edbm_inset_invoke(), gizmo_tweak_invoke(), image_view_pan_init(), image_view_zoom_init(), blender::ed::transform::initTransform(), blender::ed::object::object_transform_axis_target_invoke(), op_generic_value_invoke(), poselib_blend_init_data(), radial_control_invoke(), sample_color_invoke(), slide_plane_marker_customdata(), stencil_control_invoke(), view3d_interactive_add_begin(), view_pan_init(), and view_zoom_init().

◆ WM_window_cursor_keymap_status_get()

const char * WM_window_cursor_keymap_status_get	(	const wmWindow *	win,
		int	button_index,
		int	type_index )

Definition at line 6607 of file wm_event_system.cc.

References wmWindow::cursor_keymap_status, and CursorKeymapInfo::text.

Referenced by uiTemplateInputStatus().

◆ WM_window_cursor_keymap_status_refresh()

void WM_window_cursor_keymap_status_refresh	(	bContext *	C,
		wmWindow *	win )

Definition at line 6645 of file wm_event_system.cc.

References bScreen::active_region, ARRAY_SIZE, BKE_area_find_region_type(), BLI_findindex(), C, CTX_wm_area_set(), CTX_wm_manager(), CTX_wm_region_set(), CTX_wm_window_set(), wmWindow::cursor_keymap_status, ED_area_tag_redraw(), ED_screen_areas_iter, ELEM, wmWindow::eventstate, wmEvent::flag, ScrArea::handlers, wmWindow::handlers, wmKeyMapItem::idname, IFACE_, KM_CLICK, KM_PRESS, KM_PRESS_DRAG, LEFTMOUSE, MEM_callocN(), MEM_SAFE_FREE, MIDDLEMOUSE, bToolKey::mode, name, OPTYPE_INTERNAL, ot, wmKeyMapItem::ptr, ARegion::regiontype, RGN_TYPE_ASSET_SHELF_HEADER, RGN_TYPE_FOOTER, RGN_TYPE_HEADER, RGN_TYPE_HUD, RGN_TYPE_TEMPORARY, RGN_TYPE_TOOL_HEADER, RGN_TYPE_TOOL_PROPS, RGN_TYPE_TOOLS, RGN_TYPE_WINDOW, RIGHTMOUSE, ARegion::runtime, SPACE_STATUSBAR, SPACE_TOPBAR, bToolKey::space_type, ScrArea::spacetype, CursorKeymapInfo::state, CursorKeymapInfo::state_event, STR_ELEM, STRNCPY(), CursorKeymapInfo::text, wmEvent::type, wmKeyMapItem::type, UNLIKELY, wmEvent::val, wmKeyMapItem::val, wm_event_cursor_store(), WM_event_match_keymap_item_from_handlers(), wm_eventemulation(), WM_operatortype_find(), WM_operatortype_name(), WM_toolsystem_mode_from_spacetype(), WM_toolsystem_ref_find(), WM_TOOLSYSTEM_SPACE_MASK, WM_window_get_active_scene(), WM_window_get_active_screen(), WM_window_get_active_view_layer(), WM_window_get_active_workspace(), and WM_window_status_area_find().

Referenced by wm_event_do_notifiers().

◆ WM_window_decoration_style_apply()

void WM_window_decoration_style_apply	(	const wmWindow *	win,
		const bScreen *	screen = nullptr )

Apply the window decoration style using the current style flags and by parsing style settings from the current Blender theme. The screen parameter is optional, and can be passed for enhanced theme parsing.

Note: Avoid calling this function directly, prefer sending an NC_WINDOW notification when WM_CAPABILITY_WINDOW_DECORATION_STYLES is supported instead.

Definition at line 776 of file wm_window.cc.

References BLI_assert, GHOST_ApplyWindowDecorationStyle(), wmWindow::ghostwin, WM_capabilities_flag(), WM_CAPABILITY_WINDOW_DECORATION_STYLES, and wm_window_decoration_style_set_from_theme().

Referenced by ED_screen_do_listen(), and wm_window_ghostwindow_ensure().

◆ WM_window_decoration_style_flags_get()

eWM_WindowDecorationStyleFlag WM_window_decoration_style_flags_get ( const wmWindow * win )

Get the window decoration style flags.

Definition at line 718 of file wm_window.cc.

References GHOST_GetWindowDecorationStyleFlags(), GHOST_kDecorationColoredTitleBar, wmWindow::ghostwin, WM_WINDOW_DECORATION_STYLE_COLORED_TITLEBAR, and WM_WINDOW_DECORATION_STYLE_NONE.

◆ WM_window_decoration_style_flags_set()

void WM_window_decoration_style_flags_set	(	const wmWindow *	win,
		eWM_WindowDecorationStyleFlag	style_flags )

Set window decoration style flags. Use before calling WM_window_decoration_style_apply.

Definition at line 732 of file wm_window.cc.

References BLI_assert, GHOST_kDecorationColoredTitleBar, GHOST_kDecorationNone, GHOST_SetWindowDecorationStyleFlags(), wmWindow::ghostwin, WM_capabilities_flag(), WM_CAPABILITY_WINDOW_DECORATION_STYLES, and WM_WINDOW_DECORATION_STYLE_COLORED_TITLEBAR.

Referenced by wm_window_ghostwindow_ensure().

◆ WM_window_dpi_get_scale()

float WM_window_dpi_get_scale ( const wmWindow * win )

Return the windows DPI as a scale, bypassing UI scale preference.

Note: Use for calculating cursor size which doesn't use the UI scale.

Definition at line 700 of file wm_window.cc.

References float, GHOST_GetDPIHint(), GHOST_GetNativePixelSize(), wmWindow::ghostwin, and OS_MAC.

Referenced by wm_cursor_size(), and wm_software_cursor_draw().

◆ WM_window_dpi_set_userdef()

void WM_window_dpi_set_userdef ( const wmWindow * win )

Definition at line 654 of file wm_window.cc.

References CLAMP, GHOST_GetDPIHint(), GHOST_GetNativePixelSize(), wmWindow::ghostwin, max_ff(), max_ii(), roundf, U, VIRTUAL_PIXEL_DOUBLE, and VIRTUAL_PIXEL_NATIVE.

Referenced by ED_fileselect_window_params_get(), ghost_event_proc(), render_view_open(), screen_refresh_if_needed(), wm_window_close(), wm_window_ghostwindow_add(), wm_window_ghostwindow_ensure(), wm_window_make_drawable(), and WM_window_open_temp().

◆ WM_window_ensure_active_view_layer()

void WM_window_ensure_active_view_layer ( wmWindow * win )

Definition at line 3112 of file wm_window.cc.

References BKE_view_layer_default_view(), BKE_view_layer_find(), ViewLayer::name, STRNCPY_UTF8, wmWindow::view_layer_name, and WM_window_get_active_scene().

Referenced by ED_screen_scene_change().

◆ WM_window_find_by_area()

wmWindow * WM_window_find_by_area	(	wmWindowManager *	wm,
		const ScrArea *	area )

Knowing the area, return its screen.

Note: This should typically be avoided, only use when the context is not available.

Definition at line 2777 of file wm_window.cc.

References bScreen::areabase, BLI_findindex(), LISTBASE_FOREACH, wmWindowManager::windows, and WM_window_get_active_screen().

Referenced by area_join_init(), area_join_update_data(), graph_init(), and nla_init().

◆ WM_window_find_under_cursor()

wmWindow * WM_window_find_under_cursor	(	wmWindow *	win,
		const int	event_xy[2],
		int	r_event_xy_other[2] )

Definition at line 2745 of file wm_window.cc.

References BLI_rcti_isect_pt_v(), copy_v2_v2_int(), g_system, GHOST_GetWindowUnderCursor(), GHOST_GetWindowUserData(), WM_capabilities_flag(), WM_CAPABILITY_WINDOW_POSITION, wm_cursor_position_from_ghost_screen_coords(), wm_cursor_position_to_ghost_screen_coords(), and WM_window_rect_calc().

Referenced by ED_area_find_under_cursor(), eyedropper_color_sample_fl(), eyedropper_cryptomatte_sample_fl(), eyedropper_win_area_find(), view_edge_pan_modal(), wm_drags_exit(), and wm_event_cursor_other_windows().

◆ WM_window_get_active_layout()

WorkSpaceLayout * WM_window_get_active_layout ( const wmWindow * win )

Definition at line 3147 of file wm_window.cc.

References BKE_workspace_active_layout_get(), LIKELY, WM_window_get_active_workspace(), and wmWindow::workspace_hook.

Referenced by ED_screen_state_toggle(), wm_event_do_notifiers(), wm_file_read_setup_wm_keep_old(), wm_window_copy(), and workspace_change_get_new_layout().

◆ WM_window_get_active_scene()

Scene * WM_window_get_active_scene ( const wmWindow * win )

Definition at line 3040 of file wm_window.cc.

References wmWindow::scene.

Referenced by buttons_context_path(), buttons_shading_context(), buttons_shading_new_context(), do_versions_after_linking_500(), ED_area_init(), ED_area_newspace(), ED_area_offscreen_create(), ED_editors_init_for_undo(), ED_scene_add(), ED_screen_exit(), ED_screen_scene_find_with_window(), ED_view3d_gizmo_ruler_remove_by_gpencil_layer(), find_area_showing_render_result(), graph_init(), image_listener(), nla_init(), blender::ed::object::object_delete_exec(), RE_FreeUnusedGPUResources(), screen_change_update(), screen_ctx_active_annotation_layer(), screen_ctx_active_bone(), screen_ctx_active_object(), screen_ctx_active_pose_bone(), screen_ctx_annotation_data(), screen_ctx_annotation_data_owner(), screen_ctx_edit_object(), screen_ctx_editable_objects(), screen_ctx_grease_pencil_data(), screen_ctx_image_paint_object(), screen_ctx_object(), screen_ctx_objects_in_mode(), screen_ctx_objects_in_mode_unique_data(), screen_ctx_particle_edit_object(), screen_ctx_pose_object(), screen_ctx_scene(), screen_ctx_sculpt_object(), screen_ctx_selectable_objects(), screen_ctx_selected_bones_(), screen_ctx_selected_editable_objects(), screen_ctx_selected_objects(), screen_ctx_selected_pose_bones(), screen_ctx_selected_pose_bones_from_active_object(), screen_ctx_vertex_paint_object(), screen_ctx_visible_objects(), screen_ctx_visible_or_editable_bones_(), screen_ctx_visible_pose_bones(), screen_ctx_weight_paint_object(), screen_global_area_refresh(), sound_jack_sync_callback(), blender::ed::vse::sync_active_scene_and_time_with_scene_strip(), toolsystem_brush_activate_from_toolref_for_object_paint(), toolsystem_brush_activate_from_toolref_for_object_particle(), toolsystem_brush_clear_paint_reference(), toolsystem_refresh_screen_from_active_tool(), blender::ed::outliner::tree_element_viewlayer_activate(), view3d_main_region_cursor(), wm_draw_area_offscreen(), wm_draw_region_test(), wm_draw_update_test_window(), wm_draw_window(), wm_draw_window_offscreen(), wm_event_do_depsgraph(), wm_event_do_handlers(), wm_event_do_notifiers(), WM_event_handler_region_marker_poll(), WM_event_handler_region_v2d_mask_no_marker_poll(), WM_stereo3d_enabled(), WM_toolsystem_do_msg_notify_tag_refresh(), WM_toolsystem_ref_sync_from_context(), WM_toolsystem_refresh_active(), WM_toolsystem_refresh_screen_window(), WM_toolsystem_reinit_all(), WM_window_cursor_keymap_status_refresh(), WM_window_ensure_active_view_layer(), WM_window_get_active_view_layer(), WM_window_open(), WM_window_pixels_read_from_offscreen(), WM_window_set_active_view_layer(), WM_windows_scene_data_sync(), WM_windows_scene_get_from_screen(), wm_xr_session_scene_and_depsgraph_get(), workspace_exit(), and workspace_scene_pinning_update().

◆ WM_window_get_active_screen()

bScreen * WM_window_get_active_screen ( const wmWindow * win )

Get the active screen of the active workspace in win.

Definition at line 3158 of file wm_window.cc.

References BKE_workspace_active_screen_get(), LIKELY, WM_window_get_active_workspace(), and wmWindow::workspace_hook.

Referenced by actionzone_area_poll(), area_docking_apply(), area_join_dock_cb_window(), area_join_modal(), bpy_rna_context_temp_override_enter(), bpy_rna_context_temp_override_enter_ok_or_error(), bpy_rna_context_temp_override_exit(), bpy_rna_context_temp_set_screen_for_window(), button_activate_init(), button_tooltip_timer_reset(), context_find_graph_editor(), ED_area_find_under_cursor(), ED_area_swapspace(), ED_area_type_hud_clear(), ED_area_update_region_sizes(), ED_areas_do_frame_follow(), ED_clip_update_frame(), ED_editors_init(), ED_fileselect_handler_area_find(), ED_fileselect_handler_area_find_any_with_op(), ED_info_stats_clear(), ED_region_do_draw(), ED_render_scene_update(), ED_render_view3d_update(), ED_screen_animation_no_scrub(), ED_screen_animation_playing(), ED_screen_draw_edges(), ED_screen_refresh(), ED_screen_scene_change(), ED_screen_scene_find_with_window(), ED_screen_set_active_region(), ED_screen_state_toggle(), ED_screen_window_find(), ED_space_image_paint_update(), ED_space_image_sync(), ED_view3d_gizmo_ruler_remove_by_gpencil_layer(), blender::ed::animrig::ensure_asset_ui_visible(), eyedropper_color_sample_fl(), eyedropper_cryptomatte_sample_fl(), eyedropper_win_area_find(), find_area_showing_render_result(), blender::ed::sculpt_paint::flush_update_done(), blender::ed::asset::list::foreach_visible_asset_browser_showing_library(), get_compositor_needed_outputs(), ghost_event_proc(), gizmo_mesh_spin_redo_setup(), blender::bke::compositor::is_viewport_compositor_used(), menu_items_from_ui_create(), RE_FreeUnusedGPUResources(), redraw_timer_step(), region_cursor_set(), region_cursor_set_ex(), render_image_restore_scene_and_layer(), render_image_update_pass_and_layer(), render_view_show_invoke(), screen_animation_step_invoke(), screen_cursor_set(), screen_geom_select_connected_edge(), screen_refresh_if_needed(), screen_state_to_nonnormal(), blender::ed::asset::shelf::show_catalog_in_visible_shelves(), blender::ed::vse::sync_active_scene_and_time_with_scene_strip(), toolsystem_refresh_screen_from_active_tool(), UI_but_tooltip_refresh(), UI_popup_block_close(), ui_popup_block_remove(), window_has_sequence_editor_open(), wm_drags_exit(), wm_draw_region_clear(), wm_draw_update_clear_window(), wm_draw_update_test_window(), wm_draw_window(), wm_draw_window_offscreen(), wm_draw_window_onscreen(), wm_dropbox_active(), wm_dropbox_invoke(), wm_event_do_depsgraph(), wm_event_do_handlers(), wm_event_do_notifiers(), wm_event_do_refresh_wm_and_depsgraph(), wm_event_drag_and_drop_test(), WM_exit_ex(), wm_file_read_setup_wm_init(), wm_file_read_setup_wm_keep_old(), wm_gesture_tag_redraw(), wm_handler_fileselect_do(), wm_handler_op_context_get_if_valid(), WM_keyconfig_update_ex(), WM_operator_handlers_clear(), wm_operator_winactive_normal(), wm_operator_winactive_not_full(), WM_paint_cursor_tag_redraw(), wm_paintcursor_draw(), wm_region_tag_draw_on_gizmo_delay_refresh_for_tweak(), WM_stereo3d_enabled(), wm_stereo3d_set_exec(), WM_toolsystem_do_msg_notify_tag_refresh(), WM_toolsystem_refresh_active(), WM_toolsystem_refresh_screen_window(), WM_toolsystem_reinit_all(), WM_tooltip_clear(), WM_tooltip_immediate_init(), WM_tooltip_init(), WM_tooltip_refresh(), WM_tooltip_timer_clear(), WM_tooltip_timer_init_ex(), wm_window_close(), WM_window_cursor_keymap_status_refresh(), WM_window_find_by_area(), WM_window_is_temp_screen(), WM_window_open(), WM_window_set_active_workspace(), WM_window_status_area_tag_redraw(), WM_window_title(), WM_windows_scene_get_from_screen(), WM_windows_view_layer_get_from_screen(), and WM_windows_workspace_get_from_screen().

◆ WM_window_get_active_view_layer()

ViewLayer * WM_window_get_active_view_layer ( const wmWindow * win )

Definition at line 3074 of file wm_window.cc.

References BKE_view_layer_default_view(), BKE_view_layer_find(), wmWindow::view_layer_name, WM_window_get_active_scene(), and WM_window_set_active_view_layer().

Referenced by buttons_context_path(), buttons_context_path_brush(), buttons_context_path_view_layer(), buttons_shading_context(), buttons_shading_new_context(), buttons_texture_users_from_context(), clean_viewport_memory(), ED_area_init(), ED_editors_init_for_undo(), ED_info_stats_clear(), ED_screen_scene_change(), ED_undo_object_editmode_validate_scene_from_windows(), image_listener(), screen_ctx_active_bone(), screen_ctx_active_object(), screen_ctx_active_pose_bone(), screen_ctx_edit_object(), screen_ctx_editable_objects(), screen_ctx_grease_pencil_data(), screen_ctx_image_paint_object(), screen_ctx_object(), screen_ctx_objects_in_mode(), screen_ctx_objects_in_mode_unique_data(), screen_ctx_particle_edit_object(), screen_ctx_pose_object(), screen_ctx_sculpt_object(), screen_ctx_selectable_objects(), screen_ctx_selected_bones_(), screen_ctx_selected_editable_objects(), screen_ctx_selected_objects(), screen_ctx_selected_pose_bones(), screen_ctx_selected_pose_bones_from_active_object(), screen_ctx_vertex_paint_object(), screen_ctx_visible_objects(), screen_ctx_visible_or_editable_bones_(), screen_ctx_visible_pose_bones(), screen_ctx_weight_paint_object(), sound_jack_sync_callback(), blender::ed::vse::sync_active_scene_and_time_with_scene_strip(), toolsystem_refresh_screen_from_active_tool(), blender::ed::outliner::tree_element_object_activate(), view3d_main_region_cursor(), view3d_main_region_listener(), view_layer_add_exec(), wm_draw_update_test_window(), wm_event_do_depsgraph(), WM_event_handler_region_marker_poll(), WM_event_handler_region_v2d_mask_no_marker_poll(), WM_toolsystem_do_msg_notify_tag_refresh(), WM_toolsystem_ref_sync_from_context(), WM_toolsystem_refresh_active(), WM_toolsystem_refresh_screen_window(), WM_toolsystem_reinit_all(), WM_window_cursor_keymap_status_refresh(), WM_window_set_active_scene(), WM_windows_view_layer_get_from_screen(), and wm_xr_session_scene_and_depsgraph_get().

◆ WM_window_get_active_workspace()

WorkSpace * WM_window_get_active_workspace ( const wmWindow * win )

Definition at line 3123 of file wm_window.cc.

References BKE_workspace_active_get(), and wmWindow::workspace_hook.

Referenced by buttons_context_path(), do_versions_after_linking_500(), ED_area_init(), ED_screen_state_toggle(), ED_workspace_change(), ED_workspace_delete(), screen_state_to_nonnormal(), blender::ed::vse::sequencer_main_cursor(), space_workspace_cycle_invoke(), template_id_workspace_pin_extra_icon(), toolsystem_brush_activate_from_toolref_for_object_paint(), toolsystem_brush_activate_from_toolref_for_object_particle(), toolsystem_brush_clear_paint_reference(), toolsystem_refresh_screen_from_active_tool(), wm_event_do_handlers(), wm_event_do_notifiers(), WM_event_handler_region_marker_poll(), WM_toolsystem_do_msg_notify_tag_refresh(), WM_toolsystem_ref_sync_from_context(), WM_toolsystem_refresh_active(), WM_toolsystem_refresh_screen_window(), WM_toolsystem_reinit_all(), WM_toolsystem_update_from_context_view3d(), wm_window_close(), wm_window_copy(), WM_window_cursor_keymap_status_refresh(), WM_window_get_active_layout(), WM_window_get_active_screen(), WM_window_open(), and WM_windows_workspace_get_from_screen().

◆ WM_window_is_fullscreen()

bool WM_window_is_fullscreen ( const wmWindow * win )

Definition at line 2964 of file wm_window.cc.

References GHOST_kWindowStateFullScreen, and wmWindow::windowstate.

Referenced by area_azone_init(), and wm_stereo3d_set_exec().

◆ WM_window_is_main_top_level()

bool WM_window_is_main_top_level ( const wmWindow * win )

Return whether the window is a main/top-level window. In which case it is expected to contain global areas (top-bar/status-bar).

Definition at line 2974 of file wm_window.cc.

References BKE_workspace_active_screen_get(), wmWindow::parent, bScreen::temp, and wmWindow::workspace_hook.

Referenced by ED_screen_global_areas_refresh(), wm_window_close(), and wm_window_decoration_style_set_from_theme().

◆ WM_window_is_maximized()

bool WM_window_is_maximized ( const wmWindow * win )

Definition at line 2969 of file wm_window.cc.

References GHOST_kWindowStateMaximized, and wmWindow::windowstate.

Referenced by ED_fileselect_window_params_get(), and wm_window_close().

◆ WM_window_is_temp_screen()

bool WM_window_is_temp_screen ( const wmWindow * win )

Definition at line 3170 of file wm_window.cc.

References bScreen::temp, and WM_window_get_active_screen().

Referenced by ED_screen_exit(), render_view_cancel_exec(), render_view_show_invoke(), screen_maximize_area_poll(), space_workspace_cycle_invoke(), wm_handler_fileselect_do(), wm_homefile_write_exec(), wm_window_close(), and WM_window_title().

◆ WM_window_modal_keymap_status_draw()

bool WM_window_modal_keymap_status_draw	(	bContext *	C,
		wmWindow *	win,
		uiLayout *	layout )

◆ WM_window_native_pixel_coords()

void WM_window_native_pixel_coords	(	const wmWindow *	win,
		int *	x,
		int *	y )

Definition at line 2918 of file wm_window.cc.

References GHOST_GetNativePixelSize(), wmWindow::ghostwin, x, and y.

Referenced by area_docking_target().

◆ WM_window_native_pixel_size()

blender::int2 WM_window_native_pixel_size ( const wmWindow * win )

Definition at line 2911 of file wm_window.cc.

References GHOST_GetNativePixelSize(), wmWindow::ghostwin, wmWindow::sizex, and wmWindow::sizey.

Referenced by blender::ed::asset::clamp_point_to_window(), ED_fileselect_window_params_get(), screen_global_statusbar_area_refresh(), screen_global_topbar_area_refresh(), blender::ed::asset::screenshot_preview_draw(), blender::ed::asset::screenshot_preview_modal(), blender::ed::asset::square_points_clamp_to_window(), ui_block_bounds_calc_centered(), ui_block_bounds_calc_popup(), ui_popup_block_clip(), ui_popup_block_position(), ui_popup_block_refresh(), ui_tooltip_create_with_data(), ui_update_window_matrix(), wm_draw_window(), wm_drop_update_active(), wm_event_cursor_other_windows(), wm_gesture_draw_cross(), wm_stereo3d_draw_sidebyside(), wm_stereo3d_draw_topbottom(), WM_window_pixels_read_from_frontbuffer(), WM_window_pixels_read_from_offscreen(), WM_window_pixels_read_sample_from_offscreen(), WM_window_rect_calc(), and wmWindowViewport_ex().

◆ WM_window_native_pixel_x()

int WM_window_native_pixel_x ( const wmWindow * win )

Support for native pixel size

Note: macOS retina opens window in size X, but it has up to 2 x more pixels.

Definition at line 2898 of file wm_window.cc.

References GHOST_GetNativePixelSize(), wmWindow::ghostwin, and wmWindow::sizex.

Referenced by area_azone_init(), blender::ed::asset::shelf::layout_width_units_clamped(), screen_draw_area_drag_tip(), ui_def_but_rna__menu(), ui_searchbox_region_layout_fn(), wm_block_splash_create(), and wm_stereo3d_mouse_offset_apply().

◆ WM_window_native_pixel_y()

int WM_window_native_pixel_y ( const wmWindow * win )

Definition at line 2904 of file wm_window.cc.

References GHOST_GetNativePixelSize(), wmWindow::ghostwin, and wmWindow::sizey.

Referenced by ui_def_but_rna__menu(), wm_drag_draw_tooltip(), wm_software_cursor_draw(), and wm_stereo3d_mouse_offset_apply().

◆ WM_window_open()

wmWindow * WM_window_open	(	bContext *	C,
		const char *	title,
		const rcti *	rect_unscaled,
		int	space_type,
		bool	toplevel,
		bool	dialog,
		bool	temp,
		eWindowAlignment	alignment,
		void(*	area_setup_fn )(bScreen screen, ScrArea area, void *user_data),
		void *	area_setup_user_data )

Parameters

rect	Position & size of the window.
space_type	SPACE_VIEW3D, SPACE_INFO, ... (eSpace_Type).
toplevel	Not a child owned by other windows. A peer of main window.
dialog	whether this should be made as a dialog-style window
temp	whether this is considered a short-lived window
alignment	how this window is positioned relative to its parent
area_setup_fn	An optional callback which can be used to initialize the area before it's initialized. When set, space_type should be #SPACE_EMTPY, so the setup function can take a blank area and initialize it.
area_setup_user_data	User data argument passed to area_setup_fn.

Returns: the window or NULL in case of failure.

References C.

◆ WM_window_open_temp()

wmWindow wmWindow * WM_window_open_temp	(	bContext *	C,
		const char *	title,
		int	space_type,
		bool	dialog )

◆ WM_window_pixels_read()

uint8_t * WM_window_pixels_read	(	bContext *	C,
		wmWindow *	win,
		int	r_size[2] )

Read from the screen.

Note: Use off-screen drawing when front-buffer reading is not supported.

Definition at line 1484 of file wm_draw.cc.

References C, CTX_wm_manager(), WM_capabilities_flag(), WM_CAPABILITY_GPU_FRONT_BUFFER_READ, WM_window_pixels_read_from_frontbuffer(), and WM_window_pixels_read_from_offscreen().

Referenced by screenshot_data_create(), and blender::ed::asset::take_screenshot_crop().

◆ WM_window_pixels_read_from_frontbuffer()

uint8_t * WM_window_pixels_read_from_frontbuffer	(	const wmWindowManager *	wm,
		const wmWindow *	win,
		int	r_size[2] )

Read pixels from the front-buffer (fast).

Note: Internally this depends on the front-buffer state, for a slower but more reliable method of reading pixels, use WM_window_pixels_read_from_offscreen. Fast pixel access may be preferred for file-save thumbnails.

Warning: Drawing (swap-buffers) immediately before calling this function causes the front-buffer state to be invalid under some EGL configurations.

Definition at line 1325 of file wm_draw.cc.

References GHOST_ActivateWindowDrawingContext(), wmWindow::ghostwin, GPU_context_active_set(), GPU_DATA_UBYTE, GPU_frontbuffer_read_color(), wmWindow::gpuctx, i, MEM_malloc_arrayN(), wmWindowManager::runtime, and WM_window_native_pixel_size().

Referenced by blend_file_thumb_from_screenshot(), and WM_window_pixels_read().

◆ WM_window_pixels_read_from_offscreen()

uint8_t * WM_window_pixels_read_from_offscreen	(	bContext *	C,
		wmWindow *	win,
		int	r_size[2] )

Draw the window & read pixels from an off-screen buffer (slower than WM_window_pixels_read_from_frontbuffer).

Note: This is needed because the state of the front-buffer may be damaged (see in-line code comments for details).

Definition at line 1403 of file wm_draw.cc.

References C, get_hdr_framebuffer_format(), GPU_DATA_UBYTE, GPU_offscreen_bind(), GPU_offscreen_create(), GPU_offscreen_free(), GPU_offscreen_read_color(), GPU_offscreen_unbind(), GPU_TEXTURE_USAGE_SHADER_READ, MEM_malloc_arrayN(), UNLIKELY, wm_draw_window_onscreen(), WM_window_get_active_scene(), and WM_window_native_pixel_size().

Referenced by WM_window_pixels_read().

◆ WM_window_pixels_read_sample()

bool WM_window_pixels_read_sample	(	bContext *	C,
		wmWindow *	win,
		const int	pos[2],
		float	r_col[3] )

Read a single pixel from the screen.

Note: Use off-screen drawing when front-buffer reading is not supported.

Definition at line 1492 of file wm_draw.cc.

References C, CTX_wm_manager(), pos, WM_capabilities_flag(), WM_CAPABILITY_GPU_FRONT_BUFFER_READ, WM_window_pixels_read_sample_from_frontbuffer(), and WM_window_pixels_read_sample_from_offscreen().

Referenced by eyedropper_color_sample_fl(), and paint_sample_color().

◆ WM_window_pixels_read_sample_from_frontbuffer()

void WM_window_pixels_read_sample_from_frontbuffer	(	const wmWindowManager *	wm,
		const wmWindow *	win,
		const int	pos[2],
		float	r_col[3] )

A version of WM_window_pixels_read_from_frontbuffer that samples a pixel at pos.

Definition at line 1371 of file wm_draw.cc.

References BLI_assert, copy_v3_v3(), GHOST_ActivateWindowDrawingContext(), wmWindow::ghostwin, GPU_context_active_set(), GPU_DATA_FLOAT, GPU_frontbuffer_read_color(), wmWindow::gpuctx, pos, wmWindowManager::runtime, WM_capabilities_flag(), WM_CAPABILITY_GPU_FRONT_BUFFER_READ, and blender::VecBase< T, Size >::xyz().

Referenced by WM_window_pixels_read_sample().

◆ WM_window_pixels_read_sample_from_offscreen()

bool WM_window_pixels_read_sample_from_offscreen	(	bContext *	C,
		wmWindow *	win,
		const int	pos[2],
		float	r_col[3] )

A version of WM_window_pixels_read_from_offscreen that samples a pixel at pos.

Definition at line 1448 of file wm_draw.cc.

References BLI_assert, C, copy_v3_v3(), GPU_DATA_FLOAT, GPU_offscreen_bind(), GPU_offscreen_create(), GPU_offscreen_free(), GPU_offscreen_read_color_region(), GPU_offscreen_unbind(), GPU_TEXTURE_USAGE_SHADER_READ, pos, UNLIKELY, wm_draw_window_onscreen(), WM_window_native_pixel_size(), and zero_v3().

Referenced by eyedropper_color_sample_fl(), and WM_window_pixels_read_sample().

◆ WM_window_rect_calc()

void WM_window_rect_calc	(	const wmWindow *	win,
		rcti *	r_rect )

Get boundaries usable by all window contents, including global areas.

Definition at line 2926 of file wm_window.cc.

References BLI_rcti_init(), and WM_window_native_pixel_size().

Referenced by area_join_update_data(), area_move_set_limits(), area_split(), area_split_invoke(), screen_area_edge_from_cursor(), screen_geom_find_active_scredge(), screen_geom_vertices_scale(), WM_window_find_under_cursor(), and WM_window_screen_rect_calc().

◆ WM_window_screen_rect_calc()

void WM_window_screen_rect_calc	(	const wmWindow *	win,
		rcti *	r_rect )

Get boundaries usable by screen-layouts, excluding global areas.

Note: Depends on UI_SCALE_FAC. Should that be outdated, call WM_window_dpi_set_userdef first.

Definition at line 2931 of file wm_window.cc.

References ScrAreaMap::areabase, BLI_assert, BLI_assert_unreachable, BLI_rcti_is_valid(), ED_area_global_size_y(), GLOBAL_AREA_ALIGN_BOTTOM, GLOBAL_AREA_ALIGN_TOP, GLOBAL_AREA_IS_HIDDEN, wmWindow::global_areas, LISTBASE_FOREACH, WM_window_rect_calc(), rcti::ymax, and rcti::ymin.

Referenced by actionzone_modal(), ED_area_init(), ED_area_update_region_sizes(), ED_workspace_layout_add(), screen_draw_move_highlight(), screen_geom_find_active_scredge(), screen_geom_vertices_scale(), and uiTemplateInputStatusBorder().

◆ WM_window_set_active_layout()

void WM_window_set_active_layout	(	wmWindow *	win,
		WorkSpace *	workspace,
		WorkSpaceLayout *	layout )

Definition at line 3153 of file wm_window.cc.

References BKE_workspace_active_layout_set(), wmWindow::winid, and wmWindow::workspace_hook.

Referenced by wm_file_read_setup_wm_keep_old(), and WM_window_open().

◆ WM_window_set_active_scene()

void WM_window_set_active_scene	(	Main *	bmain,
		bContext *	C,
		wmWindow *	win,
		Scene *	scene )

◆ WM_window_set_active_screen()

void WM_window_set_active_screen	(	wmWindow *	win,
		WorkSpace *	workspace,
		bScreen *	screen )

Definition at line 3165 of file wm_window.cc.

References BKE_workspace_active_screen_set(), wmWindow::winid, and wmWindow::workspace_hook.

Referenced by bpy_rna_context_temp_set_screen_for_window(), ED_screen_change(), and wm_file_read_setup_wm_keep_old().

◆ WM_window_set_active_view_layer()

void WM_window_set_active_view_layer	(	wmWindow *	win,
		ViewLayer *	view_layer )

Definition at line 3094 of file wm_window.cc.

References BKE_view_layer_find(), BKE_workspace_active_screen_get(), BLI_assert, ED_render_view_layer_changed(), ListBase::first, G_MAIN, LISTBASE_FOREACH, ViewLayer::name, wmWindow::parent, STRNCPY_UTF8, wmWindowManager::windows, Main::wm, and WM_window_get_active_scene().

Referenced by blender::ed::outliner::tree_element_viewlayer_activate(), view_layer_add_exec(), and WM_window_get_active_view_layer().

◆ WM_window_set_active_workspace()

void WM_window_set_active_workspace	(	bContext *	C,
		wmWindow *	win,
		WorkSpace *	workspace )

Definition at line 3128 of file wm_window.cc.

References C, CTX_wm_manager(), ED_workspace_change(), LISTBASE_FOREACH, wmWindow::parent, bScreen::temp, wmWindowManager::windows, and WM_window_get_active_screen().

Referenced by bpy_rna_context_temp_set_screen_for_window(), and wm_event_do_notifiers().

◆ WM_window_status_area_find()

ScrArea * WM_window_status_area_find	(	wmWindow *	win,
		bScreen *	screen )

Similar to BKE_screen_area_map_find_area_xy and related functions, use here since the area is stored in the window manager.

Definition at line 6621 of file wm_event_system.cc.

References ScrAreaMap::areabase, wmWindow::global_areas, LISTBASE_FOREACH, SCREENFULL, SPACE_STATUSBAR, ScrArea::spacetype, and bScreen::state.

Referenced by WM_window_cursor_keymap_status_refresh(), WM_window_status_area_tag_redraw(), and WorkspaceStatus::WorkspaceStatus().

◆ WM_window_status_area_tag_redraw()

void WM_window_status_area_tag_redraw ( wmWindow * win )

Definition at line 6636 of file wm_event_system.cc.

References ED_area_tag_redraw(), WM_window_get_active_screen(), and WM_window_status_area_find().

Referenced by ED_screen_set_active_region(), blender::ed::transform::transformEvent(), WM_event_add_modal_handler_ex(), and wm_handler_operator_call().

◆ WM_window_support_hdr_color()

bool WM_window_support_hdr_color ( const wmWindow * win )

Definition at line 2987 of file wm_window.cc.

References GHOST_WindowGetHDRInfo(), wmWindow::ghostwin, GPU_hdr_support(), and GHOST_WindowHDRInfo::hdr_enabled.

◆ WM_window_title()

void WM_window_title	(	wmWindowManager *	wm,
		wmWindow *	win,
		const char *	title = nullptr )

Give a title to a window. With "Title" unspecified or nullptr, it is generated automatically from window settings and areas. Only use custom title when really needed.

Definition at line 541 of file wm_window.cc.

References bScreen::areabase, BKE_blender_version_string(), BKE_main_blendfile_path_from_global(), BLI_dir_home(), BLI_listbase_is_single(), BLI_path_basename(), BLI_path_extension_or_end(), BLI_path_ncmp, BLI_str_utf8_invalid_substitute_if_needed(), ED_area_name(), FILE_MAX, wmWindowManager::file_saved, ListBase::first, G_MAIN, GHOST_kSuccess, GHOST_SetPath(), GHOST_SetTitle(), GHOST_SetWindowModifiedState(), wmWindow::ghostwin, IFACE_, name, OS_MAC, OS_WINDOWS, wmWindow::parent, SEP, SPACE_EMPTY, ScrArea::spacetype, WM_window_get_active_screen(), and WM_window_is_temp_screen().

Referenced by area_join_apply(), area_join_modal(), area_split_apply(), ED_area_newspace(), wm_event_do_notifiers(), wm_window_ghostwindow_ensure(), and WM_window_open().

◆ WM_windows_scene_data_sync()

void WM_windows_scene_data_sync	(	const ListBase *	win_lb,
		Scene *	scene )

Some editor data may need to be synced with scene data (3D View camera and layers). This function ensures data is synced for editors in visible work-spaces and their visible layouts.

Definition at line 2999 of file wm_window.cc.

References ED_workspace_scene_data_sync(), LISTBASE_FOREACH, and WM_window_get_active_scene().

Referenced by blender::ed::outliner::tree_element_camera_activate().