#include "BLI_compiler_attrs.h"

Functions
void	wm_ghost_init (bContext *C)
void	wm_ghost_init_background ()
void	wm_ghost_exit ()
void	wm_clipboard_free ()
bool	wm_get_screensize (int r_size[2]) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT
bool	wm_get_desktopsize (int r_size[2]) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT
wmWindow *	wm_window_new (const Main bmain, wmWindowManager wm, wmWindow *parent, bool dialog)
wmWindow *	wm_window_copy (Main bmain, wmWindowManager wm, wmWindow *win_src, bool duplicate_layout, bool child)
wmWindow *	wm_window_copy_test (bContext C, wmWindow win_src, bool duplicate_layout, bool child)
void	wm_window_free (bContext C, wmWindowManager wm, wmWindow *win)
void	wm_window_close (bContext C, wmWindowManager wm, wmWindow *win)
void	wm_window_ghostwindows_ensure (wmWindowManager *wm)
void	wm_window_ghostwindows_remove_invalid (bContext C, wmWindowManager wm)
void	wm_window_events_process (const bContext *C)
void	wm_window_clear_drawable (wmWindowManager *wm)
void	wm_window_make_drawable (wmWindowManager wm, wmWindow win)
void	wm_window_reset_drawable ()
void	wm_window_raise (wmWindow *win)
void	wm_window_lower (wmWindow *win)
void	wm_window_set_size (wmWindow *win, int width, int height)
void	wm_window_swap_buffer_acquire (wmWindow *win)
	Push rendered buffer to the screen.
void	wm_window_swap_buffer_release (wmWindow *win)
void	wm_window_set_swap_interval (wmWindow *win, int interval)
bool	wm_window_get_swap_interval (wmWindow win, int r_interval)
bool	wm_cursor_position_get (wmWindow win, int r_x, int *r_y) ATTR_WARN_UNUSED_RESULT
void	wm_cursor_position_from_ghost_screen_coords (wmWindow win, int x, int *y)
void	wm_cursor_position_to_ghost_screen_coords (wmWindow win, int x, int *y)
void	wm_cursor_position_from_ghost_client_coords (wmWindow win, int x, int *y)
void	wm_cursor_position_to_ghost_client_coords (wmWindow win, int x, int *y)
void	wm_window_timers_delete_removed (wmWindowManager *wm)
wmOperatorStatus	wm_window_close_exec (bContext C, wmOperator op)
wmOperatorStatus	wm_window_fullscreen_toggle_exec (bContext C, wmOperator op)
void	wm_quit_with_optional_confirmation_prompt (bContext C, wmWindow win) ATTR_NONNULL()
wmOperatorStatus	wm_window_new_exec (bContext C, wmOperator op)
wmOperatorStatus	wm_window_new_main_exec (bContext C, wmOperator op)
void	wm_test_autorun_revert_action_set (wmOperatorType ot, PointerRNA ptr)
void	wm_test_autorun_warning (bContext *C)
void	wm_test_foreign_file_warning (bContext *C)

Function Documentation

◆ wm_clipboard_free()

void wm_clipboard_free ( )

Definition at line 2455 of file wm_window.cc.

References ARRAY_SIZE, g_wm_clipboard_text_simulate, i, and MEM_freeN().

Referenced by WM_exit_ex().

◆ wm_cursor_position_from_ghost_client_coords()

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

Definition at line 1437 of file wm_window.cc.

References GHOST_GetNativePixelSize(), wmWindow::ghostwin, wmWindow::sizey, x, and y.

Referenced by wm_cursor_position_from_ghost_screen_coords(), and wm_cursor_position_get().

◆ wm_cursor_position_from_ghost_screen_coords()

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

Definition at line 1455 of file wm_window.cc.

References GHOST_ScreenToClient(), wmWindow::ghostwin, wm_cursor_position_from_ghost_client_coords(), x, and y.

Referenced by ghost_event_proc(), wm_event_add_ghostevent(), and WM_window_find_under_cursor().

◆ wm_cursor_position_get()

bool wm_cursor_position_get	(	wmWindow *	win,
		int *	r_x,
		int *	r_y )

Definition at line 1467 of file wm_window.cc.

References wmWindow::eventstate, G, G_FLAG_EVENT_SIMULATE, g_system, GHOST_GetCursorPosition(), GHOST_kSuccess, wmWindow::ghostwin, UNLIKELY, wm_cursor_position_from_ghost_client_coords(), and wmEvent::xy.

Referenced by area_join_update_data(), wm_cursor_warp_relative(), wm_drags_draw(), wm_handler_fileselect_do(), wm_paintcursor_draw(), and wm_window_update_eventstate().

◆ wm_cursor_position_to_ghost_client_coords()

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

Definition at line 1446 of file wm_window.cc.

References GHOST_GetNativePixelSize(), wmWindow::ghostwin, wmWindow::sizey, x, and y.

Referenced by wm_cursor_position_to_ghost_screen_coords(), and WM_cursor_warp().

◆ wm_cursor_position_to_ghost_screen_coords()

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

Definition at line 1461 of file wm_window.cc.

References GHOST_ClientToScreen(), wmWindow::ghostwin, wm_cursor_position_to_ghost_client_coords(), x, and y.

Referenced by WM_cursor_grab_disable(), WM_cursor_grab_enable(), and WM_window_find_under_cursor().

◆ wm_get_desktopsize()

bool wm_get_desktopsize ( int r_size[2] )

Size of all screens (desktop), useful since the mouse is bound by this.

Returns: true on success.

Definition at line 192 of file wm_window.cc.

References g_system, GHOST_GetAllDisplayDimensions(), and GHOST_kFailure.

Referenced by wm_window_ghostwindow_add(), and wm_window_update_size_position().

◆ wm_get_screensize()

bool wm_get_screensize ( int r_size[2] )

This one should correctly check for apple top header... done for Cocoa: returns window contents (and not frame) max size.

Returns: true on success.

Definition at line 181 of file wm_window.cc.

References g_system, GHOST_GetMainDisplayDimensions(), and GHOST_kFailure.

Referenced by wm_window_check_size(), and wm_window_ghostwindows_ensure().

◆ wm_ghost_exit()

void wm_ghost_exit ( )

Definition at line 2173 of file wm_window.cc.

References g_system, and GHOST_DisposeSystem().

Referenced by WM_exit_ex().

◆ wm_ghost_init()

void wm_ghost_init ( bContext * C )

Note: bContext can be null in background mode because we don't need to event handling.

Definition at line 2106 of file wm_window.cc.

References BLI_assert, BLI_assert_msg, BLI_system_backtrace(), C, CLOG_STR_ERROR, GHOST_Debug::flags, G, G_DEBUG_GHOST, G_DEBUG_WINTAB, g_system, g_system_backend_id, GHOST_AddEventConsumer(), GHOST_CreateEventConsumer(), GHOST_CreateSystem(), ghost_event_proc(), GHOST_kDebugDefault, GHOST_kDebugWintab, GHOST_SetBacktraceHandler(), GHOST_SystemBackend(), GHOST_SystemInitDebug(), GHOST_UseNativePixels(), GHOST_UseWindowFocus(), GHOST_UseWindowFrame(), GPU_backend_ghost_system_set(), LOG_GHOST_SYSTEM, UNLIKELY, and wm_init_state.

Referenced by WM_init().

◆ wm_ghost_init_background()

void wm_ghost_init_background ( )

Definition at line 2153 of file wm_window.cc.

References BLI_system_backtrace(), GHOST_Debug::flags, G, G_DEBUG_GHOST, g_system, GHOST_CreateSystemBackground(), GHOST_kDebugDefault, GHOST_SetBacktraceHandler(), GHOST_SystemInitDebug(), and GPU_backend_ghost_system_set().

Referenced by WM_init_gpu().

◆ wm_quit_with_optional_confirmation_prompt()

void wm_quit_with_optional_confirmation_prompt	(	bContext *	C,
		wmWindow *	win )

Call the quit confirmation prompt or exit directly if needed. The use can still cancel via the confirmation popup. Also, this may not quit Blender immediately, but rather schedule the closing.

Parameters

win	The window to show the confirmation popup/window in.

Definition at line 407 of file wm_window.cc.

References C, CTX_data_main(), CTX_wm_manager(), CTX_wm_window(), CTX_wm_window_set(), G, U, USER_SAVE_PROMPT, wm_confirm_quit(), wm_exit_schedule_delayed(), wm_file_or_session_data_has_unsaved_changes(), and wm_window_raise().

Referenced by ghost_event_proc(), wm_exit_blender_invoke(), and wm_window_close().

◆ wm_test_autorun_revert_action_set()

void wm_test_autorun_revert_action_set	(	wmOperatorType *	ot,
		PointerRNA *	ptr )

Definition at line 4241 of file wm_files.cc.

References BLI_assert, G, ot, ptr, WM_operator_properties_free(), and wm_test_autorun_revert_action_data.

Referenced by wm_block_autorun_warning_ignore(), WM_exit_ex(), wm_file_read_post(), wm_recover_auto_save_exec(), wm_recover_last_session_impl(), and wm_test_autorun_revert_action_exec().

◆ wm_test_autorun_warning()

void wm_test_autorun_warning ( bContext * C )

Definition at line 4274 of file wm_files.cc.

References block_create_autorun_warning(), C, CTX_wm_manager(), CTX_wm_window(), CTX_wm_window_set(), G, G_FLAG_SCRIPT_AUTOEXEC_FAIL, G_FLAG_SCRIPT_AUTOEXEC_FAIL_QUIET, wmWindow::parent, and UI_popup_block_invoke().

Referenced by wm_event_do_notifiers().

◆ wm_test_foreign_file_warning()

void wm_test_foreign_file_warning ( bContext * C )

Definition at line 4305 of file wm_files.cc.

References ALERT_ICON_ERROR, C, CTX_wm_manager(), CTX_wm_window(), CTX_wm_window_set(), G_MAIN, wmWindow::parent, RPT_, and UI_alert().

Referenced by wm_event_do_notifiers().

◆ wm_window_clear_drawable()

void wm_window_clear_drawable ( wmWindowManager * wm )

Definition at line 1510 of file wm_window.cc.

References wmWindowManager::runtime.

Referenced by blend_file_thumb_from_camera(), wm_draw_surface(), wm_draw_update(), wm_file_read_setup_wm_use_new(), wm_ghostwindow_destroy(), wm_userpref_read_exec(), wm_window_ghostwindow_add(), wm_window_make_drawable(), and wm_window_reset_drawable().

◆ wm_window_close()

void wm_window_close	(	bContext *	C,
		wmWindowManager *	wm,
		wmWindow *	win )

This is event from ghost, or exit-Blender operator.

Definition at line 463 of file wm_window.cc.

References bScreen::areabase, BKE_workspace_active_layout_get(), BKE_workspace_layout_remove(), BKE_workspace_layout_screen_get(), BLI_assert, BLI_listbase_is_single(), BLI_remlink(), C, CTX_data_main(), CTX_wm_window_set(), ED_screen_exit(), ListBase::first, float, GHOST_GetNativePixelSize(), wmWindow::ghostwin, wmWindow::handlers, LISTBASE_FOREACH_MUTABLE, wmWindow::modalhandlers, NA_REMOVED, NC_SCREEN, NC_WINDOW, ND_LAYOUTDELETE, wmWindow::next, wmWindow::parent, wmWindow::posx, wmWindow::posy, wmWindow::sizex, wmWindow::sizey, ScrArea::spacetype, stored_window_bounds(), bScreen::temp, U, UI_SCALE_FAC, wmWindowManager::windows, WM_event_add_notifier(), WM_event_remove_handlers(), WM_main_add_notifier(), wm_quit_with_optional_confirmation_prompt(), wm_window_close(), WM_window_dpi_set_userdef(), wm_window_free(), WM_window_get_active_screen(), WM_window_get_active_workspace(), WM_window_is_main_top_level(), WM_window_is_maximized(), WM_window_is_temp_screen(), wmWindow::workspace_hook, rctf::xmax, rctf::xmin, rctf::ymax, and rctf::ymin.

Referenced by area_join_modal(), ghost_event_proc(), render_view_cancel_exec(), wm_handler_fileselect_do(), wm_homefile_write_exec(), wm_stereo3d_set_exec(), wm_window_close(), wm_window_close_exec(), wm_window_copy_test(), wm_window_ghostwindows_remove_invalid(), and WM_window_open().

◆ wm_window_close_exec()

wmOperatorStatus wm_window_close_exec	(	bContext *	C,
		wmOperator *	op )

Definition at line 1360 of file wm_window.cc.

References C, CTX_wm_manager(), CTX_wm_window(), OPERATOR_FINISHED, and wm_window_close().

Referenced by WM_OT_window_close().

◆ wm_window_copy()

wmWindow * wm_window_copy	(	Main *	bmain,
		wmWindowManager *	wm,
		wmWindow *	win_src,
		bool	duplicate_layout,
		bool	child )

Part of wm_window.cc API.

Definition at line 335 of file wm_window.cc.

References BKE_workspace_active_layout_set(), BKE_workspace_active_set(), ED_workspace_layout_duplicate(), GHOST_IsDialogWindow(), wmWindow::ghostwin, wmWindow::parent, wmWindow::posx, wmWindow::posy, wmWindow::scene, wmWindow::sizex, wmWindow::sizey, wmWindow::stereo3d_format, STRNCPY_UTF8, wmWindow::view_layer_name, wmWindow::winid, WM_window_get_active_layout(), WM_window_get_active_workspace(), wm_window_new(), and wmWindow::workspace_hook.

Referenced by wm_window_copy_test().

◆ wm_window_copy_test()

wmWindow * wm_window_copy_test	(	bContext *	C,
		wmWindow *	win_src,
		bool	duplicate_layout,
		bool	child )

A higher level version of copy that tests the new window can be added. (called from the operator directly).

Definition at line 365 of file wm_window.cc.

References C, CTX_data_main(), CTX_wm_manager(), CTX_wm_window(), wmWindow::ghostwin, NA_ADDED, NC_WINDOW, WM_check(), WM_event_add_notifier_ex(), wm_window_close(), and wm_window_copy().

Referenced by wm_stereo3d_set_exec(), and wm_window_new_main_exec().

◆ wm_window_events_process()

void wm_window_events_process ( const bContext * C )

Definition at line 2071 of file wm_window.cc.

References BLI_assert, BLI_thread_is_main(), BLI_time_sleep_precise_us(), C, CTX_wm_manager(), G, G_FLAG_EVENT_SIMULATE, g_system, GHOST_DispatchEvents(), GHOST_ProcessEvents(), GPU_render_begin(), GPU_render_end(), wm_window_timers_process(), and wm_xr_events_handle().

Referenced by WM_main().

◆ wm_window_free()

void wm_window_free	(	bContext *	C,
		wmWindowManager *	wm,
		wmWindow *	win )

Including window itself.

Parameters

C	can be NULL.

Note: ED_screen_exit should have been called.

Definition at line 245 of file wm_window.cc.

References BKE_screen_area_map_free(), BKE_workspace_instance_hook_free(), C, CTX_wm_window(), CTX_wm_window_set(), wmWindow::cursor_keymap_status, wmWindow::event_last_handled, wmWindow::event_queue_consecutive_gesture_data, wmWindow::eventstate, G_MAIN, wmWindow::global_areas, wmWindow::handlers, LISTBASE_FOREACH_MUTABLE, MEM_freeN(), wmWindow::modalhandlers, wmWindow::runtime, wmWindowManager::runtime, wmWindow::stereo3d_format, TIMERJOBS, WM_event_consecutive_data_free(), wm_event_free_all(), WM_event_remove_handlers(), WM_event_timer_remove(), WM_gestures_free_all(), wm_ghostwindow_destroy(), wm_jobs_timer_end(), WM_TIMER_TAGGED_FOR_REMOVAL, wm_window_timers_delete_removed(), and wmWindow::workspace_hook.

Referenced by wm_close_and_free(), and wm_window_close().

◆ wm_window_fullscreen_toggle_exec()

wmOperatorStatus wm_window_fullscreen_toggle_exec	(	bContext *	C,
		wmOperator *	op )

Full-screen operator callback.

Definition at line 1409 of file wm_window.cc.

References C, CTX_wm_window(), G, GHOST_GetWindowState(), GHOST_kWindowStateFullScreen, GHOST_kWindowStateNormal, GHOST_SetWindowState(), wmWindow::ghostwin, OPERATOR_CANCELLED, OPERATOR_FINISHED, and state.

Referenced by WM_OT_window_fullscreen_toggle().

◆ wm_window_get_swap_interval()

bool wm_window_get_swap_interval	(	wmWindow *	win,
		int *	r_interval )

Definition at line 2734 of file wm_window.cc.

References GHOST_GetSwapInterval(), and wmWindow::ghostwin.

◆ wm_window_ghostwindows_ensure()

void wm_window_ghostwindows_ensure ( wmWindowManager * wm )

Initialize wmWindow without ghostwin, open these and clear.

Window size is read from window, if 0 it uses prefsize called in WM_check, also initialize stuff after file read.

Warning: After running, win->ghostwin can be NULL in rare cases (where OpenGL driver fails to create a context for eg). We could remove them with wm_window_ghostwindows_remove_invalid but better not since caller may continue to use. Instead, caller needs to handle the error case and cleanup.

Definition at line 1085 of file wm_window.cc.

References BLI_assert, G, LISTBASE_FOREACH, UNLIKELY, wmWindowManager::windows, wm_get_screensize(), wm_init_state, and wm_window_ghostwindow_ensure().

Referenced by WM_check().