Blender V5.3
blender::wmWindow Struct Reference

#include <DNA_windowmanager_types.h>

Public Attributes

struct wmWindow * next = nullptr
struct wmWindow * prev = nullptr
struct wmWindow * parent = nullptr
struct Scene * scene = nullptr
struct Scene * new_scene = nullptr
char view_layer_name [64] = ""
struct Scene * unpinned_scene = nullptr
struct WorkSpaceInstanceHook * workspace_hook = nullptr
ScrAreaMap global_areas
DNA_DEPRECATED struct bScreen * screen = nullptr
int winid = 0
short posx = 0
short posy = 0
short sizex = 0
short sizey = 0
char windowstate = 0
char active = 0
short cursor = 0
short lastcursor = 0
short modalcursor = 0
short grabcursor = 0
short pie_event_type_lock = 0
short pie_event_type_last = 0
char tag_cursor_refresh = 0
char event_queue_check_click = 0
char event_queue_check_drag = 0
char event_queue_check_drag_handled = 0
short event_queue_consecutive_gesture_type = 0
int event_queue_consecutive_gesture_xy [2] = {}
struct wmEvent_ConsecutiveData * event_queue_consecutive_gesture_data = nullptr
char addmousemove = 0
char _pad1 [7] = {}
struct Stereo3dFormat * stereo3d_format = nullptr
bke::WindowRuntime * runtime = nullptr

Detailed Description

The saveable part, the rest of the data is local in GHOST.

Definition at line 167 of file DNA_windowmanager_types.h.

Member Data Documentation

◆ _pad1

char blender::wmWindow::_pad1[7] = {}

Definition at line 263 of file DNA_windowmanager_types.h.

◆ active

◆ addmousemove

char blender::wmWindow::addmousemove = 0

◆ cursor

◆ event_queue_check_click

char blender::wmWindow::event_queue_check_click = 0

Enable when KM_PRESS events are not handled (keyboard/mouse-buttons only).

Definition at line 238 of file DNA_windowmanager_types.h.

Referenced by blender::window_manager_blend_read_data(), blender::window_manager_blend_write(), blender::wm_event_do_handlers(), and blender::wm_handlers_do().

◆ event_queue_check_drag

char blender::wmWindow::event_queue_check_drag = 0

◆ event_queue_check_drag_handled

char blender::wmWindow::event_queue_check_drag_handled = 0

Enable when the drag was handled, to avoid mouse-motion continually triggering drag events which are not handled but add overhead to gizmo handling (for example), see #87511.

Definition at line 246 of file DNA_windowmanager_types.h.

Referenced by blender::window_manager_blend_read_data(), blender::window_manager_blend_write(), blender::wm_event_do_handlers(), and blender::wm_handlers_do().

◆ event_queue_consecutive_gesture_data

◆ event_queue_consecutive_gesture_type

short blender::wmWindow::event_queue_consecutive_gesture_type = 0

The last event type (that passed WM_event_consecutive_gesture_test check). A wmEventType is assigned to this value.

Definition at line 252 of file DNA_windowmanager_types.h.

Referenced by blender::window_manager_blend_read_data(), blender::window_manager_blend_write(), and blender::wm_event_do_handlers().

◆ event_queue_consecutive_gesture_xy

int blender::wmWindow::event_queue_consecutive_gesture_xy[2] = {}

◆ global_areas

◆ grabcursor

◆ lastcursor

short blender::wmWindow::lastcursor = 0

◆ modalcursor

◆ new_scene

struct Scene* blender::wmWindow::new_scene = nullptr

Temporary when switching.

Definition at line 178 of file DNA_windowmanager_types.h.

◆ next

◆ parent

◆ pie_event_type_last

short blender::wmWindow::pie_event_type_last = 0

Exception to the above rule for nested pies, store last pie event for operators that spawn a new pie right after destruction of last pie.

Definition at line 231 of file DNA_windowmanager_types.h.

Referenced by blender::ui::pie_menu_begin(), and blender::ui::popup_handler().

◆ pie_event_type_lock

short blender::wmWindow::pie_event_type_lock = 0

Internal, lock pie creation from this event until released.

Definition at line 226 of file DNA_windowmanager_types.h.

Referenced by blender::ui::pie_handler(), blender::ui::pie_menu_begin(), and blender::wm_event_pie_filter().

◆ posx

◆ posy

◆ prev

struct wmWindow * blender::wmWindow::prev = nullptr

Definition at line 170 of file DNA_windowmanager_types.h.

◆ runtime

bke::WindowRuntime* blender::wmWindow::runtime = nullptr

Definition at line 268 of file DNA_windowmanager_types.h.

Referenced by blender::achannel_setting_flush_widget_cb(), blender::actionzone_area_poll(), blender::ui::apply_but(), blender::ed::vse::blade_edit_point_update(), blender::ed::vse::blade_split_get(), blender::ed::vse::blade_tooltip_init(), blender::ui::block_end(), blender::ui::block_free_func_POPOVER(), blender::ui::but_tooltip_init(), blender::ed::outliner::collection_drop_tooltip(), blender::console_cursor(), blender::ui::do_but_textedit(), blender::ED_area_newspace(), blender::ED_area_update_region_sizes(), blender::ED_gizmotypes_snap_3d_data_get(), blender::ED_imbuf_sample_draw(), blender::ED_region_draw_mouse_line_cb(), blender::ED_screen_area_active(), blender::ED_screen_draw_edges(), blender::ED_screens_init(), blender::ED_view3d_cursor_snap_data_update(), blender::file_main_region_draw(), blender::ui::get_view_focused(), blender::ghost_event_proc(), blender::gizmo_mesh_placement_modal_from_setup(), blender::gizmo_mesh_spin_redo_modal_from_setup(), blender::gizmo_mesh_spin_redo_setup(), blender::gizmo_preselect_elem_test_select(), blender::ui::handle_layer_buttons(), blender::ui::handler_region_drag_toggle(), blender::ui::item_enum_expand_handle(), blender::ui::layer_but_cb(), blender::ed::vse::load_data_init_from_operator(), blender::ui::menu_types_add_from_keymap_items(), blender::ed::space_node::node_cursor(), blender::ed::space_node::node_draw_space(), blender::ed::outliner::outliner_collection_set_flag_recursive_fn(), blender::ed::outliner::outliner_mode_toggle_fn(), blender::ed::outliner::outliner_object_set_flag_recursive_fn(), blender::ui::panel_activate_state(), blender::ui::panel_drag_collapse_handler(), blender::ui::panel_drag_collapse_handler_add(), blender::ui::panel_handle_data_ensure(), blender::ui::pie_menu_end(), blender::ui::pie_menu_level_invoke(), blender::ui::popover_end(), blender::ui::popover_panel_create(), blender::ui::popup_block_close(), blender::ui::popup_block_create(), blender::ui::popup_block_ex(), blender::ui::popup_block_invoke_ex(), blender::ui::popup_block_refresh(), blender::ui::popup_handler(), blender::ui::popup_menu_create_impl(), blender::ui::popup_menu_end(), blender::ui::refresh_for_srna_unregister(), blender::render_view_open(), blender::screen_change_prepare(), blender::screen_ctx_ui_list(), blender::screen_draw_join_highlight(), blender::screen_refresh_if_needed(), blender::ui::scroller_activate_poll(), blender::ui::search_menu_create_tooltip(), blender::ui::searchbox_update(), blender::ui::selectcontext_apply(), blender::ed::vse::sequencer_drop_copy(), blender::ed::vse::sequencer_main_cursor(), blender::snap_gizmo_test_select(), blender::ed::spreadsheet::spreadsheet_cursor(), blender::text_cursor(), blender::ui::textedit_begin(), blender::ui::tooltip_create_from_button_or_extra_icon(), blender::ui::tooltip_create_from_gizmo(), blender::ui::tooltip_create_from_search_item_generic(), blender::ed::transform::transform_mode_snap_source_init(), blender::ui::try_activate_rna_button(), blender::ui_handler_wait_for_input(), blender::ui::uilist_focused_poll(), blender::ui::uiTemplateInputStatus(), blender::ui::uiTemplateInputStatusBorder(), blender::v3d_cursor_snap_draw_fn(), blender::v3d_cursor_snap_poll_fn(), blender::ui::view_drop_poll(), blender::ui::view_drop_tooltip(), blender::ui::view_scrolldown_exec(), blender::ui::view_scrollup_exec(), blender::window_manager_blend_read_data(), blender::window_set_custom_cursor_generator(), blender::window_set_custom_cursor_pixmap(), blender::wm_autosave_timer(), blender::wm_block_splash_close_on_fileselect(), blender::wm_cursor_arrow_move(), blender::WM_cursor_grab_disable(), blender::WM_cursor_grab_enable(), blender::wm_cursor_position_from_ghost_client_coords(), blender::wm_cursor_position_from_ghost_screen_coords(), blender::wm_cursor_position_get(), blender::wm_cursor_position_to_ghost_client_coords(), blender::wm_cursor_position_to_ghost_screen_coords(), blender::WM_cursor_set(), blender::wm_cursor_text_generator(), blender::wm_cursor_text_pixmap(), blender::wm_cursor_time_large(), blender::wm_cursor_time_small(), blender::WM_cursor_warp(), blender::wm_drags_draw(), blender::wm_drags_exit(), blender::wm_draw_callbacks(), blender::WM_draw_cb_activate(), blender::WM_draw_cb_exit(), blender::wm_draw_update(), blender::wm_draw_window(), blender::wm_draw_window_onscreen(), blender::wm_dropbox_active(), blender::WM_event_add_fileselect(), blender::wm_event_add_ghostevent(), blender::wm_event_add_intern(), blender::wm_event_add_mousemove(), blender::wm_event_add_mousemove_to_head(), blender::WM_event_add_simulate(), blender::wm_event_add_trackpad(), blender::wm_event_cursor_other_windows(), blender::wm_event_do_handlers(), blender::wm_event_do_notifiers(), blender::WM_event_fileselect_event(), blender::wm_event_free_all(), blender::wm_event_free_and_remove_from_queue_if_valid(), blender::wm_event_free_last(), blender::wm_event_free_last_handled(), blender::wm_event_init_from_window(), blender::wm_event_is_ignorable_key_press(), blender::WM_event_modal_handler_area_replace(), blender::WM_event_modal_handler_region_replace(), blender::WM_event_remove_handlers(), blender::WM_event_remove_modal_handler_all(), blender::WM_event_timer_remove(), blender::WM_event_ui_handler_region_popup_replace(), blender::WM_exit_ex(), blender::wm_exit_schedule_delayed_for_window(), blender::wm_file_read_setup_wm_init(), blender::wm_file_read_setup_wm_substitute_old_window(), blender::wm_gesture_draw(), blender::WM_gesture_end(), blender::WM_gesture_new(), blender::WM_gestures_free_all(), blender::WM_gestures_remove(), blender::wm_ghostwindow_destroy(), blender::WM_gizmo_group_refresh(), blender::wm_handler_fileselect_do(), blender::wm_handler_operator_insert(), blender::wm_keymap_item_find_props(), blender::wm_macro_modal(), blender::wm_operator_call_internal(), blender::WM_operator_find_modal_by_type(), blender::WM_operator_handlers_clear(), blender::WM_operator_name_call_ptr_with_depends_on_cursor(), blender::wm_paintcursor_draw(), blender::WM_progress_clear(), blender::WM_progress_set(), blender::wm_software_cursor_draw(), blender::wm_software_cursor_motion_test(), blender::wm_software_cursor_motion_update(), blender::wm_software_cursor_needed_for_window(), blender::WM_stereo3d_enabled(), blender::WM_tooltip_init(), blender::WM_tooltip_timer_init_ex(), blender::wm_window_close(), blender::wm_window_close_request(), blender::wm_window_copy(), blender::wm_window_copy_test(), blender::WM_window_csd_clear_alpha(), blender::WM_window_csd_draw_corner_mask(), blender::WM_window_csd_draw_titlebar(), blender::WM_window_csd_rect_calc(), blender::WM_window_cursor_keymap_status_free(), blender::WM_window_cursor_keymap_status_get(), blender::WM_window_cursor_keymap_status_refresh(), blender::WM_window_decoration_style_apply(), blender::WM_window_decoration_style_flags_get(), blender::WM_window_decoration_style_flags_set(), blender::wm_window_decoration_style_set_from_theme(), blender::WM_window_dpi_get_scale(), blender::WM_window_dpi_set_userdef(), blender::wm_window_ensure_eventstate(), blender::wm_window_free(), blender::wm_window_fullscreen_toggle_exec(), blender::wm_window_get_swap_interval(), blender::wm_window_ghostwindow_add(), blender::wm_window_ghostwindow_ensure(), blender::wm_window_ghostwindows_remove_invalid(), blender::wm_window_grab_warp_region_is_set(), blender::wm_window_lower(), blender::wm_window_make_drawable(), blender::WM_window_modal_keymap_status_draw(), blender::WM_window_native_pixel_coords(), blender::WM_window_native_pixel_size(), blender::WM_window_native_pixel_x(), blender::WM_window_native_pixel_y(), blender::wm_window_new(), blender::WM_window_open(), blender::WM_window_open_temp(), blender::WM_window_pixels_read_from_frontbuffer(), blender::WM_window_pixels_read_sample_from_frontbuffer(), blender::wm_window_raise(), blender::WM_window_rect_calc(), blender::wm_window_reset_drawable(), blender::wm_window_set_drawable(), blender::wm_window_set_size(), blender::wm_window_set_swap_interval(), blender::WM_window_support_hdr_color(), blender::wm_window_swap_buffer_acquire(), blender::wm_window_swap_buffer_release(), blender::WM_window_title_refresh(), blender::WM_window_title_set(), blender::wm_window_title_state_refresh(), blender::wm_window_update_eventstate(), blender::wm_window_update_eventstate_modifiers(), blender::wm_window_update_eventstate_modifiers_clear(), blender::wm_window_update_size_position(), and blender::wm_xr_runtime_data_free().

◆ scene

◆ screen

◆ sizex

short blender::wmWindow::sizex = 0

Window size (in pixels).

Note
Loading a window typically uses the size & position saved in the blend-file, there is an exception for startup files which works as follows: Setting the window size to zero before ghostwin has been set has a special meaning, it causes the window size to be initialized to wm_init_state.size. These default to the main screen size but can be overridden by the --window-geometry command line argument.
Warning
Using these values directly can result in errors on macOS due to HiDPI displays influencing the window native pixel size. See WM_window_native_pixel_size for a general use alternative.

Definition at line 211 of file DNA_windowmanager_types.h.

Referenced by blender::area_join_cursor(), blender::area_join_modal(), blender::ghost_event_proc(), blender::wm_clear_default_size(), blender::wm_file_read_setup_wm_substitute_old_window(), blender::wm_window_close_request(), blender::wm_window_copy(), blender::wm_window_ghostwindow_add(), blender::wm_window_ghostwindow_ensure(), blender::WM_window_native_pixel_size(), blender::WM_window_native_pixel_x(), blender::wm_window_new_exec(), blender::WM_window_open(), and blender::wm_window_update_size_position().

◆ sizey

◆ stereo3d_format

◆ tag_cursor_refresh

◆ unpinned_scene

struct Scene* blender::wmWindow::unpinned_scene = nullptr

The workspace may temporarily override the window's scene with scene pinning. This is the "overridden" or "default" scene to restore when entering a workspace with no scene pinned.

Definition at line 183 of file DNA_windowmanager_types.h.

Referenced by blender::window_manager_foreach_id(), blender::workspace_exit(), and blender::workspace_scene_pinning_update().

◆ view_layer_name

◆ windowstate

◆ winid

◆ workspace_hook

struct WorkSpaceInstanceHook* blender::wmWindow::workspace_hook = nullptr

Definition at line 185 of file DNA_windowmanager_types.h.

Referenced by blender::ed::viewer_path::activate_geometry_node(), blender::area_docking_target(), blender::area_join_cursor(), blender::BKE_workspace_id_tag_all_visible(), blender::BLO_update_defaults_startup_blend(), blender::check_rendered_viewport_visible(), blender::CTX_wm_window_set(), blender::current_screen_compat(), blender::do_version_workspaces_after_lib_link(), blender::do_versions_after_linking_280(), blender::ED_area_init(), blender::ED_screen_change(), blender::ED_screen_global_areas_refresh(), blender::ED_screen_global_areas_sync(), blender::ED_screens_init(), blender::ED_workspace_change(), blender::ED_workspace_duplicate(), blender::ED_workspace_layout_cycle(), blender::find_side_effect_nodes(), blender::ed::geometry::find_verbose_log_contexts(), blender::find_verbose_log_contexts(), blender::nodes::gizmos::foreach_active_gizmo_in_open_editors(), blender::ed::space_node::has_workbench_in_texture_color(), blender::image_walk_id_all_users(), blender::nodes::node_can_sync_cache_clear(), blender::screen_change_update(), blender::screen_new_exec(), blender::space_workspace_cycle_invoke(), blender::ed::viewer_path::update_active_geometry_nodes_viewer(), blender::view3d_data_consistency_ensure(), blender::window_manager_blend_read_data(), blender::window_manager_blend_write(), blender::window_manager_foreach_id(), blender::wm_add_default(), blender::wm_file_read_setup_wm_keep_old(), blender::wm_window_close(), blender::wm_window_copy(), blender::wm_window_free(), blender::WM_window_get_active_layout(), blender::WM_window_get_active_screen(), blender::WM_window_get_active_workspace(), blender::WM_window_is_main_top_level(), blender::wm_window_new(), blender::WM_window_open(), blender::WM_window_set_active_layout(), blender::WM_window_set_active_screen(), blender::WM_window_set_active_view_layer(), blender::WM_windows_scene_data_sync(), blender::workspace_blend_read_after_liblink(), blender::workspace_change_get_new_layout(), and blender::workspace_layout_delete_doit().


The documentation for this struct was generated from the following file: