.TH "ggiGetRayPos" 3 "2006-12-30" "libggimisc-2.2.x" GGI
.SH NAME
\fBggiGetRayPos\fR : Find out where the raster beam is
.SH SYNOPSIS
.nb
.nf
#include <ggi/misc.h>

int ggiGetRayPos(ggi_visual_t vis, int32_t* x, int32_t* y);
.fi

.SH DESCRIPTION
Though currently only implemented via matroxfb, this function will
retrieve the current position of the raster beam on a display that
uses a cathode ray tube, or resembles such internally.  Because it has
not been implemented and put into widespread use, there may be API
fluctuation as to exactly what units \fIx\fR, \fIy\fR are in, especially
on displays using doublescanning modes.  In addition to numerical
values, the following values can be returned in either dimension:
\fBGGI_RP_BORDER\fR means the raster is in the border of the screen;
\fBGGI_RP_BLANK\fR means the raster is past the border and is turned off;
\fBGGI_RP_SYNC\fR means the raster is retracing to the top of the screen.
.SH RETURN VALUE
\fB0\fR for OK, otherwise an \f(CWggi-error(3)\fR code.
.SH SEE ALSO
\f(CWggiWaitRayPos(3)\fR