1<HTML 2><HEAD 3><TITLE 4>SDL_DisplayFormat</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_FillRect" 17HREF="sdlfillrect.html"><LINK 18REL="NEXT" 19TITLE="SDL_DisplayFormatAlpha" 20HREF="sdldisplayformatalpha.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="sdlfillrect.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="sdldisplayformatalpha.html" 63ACCESSKEY="N" 64>Next</A 65></TD 66></TR 67></TABLE 68><HR 69ALIGN="LEFT" 70WIDTH="100%"></DIV 71><H1 72><A 73NAME="SDLDISPLAYFORMAT" 74></A 75>SDL_DisplayFormat</H1 76><DIV 77CLASS="REFNAMEDIV" 78><A 79NAME="AEN2394" 80></A 81><H2 82>Name</H2 83>SDL_DisplayFormat -- Convert a surface to the display format</DIV 84><DIV 85CLASS="REFSYNOPSISDIV" 86><A 87NAME="AEN2397" 88></A 89><H2 90>Synopsis</H2 91><DIV 92CLASS="FUNCSYNOPSIS" 93><A 94NAME="AEN2398" 95></A 96><P 97></P 98><PRE 99CLASS="FUNCSYNOPSISINFO" 100>#include "SDL.h"</PRE 101><P 102><CODE 103><CODE 104CLASS="FUNCDEF" 105>SDL_Surface *<B 106CLASS="FSFUNC" 107>SDL_DisplayFormat</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="AEN2404" 119></A 120><H2 121>Description</H2 122><P 123>This function takes a surface and copies it to a new surface of the 124pixel format and colors of the video framebuffer, suitable for fast 125blitting onto the display surface. It calls 126<A 127HREF="sdlconvertsurface.html" 128>SDL_ConvertSurface</A 129></P 130><P 131>If you want to take advantage of hardware colorkey or alpha blit 132acceleration, you should set the colorkey and alpha value before 133calling this function.</P 134><P 135>If you want an alpha channel, see <A 136HREF="sdldisplayformatalpha.html" 137>SDL_DisplayFormatAlpha</A 138>.</P 139></DIV 140><DIV 141CLASS="REFSECT1" 142><A 143NAME="AEN2411" 144></A 145><H2 146>Return Value</H2 147><P 148>If the conversion fails or runs out of memory, it returns 149<SPAN 150CLASS="RETURNVALUE" 151>NULL</SPAN 152></P 153></DIV 154><DIV 155CLASS="REFSECT1" 156><A 157NAME="AEN2415" 158></A 159><H2 160>See Also</H2 161><P 162><A 163HREF="sdlconvertsurface.html" 164><TT 165CLASS="FUNCTION" 166>SDL_ConvertSurface</TT 167></A 168>, 169<A 170HREF="sdldisplayformatalpha.html" 171><TT 172CLASS="FUNCTION" 173>SDL_DisplayFormatAlpha</TT 174></A 175> 176<A 177HREF="sdlsetalpha.html" 178><TT 179CLASS="FUNCTION" 180>SDL_SetAlpha</TT 181></A 182>, 183<A 184HREF="sdlsetcolorkey.html" 185><TT 186CLASS="FUNCTION" 187>SDL_SetColorKey</TT 188></A 189>, 190<A 191HREF="sdlsurface.html" 192><SPAN 193CLASS="STRUCTNAME" 194>SDL_Surface</SPAN 195></A 196></P 197></DIV 198><DIV 199CLASS="NAVFOOTER" 200><HR 201ALIGN="LEFT" 202WIDTH="100%"><TABLE 203SUMMARY="Footer navigation table" 204WIDTH="100%" 205BORDER="0" 206CELLPADDING="0" 207CELLSPACING="0" 208><TR 209><TD 210WIDTH="33%" 211ALIGN="left" 212VALIGN="top" 213><A 214HREF="sdlfillrect.html" 215ACCESSKEY="P" 216>Prev</A 217></TD 218><TD 219WIDTH="34%" 220ALIGN="center" 221VALIGN="top" 222><A 223HREF="index.html" 224ACCESSKEY="H" 225>Home</A 226></TD 227><TD 228WIDTH="33%" 229ALIGN="right" 230VALIGN="top" 231><A 232HREF="sdldisplayformatalpha.html" 233ACCESSKEY="N" 234>Next</A 235></TD 236></TR 237><TR 238><TD 239WIDTH="33%" 240ALIGN="left" 241VALIGN="top" 242>SDL_FillRect</TD 243><TD 244WIDTH="34%" 245ALIGN="center" 246VALIGN="top" 247><A 248HREF="video.html" 249ACCESSKEY="U" 250>Up</A 251></TD 252><TD 253WIDTH="33%" 254ALIGN="right" 255VALIGN="top" 256>SDL_DisplayFormatAlpha</TD 257></TR 258></TABLE 259></DIV 260></BODY 261></HTML 262>