#include <DNA_windowmanager_types.h>

Public Attributes
struct wmWindow *	next

struct wmWindow *	prev

void *	ghostwin

void *	gpuctx

struct wmWindow *	parent

struct Scene *	scene

struct Scene *	new_scene

char	view_layer_name [64]

struct Scene *	unpinned_scene

struct WorkSpaceInstanceHook *	workspace_hook

ScrAreaMap	global_areas

struct bScreen *screen	DNA_DEPRECATED

int	winid

short	posx

short	posy

short	sizex

short	sizey

char	windowstate

char	active

short	cursor

short	lastcursor

short	modalcursor

short	grabcursor

short	pie_event_type_lock

short	pie_event_type_last

char	addmousemove

char	tag_cursor_refresh

char	event_queue_check_click

char	event_queue_check_drag

char	event_queue_check_drag_handled

char	event_queue_consecutive_gesture_type

int	event_queue_consecutive_gesture_xy [2]

struct wmEvent_ConsecutiveData *	event_queue_consecutive_gesture_data

struct wmEvent *	eventstate

struct wmEvent *	event_last_handled

const struct wmIMEData *	ime_data

char	ime_data_is_composing

char	_pad1 [7]

ListBase	event_queue

ListBase	handlers

ListBase	modalhandlers

ListBase	gesture

struct Stereo3dFormat *	stereo3d_format

ListBase	drawcalls

void *	cursor_keymap_status

uint64_t	eventstate_prev_press_time_ms

Detailed Description

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

Definition at line 275 of file DNA_windowmanager_types.h.

Member Data Documentation

◆ _pad1

char wmWindow::_pad1[7]

Definition at line 396 of file DNA_windowmanager_types.h.

◆ active

char wmWindow::active

Set to 1 if an active window, for quick rejects.

Definition at line 322 of file DNA_windowmanager_types.h.

Referenced by current_screen_compat(), ghost_event_proc(), gizmo_mesh_spin_redo_setup(), and wm_file_read_setup_wm_substitute_old_window().

◆ addmousemove

char wmWindow::addmousemove

Definition at line 342 of file DNA_windowmanager_types.h.

Referenced by ghost_event_proc(), WM_event_add_mousemove(), wm_event_do_handlers(), and WM_toolsystem_ref_set_from_runtime().

◆ cursor

short wmWindow::cursor

Current mouse cursor type.

Definition at line 324 of file DNA_windowmanager_types.h.

Referenced by ui_handle_menu_event(), WM_cursor_modal_set(), WM_cursor_set(), WM_cursor_set_from_tool(), WM_cursor_time(), wm_gizmomap_highlight_set(), and wm_window_ghostwindow_ensure().

◆ cursor_keymap_status

void* wmWindow::cursor_keymap_status

Private runtime info to show text in the status bar.

Definition at line 415 of file DNA_windowmanager_types.h.

Referenced by WM_window_cursor_keymap_status_get(), WM_window_cursor_keymap_status_refresh(), and wm_window_free().

◆ DNA_DEPRECATED

struct bScreen* screen wmWindow::DNA_DEPRECATED

Definition at line 302 of file DNA_windowmanager_types.h.

◆ drawcalls

ListBase wmWindow::drawcalls

Custom drawing callbacks.

Definition at line 412 of file DNA_windowmanager_types.h.

Referenced by wm_draw_callbacks(), WM_draw_cb_activate(), and WM_draw_cb_exit().

◆ event_last_handled

struct wmEvent* wmWindow::event_last_handled

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 388 of file DNA_windowmanager_types.h.

Referenced by ui_popup_block_refresh(), wm_event_add_mousemove_to_head(), wm_event_free_last_handled(), wm_file_read_setup_wm_substitute_old_window(), and wm_window_free().

◆ event_queue

ListBase wmWindow::event_queue

All events wmEvent (ghost level events were handled).

Definition at line 399 of file DNA_windowmanager_types.h.

Referenced by wm_block_splash_close_on_fileselect(), wm_event_add_ex(), wm_event_add_mousemove(), wm_event_add_mousemove_to_head(), wm_event_add_trackpad(), wm_event_do_handlers(), wm_event_free_all(), wm_event_free_last(), and wm_event_is_ignorable_key_press().

◆ event_queue_check_click

char wmWindow::event_queue_check_click

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

Definition at line 348 of file DNA_windowmanager_types.h.

Referenced by wm_event_do_handlers(), and wm_handlers_do().

◆ event_queue_check_drag

char wmWindow::event_queue_check_drag

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

Definition at line 350 of file DNA_windowmanager_types.h.

Referenced by wm_event_do_handlers(), WM_gizmo_group_refresh(), and wm_handlers_do().

◆ event_queue_check_drag_handled

char wmWindow::event_queue_check_drag_handled

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 356 of file DNA_windowmanager_types.h.

Referenced by wm_event_do_handlers(), and wm_handlers_do().

◆ event_queue_consecutive_gesture_data

struct wmEvent_ConsecutiveData* wmWindow::event_queue_consecutive_gesture_data

See WM_event_consecutive_data_get and related API. Freed when consecutive events end.

Definition at line 363 of file DNA_windowmanager_types.h.

Referenced by WM_event_consecutive_data_free(), WM_event_consecutive_data_get(), WM_event_consecutive_data_set(), and wm_window_free().

◆ event_queue_consecutive_gesture_type

char wmWindow::event_queue_consecutive_gesture_type

The last event type (that passed WM_event_consecutive_gesture_test check).

Definition at line 359 of file DNA_windowmanager_types.h.

Referenced by wm_event_do_handlers().

◆ event_queue_consecutive_gesture_xy

int wmWindow::event_queue_consecutive_gesture_xy[2]

The cursor location when event_queue_consecutive_gesture_type was set.

Definition at line 361 of file DNA_windowmanager_types.h.

Referenced by WM_event_consecutive_gesture_test_break(), and wm_event_do_handlers().

◆ eventstate

struct wmEvent* wmWindow::eventstate

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->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 381 of file DNA_windowmanager_types.h.

◆ eventstate_prev_press_time_ms

uint64_t wmWindow::eventstate_prev_press_time_ms

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

Definition at line 421 of file DNA_windowmanager_types.h.

Referenced by wm_event_add_ghostevent().

◆ gesture

ListBase wmWindow::gesture

Gesture stuff.

Definition at line 406 of file DNA_windowmanager_types.h.

Referenced by wm_draw_window_onscreen(), wm_gesture_draw(), WM_gesture_end(), WM_gesture_new(), WM_gestures_free_all(), and WM_gestures_remove().

◆ ghostwin

void* wmWindow::ghostwin

Don't want to include ghost.h stuff.

Definition at line 279 of file DNA_windowmanager_types.h.

Referenced by ghost_event_proc(), screen_refresh(), window_set_custom_cursor(), window_set_custom_cursor_ex(), wm_cursor_arrow_move(), WM_cursor_grab_disable(), WM_cursor_grab_enable(), wm_cursor_position_from_ghost_client_coords(), wm_cursor_position_from_ghost_screen_coords(), wm_cursor_position_get(), wm_cursor_position_to_ghost_client_coords(), wm_cursor_position_to_ghost_screen_coords(), WM_cursor_set(), WM_cursor_warp(), wm_draw_update(), wm_file_read_setup_wm_substitute_old_window(), wm_ghostwindow_destroy(), WM_progress_clear(), WM_progress_set(), wm_software_cursor_draw(), wm_software_cursor_needed_for_window(), WM_stereo3d_enabled(), wm_window_copy(), wm_window_copy_test(), wm_window_fullscreen_toggle_exec(), wm_window_get_swap_interval(), wm_window_ghostwindow_add(), wm_window_ghostwindow_ensure(), wm_window_grab_warp_region_is_set(), wm_window_lower(), wm_window_make_drawable(), WM_window_native_pixel_coords(), WM_window_native_pixel_size(), WM_window_native_pixel_x(), WM_window_native_pixel_y(), WM_window_open(), WM_window_pixels_read_from_frontbuffer(), WM_window_pixels_read_sample_from_frontbuffer(), wm_window_raise(), wm_window_reset_drawable(), WM_window_set_dpi(), wm_window_set_drawable(), wm_window_set_size(), wm_window_set_swap_interval(), wm_window_swap_buffers(), WM_window_title(), and wm_window_update_size_position().

◆ global_areas

ScrAreaMap wmWindow::global_areas

Global areas aren't part of the screen, but part of the window directly.

Note: Code assumes global areas with fixed height, fixed width not supported yet

Definition at line 300 of file DNA_windowmanager_types.h.

Referenced by area_docking_apply(), area_join_modal(), area_move_set_limits(), ED_screen_areas_iter_first(), ED_screen_exit(), ED_screen_global_areas_refresh(), ED_screen_global_areas_sync(), ED_screen_state_toggle(), screen_geom_find_active_scredge(), screen_geom_vertices_scale(), screen_global_area_refresh(), screen_state_to_nonnormal(), wm_check_area_exists(), wm_window_free(), WM_window_screen_rect_calc(), and WM_window_status_area_find().

◆ gpuctx

void* wmWindow::gpuctx

Don't want to include gpu stuff.

Definition at line 281 of file DNA_windowmanager_types.h.

Referenced by wm_draw_window(), wm_file_read_setup_wm_substitute_old_window(), wm_ghostwindow_destroy(), wm_window_ghostwindow_add(), WM_window_pixels_read_from_frontbuffer(), WM_window_pixels_read_sample_from_frontbuffer(), and wm_window_set_drawable().

◆ grabcursor

short wmWindow::grabcursor

Cursor grab mode GHOST_TGrabCursorMode (run-time only)

Definition at line 330 of file DNA_windowmanager_types.h.

Referenced by image_view_pan_init(), image_view_zoom_init(), blender::ed::sculpt_paint::paint_update_mouse_cursor(), view_pan_init(), view_pan_invoke(), view_zoom_init(), view_zoomdrag_invoke(), WM_cursor_grab_disable(), WM_cursor_grab_enable(), wm_drags_draw(), wm_gizmomap_modal_set(), and wm_window_grab_warp_region_is_set().

◆ handlers

ListBase wmWindow::handlers

Window+screen handlers, handled last.

Definition at line 401 of file DNA_windowmanager_types.h.

Referenced by menu_types_add_from_keymap_items(), wm_dropbox_active(), wm_event_do_handlers(), wm_keymap_item_find_props(), wm_window_close(), WM_window_cursor_keymap_status_refresh(), wm_window_free(), and wm_window_ghostwindow_ensure().

◆ ime_data

const struct wmIMEData* wmWindow::ime_data

Input Method Editor data - complex character input (especially for Asian character input) Currently WIN32 and APPLE, runtime-only data.

Definition at line 394 of file DNA_windowmanager_types.h.

Referenced by ui_do_but_textedit(), ui_textedit_end(), and wm_event_add_ghostevent().

◆ ime_data_is_composing

char wmWindow::ime_data_is_composing

Definition at line 395 of file DNA_windowmanager_types.h.

Referenced by ui_do_but_textedit(), and wm_event_add_ghostevent().

◆ lastcursor

short wmWindow::lastcursor

Previous cursor when setting modal one.

Definition at line 326 of file DNA_windowmanager_types.h.

Referenced by WM_cursor_modal_restore(), WM_cursor_modal_set(), and WM_cursor_time().

◆ modalcursor

short wmWindow::modalcursor

The current modal cursor.

Definition at line 328 of file DNA_windowmanager_types.h.

Referenced by ui_handle_menu_event(), WM_cursor_modal_restore(), WM_cursor_modal_set(), WM_cursor_set(), and WM_cursor_set_from_tool().

◆ modalhandlers

ListBase wmWindow::modalhandlers

Priority handlers, handled first.

Definition at line 403 of file DNA_windowmanager_types.h.

Referenced by ghost_event_proc(), panel_activate_state(), panel_handle_data_ensure(), screen_change_prepare(), ui_block_free_func_POPOVER(), ui_handler_region_drag_toggle(), ui_handler_wait_for_input(), ui_panel_drag_collapse_handler(), ui_panel_drag_collapse_handler_add(), UI_pie_menu_end(), UI_popover_end(), ui_popover_panel_create(), UI_popup_block_close(), UI_popup_block_ex(), UI_popup_block_invoke_ex(), ui_popup_handler(), ui_popup_menu_create_impl(), UI_popup_menu_end(), WM_event_add_fileselect(), wm_event_cursor_other_windows(), wm_event_do_handlers(), WM_event_modal_handler_area_replace(), WM_event_modal_handler_region_replace(), WM_event_remove_modal_handler_all(), WM_event_ui_handler_region_popup_replace(), wm_exit_schedule_delayed(), wm_handler_operator_insert(), wm_keymap_item_find_props(), wm_macro_modal(), WM_operator_find_modal_by_type(), WM_operator_name_call_ptr_with_depends_on_cursor(), wm_window_close(), wm_window_free(), wm_window_ghostwindow_ensure(), and WM_window_modal_keymap_status_draw().

◆ new_scene

struct Scene* wmWindow::new_scene

Temporary when switching.

Definition at line 289 of file DNA_windowmanager_types.h.

◆ next

struct wmWindow* wmWindow::next

Definition at line 276 of file DNA_windowmanager_types.h.

Referenced by current_screen_compat(), render_image_update_pass_and_layer(), WM_cursor_wait(), WM_toolsystem_do_msg_notify_tag_refresh(), and wm_window_close().

◆ parent

struct wmWindow* wmWindow::parent

Parent window.

Definition at line 284 of file DNA_windowmanager_types.h.

Referenced by blend_file_thumb_from_screenshot(), ED_area_find_under_cursor(), ED_screen_global_areas_refresh(), window_manager_blend_read_data(), wm_event_find_fileselect_root_window_from_context(), wm_test_autorun_warning(), wm_test_gpu_backend_fallback(), wm_test_opengl_deprecation_warning(), wm_window_close(), wm_window_copy(), wm_window_ghostwindow_add(), wm_window_new(), WM_window_set_active_scene(), WM_window_set_active_view_layer(), WM_window_set_active_workspace(), and WM_window_title().

◆ pie_event_type_last

short wmWindow::pie_event_type_last

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 340 of file DNA_windowmanager_types.h.

Referenced by UI_pie_menu_begin(), and ui_popup_handler().

◆ pie_event_type_lock

short wmWindow::pie_event_type_lock

Internal: tag this for extra mouse-move event, makes cursors/buttons active on UI switching. Internal, lock pie creation from this event until released.

Definition at line 335 of file DNA_windowmanager_types.h.

Referenced by UI_pie_menu_begin(), and wm_event_pie_filter().

◆ posx

short wmWindow::posx

Window coords (in pixels).

Definition at line 307 of file DNA_windowmanager_types.h.

Referenced by area_docking_target(), ghost_event_proc(), wm_file_read_setup_wm_substitute_old_window(), wm_window_copy(), wm_window_ghostwindow_add(), wm_window_ghostwindow_ensure(), WM_window_open(), and wm_window_update_size_position().

◆ posy

short wmWindow::posy

Definition at line 307 of file DNA_windowmanager_types.h.

Referenced by area_docking_target(), ghost_event_proc(), wm_file_read_setup_wm_substitute_old_window(), wm_window_copy(), wm_window_ghostwindow_add(), wm_window_ghostwindow_ensure(), WM_window_open(), and wm_window_update_size_position().

◆ prev

struct wmWindow * wmWindow::prev

Definition at line 276 of file DNA_windowmanager_types.h.

◆ scene

struct Scene* wmWindow::scene

Active scene displayed in this window.

Definition at line 287 of file DNA_windowmanager_types.h.

Referenced by buttons_context_path_view_layer(), buttons_texture_users_from_context(), CTX_wm_window_set(), current_screen_compat(), ED_screen_scene_change(), sequencer_main_cursor(), setup_app_data(), wm_add_default(), wm_event_do_notifiers(), wm_event_get_keymap_from_toolsystem_ex(), wm_window_copy(), WM_window_get_active_scene(), and WM_window_set_active_scene().

◆ sizex

short wmWindow::sizex

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.

Definition at line 318 of file DNA_windowmanager_types.h.

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

◆ sizey

short wmWindow::sizey

Definition at line 318 of file DNA_windowmanager_types.h.

Referenced by area_join_cursor(), area_join_modal(), ghost_event_proc(), ui_def_but_rna__menu(), wm_cursor_position_from_ghost_client_coords(), wm_cursor_position_to_ghost_client_coords(), wm_file_read_setup_wm_substitute_old_window(), wm_window_copy(), wm_window_ghostwindow_add(), wm_window_ghostwindow_ensure(), WM_window_native_pixel_size(), WM_window_native_pixel_y(), wm_window_new_exec(), WM_window_open(), and wm_window_update_size_position().

◆ stereo3d_format

struct Stereo3dFormat* wmWindow::stereo3d_format

Properties for stereoscopic displays.

Definition at line 409 of file DNA_windowmanager_types.h.

Referenced by wm_draw_window(), wm_draw_window_offscreen(), wm_stereo3d_draw_sidebyside(), WM_stereo3d_enabled(), wm_stereo3d_mouse_offset_apply(), wm_stereo3d_set_exec(), wm_stereo3d_set_init(), wm_window_copy(), wm_window_free(), wm_window_ghostwindow_add(), wm_window_new(), and WM_window_open().

◆ tag_cursor_refresh

char wmWindow::tag_cursor_refresh

Definition at line 343 of file DNA_windowmanager_types.h.

Referenced by region_cursor_set_ex(), ui_popup_block_remove(), wm_drags_exit(), and WM_toolsystem_ref_set_from_runtime().

◆ unpinned_scene

struct Scene* wmWindow::unpinned_scene

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 294 of file DNA_windowmanager_types.h.

Referenced by workspace_exit(), and workspace_scene_pinning_update().

◆ view_layer_name

char wmWindow::view_layer_name[64]

Active view layer displayed in this window.

Definition at line 291 of file DNA_windowmanager_types.h.

Referenced by CTX_data_view_layer(), current_screen_compat(), wm_add_default(), wm_window_copy(), WM_window_ensure_active_view_layer(), WM_window_get_active_view_layer(), and WM_window_open().

◆ windowstate

char wmWindow::windowstate

Normal, maximized, full-screen, GHOST_TWindowState.

Definition at line 320 of file DNA_windowmanager_types.h.

Referenced by ghost_event_proc(), wm_window_ghostwindow_add(), wm_window_ghostwindow_ensure(), WM_window_is_fullscreen(), and WM_window_is_maximized().

◆ winid

int wmWindow::winid

Window-ID also in screens, is for retrieving this window after read.

Definition at line 305 of file DNA_windowmanager_types.h.

Referenced by blo_do_versions_290(), ED_workspace_change(), ghost_event_proc(), screen_is_used_by_other_window(), screen_new_activate_prepare(), screen_refresh(), wm_add_default(), wm_draw_update_test_window(), wm_software_cursor_motion_clear_with_window(), wm_software_cursor_motion_test(), wm_software_cursor_motion_update(), wm_window_copy(), wm_window_make_drawable(), wm_window_new(), WM_window_set_active_layout(), and WM_window_set_active_screen().

◆ workspace_hook

struct WorkSpaceInstanceHook* wmWindow::workspace_hook

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

DNA_windowmanager_types.h

Public Attributes