Mercurial > sdl-ios-xcode
annotate docs/man3/SDL_ListModes.3 @ 2763:6fc50bdd88c0
Some cleanups on the new XInput code.
One or two things got moved around, but largely this is hooked up correctly
in the Unix configure system now: it can be dynamically loaded and fallback
gracefully if not available, or libXi can be directly linked to libSDL.
XInput support can be --disable'd from the configure script, too (defaults to
enabled).
Please note that while the framework is in place to gracefully fallback, the
current state of the source requires XInput. We'll need to adjust a few
things still to correct this.
| author | Ryan C. Gordon <icculus@icculus.org> |
|---|---|
| date | Wed, 17 Sep 2008 08:20:57 +0000 |
| parents | 546f7c1eb755 |
| children | 1238da4a7112 |
| rev | line source |
|---|---|
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
1 .TH "SDL_ListModes" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" |
| 0 | 2 .SH "NAME" |
|
2283
546f7c1eb755
Merged revision 3472 from SDL 1.2, fixing bug #493
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
3 SDL_ListModes \- Returns a pointer to an array of available screen dimensions for the given format and video flags |
| 0 | 4 .SH "SYNOPSIS" |
| 5 .PP | |
| 6 \fB#include "SDL\&.h" | |
| 7 .sp | |
| 8 \fBSDL_Rect **\fBSDL_ListModes\fP\fR(\fBSDL_PixelFormat *format, Uint32 flags\fR); | |
| 9 .SH "DESCRIPTION" | |
| 10 .PP | |
| 11 Return a pointer to an array of available screen dimensions for the given format and video flags, sorted largest to smallest\&. Returns \fBNULL\fP if there are no dimensions available for a particular format, or \fB-1\fR if any dimension is okay for the given format\&. | |
| 12 .PP | |
| 13 If \fBformat\fR is \fBNULL\fP, the mode list will be for the format returned by \fISDL_GetVideoInfo()\fR->\fBvfmt\fR\&. The \fBflag\fR parameter is an OR\&'d combination of \fIsurface\fR flags\&. The flags are the same as those used \fI\fBSDL_SetVideoMode\fP\fR and they play a strong role in deciding what modes are valid\&. For instance, if you pass \fBSDL_HWSURFACE\fP as a flag only modes that support hardware video surfaces will be returned\&. | |
| 14 .SH "EXAMPLE" | |
| 15 .PP | |
| 16 .nf | |
| 17 \f(CWSDL_Rect **modes; | |
| 18 int i; | |
| 19 \&. | |
| 20 \&. | |
| 21 \&. | |
| 22 | |
| 23 /* Get available fullscreen/hardware modes */ | |
| 24 modes=SDL_ListModes(NULL, SDL_FULLSCREEN|SDL_HWSURFACE); | |
| 25 | |
| 26 /* Check is there are any modes available */ | |
| 27 if(modes == (SDL_Rect **)0){ | |
| 28 printf("No modes available! | |
| 29 "); | |
| 30 exit(-1); | |
| 31 } | |
| 32 | |
| 33 /* Check if or resolution is restricted */ | |
| 34 if(modes == (SDL_Rect **)-1){ | |
| 35 printf("All resolutions available\&. | |
| 36 "); | |
| 37 } | |
| 38 else{ | |
| 39 /* Print valid modes */ | |
| 40 printf("Available Modes | |
| 41 "); | |
| 42 for(i=0;modes[i];++i) | |
| 43 printf(" %d x %d | |
| 44 ", modes[i]->w, modes[i]->h); | |
| 45 } | |
| 46 \&. | |
| 47 \&.\fR | |
| 48 .fi | |
| 49 .PP | |
| 50 .SH "SEE ALSO" | |
| 51 .PP | |
| 52 \fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_GetVideoInfo\fP\fR, \fI\fBSDL_Rect\fR\fR, \fI\fBSDL_PixelFormat\fR\fR | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
53 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 |