cursor.h File Reference

#include "lib/file/vfs/vfs.h"

Go to the source code of this file.

Functions
Status	cursor_draw (const PIVFS &vfs, const wchar_t *name, int x, int y, bool forceGL)
	Draw the cursor on-screen. More...
void	cursor_shutdown ()
	Forcibly frees all cursor handles. More...

Function Documentation

Status cursor_draw	(	const PIVFS &	vfs,
		const wchar_t *	name,
		int	x,
		int	y,
		bool	forceGL
	)

Draw the cursor on-screen.

Parameters

vfs
name	Base name of cursor or zero to hide the cursor.
x,y	Coordinates [pixels] (origin at lower left) (the origin is convenient for drawing via OpenGL, but requires the mouse Y coordinate to be subtracted from the client area height. Making the caller responsible for this avoids a dependency on the g_yres global variable.)
forceGL	Require the OpenGL cursor implementation, not hardware cursor

Uses a hardware mouse cursor where available, otherwise a portable OpenGL implementation.

Definition at line 309 of file cursor.cpp.

void cursor_shutdown

(

)

Forcibly frees all cursor handles.

Currently used just prior to SDL shutdown.

Definition at line 298 of file cursor.cpp.