Mercurial > sdl-ios-xcode
annotate docs/man3/SDL_VideoModeOK.3 @ 2866:e532417a6977
Fixed SDL 1.2 compatibility problem.
The API specifies that SDL_OpenAudio() will fill out the 'desired' audio spec
with the correct samples and size set by the driver. This value is important
since it may be used by applications that size audio buffers, etc.
However, we want to allow advanced applications to call SDL_OpenAudioDevice()
which gets passed a const 'desired' parameter, and have the correct data filled
into the 'obtained' parameter, possibly allowing or not allowing format changes.
So... 'obtained' becomes the audio format the user callback is expected to use,
and we add flags to allow the application to specify which format changes are
allowed.
Note: We really need to add a way to query the 'obtained' audio spec.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Sat, 13 Dec 2008 06:36:47 +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_VideoModeOK" "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_VideoModeOK \- Check to see if a particular video mode is supported\&. |
| 0 | 4 .SH "SYNOPSIS" |
| 5 .PP | |
| 6 \fB#include "SDL\&.h" | |
| 7 .sp | |
| 8 \fBint \fBSDL_VideoModeOK\fP\fR(\fBint width, int height, int bpp, Uint32 flags\fR); | |
| 9 .SH "DESCRIPTION" | |
| 10 .PP | |
| 11 \fBSDL_VideoModeOK\fP returns \fB0\fR if the requested mode is not supported under any bit depth, or returns the bits-per-pixel of the closest available mode with the given width, height and requested \fIsurface\fR flags (see \fI\fBSDL_SetVideoMode\fP\fR)\&. | |
| 12 .PP | |
| 13 The bits-per-pixel value returned is only a suggested mode\&. You can usually request and bpp you want when \fIsetting\fR the video mode and SDL will emulate that color depth with a shadow video surface\&. | |
| 14 .PP | |
| 15 The arguments to \fBSDL_VideoModeOK\fP are the same ones you would pass to \fISDL_SetVideoMode\fR | |
| 16 .SH "EXAMPLE" | |
| 17 .PP | |
| 18 .nf | |
| 19 \f(CWSDL_Surface *screen; | |
| 20 Uint32 bpp; | |
| 21 \&. | |
| 22 \&. | |
| 23 \&. | |
| 24 printf("Checking mode 640x480@16bpp\&. | |
| 25 "); | |
| 26 bpp=SDL_VideoModeOK(640, 480, 16, SDL_HWSURFACE); | |
| 27 | |
| 28 if(!bpp){ | |
| 29 printf("Mode not available\&. | |
| 30 "); | |
| 31 exit(-1); | |
| 32 } | |
| 33 | |
| 34 printf("SDL Recommends 640x480@%dbpp\&. | |
| 35 ", bpp); | |
| 36 screen=SDL_SetVideoMode(640, 480, bpp, SDL_HWSURFACE); | |
| 37 \&. | |
| 38 \&.\fR | |
| 39 .fi | |
| 40 .PP | |
| 41 .SH "SEE ALSO" | |
| 42 .PP | |
| 43 \fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_GetVideoInfo\fP\fR | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
44 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 |