home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue2 / SDL.ARC / sdlhtmldox / sdlflip_ht < prev    next >
Encoding:
Text File  |  2001-05-09  |  3.2 KB  |  251 lines
  1. <HTML
  2. ><HEAD
  3. ><TITLE
  4. >SDL_Flip</TITLE
  5. ><META
  6. NAME="GENERATOR"
  7. CONTENT="Modular DocBook HTML Stylesheet Version 1.64
  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_UpdateRects"
  17. HREF="sdlupdaterects.html"><LINK
  18. REL="NEXT"
  19. TITLE="SDL_SetColors"
  20. HREF="sdlsetcolors.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="sdlupdaterects.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="sdlsetcolors.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="SDLFLIP"
  71. >SDL_Flip</A
  72. ></H1
  73. ><DIV
  74. CLASS="REFNAMEDIV"
  75. ><A
  76. NAME="AEN1044"
  77. ></A
  78. ><H2
  79. >Name</H2
  80. >SDL_Flip -- Swaps screen buffers</DIV
  81. ><DIV
  82. CLASS="REFSYNOPSISDIV"
  83. ><A
  84. NAME="AEN1047"
  85. ></A
  86. ><H2
  87. >Synopsis</H2
  88. ><DIV
  89. CLASS="FUNCSYNOPSIS"
  90. ><A
  91. NAME="AEN1048"
  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_Flip</B
  105. ></CODE
  106. >(SDL_Surface *screen);</CODE
  107. ></P
  108. ><P
  109. ></P
  110. ></DIV
  111. ></DIV
  112. ><DIV
  113. CLASS="REFSECT1"
  114. ><A
  115. NAME="AEN1054"
  116. ></A
  117. ><H2
  118. >Description</H2
  119. ><P
  120. >On hardware that supports double-buffering, this function sets up a flip
  121. and returns.  The hardware will wait for vertical retrace, and then swap
  122. video buffers before the next video surface blit or lock will return.
  123. On hardware that doesn't support double-buffering, this is equivalent
  124. to calling <A
  125. HREF="sdlupdaterect.html"
  126. >SDL_UpdateRect</A
  127. ><TT
  128. CLASS="PARAMETER"
  129. ><I
  130. >(screen, 0, 0, 0, 0)</I
  131. ></TT
  132. ></P
  133. ><P
  134. >The <TT
  135. CLASS="LITERAL"
  136. >SDL_DOUBLEBUF</TT
  137. > flag must have been passed to 
  138. <A
  139. HREF="sdlsetvideomode.html"
  140. >SDL_SetVideoMode</A
  141. >,
  142.  when
  143. setting the video mode for this function to perform hardware flipping.</P
  144. ></DIV
  145. ><DIV
  146. CLASS="REFSECT1"
  147. ><A
  148. NAME="AEN1062"
  149. ></A
  150. ><H2
  151. >Return Value</H2
  152. ><P
  153. >This function returns <SPAN
  154. CLASS="RETURNVALUE"
  155. >0</SPAN
  156. > if successful, or 
  157. <SPAN
  158. CLASS="RETURNVALUE"
  159. >-1</SPAN
  160. > if there was an error.</P
  161. ></DIV
  162. ><DIV
  163. CLASS="REFSECT1"
  164. ><A
  165. NAME="AEN1067"
  166. ></A
  167. ><H2
  168. >See Also</H2
  169. ><P
  170. ><A
  171. HREF="sdlsetvideomode.html"
  172. ><TT
  173. CLASS="FUNCTION"
  174. >SDL_SetVideoMode</TT
  175. ></A
  176. >,
  177. <A
  178. HREF="sdlupdaterect.html"
  179. ><TT
  180. CLASS="FUNCTION"
  181. >SDL_UpdateRect</TT
  182. ></A
  183. >,
  184. <A
  185. HREF="sdlsurface.html"
  186. ><SPAN
  187. CLASS="STRUCTNAME"
  188. >SDL_Surface</SPAN
  189. ></A
  190. ></P
  191. ></DIV
  192. ><DIV
  193. CLASS="NAVFOOTER"
  194. ><HR
  195. ALIGN="LEFT"
  196. WIDTH="100%"><TABLE
  197. WIDTH="100%"
  198. BORDER="0"
  199. CELLPADDING="0"
  200. CELLSPACING="0"
  201. ><TR
  202. ><TD
  203. WIDTH="33%"
  204. ALIGN="left"
  205. VALIGN="top"
  206. ><A
  207. HREF="sdlupdaterects.html"
  208. >Prev</A
  209. ></TD
  210. ><TD
  211. WIDTH="34%"
  212. ALIGN="center"
  213. VALIGN="top"
  214. ><A
  215. HREF="index.html"
  216. >Home</A
  217. ></TD
  218. ><TD
  219. WIDTH="33%"
  220. ALIGN="right"
  221. VALIGN="top"
  222. ><A
  223. HREF="sdlsetcolors.html"
  224. >Next</A
  225. ></TD
  226. ></TR
  227. ><TR
  228. ><TD
  229. WIDTH="33%"
  230. ALIGN="left"
  231. VALIGN="top"
  232. >SDL_UpdateRects</TD
  233. ><TD
  234. WIDTH="34%"
  235. ALIGN="center"
  236. VALIGN="top"
  237. ><A
  238. HREF="video.html"
  239. >Up</A
  240. ></TD
  241. ><TD
  242. WIDTH="33%"
  243. ALIGN="right"
  244. VALIGN="top"
  245. >SDL_SetColors</TD
  246. ></TR
  247. ></TABLE
  248. ></DIV
  249. ></BODY
  250. ></HTML
  251. >