.\" Generated by the Allegro makedoc utility
.TH mouse_on_screen 3alleg4 "version 4.4.3" "Allegro" "Allegro manual"
.SH NAME
mouse_on_screen \- Tells you whether the mouse pointer is currently on screen. Allegro game programming library.\&
.SH SYNOPSIS
.B #include <allegro.h>

.sp
.B int mouse_on_screen();
.SH DESCRIPTION
This function can be useful to prevent having two mouse pointers on the 
screen at the same time when running your program in windowed mode and 
drawing the mouse pointer yourself. Other possible uses include the 
ability to pause your game when the mouse goes off of the window, or 
only scrolling the view when the pointer is near the edge of the window,
but not while off of the window.

Example :

.nf
   if (mouse_on_screen()) {draw_sprite(buffer , mouse_sprite , mouse_x , mouse_y);}
   
.fi

.SH "RETURN VALUE"
Returns 0 if the mouse pointer is off of the screen, or non-zero otherwise.