Mercurial > sdl-ios-xcode

diff docs/html/sdldisplayformat.html @ 0:74212992fb08

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial revision
author Sam Lantinga <slouken@lokigames.com>
date Thu, 26 Apr 2001 16:45:43 +0000
parents
children 55f1f1b3e27d
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/html/sdldisplayformat.html	Thu Apr 26 16:45:43 2001 +0000
@@ -0,0 +1,254 @@
+<HTML
+><HEAD
+><TITLE
+>SDL_DisplayFormat</TITLE
+><META
+NAME="GENERATOR"
+CONTENT="Modular DocBook HTML Stylesheet Version 1.61
+"><LINK
+REL="HOME"
+TITLE="SDL Library Documentation"
+HREF="index.html"><LINK
+REL="UP"
+TITLE="Video"
+HREF="video.html"><LINK
+REL="PREVIOUS"
+TITLE="SDL_FillRect"
+HREF="sdlfillrect.html"><LINK
+REL="NEXT"
+TITLE="SDL_DisplayFormatAlpha"
+HREF="sdldisplayformatalpha.html"></HEAD
+><BODY
+CLASS="REFENTRY"
+BGCOLOR="#FFF8DC"
+TEXT="#000000"
+LINK="#0000ee"
+VLINK="#551a8b"
+ALINK="#ff0000"
+><DIV
+CLASS="NAVHEADER"
+><TABLE
+WIDTH="100%"
+BORDER="0"
+CELLPADDING="0"
+CELLSPACING="0"
+><TR
+><TH
+COLSPAN="3"
+ALIGN="center"
+>SDL Library Documentation</TH
+></TR
+><TR
+><TD
+WIDTH="10%"
+ALIGN="left"
+VALIGN="bottom"
+><A
+HREF="sdlfillrect.html"
+>Prev</A
+></TD
+><TD
+WIDTH="80%"
+ALIGN="center"
+VALIGN="bottom"
+></TD
+><TD
+WIDTH="10%"
+ALIGN="right"
+VALIGN="bottom"
+><A
+HREF="sdldisplayformatalpha.html"
+>Next</A
+></TD
+></TR
+></TABLE
+><HR
+ALIGN="LEFT"
+WIDTH="100%"></DIV
+><H1
+><A
+NAME="SDLDISPLAYFORMAT"
+>SDL_DisplayFormat</A
+></H1
+><DIV
+CLASS="REFNAMEDIV"
+><A
+NAME="AEN1898"
+></A
+><H2
+>Name</H2
+>SDL_DisplayFormat&nbsp;--&nbsp;Convert a surface to the display format</DIV
+><DIV
+CLASS="REFSYNOPSISDIV"
+><A
+NAME="AEN1901"
+></A
+><H2
+>Synopsis</H2
+><DIV
+CLASS="FUNCSYNOPSIS"
+><A
+NAME="AEN1902"
+></A
+><P
+></P
+><PRE
+CLASS="FUNCSYNOPSISINFO"
+>#include "SDL.h"</PRE
+><P
+><CODE
+><CODE
+CLASS="FUNCDEF"
+>SDL_Surface *<B
+CLASS="FSFUNC"
+>SDL_DisplayFormat</B
+></CODE
+>(SDL_Surface *surface);</CODE
+></P
+><P
+></P
+></DIV
+></DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN1908"
+></A
+><H2
+>Description</H2
+><P
+>This function takes a surface and copies it to a new surface of the
+pixel format and colors of the video framebuffer, suitable for fast
+blitting onto the display surface.  It calls
+<A
+HREF="sdlconvertsurface.html"
+>SDL_ConvertSurface</A
+></P
+><P
+>If you want to take advantage of hardware colorkey or alpha blit
+acceleration, you should set the colorkey and alpha value before
+calling this function.</P
+><P
+>If you want an alpha channel, see <A
+HREF="sdldisplayformatalpha.html"
+>SDL_DisplayFormatAlpha</A
+>.</P
+></DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN1915"
+></A
+><H2
+>Return Value</H2
+><P
+>If the conversion fails or runs out of memory, it returns
+<SPAN
+CLASS="RETURNVALUE"
+>NULL</SPAN
+></P
+></DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN1919"
+></A
+><H2
+>See Also</H2
+><P
+><A
+HREF="sdlconvertsurface.html"
+><TT
+CLASS="FUNCTION"
+>SDL_ConvertSurface</TT
+></A
+>,
+<A
+HREF="sdldisplayformatalpha.html"
+><TT
+CLASS="FUNCTION"
+>SDL_DisplayFormatAlpha</TT
+></A
+>
+<A
+HREF="sdlsetalpha.html"
+><TT
+CLASS="FUNCTION"
+>SDL_SetAlpha</TT
+></A
+>,
+<A
+HREF="sdlsetcolorkey.html"
+><TT
+CLASS="FUNCTION"
+>SDL_SetColorKey</TT
+></A
+>,
+<A
+HREF="sdlsurface.html"
+><SPAN
+CLASS="STRUCTNAME"
+>SDL_Surface</SPAN
+></A
+></P
+></DIV
+><DIV
+CLASS="NAVFOOTER"
+><HR
+ALIGN="LEFT"
+WIDTH="100%"><TABLE
+WIDTH="100%"
+BORDER="0"
+CELLPADDING="0"
+CELLSPACING="0"
+><TR
+><TD
+WIDTH="33%"
+ALIGN="left"
+VALIGN="top"
+><A
+HREF="sdlfillrect.html"
+>Prev</A
+></TD
+><TD
+WIDTH="34%"
+ALIGN="center"
+VALIGN="top"
+><A
+HREF="index.html"
+>Home</A
+></TD
+><TD
+WIDTH="33%"
+ALIGN="right"
+VALIGN="top"
+><A
+HREF="sdldisplayformatalpha.html"
+>Next</A
+></TD
+></TR
+><TR
+><TD
+WIDTH="33%"
+ALIGN="left"
+VALIGN="top"
+>SDL_FillRect</TD
+><TD
+WIDTH="34%"
+ALIGN="center"
+VALIGN="top"
+><A
+HREF="video.html"
+>Up</A
+></TD
+><TD
+WIDTH="33%"
+ALIGN="right"
+VALIGN="top"
+>SDL_DisplayFormatAlpha</TD
+></TR
+></TABLE
+></DIV
+></BODY
+></HTML
+>
\ No newline at end of file