Blender V5.3
WM_api.hh File Reference
#include <functional>
#include <optional>
#include <string>
#include "DNA_windowmanager_types.h"
#include "BLI_array.hh"
#include "BLI_bounds_types.hh"
#include "BLI_compiler_attrs.hh"
#include "BLI_enum_flags.hh"
#include "BLI_function_ref.hh"
#include "BLI_index_range.hh"
#include "BLI_math_vector_types.hh"
#include "BLI_set.hh"
#include "BLI_sys_types.hh"
#include "WM_keymap.hh"
#include "WM_types.hh"

Go to the source code of this file.

Classes

struct  blender::wmEventHandler_KeymapResult
struct  blender::CheckerIntervalParams

Namespaces

namespace  blender
 BMesh Iterators.
namespace  blender::bke
namespace  blender::bke::id
namespace  blender::asset_system
namespace  blender::ui

Macros

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

Typedefs

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

Enumerations

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

Functions

void blender::WM_init_state_start_with_console_set (bool value)
void blender::WM_init (bContext *C, int argc, const char **argv)
void blender::WM_exit_ex (bContext *C, const bool do_python_exit, const bool do_user_exit_actions)
void blender::WM_exit (bContext *C, const int exit_code)
void blender::WM_main (bContext *C)
void blender::WM_init_splash_on_startup (bContext *C)
void blender::WM_init_splash (bContext *C)
void blender::WM_init_gpu_backend ()
void blender::WM_init_gpu_offscreen ()
void blender::WM_check (bContext *C)
void blender::WM_script_tag_reload ()
void blender::WM_window_csd_params_update ()
bool blender::WM_stereo3d_enabled (wmWindow *win, bool skip_stereo3d_check)
void blender::WM_cursor_set (wmWindow *win, int curs)
bool blender::WM_cursor_set_from_tool (wmWindow *win, const ScrArea *area, const ARegion *region)
bool blender::WM_cursor_modal_is_set_ok (const wmWindow *win)
void blender::WM_cursor_modal_set (wmWindow *win, int val)
void blender::WM_cursor_modal_restore (wmWindow *win)
void blender::WM_cursor_wait (bool val)
void blender::WM_cursor_grab_enable (wmWindow *win, const eWM_CursorWrapAxis wrap, const rcti *wrap_region, const bool hide)
void blender::WM_cursor_grab_disable (wmWindow *win, const int mouse_ungrab_xy[2])
void blender::WM_cursor_time (wmWindow *win, int nr)
void blender::WM_cursor_progress (wmWindow *win, float progress_factor)
void blender::WM_operator_free (wmOperator *op)
void blender::WM_operator_free_all_after (wmWindowManager *wm, wmOperator *op)
void blender::WM_operator_type_set (wmOperator *op, wmOperatorType *ot)
void blender::WM_operator_stack_clear (wmWindowManager *wm)
void blender::WM_operator_stack_clear (wmWindowManager *wm, const Set< wmOperatorType * > &types)
void blender::WM_operator_handlers_clear (wmWindowManager *wm, wmOperatorType *ot)
void blender::WM_operator_handlers_clear (wmWindowManager *wm, const Set< wmOperatorType * > &types)
void blender::WM_operator_properties_confirm_or_exec (wmOperatorType *ot)
void blender::WM_operator_properties_filesel (wmOperatorType *ot, const int filter, const short type, const eFileSel_Action action, const eFileSel_Flag flag, const short display, const short sort)
void blender::WM_operator_properties_id_lookup_set_from_id (PointerRNA *ptr, const ID *id)
ID * blender::WM_operator_properties_id_lookup_from_name_or_session_uid (Main *bmain, PointerRNA *ptr, const ID_Type type)
bool blender::WM_operator_properties_id_lookup_is_set (PointerRNA *ptr)
void blender::WM_operator_properties_id_lookup (wmOperatorType *ot, const bool add_name_prop)
void blender::WM_operator_properties_use_cursor_init (wmOperatorType *ot)
void blender::WM_operator_properties_border (wmOperatorType *ot)
void blender::WM_operator_properties_border_to_rcti (wmOperator *op, rcti *r_rect)
void blender::WM_operator_properties_border_to_rctf (wmOperator *op, rctf *r_rect)
Bounds< int2 > blender::WM_operator_properties_border_to_bounds (wmOperator *op)
void blender::WM_operator_properties_gesture_box_ex (wmOperatorType *ot, bool deselect, bool extend)
void blender::WM_operator_properties_gesture_box (wmOperatorType *ot)
void blender::WM_operator_properties_gesture_box_select (wmOperatorType *ot)
void blender::WM_operator_properties_gesture_box_zoom (wmOperatorType *ot)
void blender::WM_operator_properties_gesture_lasso (wmOperatorType *ot)
void blender::WM_operator_properties_gesture_polyline (wmOperatorType *ot)
void blender::WM_operator_properties_gesture_straightline (wmOperatorType *ot, int cursor)
void blender::WM_operator_properties_gesture_circle (wmOperatorType *ot)
void blender::WM_operator_properties_mouse_select (wmOperatorType *ot)
void blender::WM_operator_properties_select_all (wmOperatorType *ot)
void blender::WM_operator_properties_select_action (wmOperatorType *ot, int default_action, bool hide_gui)
void blender::WM_operator_properties_select_action_simple (wmOperatorType *ot, int default_action, bool hide_gui)
void blender::WM_operator_properties_select_random (wmOperatorType *ot)
int blender::WM_operator_properties_select_random_seed_increment_get (wmOperator *op)
void blender::WM_operator_properties_select_operation (wmOperatorType *ot)
void blender::WM_operator_properties_select_operation_simple (wmOperatorType *ot)
void blender::WM_operator_properties_select_walk_direction (wmOperatorType *ot)
void blender::WM_operator_properties_generic_select (wmOperatorType *ot)
void blender::WM_operator_properties_checker_interval (wmOperatorType *ot, bool nth_can_disable)
void blender::WM_operator_properties_checker_interval_from_op (wmOperator *op, CheckerIntervalParams *op_params)
bool blender::WM_operator_properties_checker_interval_test (const CheckerIntervalParams *op_params, int depth)
void blender::WM_uilisttype_init ()
uiListType * blender::WM_uilisttype_find (const StringRef idname, bool quiet)
bool blender::WM_uilisttype_add (uiListType *ult)
void blender::WM_uilisttype_remove_ptr (Main *bmain, uiListType *ult)
void blender::WM_uilisttype_free ()
void blender::WM_uilisttype_to_full_list_id (const uiListType *ult, const char *list_id, char r_full_list_id[])
const char * blender::WM_uilisttype_list_id_get (const uiListType *ult, uiList *list)
void blender::WM_menutype_init ()
MenuType * blender::WM_menutype_find (const StringRef idname, bool quiet)
Span< MenuType * > blender::WM_menutypes_registered_get ()
bool blender::WM_menutype_add (MenuType *mt)
void blender::WM_menutype_freelink (MenuType *mt)
void blender::WM_menutype_free ()
bool blender::WM_menutype_poll (bContext *C, MenuType *mt)
void blender::WM_menutype_idname_visit_for_search (const bContext *, PointerRNA *, PropertyRNA *, const char *, FunctionRef< void(StringPropertySearchVisitParams)> visit_fn)
void blender::WM_paneltype_init ()
void blender::WM_paneltype_clear ()
PanelType * blender::WM_paneltype_find (const StringRef idname, bool quiet)
bool blender::WM_paneltype_add (PanelType *pt)
void blender::WM_paneltype_remove (PanelType *pt)
void blender::WM_paneltype_idname_visit_for_search (const bContext *, PointerRNA *, PropertyRNA *, const char *, FunctionRef< void(StringPropertySearchVisitParams)> visit_fn)
wmGesture * blender::WM_gesture_new (wmWindow *window, const ARegion *region, const wmEvent *event, int type)
void blender::WM_gesture_end (wmWindow *win, wmGesture *gesture)
void blender::WM_gestures_remove (wmWindow *win)
void blender::WM_gestures_free_all (wmWindow *win)
bool blender::WM_gesture_is_modal_first (const wmGesture *gesture)
void blender::WM_event_start_drag (bContext *C, int icon, eWM_DragDataType type, void *poin, uint flags)
wmDrag * blender::WM_drag_data_create (bContext *C, int icon, eWM_DragDataType type, void *poin, uint flags)
void blender::WM_event_start_prepared_drag (bContext *C, wmDrag *drag)
void blender::WM_event_drag_image (wmDrag *drag, const ImBuf *imb, float scale)
void blender::WM_event_drag_path_override_poin_data_with_space_file_paths (const bContext *C, wmDrag *drag)
void blender::WM_event_drag_preview_icon (wmDrag *drag, int icon_id)
void blender::WM_drag_free (wmDrag *drag)
void blender::WM_drag_data_free (eWM_DragDataType dragtype, void *poin)
void blender::WM_drag_free_list (ListBaseT< wmDrag > *lb)
wmDropBox * blender::WM_dropbox_add (ListBaseT< wmDropBox > *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 blender::WM_drag_global_prefetch_handler_add (const eWM_DragDataType drag_type, const std::function< void(bContext &C, wmDrag &drag)> on_drag_start)
void blender::WM_dropbox_update_ot ()
void blender::WM_drag_draw_item_name_fn (bContext *, wmWindow *win, wmDrag *drag, const int xy[2])
void blender::WM_drag_draw_default_fn (bContext *C, wmWindow *win, wmDrag *drag, const int xy[2])
ListBaseT< wmDropBox > * blender::WM_dropboxmap_find (const char *idname, int spaceid, int regionid)
ID * blender::WM_drag_asset_id_import (const bContext *C, wmDragAsset *asset_drag, const int flag_extra)
bool blender::WM_drag_asset_will_import_linked (const wmDrag *drag)
bool blender::WM_drag_asset_will_import_packed (const wmDrag *drag)
void blender::WM_drag_add_local_ID (wmDrag *drag, ID *id, ID *from_parent)
ID * blender::WM_drag_get_local_ID (const wmDrag *drag, short idcode)
ID * blender::WM_drag_get_local_ID_from_event (const wmEvent *event, short idcode)
bool blender::WM_drag_is_ID_type (const wmDrag *drag, int idcode)
wmDragAsset * blender::WM_drag_create_asset_data (const asset_system::AssetRepresentation *asset, const AssetImportSettings &import_settings)
wmDragAsset * blender::WM_drag_get_asset_data (const wmDrag *drag, int idcode)
AssetMetaData * blender::WM_drag_get_asset_meta_data (const wmDrag *drag, int idcode)
ID * blender::WM_drag_get_local_ID_or_import_from_asset (const bContext *C, const wmDrag *drag, int idcode)
void blender::WM_drag_free_imported_drag_ID (Main *bmain, wmDrag *drag, wmDropBox *drop)
 Free asset ID imported for canceled drop.
wmDragAssetCatalog * blender::WM_drag_get_asset_catalog_data (const wmDrag *drag)
void blender::WM_drag_add_asset_list_item (wmDrag *drag, const asset_system::AssetRepresentation *asset)
const ListBaseT< wmDragAssetListItem > * blender::WM_drag_asset_list_get (const wmDrag *drag)
const std::string blender::WM_drag_get_item_name (wmDrag *drag)
wmDragPath * blender::WM_drag_create_path_data (Span< const char * > paths)
const char * blender::WM_drag_get_single_path (const wmDrag *drag)
const char * blender::WM_drag_get_single_path (const wmDrag *drag, int file_type)
Span< std::string > blender::WM_drag_get_paths (const wmDrag *drag)
bool blender::WM_drag_has_path_file_type (const wmDrag *drag, int file_type)
int blender::WM_drag_get_path_file_type (const wmDrag *drag)
const std::string & blender::WM_drag_get_string (const wmDrag *drag)
std::string blender::WM_drag_get_string_firstline (const wmDrag *drag)
void blender::wmViewport (const rcti *winrct)
void blender::wmPartialViewport (rcti *drawrct, const rcti *winrct, const rcti *partialrct)
void blender::wmWindowViewport (const wmWindow *win)
void blender::wmWindowViewport_ex (const wmWindow *win, float offset)
void blender::wmWindowViewportTitle_ex (const rcti &rect, float offset)
void blender::wmWindowViewportTitle (const rcti &rect)
void blender::wmOrtho2 (float x1, float x2, float y1, float y2)
void blender::wmOrtho2_region_pixelspace (const ARegion *region)
void blender::wmOrtho2_pixelspace (const float x, const float y)
void blender::wmGetProjectionMatrix (float mat[4][4], const rcti *winrct)
 blender::ENUM_OPERATORS (eWM_JobFlag)
wmJob * blender::WM_jobs_get (wmWindowManager *wm, wmWindow *win, const void *owner, const char *name, const eWM_JobFlag flag, const eWM_JobType job_type)
bool blender::WM_jobs_progress_test (const wmWindowManager *wm, const void *owner, int job_type)
float blender::WM_jobs_progress (const wmWindowManager *wm, const void *owner)
const char * blender::WM_jobs_name (const wmWindowManager *wm, const void *owner)
double blender::WM_jobs_starttime (const wmWindowManager *wm, const void *owner)
void * blender::WM_jobs_customdata_from_type (wmWindowManager *wm, const void *owner, int job_type)
bool blender::WM_jobs_is_running (const wmJob *wm_job)
bool blender::WM_jobs_is_stopped (const wmWindowManager *wm, const void *owner)
void * blender::WM_jobs_customdata_get (wmJob *wm_job)
void blender::WM_jobs_customdata_set (wmJob *wm_job, void *customdata, void(*free)(void *customdata))
void blender::WM_jobs_timer (wmJob *wm_job, double time_step, uint note, uint endnote, void(*timer_step)(void *))
void blender::WM_jobs_delay_start (wmJob *wm_job, double delay_time)
void blender::WM_jobs_callbacks (wmJob *wm_job, wm_jobs_start_callback startjob, void(*initjob)(void *), void(*update)(void *), void(*endjob)(void *))
void blender::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 blender::WM_jobs_start (wmWindowManager *wm, wmJob *wm_job)
void blender::WM_jobs_stop_type (wmWindowManager *wm, const void *owner, eWM_JobType job_type)
void blender::WM_jobs_stop_all_from_owner (wmWindowManager *wm, const void *owner)
void blender::WM_jobs_kill_all (wmWindowManager *wm)
void blender::WM_jobs_kill_all_except (wmWindowManager *wm, const void *owner)
void blender::WM_jobs_kill_type (wmWindowManager *wm, const void *owner, int job_type)
void blender::WM_jobs_kill_all_from_owner (wmWindowManager *wm, const void *owner)
bool blender::WM_jobs_has_running (const wmWindowManager *window_manager, const void *owner, const eWM_JobType type, const eWM_JobFlag exclude_flags)
void blender::WM_job_main_thread_lock_acquire (wmJob *wm_job)
void blender::WM_job_main_thread_lock_release (wmJob *wm_job)
int blender::WM_main_playanim (int argc, const char **argv)
void blender::WM_tooltip_immediate_init (bContext *C, wmWindow *win, ScrArea *area, ARegion *region, wmTooltipInitFn init)
void blender::WM_tooltip_timer_init_ex (bContext *C, wmWindow *win, ScrArea *area, ARegion *region, wmTooltipInitFn init, double delay)
void blender::WM_tooltip_timer_init (bContext *C, wmWindow *win, ScrArea *area, ARegion *region, wmTooltipInitFn init)
void blender::WM_tooltip_timer_clear (bContext *C, wmWindow *win)
void blender::WM_tooltip_clear (bContext *C, wmWindow *win)
void blender::WM_tooltip_init (bContext *C, wmWindow *win)
void blender::WM_tooltip_refresh (bContext *C, wmWindow *win)
double blender::WM_tooltip_time_closed ()
Read Main Blend-File API
void blender::WM_init_state_app_template_set (const char *app_template)
const char * blender::WM_init_state_app_template_get ()
bool blender::WM_file_read (bContext *C, const char *filepath, const bool use_scripts_autoexec_check, ReportList *reports)
bool blender::WM_file_read_project (bContext *C, const char *filepath, ReportList *reports)
Initial Window State API
void blender::WM_init_state_size_set (int stax, int stay, int sizx, int sizy)
void blender::WM_init_state_fullscreen_set ()
void blender::WM_init_state_normal_set ()
void blender::WM_init_state_maximized_set ()
void blender::WM_init_window_focus_set (bool do_it)
bool blender::WM_init_window_frame_get ()
void blender::WM_init_window_frame_set (bool do_it)
void blender::WM_init_native_pixels (bool do_it)
Cursor API
void blender::WM_init_input_devices ()
void blender::WM_cursor_warp (wmWindow *win, int x, int y)
uint blender::WM_cursor_preferred_logical_size (const bool hardware_cursor)
Splash Screen
std::string blender::WM_project_splash_image_filepath (const Main *bmain)
ImBuf * blender::WM_project_splash_image_load (const StringRefNull filepath, const int width, const bool add_logo)
Ghost Init/Exit
const char * blender::WM_ghost_backend ()
eWM_CapabilitiesFlag blender::WM_capabilities_flag ()
Recreate All Gizmos

Use when adjusting themes.

void blender::WM_reinit_gizmomap_all (Main *bmain)
Find Window Utility
wmWindow * blender::WM_window_find_under_cursor (wmWindow *win, const int event_xy[2], int r_event_xy_other[2])
wmWindow * blender::WM_window_find_by_area (wmWindowManager *wm, const ScrArea *area)
Window Screen Shot Utility (Front-Buffer & Off-Screen)

Include here since it can involve low level buffer switching.

bool blender::WM_desktop_cursor_sample_read (float r_col[3])
uint8_t * blender::WM_window_pixels_read_from_frontbuffer (const wmWindowManager *wm, const wmWindow *win, int r_size[2])
void blender::WM_window_pixels_read_sample_from_frontbuffer (const wmWindowManager *wm, const wmWindow *win, const int pos[2], float r_col[3])
uint8_t * blender::WM_window_pixels_read_from_offscreen (bContext *C, wmWindow *win, int r_size[2])
bool blender::WM_window_pixels_read_sample_from_offscreen (bContext *C, wmWindow *win, const int pos[2], float r_col[3])
uint8_t * blender::WM_window_pixels_read (bContext *C, wmWindow *win, int r_size[2])
bool blender::WM_window_pixels_read_sample (bContext *C, wmWindow *win, const int pos[2], float r_col[3])
Window Size (public)
int blender::WM_window_native_pixel_x (const wmWindow *win)
int blender::WM_window_native_pixel_y (const wmWindow *win)
int2 blender::WM_window_native_pixel_size (const wmWindow *win)
void blender::WM_window_native_pixel_coords (const wmWindow *win, int *x, int *y)
bool blender::WM_window_csd_is_active ()
bool blender::WM_window_is_csd (const wmWindow *win)
void blender::WM_window_rect_calc (const wmWindow *win, rcti *r_rect)
void blender::WM_window_screen_rect_calc (const wmWindow *win, rcti *r_rect)
bool blender::WM_window_is_main_top_level (const wmWindow *win)
bool blender::WM_window_is_fullscreen (const wmWindow *win)
bool blender::WM_window_is_maximized (const wmWindow *win)
bool blender::WM_window_support_hdr_color (const wmWindow *win)
Window Title Bar Layout

Generate a client-side-decorations (CSD).

void blender::WM_window_csd_rect_calc (const wmWindow *win, rcti *r_rect)
Window Screen/Scene/WorkSpaceViewLayer API
void blender::WM_windows_scene_data_sync (const ListBaseT< wmWindow > *win_lb, Scene *scene)
Scene * blender::WM_windows_scene_get_from_screen (const wmWindowManager *wm, const bScreen *screen)
ViewLayer * blender::WM_windows_view_layer_get_from_screen (const wmWindowManager *wm, const bScreen *screen)
WorkSpace * blender::WM_windows_workspace_get_from_screen (const wmWindowManager *wm, const bScreen *screen)
Scene * blender::WM_window_get_active_scene (const wmWindow *win)
void blender::WM_window_set_active_scene (Main *bmain, bContext *C, wmWindow *win, Scene *scene)
WorkSpace * blender::WM_window_get_active_workspace (const wmWindow *win)
void blender::WM_window_set_active_workspace (bContext *C, wmWindow *win, WorkSpace *workspace)
WorkSpaceLayout * blender::WM_window_get_active_layout (const wmWindow *win)
void blender::WM_window_set_active_layout (wmWindow *win, WorkSpace *workspace, WorkSpaceLayout *layout)
bScreen * blender::WM_window_get_active_screen (const wmWindow *win)
void blender::WM_window_set_active_screen (wmWindow *win, WorkSpace *workspace, bScreen *screen)
ViewLayer * blender::WM_window_get_active_view_layer (const wmWindow *win)
void blender::WM_window_set_active_view_layer (wmWindow *win, ViewLayer *view_layer)
void blender::WM_window_ensure_active_view_layer (wmWindow *win)
bool blender::WM_window_is_temp_screen (const wmWindow *win)
Direct GPU Context Management
GHOST_IContext * blender::WM_system_gpu_context_create ()
void blender::WM_system_gpu_context_dispose (GHOST_IContext *context)
void blender::WM_system_gpu_context_activate (GHOST_IContext *context)
void blender::WM_system_gpu_context_release (GHOST_IContext *context)
Window Decoration Style
wmWindow * blender::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)
wmWindow * blender::WM_window_open_temp (bContext *C, const char *title, int space_type, bool dialog)
eWM_WindowDecorationStyleFlag blender::WM_window_decoration_style_flags_get (const wmWindow *win)
void blender::WM_window_decoration_style_flags_set (const wmWindow *win, eWM_WindowDecorationStyleFlag style_flags)
void blender::WM_window_decoration_style_apply (const wmWindow *win, const bScreen *screen)
Window Close
void blender::WM_window_dpi_set_userdef (const wmWindow *win)
float blender::WM_window_dpi_get_scale (const wmWindow *win)
void blender::WM_window_title_set (wmWindow *win, const char *title)
void blender::WM_window_title_refresh (wmWindowManager *wm, wmWindow *win)
Read Blend-File Shared Utilities
void blender::WM_file_autoexec_init (const char *filepath)
Auto-Save API
void blender::WM_file_autosave_init (wmWindowManager *wm)
bool blender::WM_autosave_is_scheduled (wmWindowManager *wm)
bool blender::WM_autosave_write (wmWindowManager *wm, Main *bmain, ReportList *reports)
Recover Last Session Operator
bool blender::WM_file_recover_last_session (bContext *C, const bool use_scripts_autoexec_check, ReportList *reports)
Misc Utility Functions
void blender::WM_file_tag_modified ()
Link/Append Single Data-Block & Return it
ID * blender::WM_file_link_datablock (Main *bmain, Scene *scene, ViewLayer *view_layer, View3D *v3d, const char *filepath, const short id_code, const char *id_name, int flag, ReportList *reports)
ID * blender::WM_file_append_datablock (Main *bmain, Scene *scene, ViewLayer *view_layer, View3D *v3d, const char *filepath, const short id_code, const char *id_name, int flag, ReportList *reports)
Library Relocate Operator & Library Reload API
void blender::WM_lib_reload (Library *lib, bContext *C, ReportList *reports)
default paint cursors, draw always around cursor
  • Returns handler to free.
  • poll(bContext): returns 1 if draw should happen.
  • draw(bContext): drawing callback for paint cursor.
wmPaintCursor * blender::WM_paint_cursor_activate (short space_type, short region_type, wmPaintCursorPoll poll, wmPaintCursorDraw draw, void *customdata)
bool blender::WM_paint_cursor_end (wmPaintCursor *handle)
void blender::WM_paint_cursor_remove_by_type (wmWindowManager *wm, wmPaintCursorDraw draw_fn, void(*free)(void *))
Main Update Call
void blender::WM_paint_cursor_tag_redraw (wmWindow *win, ARegion *)
void blender::WM_redraw_windows (bContext *C)
void blender::WM_draw_region_free (ARegion *region)
Modal Operator Handling
wmEventHandler_Keymap * blender::WM_event_add_keymap_handler (ListBaseT< wmEventHandler > *handlers, wmKeyMap *keymap)
wmEventHandler_Keymap * blender::WM_event_add_keymap_handler_poll (ListBaseT< wmEventHandler > *handlers, wmKeyMap *keymap, EventHandlerPoll poll)
bool blender::WM_event_handler_region_v2d_mask_poll (const wmWindow *, const ScrArea *, const ARegion *region, const wmEvent *event)
bool blender::WM_event_handler_region_marker_poll (const wmWindow *win, const ScrArea *area, const ARegion *region, const wmEvent *event)
bool blender::WM_event_handler_region_v2d_mask_no_marker_poll (const wmWindow *win, const ScrArea *area, const ARegion *region, const wmEvent *event)
wmEventHandler_Keymap * blender::WM_event_add_keymap_handler_v2d_mask (ListBaseT< wmEventHandler > *handlers, wmKeyMap *keymap)
wmEventHandler_Keymap * blender::WM_event_add_keymap_handler_priority (ListBaseT< wmEventHandler > *handlers, wmKeyMap *keymap, int)
void blender::WM_event_get_keymap_from_toolsystem_with_gizmos (wmWindowManager *wm, wmWindow *win, wmEventHandler_Keymap *handler, wmEventHandler_KeymapResult *km_result)
void blender::WM_event_get_keymap_from_toolsystem (wmWindowManager *wm, wmWindow *win, wmEventHandler_Keymap *handler, wmEventHandler_KeymapResult *km_result)
wmEventHandler_Keymap * blender::WM_event_add_keymap_handler_dynamic (ListBaseT< wmEventHandler > *handlers, wmEventHandler_KeymapDynamicFn keymap_fn, void *user_data)
void blender::WM_event_remove_keymap_handler (ListBaseT< wmEventHandler > *handlers, wmKeyMap *keymap)
void blender::WM_event_set_keymap_handler_post_callback (wmEventHandler_Keymap *handler, void(keymap_tag)(wmKeyMap *keymap, wmKeyMapItem *kmi, void *user_data), void *user_data)
wmEventHandler_UI * blender::WM_event_add_ui_handler (const bContext *C, ListBaseT< wmEventHandler > *handlers, wmUIHandlerFunc handle_fn, wmUIHandlerRemoveFunc remove_fn, void *user_data, const eWM_EventHandlerFlag flag)
wmOperator * blender::WM_operator_find_modal_by_type (wmWindow *win, const wmOperatorType *ot)
void blender::WM_event_remove_ui_handler (ListBaseT< wmEventHandler > *handlers, wmUIHandlerFunc handle_fn, wmUIHandlerRemoveFunc remove_fn, void *user_data, const bool postpone)
void blender::WM_event_remove_handlers_by_area (ListBaseT< wmEventHandler > *handlers, const ScrArea *area)
void blender::WM_event_free_ui_handler_all (bContext *C, ListBaseT< wmEventHandler > *handlers, wmUIHandlerFunc handle_fn, wmUIHandlerRemoveFunc remove_fn)
wmEventHandler_Op * blender::WM_event_add_modal_handler_ex (wmWindow *win, ScrArea *area, ARegion *region, wmOperator *op)
wmEventHandler_Op * blender::WM_event_add_modal_handler (bContext *C, wmOperator *op)
void blender::WM_event_remove_modal_handler (ListBaseT< wmEventHandler > *handlers, const wmOperator *op, const bool postpone)
void blender::WM_event_remove_modal_handler_all (const wmOperator *op, const bool postpone)
void blender::WM_event_modal_handler_area_replace (wmWindow *win, const ScrArea *old_area, ScrArea *new_area)
void blender::WM_event_modal_handler_region_replace (wmWindow *win, const ARegion *old_region, ARegion *new_region)
void blender::WM_event_ui_handler_region_popup_replace (wmWindow *win, const ARegion *old_region, ARegion *new_region)
wmEventHandler_Dropbox * blender::WM_event_add_dropbox_handler (ListBaseT< wmEventHandler > *handlers, ListBaseT< wmDropBox > *dropboxes)
void blender::WM_event_add_mousemove (wmWindow *win)
Event / Keymap Matching API
void blender::WM_event_get_keymaps_from_handler (wmWindowManager *wm, wmWindow *win, wmEventHandler_Keymap *handler, wmEventHandler_KeymapResult *km_result)
wmKeyMapItem * blender::WM_event_match_keymap_item (bContext *C, wmKeyMap *keymap, const wmEvent *event)
wmKeyMapItem * blender::WM_event_match_keymap_item_from_handlers (bContext *C, wmWindowManager *wm, wmWindow *win, ListBaseT< wmEventHandler > *handlers, const wmEvent *event)
bool blender::WM_event_match (const wmEvent *winevent, const wmKeyMapItem *kmi)
bool blender::WM_event_modifier_flag_match_kmi_press (const wmEventModifierFlag event_modifier, const wmKeyMapItem *kmi)
Handler Types

General API for different handler types.

void blender::WM_event_remove_handlers (bContext *C, ListBaseT< wmEventHandler > *handlers)
Notifiers & Listeners
void blender::WM_event_handling_break (const bContext &C)
void blender::WM_event_add_notifier_ex (wmWindowManager *wm, const wmWindow *win, uint type, void *reference)
void blender::WM_event_add_notifier (const bContext *C, uint type, void *reference)
void blender::WM_main_add_notifier (uint type, void *reference)
void blender::WM_main_remove_notifier_reference (const void *reference)
void blender::WM_main_remap_editor_id_reference (const bke::id::IDRemapper &mappings)
WM Reports

Access to #wmWindowManager.reports

void blender::WM_report_banner_show (wmWindowManager *wm, wmWindow *win)
void blender::WM_report_banners_cancel (Main *bmain)
void blender::WM_reports_from_reports_move (wmWindowManager *wm, ReportList *reports)
void blender::WM_global_report (eReportType type, const char *message)
void blender::WM_global_reportf (eReportType type, const char *format,...)
Event Management
wmEvent * blender::WM_event_add (wmWindow *win, const wmEvent *event_to_add)
void blender::wm_event_init_from_window (wmWindow *win, wmEvent *event)
wmEvent * blender::WM_event_add_simulate (wmWindow *win, const wmEvent *event_to_add)
Event Timer
wmTimer * blender::WM_event_timer_add (wmWindowManager *wm, wmWindow *win, const wmEventType event_type, const double time_step)
wmTimer * blender::WM_event_timer_add_notifier (wmWindowManager *wm, wmWindow *win, const uint type, const double time_step)
void blender::WM_event_timer_free_data (wmTimer *timer)
void blender::WM_event_timer_remove (wmWindowManager *wm, wmWindow *, wmTimer *timer)
void blender::WM_event_timer_remove_notifier (wmWindowManager *wm, wmWindow *win, wmTimer *timer)
void blender::WM_event_timer_sleep (wmWindowManager *wm, wmWindow *, wmTimer *timer, bool do_sleep)
Default Operator Callbacks
wmOperatorStatus blender::WM_generic_select_modal (bContext *C, wmOperator *op, const wmEvent *event)
wmOperatorStatus blender::WM_generic_select_invoke (bContext *C, wmOperator *op, const wmEvent *event)
void blender::WM_operator_view3d_unit_defaults (bContext *C, wmOperator *op)
int blender::WM_operator_smooth_viewtx_get (const wmOperator *op)
wmOperatorStatus blender::WM_menu_invoke_ex (bContext *C, wmOperator *op, wm::OpCallContext opcontext)
wmOperatorStatus blender::WM_menu_invoke (bContext *C, wmOperator *op, const wmEvent *)
wmOperatorStatus blender::WM_enum_search_invoke (bContext *C, wmOperator *op, const wmEvent *)
wmOperatorStatus blender::WM_operator_confirm (bContext *C, wmOperator *op, const wmEvent *)
wmOperatorStatus blender::WM_operator_confirm_or_exec (bContext *C, wmOperator *op, const wmEvent *)
wmOperatorStatus blender::WM_operator_confirm_ex (bContext *C, wmOperator *op, const char *title, const char *message, const char *confirm_text, ui::AlertIcon icon, bool cancel_default)
wmOperatorStatus blender::WM_operator_filesel (bContext *C, wmOperator *op, const wmEvent *)
bool blender::WM_operator_filesel_ensure_ext_imtype (wmOperator *op, const ImageFormatData *im_format)
bool blender::WM_operator_winactive (bContext *C)
wmOperatorStatus blender::WM_operator_props_popup_confirm (bContext *C, wmOperator *op, const wmEvent *)
wmOperatorStatus blender::WM_operator_props_popup_confirm_ex (bContext *C, wmOperator *op, const wmEvent *, std::optional< std::string > title, std::optional< std::string > confirm_text, const bool cancel_default, std::optional< std::string > message)
wmOperatorStatus blender::WM_operator_props_popup_call (bContext *C, wmOperator *op, const wmEvent *)
wmOperatorStatus blender::WM_operator_props_popup (bContext *C, wmOperator *op, const wmEvent *)
wmOperatorStatus blender::WM_operator_props_dialog_popup (bContext *C, wmOperator *op, int width, std::optional< std::string > title, std::optional< std::string > confirm_text, const bool cancel_default, std::optional< std::string > message, const bool show_icon)
wmOperatorStatus blender::WM_operator_redo_popup (bContext *C, wmOperator *op)
wmOperatorStatus blender::WM_operator_ui_popup (bContext *C, wmOperator *op, int width, const bool use_numselect)
wmOperatorStatus blender::WM_operator_confirm_message_ex (bContext *C, wmOperator *op, const char *title, const int icon, const char *message, const wm::OpCallContext)
wmOperatorStatus blender::WM_operator_confirm_message (bContext *C, wmOperator *op, const char *message)
bool blender::WM_operator_check_ui_enabled (const bContext *C, const char *idname)
IDProperty * blender::WM_operator_last_properties_ensure_idprops (wmOperatorType *ot)
void blender::WM_operator_last_properties_ensure (wmOperatorType *ot, PointerRNA *ptr)
wmOperator * blender::WM_operator_last_redo (const bContext *C)
ID * blender::WM_operator_drop_load_path (bContext *C, wmOperator *op, const short idcode)
Operator Logic
void blender::WM_menu_name_call (bContext *C, const char *menu_name, wm::OpCallContext context)
bool blender::WM_operator_poll (bContext *C, wmOperatorType *ot)
bool blender::WM_operator_poll_context (bContext *C, wmOperatorType *ot, wm::OpCallContext context)
bool blender::WM_operator_poll_or_report_error (bContext *C, wmOperatorType *ot, ReportList *reports)
wmOperatorStatus blender::WM_operator_call_ex (bContext *C, wmOperator *op, const bool store)
wmOperatorStatus blender::WM_operator_call (bContext *C, wmOperator *op)
wmOperatorStatus blender::WM_operator_call_notest (bContext *C, wmOperator *op)
wmOperatorStatus blender::WM_operator_repeat (bContext *C, wmOperator *op)
wmOperatorStatus blender::WM_operator_repeat_last (bContext *C, wmOperator *op)
bool blender::WM_operator_repeat_check (const bContext *, wmOperator *op)
bool blender::WM_operator_is_repeat (const bContext *C, const wmOperator *op)
bool blender::WM_operator_name_poll (bContext *C, const char *opstring)
wmOperatorStatus blender::WM_operator_type_call_ptr_with_reports (bContext *C, wmOperatorType *ot, wm::OpCallContext context, PointerRNA *properties, ReportList *reports, const wmEvent *event)
wmOperatorStatus blender::WM_operator_name_call_ptr (bContext *C, wmOperatorType *ot, wm::OpCallContext context, PointerRNA *properties, const wmEvent *event)
wmOperatorStatus blender::WM_operator_name_call (bContext *C, const char *opstring, wm::OpCallContext context, PointerRNA *properties, const wmEvent *event)
wmOperatorStatus blender::WM_operator_name_call_with_properties (bContext *C, const char *opstring, wm::OpCallContext context, IDProperty *properties, const wmEvent *event)
wmOperatorStatus blender::WM_operator_call_py (bContext *C, wmOperatorType *ot, wm::OpCallContext context, PointerRNA *properties, ReportList *reports, const bool is_undo)
bool blender::WM_operator_ui_poll (wmOperatorType *ot, PointerRNA *ptr)
void blender::WM_operator_region_active_win_set (bContext *C)
Operator Wait For Input

Delay executing operators that depend on cursor location.

See: OPTYPE_DEPENDS_ON_CURSOR docstring for more information.

void blender::WM_operator_name_call_ptr_with_depends_on_cursor (bContext *C, wmOperatorType *ot, wm::OpCallContext opcontext, PointerRNA *properties, const wmEvent *event, const StringRef drawstr)
Operator API
void blender::WM_operator_properties_alloc (PointerRNA **ptr, IDProperty **properties, const char *opstring)
void blender::WM_operator_properties_sanitize (PointerRNA *ptr, const bool no_context)
bool blender::WM_operator_properties_default (PointerRNA *ptr, const bool do_update)
void blender::WM_operator_properties_reset (wmOperator *op)
PointerRNA blender::WM_operator_properties_create (const char *opstring)
PointerRNA blender::WM_operator_properties_create_ptr (wmOperatorType *ot)
void blender::WM_operator_properties_clear (PointerRNA *ptr)
void blender::WM_operator_properties_free (PointerRNA *ptr)
std::string blender::WM_operator_pystring_ex (bContext *C, wmOperator *op, const bool all_args, const bool macro_args, wmOperatorType *ot, PointerRNA *opptr)
std::string blender::WM_operator_pystring (bContext *C, wmOperator *op, const bool all_args, const bool macro_args)
std::string blender::WM_operator_pystring_abbreviate (std::string str, int str_len_max)
std::optional< std::string > blender::WM_prop_pystring_assign (bContext *C, PointerRNA *ptr, PropertyRNA *prop, int index)
size_t blender::WM_operator_bl_idname (char *dst, const char *src)
size_t blender::WM_operator_py_idname (char *dst, const char *src)
bool blender::WM_operator_py_idname_ok_or_report (ReportList *reports, const char *classname, const char *idname)
bool blender::WM_operator_idname_ok_or_report (ReportList *reports, const char *idname)
bool blender::WM_operator_bl_idname_is_valid (const char *idname)
std::optional< std::string > blender::WM_context_path_resolve_property_full (const bContext *C, const PointerRNA *ptr, PropertyRNA *prop, int index)
std::optional< std::string > blender::WM_context_path_resolve_full (bContext *C, const PointerRNA *ptr)
Operator Last Properties API
bool blender::WM_operator_last_properties_init (wmOperator *op)
bool blender::WM_operator_last_properties_store (wmOperator *op)
Operator Type Registry
wmOperatorType * blender::WM_operatortype_find (const char *idname, bool quiet)
Span< wmOperatorType * > blender::WM_operatortypes_registered_get ()
Operator Type Append
void blender::WM_operatortype_append (void(*opfunc)(wmOperatorType *))
void blender::WM_operatortype_append_ptr (void(*opfunc)(wmOperatorType *, void *), void *userdata)
Operator Macro Type
void blender::WM_operatortype_append_macro_ptr (void(*opfunc)(wmOperatorType *ot, void *userdata), void *userdata)
wmOperatorType * blender::WM_operatortype_append_macro (const char *idname, const char *name, const char *description, int flag)
wmOperatorTypeMacro * blender::WM_operatortype_macro_define (wmOperatorType *ot, const char *idname)
std::string blender::WM_operatortype_name (wmOperatorType *ot, PointerRNA *properties)
std::string blender::WM_operatortype_description (bContext *C, wmOperatorType *ot, PointerRNA *properties)
std::string blender::WM_operatortype_description_or_name (bContext *C, wmOperatorType *ot, PointerRNA *properties)
bool blender::WM_operator_depends_on_cursor (bContext &C, wmOperatorType &ot, PointerRNA *properties)
Operator Type Removal & Property Search
void blender::WM_operatortype_remove_ptr (wmOperatorType *ot)
bool blender::WM_operatortype_remove (const char *idname)
void blender::WM_operatortype_last_properties_clear_all ()
void blender::WM_operatortype_idname_visit_for_search (const bContext *, PointerRNA *, PropertyRNA *, const char *, FunctionRef< void(StringPropertySearchVisitParams)> visit_fn)
void blender::WM_operatortype_props_advanced_begin (wmOperatorType *ot)
void blender::WM_operatortype_props_advanced_end (wmOperatorType *ot)
Object Edit Mode Coords (Modal Callbacks)
Note
We could support object mode coords too, it's just not needed at the moment.
void blender::WM_operator_type_modal_from_exec_for_object_edit_coords (wmOperatorType *ot)
Border Gesture

Border gesture has two types:

  1. WM_GESTURE_CROSS_RECT: starts a cross, on mouse click it changes to border.
  2. WM_GESTURE_RECT: starts immediate as a border, on mouse click or release it ends.

It stores 4 values (xmin, xmax, ymin, ymax) and event it ended with (event_type).

wmOperatorStatus blender::WM_gesture_box_invoke (bContext *C, wmOperator *op, const wmEvent *event)
wmOperatorStatus blender::WM_gesture_box_modal (bContext *C, wmOperator *op, const wmEvent *event)
void blender::WM_gesture_box_cancel (bContext *C, wmOperator *op)
Circle Gesture

Currently only used for selection or modal paint stuff, calls #wmOperatorType.exec while hold mouse, exits on release (with no difference between cancel and confirm).

wmOperatorStatus blender::WM_gesture_circle_invoke (bContext *C, wmOperator *op, const wmEvent *event)
wmOperatorStatus blender::WM_gesture_circle_modal (bContext *C, wmOperator *op, const wmEvent *event)
void blender::WM_gesture_circle_cancel (bContext *C, wmOperator *op)
Lasso Gesture

There are two types of lasso gesture:

  1. WM_GESTURE_LASSO: A lasso that follows the mouse cursor with the enclosed area shaded.
  2. WM_GESTURE_LINES: A lasso that follows the mouse cursor without the enclosed area shaded.

The operator stores data in the "path" property as a series of screen space positions.

wmOperatorStatus blender::WM_gesture_lines_invoke (bContext *C, wmOperator *op, const wmEvent *event)
wmOperatorStatus blender::WM_gesture_lines_modal (bContext *C, wmOperator *op, const wmEvent *event)
void blender::WM_gesture_lines_cancel (bContext *C, wmOperator *op)
wmOperatorStatus blender::WM_gesture_lasso_invoke (bContext *C, wmOperator *op, const wmEvent *event)
wmOperatorStatus blender::WM_gesture_lasso_modal (bContext *C, wmOperator *op, const wmEvent *event)
void blender::WM_gesture_lasso_cancel (bContext *C, wmOperator *op)
Array< int2 > blender::WM_gesture_lasso_path_to_array (bContext *, wmOperator *op)
Polyline Gesture

Gesture defined by three or more points in a viewport enclosing a particular area.

Like the Lasso Gesture, the data passed onto other operators via the 'path' property is a sequential array of mouse positions.

wmOperatorStatus blender::WM_gesture_polyline_invoke (bContext *C, wmOperator *op, const wmEvent *event)
wmOperatorStatus blender::WM_gesture_polyline_modal (bContext *C, wmOperator *op, const wmEvent *event)
void blender::WM_gesture_polyline_cancel (bContext *C, wmOperator *op)
Straight Line Gesture

Gesture defined by the start and end points of a line that is created between the position of the initial event and the position of the current event.

Straight Line Gesture has two modal callbacks depending on the tool that is being implemented: a regular modal callback intended to update the data during the execution of the gesture and a one-shot callback that only updates the data once when the gesture finishes.

It stores 4 values: xstart, ystart, xend, yend.

wmOperatorStatus blender::WM_gesture_straightline_invoke (bContext *C, wmOperator *op, const wmEvent *event)
wmOperatorStatus blender::WM_gesture_straightline_active_side_invoke (bContext *C, wmOperator *op, const wmEvent *event)
wmOperatorStatus blender::WM_gesture_straightline_modal (bContext *C, wmOperator *op, const wmEvent *event)
wmOperatorStatus blender::WM_gesture_straightline_oneshot_modal (bContext *C, wmOperator *op, const wmEvent *event)
void blender::WM_gesture_straightline_cancel (bContext *C, wmOperator *op)
File Selector Handling
void blender::WM_event_add_fileselect (bContext *C, wmOperator *op)
void blender::WM_event_fileselect_event (wmWindowManager *wm, void *ophandle, const int eventval)
Consecutive Event Access
void * blender::WM_event_consecutive_data_get (wmWindow *win, const char *id)
void blender::WM_event_consecutive_data_set (wmWindow *win, const char *id, void *custom_data)
void blender::WM_event_consecutive_data_free (wmWindow *win)
Generic Utilities
wmOperatorStatus blender::WM_operator_flag_only_pass_through_on_press (wmOperatorStatus retval, const wmEvent *event)
Clipboard
char * blender::WM_clipboard_text_get (bool selection, bool ensure_utf8, int *r_len)
char * blender::WM_clipboard_text_get_firstline (bool selection, bool ensure_utf8, int *r_len)
void blender::WM_clipboard_text_set (const char *buf, bool selection)
bool blender::WM_clipboard_image_available ()
ImBuf * blender::WM_clipboard_image_get ()
bool blender::WM_clipboard_image_set_byte_buffer (ImBuf *ibuf)
Progress Bar
void blender::WM_progress_set (wmWindow *win, float progress)
void blender::WM_progress_clear (wmWindow *win)
Window Drawing (Draw All)

Reference method, draw all each time.

void * blender::WM_draw_cb_activate (wmWindow *win, void(*draw)(const wmWindow *win, void *customdata), void *customdata)
void blender::WM_draw_cb_exit (wmWindow *win, void *handle)
Region Viewport Drawing

This is needed for viewport drawing for operator use (where the viewport may not have drawn yet).

Otherwise avoid using these since they're exposing low level logic externally.

void blender::WM_draw_region_viewport_ensure (Scene *scene, ARegion *region, short space_type)
void blender::WM_draw_region_viewport_bind (ARegion *region)
void blender::WM_draw_region_viewport_unbind (ARegion *region)
Region Drawing

Each region draws into its own frame-buffer, which is then blit on the window draw buffer. This helps with fast redrawing if only some regions change. It also means we can share a single context for multiple windows, so that for example VAOs can be shared between windows.

GPUViewport * blender::WM_draw_region_get_viewport (ARegion *region)
GPUViewport * blender::WM_draw_region_get_bound_viewport (ARegion *region)
Write Main Blend-File (internal)
bool blender::write_crash_blend ()
WM Interface Locking
void blender::WM_locked_interface_set (wmWindowManager *wm, bool lock)
void blender::WM_locked_interface_set_with_flags (wmWindowManager *wm, short lock_flags)
Ghost Event Conversion
void blender::WM_event_tablet_data_default_set (wmTabletData *tablet_data)
Cursor Keymap Status

Show cursor keys in the status bar. This is done by detecting changes to the state - full key-map lookups are expensive so only perform this on changing tools, space types, pressing different modifier keys... etc.

const char * blender::WM_window_cursor_keymap_status_get (const wmWindow *win, int button_index, int type_index)
void blender::WM_window_cursor_keymap_status_refresh (bContext *C, wmWindow *win)
void blender::WM_window_cursor_keymap_status_free (wmWindow *win)
void blender::WM_window_status_area_tag_redraw (wmWindow *win)
ScrArea * blender::WM_window_status_area_find (wmWindow *win, bScreen *screen)
Modal Keymap Status
bool blender::WM_window_modal_keymap_status_draw (bContext *C, wmWindow *win, ui::Layout &layout)
Event Printing
void blender::WM_event_print (const wmEvent *event)
Event Motion Queries
bool blender::WM_event_is_modal_drag_exit (const wmEvent *event, const short init_event_type, const short init_event_val)
bool blender::WM_event_is_mouse_drag (const wmEvent *event)
bool blender::WM_event_is_mouse_drag_or_press (const wmEvent *event)
int blender::WM_event_drag_direction (const wmEvent *event)
bool blender::WM_cursor_test_motion_and_update (const int mval[2])
Event Text Queries
char blender::WM_event_utf8_to_ascii (const wmEvent *event)
Event Consecutive Checks
bool blender::WM_event_consecutive_gesture_test (const wmEvent *event)
bool blender::WM_event_consecutive_gesture_test_break (const wmWindow *win, const wmEvent *event)
Event Click/Drag Checks

Values under this limit are detected as clicks.

int blender::WM_event_drag_threshold (const wmEvent *event)
bool blender::WM_event_drag_test (const wmEvent *event, const int prev_xy[2])
bool blender::WM_event_drag_test_with_delta (const wmEvent *event, const int drag_delta[2])
void blender::WM_event_drag_start_mval (const wmEvent *event, const ARegion *region, int r_mval[2])
void blender::WM_event_drag_start_mval_fl (const wmEvent *event, const ARegion *region, float r_mval[2])
void blender::WM_event_drag_start_xy (const wmEvent *event, int r_xy[2])
Event Preference Mapping
int blender::WM_userdef_event_map (int kmitype)
int blender::WM_userdef_event_type_from_keymap_type (int kmitype)
Event Tablet Input Access
float blender::WM_event_tablet_data (const wmEvent *event, bool *r_pen_flip, float r_tilt[2])
bool blender::WM_event_is_tablet (const wmEvent *event)
Event Scroll's Absolute Deltas

User may change the scroll behavior, and the deltas are automatically inverted. These functions return the absolute direction, swipe up/right gives positive values.

int blender::WM_event_absolute_delta_x (const wmEvent *event)
int blender::WM_event_absolute_delta_y (const wmEvent *event)
Generic Callback
wmGenericCallback * blender::WM_generic_callback_steal (wmGenericCallback *callback)
void blender::WM_generic_callback_free (wmGenericCallback *callback)
Generic User Data
void blender::WM_generic_user_data_free (wmGenericUserData *wm_userdata)
Internal Utilities
bool blender::WM_region_use_viewport (ScrArea *area, ARegion *region)
Register File Association
bool blender::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 693 of file WM_api.hh.

Referenced by blender::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 1594 of file WM_api.hh.

Referenced by blender::WM_operatortype_props_advanced_end().