mouse_getx - Man Page

query the mouse state


#include <vgamouse.h>

int mouse_getx(void);
int mouse_gety(void);
int mouse_getbutton(void);


These three routines do the obvious, namely returning current mouse pointer position and button state. mouse_getbutton() returns an integer which can be bitwise &'d with MOUSE_LEFTBUTTON, MOUSE_MIDDLEBUTTON, MOUSE_RIGHTBUTTON, MOUSE_FOURTHBUTTON, MOUSE_FIFTHBUTTON, MOUSE_SIXTHBUTTON, or MOUSE_RESETBUTTON.

A 1 on any of these bits means the button has been pressed, a 0 means it hasn't.

Please note that you need to call mouse_update(3) or mouse_waitforupdate(3) for the mouse state actually to change.

For 3d pointer devices, there is actually another interface. See mouse_getposition_6d(3).

See Also

svgalib(7), vgagl(7), libvga.config(5), eventtest(6), mouse_close(3), mouse_init(3), mouse_getposition_6d(3), mouse_setposition(3), mouse_setscale(3), mouse_setwrap(3), mouse_setxrange(3), mouse_update(3), mouse_waitforupdate(3), vga_setmousesupport(3), mouse_seteventhandler(3), vga_waitevent(3)


This manual page was edited by Michael Weller <>. The exact source of the referenced function as well as of the original documentation is unknown.

It is very likely that both are at least to some extent are due to Harm Hanemaayer <>.

Occasionally this might be wrong. I hereby asked to be excused by the original author and will happily accept any additions or corrections to this first version of the svgalib manual.

Referenced By

mouse_close(3), mouse_getcaps(3), mouse_getposition_6d(3), mouse_init(3), mouse_seteventhandler(3), mouse_setposition(3), mouse_setscale(3), mouse_setwrap(3), mouse_setxrange(3), mouse_update(3), mouse_waitforupdate(3), svgalib(7), vga_getmousetype(3), vga_setmousesupport(3), vga_waitevent(3).

The man pages mouse_getbutton(3) and mouse_gety(3) are aliases of mouse_getx(3).

27 July 1997 Svgalib (>= 1.2.11) Svgalib User Manual