SDL-1.2.14
[sdl_omap.git] / docs / man3 / SDL_GetVideoInfo.3
1 .TH "SDL_GetVideoInfo" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" 
2 .SH "NAME"
3 SDL_GetVideoInfo \- returns a pointer to information about the video hardware
4 .SH "SYNOPSIS"
5 .PP
6 \fB#include "SDL\&.h"
7 .sp
8 \fBSDL_VideoInfo *\fBSDL_GetVideoInfo\fP\fR(\fBvoid\fR);
9 .SH "DESCRIPTION"
10 .PP
11 This function returns a read-only pointer to \fIinformation\fR about the video hardware\&. If this is called before \fISDL_SetVideoMode\fR, the \fBvfmt\fR member of the returned structure will contain the pixel format of the "best" video mode\&.
12 .SH "SEE ALSO"
13 .PP
14 \fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_VideoInfo\fR\fR
15 .\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01