• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_VideoModeOK</TITLE
5><META
6NAME="GENERATOR"
7CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8"><LINK
9REL="HOME"
10TITLE="SDL Library Documentation"
11HREF="index.html"><LINK
12REL="UP"
13TITLE="Video"
14HREF="video.html"><LINK
15REL="PREVIOUS"
16TITLE="SDL_ListModes"
17HREF="sdllistmodes.html"><LINK
18REL="NEXT"
19TITLE="SDL_SetVideoMode"
20HREF="sdlsetvideomode.html"></HEAD
21><BODY
22CLASS="REFENTRY"
23BGCOLOR="#FFF8DC"
24TEXT="#000000"
25LINK="#0000ee"
26VLINK="#551a8b"
27ALINK="#ff0000"
28><DIV
29CLASS="NAVHEADER"
30><TABLE
31SUMMARY="Header navigation table"
32WIDTH="100%"
33BORDER="0"
34CELLPADDING="0"
35CELLSPACING="0"
36><TR
37><TH
38COLSPAN="3"
39ALIGN="center"
40>SDL Library Documentation</TH
41></TR
42><TR
43><TD
44WIDTH="10%"
45ALIGN="left"
46VALIGN="bottom"
47><A
48HREF="sdllistmodes.html"
49ACCESSKEY="P"
50>Prev</A
51></TD
52><TD
53WIDTH="80%"
54ALIGN="center"
55VALIGN="bottom"
56></TD
57><TD
58WIDTH="10%"
59ALIGN="right"
60VALIGN="bottom"
61><A
62HREF="sdlsetvideomode.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLVIDEOMODEOK"
74></A
75>SDL_VideoModeOK</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN1202"
80></A
81><H2
82>Name</H2
83>SDL_VideoModeOK&nbsp;--&nbsp;Check to see if a particular video mode is supported.</DIV
84><DIV
85CLASS="REFSYNOPSISDIV"
86><A
87NAME="AEN1205"
88></A
89><H2
90>Synopsis</H2
91><DIV
92CLASS="FUNCSYNOPSIS"
93><A
94NAME="AEN1206"
95></A
96><P
97></P
98><PRE
99CLASS="FUNCSYNOPSISINFO"
100>#include "SDL.h"</PRE
101><P
102><CODE
103><CODE
104CLASS="FUNCDEF"
105>int <B
106CLASS="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
116CLASS="REFSECT1"
117><A
118NAME="AEN1212"
119></A
120><H2
121>Description</H2
122><P
123><TT
124CLASS="FUNCTION"
125>SDL_VideoModeOK</TT
126> returns <SPAN
127CLASS="RETURNVALUE"
128>0</SPAN
129>
130if the requested mode is not supported under any bit depth, or returns the
131bits-per-pixel of the closest available mode with the given width, height and requested <A
132HREF="sdlsurface.html"
133>surface</A
134> flags (see <A
135HREF="sdlsetvideomode.html"
136><TT
137CLASS="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
143HREF="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
148CLASS="FUNCTION"
149>SDL_VideoModeOK</TT
150> are the same ones you
151would pass to <A
152HREF="sdlsetvideomode.html"
153>SDL_SetVideoMode</A
154></P
155></DIV
156><DIV
157CLASS="REFSECT1"
158><A
159NAME="AEN1225"
160></A
161><H2
162>Example</H2
163><PRE
164CLASS="PROGRAMLISTING"
165>SDL_Surface *screen;
166Uint32 bpp;
167.
168.
169.
170printf("Checking mode 640x480@16bpp.\n");
171bpp=SDL_VideoModeOK(640, 480, 16, SDL_HWSURFACE);
172
173if(!bpp){
174  printf("Mode not available.\n");
175  exit(-1);
176}
177
178printf("SDL Recommends 640x480@%dbpp.\n", bpp);
179screen=SDL_SetVideoMode(640, 480, bpp, SDL_HWSURFACE);
180.
181.</PRE
182></DIV
183><DIV
184CLASS="REFSECT1"
185><A
186NAME="AEN1228"
187></A
188><H2
189>See Also</H2
190><P
191><A
192HREF="sdlsetvideomode.html"
193><TT
194CLASS="FUNCTION"
195>SDL_SetVideoMode</TT
196></A
197>,
198<A
199HREF="sdlgetvideoinfo.html"
200><TT
201CLASS="FUNCTION"
202>SDL_GetVideoInfo</TT
203></A
204></P
205></DIV
206><DIV
207CLASS="NAVFOOTER"
208><HR
209ALIGN="LEFT"
210WIDTH="100%"><TABLE
211SUMMARY="Footer navigation table"
212WIDTH="100%"
213BORDER="0"
214CELLPADDING="0"
215CELLSPACING="0"
216><TR
217><TD
218WIDTH="33%"
219ALIGN="left"
220VALIGN="top"
221><A
222HREF="sdllistmodes.html"
223ACCESSKEY="P"
224>Prev</A
225></TD
226><TD
227WIDTH="34%"
228ALIGN="center"
229VALIGN="top"
230><A
231HREF="index.html"
232ACCESSKEY="H"
233>Home</A
234></TD
235><TD
236WIDTH="33%"
237ALIGN="right"
238VALIGN="top"
239><A
240HREF="sdlsetvideomode.html"
241ACCESSKEY="N"
242>Next</A
243></TD
244></TR
245><TR
246><TD
247WIDTH="33%"
248ALIGN="left"
249VALIGN="top"
250>SDL_ListModes</TD
251><TD
252WIDTH="34%"
253ALIGN="center"
254VALIGN="top"
255><A
256HREF="video.html"
257ACCESSKEY="U"
258>Up</A
259></TD
260><TD
261WIDTH="33%"
262ALIGN="right"
263VALIGN="top"
264>SDL_SetVideoMode</TD
265></TR
266></TABLE
267></DIV
268></BODY
269></HTML
270>