Mercurial > sdl-ios-xcode
annotate docs/html/sdlvideomodeok.html @ 665:d27aab66c5d6
*** empty log message ***
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Wed, 06 Aug 2003 20:12:00 +0000 |
| parents | e5bc29de3f0a |
| children | 355632dca928 |
| rev | line source |
|---|---|
| 0 | 1 <HTML |
| 2 ><HEAD | |
| 3 ><TITLE | |
| 4 >SDL_VideoModeOK</TITLE | |
| 5 ><META | |
| 6 NAME="GENERATOR" | |
|
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.64 |
| 0 | 8 "><LINK |
| 9 REL="HOME" | |
| 10 TITLE="SDL Library Documentation" | |
| 11 HREF="index.html"><LINK | |
| 12 REL="UP" | |
| 13 TITLE="Video" | |
| 14 HREF="video.html"><LINK | |
| 15 REL="PREVIOUS" | |
| 16 TITLE="SDL_ListModes" | |
| 17 HREF="sdllistmodes.html"><LINK | |
| 18 REL="NEXT" | |
| 19 TITLE="SDL_SetVideoMode" | |
| 20 HREF="sdlsetvideomode.html"></HEAD | |
| 21 ><BODY | |
| 22 CLASS="REFENTRY" | |
| 23 BGCOLOR="#FFF8DC" | |
| 24 TEXT="#000000" | |
| 25 LINK="#0000ee" | |
| 26 VLINK="#551a8b" | |
| 27 ALINK="#ff0000" | |
| 28 ><DIV | |
| 29 CLASS="NAVHEADER" | |
| 30 ><TABLE | |
| 31 WIDTH="100%" | |
| 32 BORDER="0" | |
| 33 CELLPADDING="0" | |
| 34 CELLSPACING="0" | |
| 35 ><TR | |
| 36 ><TH | |
| 37 COLSPAN="3" | |
| 38 ALIGN="center" | |
| 39 >SDL Library Documentation</TH | |
| 40 ></TR | |
| 41 ><TR | |
| 42 ><TD | |
| 43 WIDTH="10%" | |
| 44 ALIGN="left" | |
| 45 VALIGN="bottom" | |
| 46 ><A | |
| 47 HREF="sdllistmodes.html" | |
| 48 >Prev</A | |
| 49 ></TD | |
| 50 ><TD | |
| 51 WIDTH="80%" | |
| 52 ALIGN="center" | |
| 53 VALIGN="bottom" | |
| 54 ></TD | |
| 55 ><TD | |
| 56 WIDTH="10%" | |
| 57 ALIGN="right" | |
| 58 VALIGN="bottom" | |
| 59 ><A | |
| 60 HREF="sdlsetvideomode.html" | |
| 61 >Next</A | |
| 62 ></TD | |
| 63 ></TR | |
| 64 ></TABLE | |
| 65 ><HR | |
| 66 ALIGN="LEFT" | |
| 67 WIDTH="100%"></DIV | |
| 68 ><H1 | |
| 69 ><A | |
| 70 NAME="SDLVIDEOMODEOK" | |
| 71 >SDL_VideoModeOK</A | |
| 72 ></H1 | |
| 73 ><DIV | |
| 74 CLASS="REFNAMEDIV" | |
| 75 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
76 NAME="AEN819" |
| 0 | 77 ></A |
| 78 ><H2 | |
| 79 >Name</H2 | |
| 80 >SDL_VideoModeOK -- Check to see if a particular video mode is supported.</DIV | |
| 81 ><DIV | |
| 82 CLASS="REFSYNOPSISDIV" | |
| 83 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
84 NAME="AEN822" |
| 0 | 85 ></A |
| 86 ><H2 | |
| 87 >Synopsis</H2 | |
| 88 ><DIV | |
| 89 CLASS="FUNCSYNOPSIS" | |
| 90 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
91 NAME="AEN823" |
| 0 | 92 ></A |
| 93 ><P | |
| 94 ></P | |
| 95 ><PRE | |
| 96 CLASS="FUNCSYNOPSISINFO" | |
| 97 >#include "SDL.h"</PRE | |
| 98 ><P | |
| 99 ><CODE | |
| 100 ><CODE | |
| 101 CLASS="FUNCDEF" | |
| 102 >int <B | |
| 103 CLASS="FSFUNC" | |
| 104 >SDL_VideoModeOK</B | |
| 105 ></CODE | |
| 106 >(int width, int height, int bpp, Uint32 flags);</CODE | |
| 107 ></P | |
| 108 ><P | |
| 109 ></P | |
| 110 ></DIV | |
| 111 ></DIV | |
| 112 ><DIV | |
| 113 CLASS="REFSECT1" | |
| 114 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
115 NAME="AEN829" |
| 0 | 116 ></A |
| 117 ><H2 | |
| 118 >Description</H2 | |
| 119 ><P | |
| 120 ><TT | |
| 121 CLASS="FUNCTION" | |
| 122 >SDL_VideoModeOK</TT | |
| 123 > returns <SPAN | |
| 124 CLASS="RETURNVALUE" | |
| 125 >0</SPAN | |
| 126 > | |
| 127 if the requested mode is not supported under any bit depth, or returns the | |
| 128 bits-per-pixel of the closest available mode with the given width, height and requested <A | |
| 129 HREF="sdlsurface.html" | |
| 130 >surface</A | |
| 131 > flags (see <A | |
| 132 HREF="sdlsetvideomode.html" | |
| 133 ><TT | |
| 134 CLASS="FUNCTION" | |
| 135 >SDL_SetVideoMode</TT | |
| 136 ></A | |
| 137 >).</P | |
| 138 ><P | |
| 139 >The bits-per-pixel value returned is only a suggested mode. You can usually request and bpp you want when <A | |
| 140 HREF="sdlsetvideomode.html" | |
| 141 >setting</A | |
| 142 > the video mode and SDL will emulate that color depth with a shadow video surface.</P | |
| 143 ><P | |
| 144 >The arguments to <TT | |
| 145 CLASS="FUNCTION" | |
| 146 >SDL_VideoModeOK</TT | |
| 147 > are the same ones you | |
| 148 would pass to <A | |
| 149 HREF="sdlsetvideomode.html" | |
| 150 >SDL_SetVideoMode</A | |
| 151 ></P | |
| 152 ></DIV | |
| 153 ><DIV | |
| 154 CLASS="REFSECT1" | |
| 155 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
156 NAME="AEN842" |
| 0 | 157 ></A |
| 158 ><H2 | |
| 159 >Example</H2 | |
| 160 ><PRE | |
| 161 CLASS="PROGRAMLISTING" | |
| 162 >SDL_Surface *screen; | |
| 163 Uint32 bpp; | |
| 164 . | |
| 165 . | |
| 166 . | |
| 167 printf("Checking mode 640x480@16bpp.\n"); | |
| 168 bpp=SDL_VideoModeOK(640, 480, 16, SDL_HWSURFACE); | |
| 169 | |
| 170 if(!bpp){ | |
| 171 printf("Mode not available.\n"); | |
| 172 exit(-1); | |
| 173 } | |
| 174 | |
| 175 printf("SDL Recommends 640x480@%dbpp.\n", bpp); | |
| 176 screen=SDL_SetVideoMode(640, 480, bpp, SDL_HWSURFACE); | |
| 177 . | |
| 178 .</PRE | |
| 179 ></DIV | |
| 180 ><DIV | |
| 181 CLASS="REFSECT1" | |
| 182 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
183 NAME="AEN845" |
| 0 | 184 ></A |
| 185 ><H2 | |
| 186 >See Also</H2 | |
| 187 ><P | |
| 188 ><A | |
| 189 HREF="sdlsetvideomode.html" | |
| 190 ><TT | |
| 191 CLASS="FUNCTION" | |
| 192 >SDL_SetVideoMode</TT | |
| 193 ></A | |
| 194 >, | |
| 195 <A | |
| 196 HREF="sdlgetvideoinfo.html" | |
| 197 ><TT | |
| 198 CLASS="FUNCTION" | |
| 199 >SDL_GetVideoInfo</TT | |
| 200 ></A | |
| 201 ></P | |
| 202 ></DIV | |
| 203 ><DIV | |
| 204 CLASS="NAVFOOTER" | |
| 205 ><HR | |
| 206 ALIGN="LEFT" | |
| 207 WIDTH="100%"><TABLE | |
| 208 WIDTH="100%" | |
| 209 BORDER="0" | |
| 210 CELLPADDING="0" | |
| 211 CELLSPACING="0" | |
| 212 ><TR | |
| 213 ><TD | |
| 214 WIDTH="33%" | |
| 215 ALIGN="left" | |
| 216 VALIGN="top" | |
| 217 ><A | |
| 218 HREF="sdllistmodes.html" | |
| 219 >Prev</A | |
| 220 ></TD | |
| 221 ><TD | |
| 222 WIDTH="34%" | |
| 223 ALIGN="center" | |
| 224 VALIGN="top" | |
| 225 ><A | |
| 226 HREF="index.html" | |
| 227 >Home</A | |
| 228 ></TD | |
| 229 ><TD | |
| 230 WIDTH="33%" | |
| 231 ALIGN="right" | |
| 232 VALIGN="top" | |
| 233 ><A | |
| 234 HREF="sdlsetvideomode.html" | |
| 235 >Next</A | |
| 236 ></TD | |
| 237 ></TR | |
| 238 ><TR | |
| 239 ><TD | |
| 240 WIDTH="33%" | |
| 241 ALIGN="left" | |
| 242 VALIGN="top" | |
| 243 >SDL_ListModes</TD | |
| 244 ><TD | |
| 245 WIDTH="34%" | |
| 246 ALIGN="center" | |
| 247 VALIGN="top" | |
| 248 ><A | |
| 249 HREF="video.html" | |
| 250 >Up</A | |
| 251 ></TD | |
| 252 ><TD | |
| 253 WIDTH="33%" | |
| 254 ALIGN="right" | |
| 255 VALIGN="top" | |
| 256 >SDL_SetVideoMode</TD | |
| 257 ></TR | |
| 258 ></TABLE | |
| 259 ></DIV | |
| 260 ></BODY | |
| 261 ></HTML | |
| 262 > |