diff docs/man3/SDL_ShowCursor.3 @ 0:74212992fb08

Initial revision
author Sam Lantinga <slouken@lokigames.com>
date Thu, 26 Apr 2001 16:45:43 +0000
parents
children 55f1f1b3e27d
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man3/SDL_ShowCursor.3	Thu Apr 26 16:45:43 2001 +0000
@@ -0,0 +1,20 @@
+.TH "SDL_ShowCursor" "3" "Mon 12 Mar 2001, 01:04" "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, Mon 12 Mar 2001, 01:04