docs/html/sdlwmtogglefullscreen.html

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