Blender V5.3
blender::bke::WindowRuntime Struct Reference

#include <BKE_wm_runtime.hh>

Public Member Functions

 WindowRuntime ()=default
 ~WindowRuntime ()

Public Attributes

ListBaseT< wmEvent > event_queue = {nullptr, nullptr}
wmIMEData * ime_data = nullptr
std::optional< wmIMEOwnerType > ime_owner
bool ime_data_is_composing = false
std::string recents_storage_key = {}
void * ghostwin = nullptr
void * gpuctx = nullptr
ListBaseT< wmEventHandler > handlers = {nullptr, nullptr}
ListBaseT< wmEventHandler > modalhandlers = {nullptr, nullptr}
ListBaseT< WindowDrawCB > drawcalls = {nullptr, nullptr}
ListBaseT< wmGesture > gesture = {nullptr, nullptr}
wmEvent * event_last_handled = nullptr
wmEvent * eventstate = nullptr
uint64_t eventstate_prev_press_time_ms = 0
void * cursor_keymap_status = nullptr

Detailed Description

Definition at line 151 of file BKE_wm_runtime.hh.

Constructor & Destructor Documentation

◆ WindowRuntime()

blender::bke::WindowRuntime::WindowRuntime ( )
default

References WindowRuntime().

Referenced by WindowRuntime().

◆ ~WindowRuntime()

blender::bke::WindowRuntime::~WindowRuntime ( )

The event_queue should be freed when the window is freed.

Definition at line 62 of file wm_runtime.cc.

References blender::BLI_assert(), event_queue, and ime_data.

Member Data Documentation

◆ cursor_keymap_status

void* blender::bke::WindowRuntime::cursor_keymap_status = nullptr

Private runtime info to show text in the status bar.

Definition at line 242 of file BKE_wm_runtime.hh.

Referenced by blender::WM_window_cursor_keymap_status_free(), blender::WM_window_cursor_keymap_status_get(), and blender::WM_window_cursor_keymap_status_refresh().

◆ drawcalls

ListBaseT<WindowDrawCB> blender::bke::WindowRuntime::drawcalls = {nullptr, nullptr}

◆ event_last_handled

wmEvent* blender::bke::WindowRuntime::event_last_handled = nullptr

Keep the last handled event in event_queue here (owned and must be freed).

Warning
This must only to be used for event queue logic. User interactions should use eventstate instead (if the event isn't passed to the function).

Definition at line 215 of file BKE_wm_runtime.hh.

Referenced by blender::ui::popup_block_refresh(), blender::wm_event_add_mousemove_to_head(), blender::wm_event_free_last_handled(), blender::wm_file_read_setup_wm_substitute_old_window(), and blender::wm_window_free().

◆ event_queue

◆ eventstate

wmEvent* blender::bke::WindowRuntime::eventstate = nullptr

Storage for event system.

For the most part this is storage for wmEvent.xy & wmEvent.modifiers. newly added key/button events copy the cursor location and modifier state stored here.

It's also convenient at times to be able to pass this as if it's a regular event.

  • This is not simply the current event being handled. The type and value is always set to the last press/release events otherwise cursor motion would always clear these values.
  • The value of eventstate->Object Modifiers is set from the last pressed/released modifier key. This has the down side that the modifier value will be incorrect if users hold both left/right modifiers then release one. See note in wm_event_add_ghostevent for details.

Definition at line 233 of file BKE_wm_runtime.hh.

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::but_tooltip_init(), blender::ed::outliner::collection_drop_tooltip(), blender::console_cursor(), 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::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_drag_collapse_handler_add(), blender::ui::panel_handle_data_ensure(), blender::ui::pie_menu_level_invoke(), blender::ui::popover_panel_create(), blender::ui::popup_block_create(), blender::ui::popup_block_refresh(), blender::ui::popup_menu_create_impl(), blender::ui::popup_menu_end(), blender::screen_ctx_ui_list(), blender::screen_draw_join_highlight(), 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::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::WM_cursor_grab_enable(), blender::wm_cursor_position_get(), blender::WM_cursor_warp(), blender::wm_drags_draw(), blender::wm_drags_exit(), blender::WM_event_add_fileselect(), blender::wm_event_add_ghostevent(), blender::wm_event_add_mousemove(), blender::WM_event_add_simulate(), blender::wm_event_do_handlers(), blender::WM_event_fileselect_event(), blender::wm_event_init_from_window(), blender::WM_event_remove_handlers(), blender::wm_file_read_setup_wm_substitute_old_window(), blender::WM_gizmo_group_refresh(), blender::wm_handler_fileselect_do(), blender::wm_operator_call_internal(), blender::wm_paintcursor_draw(), blender::wm_software_cursor_draw(), blender::wm_software_cursor_motion_test(), blender::wm_software_cursor_motion_update(), blender::WM_tooltip_init(), blender::WM_tooltip_timer_init_ex(), blender::WM_window_cursor_keymap_status_refresh(), blender::wm_window_ensure_eventstate(), blender::wm_window_free(), blender::WM_window_open_temp(), blender::wm_window_update_eventstate(), blender::wm_window_update_eventstate_modifiers(), and blender::wm_window_update_eventstate_modifiers_clear().

◆ eventstate_prev_press_time_ms

uint64_t blender::bke::WindowRuntime::eventstate_prev_press_time_ms = 0

The time when the key is pressed in milliseconds (see GHOST_IEvent::getTime). Used to detect double-click events.

Definition at line 239 of file BKE_wm_runtime.hh.

Referenced by blender::wm_event_add_ghostevent().

◆ gesture

◆ ghostwin

void* blender::bke::WindowRuntime::ghostwin = nullptr

Don't want to include ghost.h stuff.

Definition at line 192 of file BKE_wm_runtime.hh.

Referenced by blender::ED_area_newspace(), blender::ui::popup_block_create(), blender::screen_refresh_if_needed(), blender::window_set_custom_cursor_generator(), blender::window_set_custom_cursor_pixmap(), 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_draw_update(), blender::wm_file_read_setup_wm_substitute_old_window(), blender::wm_ghostwindow_destroy(), blender::WM_progress_clear(), blender::WM_progress_set(), blender::wm_software_cursor_draw(), blender::wm_software_cursor_needed_for_window(), blender::WM_stereo3d_enabled(), 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_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_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_native_pixel_coords(), blender::WM_window_native_pixel_size(), blender::WM_window_native_pixel_x(), blender::WM_window_native_pixel_y(), blender::WM_window_open(), 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(), and blender::wm_window_update_size_position().

◆ gpuctx

◆ handlers

◆ ime_data

wmIMEData* blender::bke::WindowRuntime::ime_data = nullptr

Input Method Editor data - complex character input (especially for Asian character input) Only used when WITH_INPUT_IME is defined.

Definition at line 159 of file BKE_wm_runtime.hh.

Referenced by blender::ui::do_but_textedit(), blender::wm_event_add_ghostevent(), and ~WindowRuntime().

◆ ime_data_is_composing

bool blender::bke::WindowRuntime::ime_data_is_composing = false

True while the user is composing text via an IME (set by WM_IME_COMPOSITE_START, cleared by WM_IME_COMPOSITE_END or #WM_window_IME_end).

Operators

When true, text input operators that support IME are skipped (returning canceled). This is needed because keys that edit the composition (backspace, enter, arrow-keys... etc) are consumed by the IME but also pass-through as regular key events, which the key-map handles as usual: a backspace that removes a pre-edit character would also delete committed text. Theoretically these events could be filtered out before being handled, however only the IME knows which keys it consumes and this isn't exposed by any API, so operators must skip them while composing. Canceling instead of passing the event through prevents other key-map items from matching it.

See:

  • #WM_operator_IME_edit_maybe
  • #WM_operator_IME_insert_maybe

Definition at line 186 of file BKE_wm_runtime.hh.

Referenced by blender::ui::do_but_textedit(), and blender::wm_event_add_ghostevent().

◆ ime_owner

std::optional<wmIMEOwnerType> blender::bke::WindowRuntime::ime_owner

The UI element this session was begun with. Set by #WM_window_IME_begin, cleared by #WM_window_IME_end.

Definition at line 164 of file BKE_wm_runtime.hh.

◆ modalhandlers

ListBaseT<wmEventHandler> blender::bke::WindowRuntime::modalhandlers = {nullptr, nullptr}

Priority handlers, handled first.

Definition at line 201 of file BKE_wm_runtime.hh.

Referenced by blender::ui::block_free_func_POPOVER(), blender::ghost_event_proc(), blender::ui::handler_region_drag_toggle(), 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::popover_end(), blender::ui::popover_panel_create(), blender::ui::popup_block_close(), blender::ui::popup_block_ex(), blender::ui::popup_block_invoke_ex(), blender::ui::popup_handler(), blender::ui::popup_menu_create_impl(), blender::ui::popup_menu_end(), blender::ui::refresh_for_srna_unregister(), blender::screen_change_prepare(), blender::ui_handler_wait_for_input(), blender::wm_autosave_timer(), blender::WM_event_add_fileselect(), blender::wm_event_cursor_other_windows(), blender::wm_event_do_handlers(), blender::wm_event_do_notifiers(), blender::WM_event_modal_handler_area_replace(), blender::WM_event_modal_handler_region_replace(), blender::WM_event_remove_modal_handler_all(), 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_handler_operator_insert(), blender::wm_keymap_item_find_props(), blender::wm_macro_modal(), blender::WM_operator_find_modal_by_type(), blender::WM_operator_handlers_clear(), blender::WM_operator_name_call_ptr_with_depends_on_cursor(), blender::wm_window_close(), blender::wm_window_free(), blender::wm_window_ghostwindow_ensure(), and blender::WM_window_modal_keymap_status_draw().

◆ recents_storage_key

std::string blender::bke::WindowRuntime::recents_storage_key = {}

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