diff docs/man3/SDL_VideoDriverName.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_VideoDriverName.3	Thu Apr 26 16:45:43 2001 +0000
@@ -0,0 +1,18 @@
+.TH "SDL_VideoDriverName" "3" "Mon 12 Mar 2001, 01:05" "SDL" "SDL API Reference" 
+.SH "NAME"
+SDL_VideoDriverName\- Obtain the name of the video driver
+.SH "SYNOPSIS"
+.PP
+\fB#include "SDL\&.h"
+.sp
+\fBchar *\fBSDL_VideoDriverName\fP\fR(\fBchar *namebuf, int maxlen\fR);
+.SH "DESCRIPTION"
+.PP
+The buffer pointed to by \fBnamebuf\fR is filled up to a maximum of \fBmaxlen\fR characters (include the NULL terminator) with the name of the initialised video driver\&. The driver name is a simple one word identifier like "x11" or "windib"\&.
+.SH "RETURN VALUE"
+.PP
+Returns \fBNULL\fP if video has not been initialised with \fBSDL_Init\fP or a pointer to \fBnamebuf\fR otherwise\&.
+.SH "SEE ALSO"
+.PP
+\fI\fBSDL_Init\fP\fR \fI\fBSDL_InitSubSystem\fP\fR
+...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:05