Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
mouse_getx(3)		      Svgalib User Manual		 mouse_getx(3)

NAME
       mouse_getx, mouse_gety, mouse_getbutton - query the mouse state

SYNOPSIS
       #include	<vgamouse.h>

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

DESCRIPTION
       These  three  routines  do  the obvious,	namely returning current mouse
       pointer position	and button state.  mouse_getbutton() returns an	 inte-
       ger which can be	bitwise	&'d with MOUSE_LEFTBUTTON, MOUSE_MIDDLEBUTTON,
       MOUSE_RIGHTBUTTON,  MOUSE_FOURTHBUTTON, MOUSE_FIFTHBUTTON, MOUSE_SIXTH-
       BUTTON, 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_waitforup-
       date(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_up-
       date(3),	mouse_waitforupdate(3),	vga_setmousesupport(3),	mouse_seteven-
       thandler(3), vga_waitevent(3)

AUTHOR
       This manual page	was edited by Michael Weller  <eowmob@exp-math.uni-es-
       sen.de>.	 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 <H.Hanemaayer@inter.nl.net>.

       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.

Svgalib	(>= 1.2.11)		 27 July 1997			 mouse_getx(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mouse_getbutton&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help