• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_Flip</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_UpdateRects"
17HREF="sdlupdaterects.html"><LINK
18REL="NEXT"
19TITLE="SDL_SetColors"
20HREF="sdlsetcolors.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="sdlupdaterects.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="sdlsetcolors.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLFLIP"
74></A
75>SDL_Flip</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN1426"
80></A
81><H2
82>Name</H2
83>SDL_Flip&nbsp;--&nbsp;Swaps screen buffers</DIV
84><DIV
85CLASS="REFSYNOPSISDIV"
86><A
87NAME="AEN1429"
88></A
89><H2
90>Synopsis</H2
91><DIV
92CLASS="FUNCSYNOPSIS"
93><A
94NAME="AEN1430"
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_Flip</B
108></CODE
109>(SDL_Surface *screen);</CODE
110></P
111><P
112></P
113></DIV
114></DIV
115><DIV
116CLASS="REFSECT1"
117><A
118NAME="AEN1436"
119></A
120><H2
121>Description</H2
122><P
123>On hardware that supports double-buffering, this function sets up a flip
124and returns.  The hardware will wait for vertical retrace, and then swap
125video buffers before the next video surface blit or lock will return.
126On hardware that doesn't support double-buffering, this is equivalent
127to calling <A
128HREF="sdlupdaterect.html"
129>SDL_UpdateRect</A
130><TT
131CLASS="PARAMETER"
132><I
133>(screen, 0, 0, 0, 0)</I
134></TT
135></P
136><P
137>The <TT
138CLASS="LITERAL"
139>SDL_DOUBLEBUF</TT
140> flag must have been passed to
141<A
142HREF="sdlsetvideomode.html"
143>SDL_SetVideoMode</A
144>,
145 when
146setting the video mode for this function to perform hardware flipping.</P
147></DIV
148><DIV
149CLASS="REFSECT1"
150><A
151NAME="AEN1444"
152></A
153><H2
154>Return Value</H2
155><P
156>This function returns <SPAN
157CLASS="RETURNVALUE"
158>0</SPAN
159> if successful, or
160<SPAN
161CLASS="RETURNVALUE"
162>-1</SPAN
163> if there was an error.</P
164></DIV
165><DIV
166CLASS="REFSECT1"
167><A
168NAME="AEN1449"
169></A
170><H2
171>See Also</H2
172><P
173><A
174HREF="sdlsetvideomode.html"
175><TT
176CLASS="FUNCTION"
177>SDL_SetVideoMode</TT
178></A
179>,
180<A
181HREF="sdlupdaterect.html"
182><TT
183CLASS="FUNCTION"
184>SDL_UpdateRect</TT
185></A
186>,
187<A
188HREF="sdlsurface.html"
189><SPAN
190CLASS="STRUCTNAME"
191>SDL_Surface</SPAN
192></A
193></P
194></DIV
195><DIV
196CLASS="NAVFOOTER"
197><HR
198ALIGN="LEFT"
199WIDTH="100%"><TABLE
200SUMMARY="Footer navigation table"
201WIDTH="100%"
202BORDER="0"
203CELLPADDING="0"
204CELLSPACING="0"
205><TR
206><TD
207WIDTH="33%"
208ALIGN="left"
209VALIGN="top"
210><A
211HREF="sdlupdaterects.html"
212ACCESSKEY="P"
213>Prev</A
214></TD
215><TD
216WIDTH="34%"
217ALIGN="center"
218VALIGN="top"
219><A
220HREF="index.html"
221ACCESSKEY="H"
222>Home</A
223></TD
224><TD
225WIDTH="33%"
226ALIGN="right"
227VALIGN="top"
228><A
229HREF="sdlsetcolors.html"
230ACCESSKEY="N"
231>Next</A
232></TD
233></TR
234><TR
235><TD
236WIDTH="33%"
237ALIGN="left"
238VALIGN="top"
239>SDL_UpdateRects</TD
240><TD
241WIDTH="34%"
242ALIGN="center"
243VALIGN="top"
244><A
245HREF="video.html"
246ACCESSKEY="U"
247>Up</A
248></TD
249><TD
250WIDTH="33%"
251ALIGN="right"
252VALIGN="top"
253>SDL_SetColors</TD
254></TR
255></TABLE
256></DIV
257></BODY
258></HTML
259>