#include <cstring>
#include "GHOST_C-api.h"
#include "BLI_utildefines.h"
#include "DNA_listBase.h"
#include "DNA_userdef_types.h"
#include "DNA_workspace_types.h"
#include "BKE_global.hh"
#include "BKE_main.hh"
#include "WM_api.hh"
#include "WM_types.hh"
#include "wm_cursors.hh"
#include "wm_window.hh"

Classes
struct	BCursor

Macros
#define	CURSOR_SIZE_NUM (CURSOR_SIZE_32 + 1)
#define	BEGIN_CURSOR_BLOCK
#define	END_CURSOR_BLOCK

Enumerations
enum	CursorSize { CURSOR_SIZE_16 = 0 , CURSOR_SIZE_24 , CURSOR_SIZE_32 }

Functions
static GHOST_TStandardCursor	convert_to_ghost_standard_cursor (WMCursorType curs)
static CursorSize	window_size_calc ()
static void	window_set_custom_cursor (wmWindow win, BCursor cursor)
void	WM_cursor_set (wmWindow *win, int curs)
bool	WM_cursor_set_from_tool (wmWindow win, const ScrArea area, const ARegion *region)
void	WM_cursor_modal_set (wmWindow *win, int val)
void	WM_cursor_modal_restore (wmWindow *win)
void	WM_cursor_wait (bool val)
void	WM_cursor_grab_enable (wmWindow win, const eWM_CursorWrapAxis wrap, const rcti wrap_region, const bool hide)
void	WM_cursor_grab_disable (wmWindow *win, const int mouse_ungrab_xy[2])
static void	wm_cursor_warp_relative (wmWindow *win, int x, int y)
bool	wm_cursor_arrow_move (wmWindow win, const wmEvent event)
static bool	wm_cursor_time_large (wmWindow *win, uint32_t nr)
static void	wm_cursor_time_small (wmWindow *win, uint32_t nr)
void	WM_cursor_time (wmWindow *win, int nr)
void	wm_init_cursor_data ()

Variables
static const uchar	cursor_size_px [CURSOR_SIZE_NUM]
static BCursor *	BlenderCursor [WM_CURSOR_NUM] = {nullptr}

Detailed Description

Cursor pixmap and cursor utility functions to change the cursor.

Definition in file wm_cursors.cc.

Macro Definition Documentation

◆ BEGIN_CURSOR_BLOCK

#define BEGIN_CURSOR_BLOCK

Value:

{ \

((void)0)

Custom Cursor Description

Each bit represents a pixel, so 1 byte = 8 pixels, the bytes go Left to Right. Top to bottom the bits in a byte go right to left (ie; 0x01, 0x80 represents a line of 16 pix with the first and last pix set.)

A 0 in the bitmap = white, a 1 black
a 0 in the mask = transparent pix.

This type of cursor is 16x16 pixels only.

There is a nice Python GUI utility that can be used for drawing cursors in this format in the Blender source distribution, in ./tools/utils/make_cursor_gui.py .

Start it with the command python3 make_cursor_gui.py It will copy its output to the console when you press 'Do it'. Because defining a cursor mixes declarations and executable code each cursor needs its own scoping block or it would be split up over several hundred lines of code. To enforce/document this better I define 2 pretty brain-dead macros so it's obvious what the extra "[]" are for.

Definition at line 553 of file wm_cursors.cc.

Referenced by wm_init_cursor_data().

◆ CURSOR_SIZE_NUM

#define CURSOR_SIZE_NUM (CURSOR_SIZE_32 + 1)

Definition at line 37 of file wm_cursors.cc.

◆ END_CURSOR_BLOCK

#define END_CURSOR_BLOCK

Value:

} \

((void)0)

Definition at line 556 of file wm_cursors.cc.

Referenced by wm_init_cursor_data().

Enumeration Type Documentation

◆ CursorSize

enum CursorSize

Enumerator
CURSOR_SIZE_16	Size: 16x16.
CURSOR_SIZE_24	Size: 24x24.
CURSOR_SIZE_32	Size: 32x32.

Definition at line 29 of file wm_cursors.cc.

Function Documentation

◆ convert_to_ghost_standard_cursor()

GHOST_TStandardCursor convert_to_ghost_standard_cursor ( WMCursorType curs )

static

Definition at line 57 of file wm_cursors.cc.

Referenced by WM_cursor_set().

◆ window_set_custom_cursor()

void window_set_custom_cursor	(	wmWindow *	win,
		BCursor *	cursor )

static

Definition at line 161 of file wm_cursors.cc.

References BCursor::bitmap, BCursor::can_invert_color, cursor_size_px, GHOST_SetCustomCursorShape(), wmWindow::ghostwin, BCursor::hotspot, BCursor::mask, size(), and window_size_calc().

Referenced by WM_cursor_set().

◆ window_size_calc()

CursorSize window_size_calc ( )

static

Definition at line 134 of file wm_cursors.cc.

References CURSOR_SIZE_16, CURSOR_SIZE_24, CURSOR_SIZE_32, U, WM_CURSOR_DEFAULT_LOGICAL_SIZE, and WM_cursor_preferred_logical_size().

Referenced by window_set_custom_cursor().

◆ wm_cursor_arrow_move()

bool wm_cursor_arrow_move	(	wmWindow *	win,
		const wmEvent *	event )

Definition at line 364 of file wm_cursors.cc.

References EVT_DOWNARROWKEY, EVT_LEFTARROWKEY, EVT_RIGHTARROWKEY, EVT_UPARROWKEY, GHOST_GetNativePixelSize(), wmWindow::ghostwin, KM_PRESS, wmEvent::type, wmEvent::val, and wm_cursor_warp_relative().

Referenced by wm_handlers_do_intern().

◆ WM_cursor_grab_disable()

void WM_cursor_grab_disable	(	wmWindow *	win,
		const int	mouse_ungrab_xy[2] )

Definition at line 329 of file wm_cursors.cc.

References G, G_DEBUG, GHOST_kAxisNone, GHOST_kGrabDisable, GHOST_SetCursorGrab(), wmWindow::ghostwin, wmWindow::grabcursor, and wm_cursor_position_to_ghost_screen_coords().

Referenced by button_activate_state(), walkEnd(), WM_event_remove_handlers(), wm_gizmomap_modal_set(), and wm_handler_operator_call().

◆ WM_cursor_grab_enable()

void WM_cursor_grab_enable	(	wmWindow *	win,
		eWM_CursorWrapAxis	wrap,
		const rcti *	wrap_region,
		bool	hide )

Enable cursor grabbing, optionally hiding the cursor and wrapping cursor-motion within a sub-region of the window.

Parameters

wrap	an enum (WM_CURSOR_WRAP_NONE, WM_CURSOR_WRAP_XY... etc).
wrap_region	Window-relative region for cursor wrapping (when wrap is WM_CURSOR_WRAP_XY). When NULL, the window bounds are used for wrapping.

Note: The current grab state can be accessed by #wmWindowManager.grabcursor although.

Definition at line 277 of file wm_cursors.cc.

References wmWindow::eventstate, G, G_DEBUG, GHOST_kAxisX, GHOST_kAxisY, GHOST_kGrabHide, GHOST_kGrabNormal, GHOST_kGrabWrap, GHOST_SetCursorGrab(), wmWindow::ghostwin, wmWindow::grabcursor, wmTabletData::is_motion_absolute, wmEvent::tablet, wm_cursor_position_to_ghost_screen_coords(), WM_CURSOR_WRAP_NONE, WM_CURSOR_WRAP_X, WM_CURSOR_WRAP_Y, wrap(), rcti::xmax, rcti::xmin, rcti::ymax, and rcti::ymin.

Referenced by button_activate_state(), initWalkInfo(), wm_gizmomap_modal_set(), wm_macro_modal(), and wm_operator_invoke().

◆ WM_cursor_modal_restore()

void WM_cursor_modal_restore ( wmWindow * win )

Definition at line 251 of file wm_cursors.cc.

References wmWindow::lastcursor, wmWindow::modalcursor, and WM_cursor_set().

Referenced by annotation_draw_exit(), area_split_exit(), area_swap_exit(), blender::ui::bonedropper_exit(), button_activate_exit(), blender::ed::curves::curve_draw_exit(), curve_draw_exit(), datadropper_exit(), depthdropper_exit(), driverdropper_exit(), blender::ui::eyedropper_colorband_exit(), eyedropper_exit(), gesture_modal_end(), graph_slider_exit(), blender::ed::sculpt_paint::grease_pencil_apply_fill(), blender::ed::sculpt_paint::grease_pencil_fill_exit(), blender::ed::sculpt_paint::greasepencil::grease_pencil_interpolate_modal(), blender::ed::greasepencil::grease_pencil_primitive_exit(), image_view_pan_exit(), image_view_zoom_exit(), knifetool_exit_ex(), blender::ed::space_node::node_resize_exit(), pose_slide_modal(), poselib_blend_exit(), blender::ed::transform::postTrans(), sample_color_modal(), screen_opengl_render_end(), blender::ed::asset::screenshot_preview_exit(), blender::ed::sculpt_paint::filter::sculpt_mesh_filter_modal(), blender::ed::sculpt_paint::dyntopo::sculpt_sample_detail_size_modal(), ui_do_button(), ui_handler_wait_for_input(), ui_numedit_set_active(), ui_textedit_end(), view_pan_exit(), view_pan_modal(), view_zoom_exit(), view_zoomdrag_modal(), WM_cursor_wait(), and wm_drags_exit().

◆ WM_cursor_modal_set()

void WM_cursor_modal_set	(	wmWindow *	win,
		int	val )

Definition at line 242 of file wm_cursors.cc.

References wmWindow::cursor, wmWindow::lastcursor, wmWindow::modalcursor, and WM_cursor_set().

Referenced by annotation_draw_cursor_set(), area_swap_invoke(), blender::ui::bonedropper_invoke(), button_activate_init(), curve_draw_invoke(), blender::ed::curves::curves_draw_invoke(), datadropper_invoke(), depthdropper_invoke(), driverdropper_invoke(), blender::ui::eyedropper_colorband_invoke(), eyedropper_invoke(), graph_slider_invoke(), blender::ed::sculpt_paint::grease_pencil_fill_event_modal_map(), blender::ed::sculpt_paint::grease_pencil_fill_invoke(), blender::ed::sculpt_paint::greasepencil::grease_pencil_interpolate_invoke(), blender::ed::greasepencil::grease_pencil_primitive_cursor_update(), blender::ed::greasepencil::grease_pencil_primitive_invoke(), image_view_pan_init(), image_view_zoom_init(), blender::ed::transform::initMouseInputMode(), knifetool_invoke(), blender::ed::space_node::node_resize_init(), pose_slide_invoke_common(), poselib_blend_invoke(), sample_color_invoke(), blender::ed::asset::screenshot_preview_invoke(), blender::ed::sculpt_paint::filter::sculpt_mesh_filter_modal(), blender::ed::sculpt_paint::dyntopo::sculpt_sample_detail_size_invoke(), ui_numedit_set_active(), ui_textedit_begin(), view_pan_init(), view_pan_invoke(), view_zoom_init(), view_zoomdrag_invoke(), WM_cursor_wait(), wm_drags_check_ops(), WM_gesture_lasso_invoke(), WM_gesture_lines_invoke(), WM_gesture_polyline_invoke(), WM_gesture_straightline_invoke(), and WM_operator_name_call_ptr_with_depends_on_cursor().

◆ WM_cursor_set()

void WM_cursor_set	(	wmWindow *	win,
		int	curs )

Definition at line 175 of file wm_cursors.cc.

References BlenderCursor, BLI_assert_msg, convert_to_ghost_standard_cursor(), wmWindow::cursor, G, GHOST_HasCursorShape(), GHOST_kStandardCursorCustom, GHOST_kStandardCursorDefault, GHOST_SetCursorShape(), GHOST_SetCursorVisibility(), wmWindow::ghostwin, wmWindow::modalcursor, window_set_custom_cursor(), WM_CURSOR_DEFAULT, WM_CURSOR_NONE, and WM_CURSOR_NUM.

Referenced by actionzone_modal(), area_join_cancel(), area_join_invoke(), area_join_modal(), area_split_preview_update_cursor(), area_swap_modal(), clip_tracking_hide_cursor(), clip_tracking_show_cursor(), console_cursor(), ED_region_cursor_set(), file_external_operation_exec(), blender::ed::sculpt_paint::grease_pencil_fill_event_modal_map(), blender::ed::space_node::node_set_cursor(), blender::ed::sculpt_paint::paint_draw_cursor(), blender::ed::sculpt_paint::paint_update_mouse_cursor(), region_scale_modal(), blender::ed::spreadsheet::reorder_columns_invoke(), blender::ed::spreadsheet::reorder_columns_modal(), screen_cursor_set(), blender::ed::vse::sequencer_main_cursor(), blender::ed::spreadsheet::spreadsheet_cursor(), text_cursor(), ui_handle_menu_event(), ui_popup_block_create(), view3d_main_region_cursor(), WM_cursor_modal_restore(), WM_cursor_modal_set(), WM_cursor_set_from_tool(), WM_gizmomap_cursor_set(), and wm_gizmomap_highlight_set().

◆ WM_cursor_set_from_tool()

bool WM_cursor_set_from_tool	(	wmWindow *	win,
		const ScrArea *	area,
		const ARegion *	region )

Definition at line 225 of file wm_cursors.cc.

References bToolRef_Runtime::cursor, wmWindow::cursor, ELEM, wmWindow::modalcursor, ARegion::regiontype, RGN_TYPE_PREVIEW, RGN_TYPE_WINDOW, bToolRef::runtime, ScrArea::runtime, ScrArea_Runtime::tool, WM_CURSOR_DEFAULT, and WM_cursor_set().

Referenced by ED_region_cursor_set(), and view3d_main_region_cursor().

◆ WM_cursor_time()

void WM_cursor_time	(	wmWindow *	win,
		int	nr )

After this you can call restore too.

Definition at line 501 of file wm_cursors.cc.

References wmWindow::cursor, wmWindow::lastcursor, U, wm_cursor_time_large(), and wm_cursor_time_small().

Referenced by screen_opengl_render_anim_step().

◆ wm_cursor_time_large()

bool wm_cursor_time_large	(	wmWindow *	win,
		uint32_t	nr )

static

Definition at line 392 of file wm_cursors.cc.

References GHOST_kSuccess, GHOST_SetCustomCursorShape(), wmWindow::ghostwin, i, mask(), x, and y.

Referenced by WM_cursor_time().

◆ wm_cursor_time_small()

void wm_cursor_time_small	(	wmWindow *	win,
		uint32_t	nr )

static

Definition at line 458 of file wm_cursors.cc.

References GHOST_SetCustomCursorShape(), wmWindow::ghostwin, i, mask(), x, and y.

Referenced by WM_cursor_time().

◆ WM_cursor_wait()

void WM_cursor_wait ( bool val )

To allow usage all over, we do entire WM.

Definition at line 260 of file wm_cursors.cc.

References ListBase::first, G, G_MAIN, wmWindow::next, wmWindowManager::windows, WM_cursor_modal_restore(), WM_cursor_modal_set(), and WM_CURSOR_WAIT.

Referenced by blender::ed::object::apply_grease_pencil_for_modifier_all_keyframes(), blender::ed::asset::asset_bundle_install_exec(), associate_blend_exec(), blender::ed::greasepencil::bake_grease_pencil_animation_exec(), blender::ed::object::bake_invoke(), edbm_duplicate_invoke(), blender::ed::greasepencil::grease_pencil_separate_exec(), image_clipboard_copy_exec(), image_clipboard_paste_exec(), lightprobe_cache_bake_invoke(), blender::ed::object::multiresbake_image_exec(), pack_islands_exec(), pack_islands_freejob(), blender::ed::object::parent_set_with_depsgraph(), redraw_timer_exec(), save_image_op(), screen_render_invoke(), script_reload_exec(), blender::ed::sculpt_paint::dyntopo::sculpt_dynamic_topology_toggle_exec(), separate_armature_exec(), separate_exec(), solve_camera_invoke(), track_markers(), unassociate_blend_exec(), unpack_all_exec(), unpack_item_exec(), unpack_libraries_exec(), WM_file_read(), and wm_file_write().

◆ wm_cursor_warp_relative()

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

static

Definition at line 355 of file wm_cursors.cc.

References wm_cursor_position_get(), WM_cursor_warp(), x, and y.

Referenced by wm_cursor_arrow_move().

◆ wm_init_cursor_data()

void wm_init_cursor_data ( )

Definition at line 560 of file wm_cursors.cc.

References BEGIN_CURSOR_BLOCK, BlenderCursor, BLI_assert, END_CURSOR_BLOCK, i, WM_CURSOR_BLADE, WM_CURSOR_BOTH_HANDLES, WM_CURSOR_COPY, WM_CURSOR_CROSS, WM_CURSOR_CROSSC, WM_CURSOR_DEFAULT, WM_CURSOR_DOT, WM_CURSOR_E_ARROW, WM_CURSOR_EDIT, WM_CURSOR_ERASER, WM_CURSOR_EW_ARROW, WM_CURSOR_EW_SCROLL, WM_CURSOR_EYEDROPPER, WM_CURSOR_H_SPLIT, WM_CURSOR_HAND, WM_CURSOR_HAND_CLOSED, WM_CURSOR_HAND_POINT, WM_CURSOR_KNIFE, WM_CURSOR_LEFT_HANDLE, WM_CURSOR_MOVE, WM_CURSOR_MUTE, WM_CURSOR_N_ARROW, WM_CURSOR_NONE, WM_CURSOR_NS_ARROW, WM_CURSOR_NS_SCROLL, WM_CURSOR_NSEW_SCROLL, WM_CURSOR_NUM, WM_CURSOR_NW_ARROW, WM_CURSOR_PAINT, WM_CURSOR_PAINT_BRUSH, WM_CURSOR_PICK_AREA, WM_CURSOR_RIGHT_HANDLE, WM_CURSOR_S_ARROW, WM_CURSOR_STOP, WM_CURSOR_SWAP_AREA, WM_CURSOR_TEXT_EDIT, WM_CURSOR_V_SPLIT, WM_CURSOR_VERTEX_LOOP, WM_CURSOR_W_ARROW, WM_CURSOR_WAIT, WM_CURSOR_X_MOVE, WM_CURSOR_Y_MOVE, WM_CURSOR_ZOOM_IN, and WM_CURSOR_ZOOM_OUT.

Referenced by WM_init().

Variable Documentation

◆ BlenderCursor

BCursor* BlenderCursor[WM_CURSOR_NUM] = {nullptr}

static

Definition at line 54 of file wm_cursors.cc.

Referenced by WM_cursor_set(), and wm_init_cursor_data().

◆ cursor_size_px

const uchar cursor_size_px[CURSOR_SIZE_NUM]

static

Initial value:

Definition at line 39 of file wm_cursors.cc.

Referenced by window_set_custom_cursor().

Classes

Macros

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ BEGIN_CURSOR_BLOCK

Custom Cursor Description

◆ CURSOR_SIZE_NUM

◆ END_CURSOR_BLOCK

Enumeration Type Documentation

◆ CursorSize

Function Documentation

◆ convert_to_ghost_standard_cursor()

◆ window_set_custom_cursor()

◆ window_size_calc()

◆ wm_cursor_arrow_move()

◆ WM_cursor_grab_disable()

◆ WM_cursor_grab_enable()

◆ WM_cursor_modal_restore()

◆ WM_cursor_modal_set()

◆ WM_cursor_set()

◆ WM_cursor_set_from_tool()

◆ WM_cursor_time()

◆ wm_cursor_time_large()

◆ wm_cursor_time_small()

◆ WM_cursor_wait()

◆ wm_cursor_warp_relative()

◆ wm_init_cursor_data()

Variable Documentation

◆ BlenderCursor

◆ cursor_size_px