SDL-1.2.14
[sdl_omap.git] / docs / html / sdlwmtogglefullscreen.html
CommitLineData
e14743d1 1<HTML
2><HEAD
3><TITLE
4>SDL_WM_ToggleFullScreen</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="Window Management"
14HREF="wm.html"><LINK
15REL="PREVIOUS"
16TITLE="SDL_WM_IconifyWindow"
17HREF="sdlwmiconifywindow.html"><LINK
18REL="NEXT"
19TITLE="SDL_WM_GrabInput"
20HREF="sdlwmgrabinput.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="sdlwmiconifywindow.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="sdlwmgrabinput.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLWMTOGGLEFULLSCREEN"
74></A
75>SDL_WM_ToggleFullScreen</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN3641"
80></A
81><H2
82>Name</H2
83>SDL_WM_ToggleFullScreen&nbsp;--&nbsp;Toggles fullscreen mode</DIV
84><DIV
85CLASS="REFSYNOPSISDIV"
86><A
87NAME="AEN3644"
88></A
89><H2
90>Synopsis</H2
91><DIV
92CLASS="FUNCSYNOPSIS"
93><A
94NAME="AEN3645"
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_WM_ToggleFullScreen</B
108></CODE
109>(SDL_Surface *surface);</CODE
110></P
111><P
112></P
113></DIV
114></DIV
115><DIV
116CLASS="REFSECT1"
117><A
118NAME="AEN3651"
119></A
120><H2
121>Description</H2
122><P
123>Toggles the application between windowed and fullscreen mode, if supported. (X11 is the only target currently supported, BeOS support is experimental).</P
124></DIV
125><DIV
126CLASS="REFSECT1"
127><A
128NAME="AEN3654"
129></A
130><H2
131>Return Value</H2
132><P
133>Returns <SPAN
134CLASS="RETURNVALUE"
135>0</SPAN
136> on failure or <SPAN
137CLASS="RETURNVALUE"
138>1</SPAN
139> on success.</P
140></DIV
141><DIV
142CLASS="NAVFOOTER"
143><HR
144ALIGN="LEFT"
145WIDTH="100%"><TABLE
146SUMMARY="Footer navigation table"
147WIDTH="100%"
148BORDER="0"
149CELLPADDING="0"
150CELLSPACING="0"
151><TR
152><TD
153WIDTH="33%"
154ALIGN="left"
155VALIGN="top"
156><A
157HREF="sdlwmiconifywindow.html"
158ACCESSKEY="P"
159>Prev</A
160></TD
161><TD
162WIDTH="34%"
163ALIGN="center"
164VALIGN="top"
165><A
166HREF="index.html"
167ACCESSKEY="H"
168>Home</A
169></TD
170><TD
171WIDTH="33%"
172ALIGN="right"
173VALIGN="top"
174><A
175HREF="sdlwmgrabinput.html"
176ACCESSKEY="N"
177>Next</A
178></TD
179></TR
180><TR
181><TD
182WIDTH="33%"
183ALIGN="left"
184VALIGN="top"
185>SDL_WM_IconifyWindow</TD
186><TD
187WIDTH="34%"
188ALIGN="center"
189VALIGN="top"
190><A
191HREF="wm.html"
192ACCESSKEY="U"
193>Up</A
194></TD
195><TD
196WIDTH="33%"
197ALIGN="right"
198VALIGN="top"
199>SDL_WM_GrabInput</TD
200></TR
201></TABLE
202></DIV
203></BODY
204></HTML
205>