docs/html/sdlgetvideoinfo.html

   1 <HTML
   2 ><HEAD
   3 ><TITLE
   4 >SDL_GetVideoInfo</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="Video"
  14 HREF="video.html"><LINK
  15 REL="PREVIOUS"
  16 TITLE="SDL_GetVideoSurface"
  17 HREF="sdlgetvideosurface.html"><LINK
  18 REL="NEXT"
  19 TITLE="SDL_VideoDriverName"
  20 HREF="sdlvideodrivername.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="sdlgetvideosurface.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="sdlvideodrivername.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="SDLGETVIDEOINFO"
  74 ></A
  75 >SDL_GetVideoInfo</H1
  76 ><DIV
  77 CLASS="REFNAMEDIV"
  78 ><A
  79 NAME="AEN1100"
  80 ></A
  81 ><H2
  82 >Name</H2
  83 >SDL_GetVideoInfo&nbsp;--&nbsp;returns a pointer to information about the video hardware</DIV
  84 ><DIV
  85 CLASS="REFSYNOPSISDIV"
  86 ><A
  87 NAME="AEN1103"
  88 ></A
  89 ><H2
  90 >Synopsis</H2
  91 ><DIV
  92 CLASS="FUNCSYNOPSIS"
  93 ><A
  94 NAME="AEN1104"
  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 >SDL_VideoInfo *<B
 106 CLASS="FSFUNC"
 107 >SDL_GetVideoInfo</B
 108 ></CODE
 109 >(void);</CODE
 110 ></P
 111 ><P
 112 ></P
 113 ></DIV
 114 ></DIV
 115 ><DIV
 116 CLASS="REFSECT1"
 117 ><A
 118 NAME="AEN1110"
 119 ></A
 120 ><H2
 121 >Description</H2
 122 ><P
 123 >This function returns a read-only pointer to <A
 124 HREF="sdlvideoinfo.html"
 125 >information</A
 126 > about the video
 127 hardware.  If this is called before <A
 128 HREF="sdlsetvideomode.html"
 129 >SDL_SetVideoMode</A
 130 >, the
 131 <TT
 132 CLASS="STRUCTFIELD"
 133 ><I
 134 >vfmt</I
 135 ></TT
 136 > member of the returned structure will contain the
 137 pixel format of the "best" video mode.</P
 138 ></DIV
 139 ><DIV
 140 CLASS="REFSECT1"
 141 ><A
 142 NAME="AEN1116"
 143 ></A
 144 ><H2
 145 >See Also</H2
 146 ><P
 147 ><A
 148 HREF="sdlsetvideomode.html"
 149 ><TT
 150 CLASS="FUNCTION"
 151 >SDL_SetVideoMode</TT
 152 ></A
 153 >,
 154 <A
 155 HREF="sdlvideoinfo.html"
 156 ><SPAN
 157 CLASS="STRUCTNAME"
 158 >SDL_VideoInfo</SPAN
 159 ></A
 160 ></P
 161 ></DIV
 162 ><DIV
 163 CLASS="NAVFOOTER"
 164 ><HR
 165 ALIGN="LEFT"
 166 WIDTH="100%"><TABLE
 167 SUMMARY="Footer navigation table"
 168 WIDTH="100%"
 169 BORDER="0"
 170 CELLPADDING="0"
 171 CELLSPACING="0"
 172 ><TR
 173 ><TD
 174 WIDTH="33%"
 175 ALIGN="left"
 176 VALIGN="top"
 177 ><A
 178 HREF="sdlgetvideosurface.html"
 179 ACCESSKEY="P"
 180 >Prev</A
 181 ></TD
 182 ><TD
 183 WIDTH="34%"
 184 ALIGN="center"
 185 VALIGN="top"
 186 ><A
 187 HREF="index.html"
 188 ACCESSKEY="H"
 189 >Home</A
 190 ></TD
 191 ><TD
 192 WIDTH="33%"
 193 ALIGN="right"
 194 VALIGN="top"
 195 ><A
 196 HREF="sdlvideodrivername.html"
 197 ACCESSKEY="N"
 198 >Next</A
 199 ></TD
 200 ></TR
 201 ><TR
 202 ><TD
 203 WIDTH="33%"
 204 ALIGN="left"
 205 VALIGN="top"
 206 >SDL_GetVideoSurface</TD
 207 ><TD
 208 WIDTH="34%"
 209 ALIGN="center"
 210 VALIGN="top"
 211 ><A
 212 HREF="video.html"
 213 ACCESSKEY="U"
 214 >Up</A
 215 ></TD
 216 ><TD
 217 WIDTH="33%"
 218 ALIGN="right"
 219 VALIGN="top"
 220 >SDL_VideoDriverName</TD
 221 ></TR
 222 ></TABLE
 223 ></DIV
 224 ></BODY
 225 ></HTML
 226 >