#include <cstdio>
#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	BEGIN_CURSOR_BLOCK

#define	END_CURSOR_BLOCK

Functions
static GHOST_TStandardCursor	convert_to_ghost_standard_cursor (WMCursorType curs)

static void	window_set_custom_cursor (wmWindow *win, const uchar mask[16][2], const uchar bitmap[16][2], int hotx, int hoty)

static void	window_set_custom_cursor_ex (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)

void	WM_cursor_time (wmWindow *win, int nr)

void	wm_init_cursor_data ()

Variables
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 431 of file wm_cursors.cc.

Referenced by wm_init_cursor_data().

◆ END_CURSOR_BLOCK

#define END_CURSOR_BLOCK

Value:

} \

((void)0)

Definition at line 434 of file wm_cursors.cc.

Referenced by wm_init_cursor_data().

Function Documentation

◆ convert_to_ghost_standard_cursor()

static GHOST_TStandardCursor convert_to_ghost_standard_cursor ( WMCursorType curs )

static

Definition at line 42 of file wm_cursors.cc.

Referenced by WM_cursor_set().

◆ window_set_custom_cursor()

static void window_set_custom_cursor	(	wmWindow *	win,
		const uchar	mask[16][2],
		const uchar	bitmap[16][2],
		int	hotx,
		int	hoty )

static

Definition at line 117 of file wm_cursors.cc.

References GHOST_SetCustomCursorShape(), and wmWindow::ghostwin.

Referenced by WM_cursor_time().

◆ window_set_custom_cursor_ex()

static void window_set_custom_cursor_ex	(	wmWindow *	win,
		BCursor *	cursor )

static

Definition at line 130 of file wm_cursors.cc.

References GHOST_SetCustomCursorShape(), and wmWindow::ghostwin.

Referenced by WM_cursor_set().

◆ wm_cursor_arrow_move()

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

Definition at line 331 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 296 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.