[sdl_omap.git] / docs / man3 / SDL_ShowCursor.3

.TH "SDL_ShowCursor" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_ShowCursor \- Toggle whether or not the cursor is shown on the screen\&.
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBint \fBSDL_ShowCursor\fP\fR(\fBint toggle\fR);
.SH "DESCRIPTION"
.PP
Toggle whether or not the cursor is shown on the screen\&. Passing \fBSDL_ENABLE\fP displays the cursor and passing \fBSDL_DISABLE\fP hides it\&. The current state of the mouse cursor can be queried by passing \fBSDL_QUERY\fP, either \fBSDL_DISABLE\fP or \fBSDL_ENABLE\fP will be returned\&.
.PP
The cursor starts off displayed, but can be turned off\&.
.SH "RETURN VALUE"
.PP
Returns the current state of the cursor\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_CreateCursor\fP\fR, \fI\fBSDL_SetCursor\fP\fR
.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01
Commit	Line	Data
e14743d1	1	.TH "SDL_ShowCursor" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
	2	.SH "NAME"
	3	SDL_ShowCursor \- Toggle whether or not the cursor is shown on the screen\&.
	4	.SH "SYNOPSIS"
	5	.PP
	6	\fB#include "SDL\&.h"
	7	.sp
	8	\fBint \fBSDL_ShowCursor\fP\fR(\fBint toggle\fR);
	9	.SH "DESCRIPTION"
	10	.PP
	11	Toggle whether or not the cursor is shown on the screen\&. Passing \fBSDL_ENABLE\fP displays the cursor and passing \fBSDL_DISABLE\fP hides it\&. The current state of the mouse cursor can be queried by passing \fBSDL_QUERY\fP, either \fBSDL_DISABLE\fP or \fBSDL_ENABLE\fP will be returned\&.
	12	.PP
	13	The cursor starts off displayed, but can be turned off\&.
	14	.SH "RETURN VALUE"
	15	.PP
	16	Returns the current state of the cursor\&.
	17	.SH "SEE ALSO"
	18	.PP
	19	\fI\fBSDL_CreateCursor\fP\fR, \fI\fBSDL_SetCursor\fP\fR
	20	.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01