Mercurial > sdl-ios-xcode
annotate docs/html/sdlvideomodeok.html @ 2978:4c9130d66e2c
Added a few things to the TODO list.
Unit testing is becoming more and more important the more features are added
and the more combinations of factors there are to test.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Sat, 03 Jan 2009 07:23:11 +0000 |
| parents | 355632dca928 |
| children |
| rev | line source |
|---|---|
| 0 | 1 <HTML |
| 2 ><HEAD | |
| 3 ><TITLE | |
| 4 >SDL_VideoModeOK</TITLE | |
| 5 ><META | |
| 6 NAME="GENERATOR" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ |
| 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 | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
31 SUMMARY="Header navigation table" |
| 0 | 32 WIDTH="100%" |
| 33 BORDER="0" | |
| 34 CELLPADDING="0" | |
| 35 CELLSPACING="0" | |
| 36 ><TR | |
| 37 ><TH | |
| 38 COLSPAN="3" | |
| 39 ALIGN="center" | |
| 40 >SDL Library Documentation</TH | |
| 41 ></TR | |
| 42 ><TR | |
| 43 ><TD | |
| 44 WIDTH="10%" | |
| 45 ALIGN="left" | |
| 46 VALIGN="bottom" | |
| 47 ><A | |
| 48 HREF="sdllistmodes.html" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
49 ACCESSKEY="P" |
| 0 | 50 >Prev</A |
| 51 ></TD | |
| 52 ><TD | |
| 53 WIDTH="80%" | |
| 54 ALIGN="center" | |
| 55 VALIGN="bottom" | |
| 56 ></TD | |
| 57 ><TD | |
| 58 WIDTH="10%" | |
| 59 ALIGN="right" | |
| 60 VALIGN="bottom" | |
| 61 ><A | |
| 62 HREF="sdlsetvideomode.html" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
63 ACCESSKEY="N" |
| 0 | 64 >Next</A |
| 65 ></TD | |
| 66 ></TR | |
| 67 ></TABLE | |
| 68 ><HR | |
| 69 ALIGN="LEFT" | |
| 70 WIDTH="100%"></DIV | |
| 71 ><H1 | |
| 72 ><A | |
| 73 NAME="SDLVIDEOMODEOK" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
74 ></A |
|
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
75 >SDL_VideoModeOK</H1 |
| 0 | 76 ><DIV |
| 77 CLASS="REFNAMEDIV" | |
| 78 ><A | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
79 NAME="AEN1202" |
| 0 | 80 ></A |
| 81 ><H2 | |
| 82 >Name</H2 | |
| 83 >SDL_VideoModeOK -- Check to see if a particular video mode is supported.</DIV | |
| 84 ><DIV | |
| 85 CLASS="REFSYNOPSISDIV" | |
| 86 ><A | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
87 NAME="AEN1205" |
| 0 | 88 ></A |
| 89 ><H2 | |
| 90 >Synopsis</H2 | |
| 91 ><DIV | |
| 92 CLASS="FUNCSYNOPSIS" | |
| 93 ><A | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
94 NAME="AEN1206" |
| 0 | 95 ></A |
| 96 ><P | |
| 97 ></P | |
| 98 ><PRE | |
| 99 CLASS="FUNCSYNOPSISINFO" | |
| 100 >#include "SDL.h"</PRE | |
| 101 ><P | |
| 102 ><CODE | |
| 103 ><CODE | |
| 104 CLASS="FUNCDEF" | |
| 105 >int <B | |
| 106 CLASS="FSFUNC" | |
| 107 >SDL_VideoModeOK</B | |
| 108 ></CODE | |
| 109 >(int width, int height, int bpp, Uint32 flags);</CODE | |
| 110 ></P | |
| 111 ><P | |
| 112 ></P | |
| 113 ></DIV | |
| 114 ></DIV | |
| 115 ><DIV | |
| 116 CLASS="REFSECT1" | |
| 117 ><A | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
118 NAME="AEN1212" |
| 0 | 119 ></A |
| 120 ><H2 | |
| 121 >Description</H2 | |
| 122 ><P | |
| 123 ><TT | |
| 124 CLASS="FUNCTION" | |
| 125 >SDL_VideoModeOK</TT | |
| 126 > returns <SPAN | |
| 127 CLASS="RETURNVALUE" | |
| 128 >0</SPAN | |
| 129 > | |
| 130 if the requested mode is not supported under any bit depth, or returns the | |
| 131 bits-per-pixel of the closest available mode with the given width, height and requested <A | |
| 132 HREF="sdlsurface.html" | |
| 133 >surface</A | |
| 134 > flags (see <A | |
| 135 HREF="sdlsetvideomode.html" | |
| 136 ><TT | |
| 137 CLASS="FUNCTION" | |
| 138 >SDL_SetVideoMode</TT | |
| 139 ></A | |
| 140 >).</P | |
| 141 ><P | |
| 142 >The bits-per-pixel value returned is only a suggested mode. You can usually request and bpp you want when <A | |
| 143 HREF="sdlsetvideomode.html" | |
| 144 >setting</A | |
| 145 > the video mode and SDL will emulate that color depth with a shadow video surface.</P | |
| 146 ><P | |
| 147 >The arguments to <TT | |
| 148 CLASS="FUNCTION" | |
| 149 >SDL_VideoModeOK</TT | |
| 150 > are the same ones you | |
| 151 would pass to <A | |
| 152 HREF="sdlsetvideomode.html" | |
| 153 >SDL_SetVideoMode</A | |
| 154 ></P | |
| 155 ></DIV | |
| 156 ><DIV | |
| 157 CLASS="REFSECT1" | |
| 158 ><A | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
159 NAME="AEN1225" |
| 0 | 160 ></A |
| 161 ><H2 | |
| 162 >Example</H2 | |
| 163 ><PRE | |
| 164 CLASS="PROGRAMLISTING" | |
| 165 >SDL_Surface *screen; | |
| 166 Uint32 bpp; | |
| 167 . | |
| 168 . | |
| 169 . | |
| 170 printf("Checking mode 640x480@16bpp.\n"); | |
| 171 bpp=SDL_VideoModeOK(640, 480, 16, SDL_HWSURFACE); | |
| 172 | |
| 173 if(!bpp){ | |
| 174 printf("Mode not available.\n"); | |
| 175 exit(-1); | |
| 176 } | |
| 177 | |
| 178 printf("SDL Recommends 640x480@%dbpp.\n", bpp); | |
| 179 screen=SDL_SetVideoMode(640, 480, bpp, SDL_HWSURFACE); | |
| 180 . | |
| 181 .</PRE | |
| 182 ></DIV | |
| 183 ><DIV | |
| 184 CLASS="REFSECT1" | |
| 185 ><A | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
186 NAME="AEN1228" |
| 0 | 187 ></A |
| 188 ><H2 | |
| 189 >See Also</H2 | |
| 190 ><P | |
| 191 ><A | |
| 192 HREF="sdlsetvideomode.html" | |
| 193 ><TT | |
| 194 CLASS="FUNCTION" | |
| 195 >SDL_SetVideoMode</TT | |
| 196 ></A | |
| 197 >, | |
| 198 <A | |
| 199 HREF="sdlgetvideoinfo.html" | |
| 200 ><TT | |
| 201 CLASS="FUNCTION" | |
| 202 >SDL_GetVideoInfo</TT | |
| 203 ></A | |
| 204 ></P | |
| 205 ></DIV | |
| 206 ><DIV | |
| 207 CLASS="NAVFOOTER" | |
| 208 ><HR | |
| 209 ALIGN="LEFT" | |
| 210 WIDTH="100%"><TABLE | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
211 SUMMARY="Footer navigation table" |
| 0 | 212 WIDTH="100%" |
| 213 BORDER="0" | |
| 214 CELLPADDING="0" | |
| 215 CELLSPACING="0" | |
| 216 ><TR | |
| 217 ><TD | |
| 218 WIDTH="33%" | |
| 219 ALIGN="left" | |
| 220 VALIGN="top" | |
| 221 ><A | |
| 222 HREF="sdllistmodes.html" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
223 ACCESSKEY="P" |
| 0 | 224 >Prev</A |
| 225 ></TD | |
| 226 ><TD | |
| 227 WIDTH="34%" | |
| 228 ALIGN="center" | |
| 229 VALIGN="top" | |
| 230 ><A | |
| 231 HREF="index.html" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
232 ACCESSKEY="H" |
| 0 | 233 >Home</A |
| 234 ></TD | |
| 235 ><TD | |
| 236 WIDTH="33%" | |
| 237 ALIGN="right" | |
| 238 VALIGN="top" | |
| 239 ><A | |
| 240 HREF="sdlsetvideomode.html" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
241 ACCESSKEY="N" |
| 0 | 242 >Next</A |
| 243 ></TD | |
| 244 ></TR | |
| 245 ><TR | |
| 246 ><TD | |
| 247 WIDTH="33%" | |
| 248 ALIGN="left" | |
| 249 VALIGN="top" | |
| 250 >SDL_ListModes</TD | |
| 251 ><TD | |
| 252 WIDTH="34%" | |
| 253 ALIGN="center" | |
| 254 VALIGN="top" | |
| 255 ><A | |
| 256 HREF="video.html" | |
|
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
257 ACCESSKEY="U" |
| 0 | 258 >Up</A |
| 259 ></TD | |
| 260 ><TD | |
| 261 WIDTH="33%" | |
| 262 ALIGN="right" | |
| 263 VALIGN="top" | |
| 264 >SDL_SetVideoMode</TD | |
| 265 ></TR | |
| 266 ></TABLE | |
| 267 ></DIV | |
| 268 ></BODY | |
| 269 ></HTML | |
| 270 > |