cursor.h File Reference

Go to the source code of this file.

Typedefs
typedef void *	sys_cursor

Functions
Status	sys_cursor_create (int w, int h, void *bgra_img, int hx, int hy, sys_cursor *cursor)
	Create a cursor from the given color image. More...
Status	sys_cursor_create_empty (sys_cursor *cursor)
	Create a transparent cursor (used to hide the system cursor). More...
Status	sys_cursor_set (sys_cursor cursor)
	override the current system cursor. More...
Status	sys_cursor_free (sys_cursor cursor)
	destroy the indicated cursor and frees its resources. More...
Status	sys_cursor_reset ()
	reset any cached cursor data. More...

Typedef Documentation

typedef void* sys_cursor

Definition at line 30 of file cursor.h.

Function Documentation

Status sys_cursor_create	(	int	w,
		int	h,
		void *	bgra_img,
		int	hx,
		int	hy,
		sys_cursor *	cursor
	)

Create a cursor from the given color image.

Parameters

w,h	Image dimensions [pixels]. the maximum value is implementation-defined; 32x32 is typical and safe.
bgra_img	cursor image (BGRA format, bottom-up). It is copied and can be freed after this call returns.
hx,hy	'hotspot', i.e. offset from the upper-left corner to the position where mouse clicks are registered.
cursor	Is 0 if the return code indicates failure, otherwise a valid cursor that must be sys_cursor_free-ed when no longer needed.

Definition at line 72 of file android.cpp.

Status sys_cursor_create_empty

(

sys_cursor *

cursor

)

Create a transparent cursor (used to hide the system cursor).

Parameters

cursor

is 0 if the return code indicates failure, otherwise a valid cursor that must be sys_cursor_free-ed when no longer needed.

Definition at line 85 of file android.cpp.

Status sys_cursor_free

(

sys_cursor

cursor

)

destroy the indicated cursor and frees its resources.

Parameters

cursor

if currently in use, the default cursor is restored first.

Definition at line 105 of file android.cpp.

Status sys_cursor_reset

(

)

reset any cached cursor data.

on some systems, this is needed when resetting the SDL video subsystem.

Definition at line 116 of file android.cpp.

Status sys_cursor_set

(

sys_cursor

cursor

)

override the current system cursor.

Parameters

cursor

can be 0 to restore the default.

Definition at line 93 of file android.cpp.