Mercurial > sdl-ios-xcode
view docs/html/sdlcreatergbsurface.html @ 0:74212992fb08
Initial revision
author | Sam Lantinga <slouken@lokigames.com> |
---|---|
date | Thu, 26 Apr 2001 16:45:43 +0000 |
parents | |
children | 55f1f1b3e27d |
line wrap: on
line source
<HTML ><HEAD ><TITLE >SDL_CreateRGBSurface</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_GetRGBA" HREF="sdlgetrgba.html"><LINK REL="NEXT" TITLE="SDL_CreateRGBSurfaceFrom" HREF="sdlcreatergbsurfacefrom.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="sdlgetrgba.html" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="sdlcreatergbsurfacefrom.html" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="SDLCREATERGBSURFACE" >SDL_CreateRGBSurface</A ></H1 ><DIV CLASS="REFNAMEDIV" ><A NAME="AEN1316" ></A ><H2 >Name</H2 >SDL_CreateRGBSurface -- Create an empty SDL_Surface</DIV ><DIV CLASS="REFSYNOPSISDIV" ><A NAME="AEN1319" ></A ><H2 >Synopsis</H2 ><DIV CLASS="FUNCSYNOPSIS" ><A NAME="AEN1320" ></A ><P ></P ><PRE CLASS="FUNCSYNOPSISINFO" >#include "SDL.h"</PRE ><P ><CODE ><CODE CLASS="FUNCDEF" >SDL_Surface *<B CLASS="FSFUNC" >SDL_CreateRGBSurface</B ></CODE >(Uint32 flags, int width, int height, int depth, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask);</CODE ></P ><P ></P ></DIV ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN1326" ></A ><H2 >Description</H2 ><P >Allocate an empty surface (must be called after <A HREF="sdlsetvideomode.html" >SDL_SetVideoMode</A >)</P ><P >If <TT CLASS="PARAMETER" ><I >depth</I ></TT > is 8 bits an empty palette is allocated for the surface, otherwise a 'packed-pixel' <A HREF="sdlpixelformat.html" ><SPAN CLASS="STRUCTNAME" >SDL_PixelFormat</SPAN ></A > is created using the <TT CLASS="PARAMETER" ><I >[RGBA]mask</I ></TT >'s provided (see <A HREF="sdlpixelformat.html" ><SPAN CLASS="STRUCTNAME" >SDL_PixelFormat</SPAN ></A >). The <TT CLASS="PARAMETER" ><I >flags</I ></TT > specifies the type of surface that should be created, it is an OR'd combination of the following possible values.</P ><DIV CLASS="INFORMALTABLE" ><A NAME="AEN1338" ></A ><P ></P ><TABLE BORDER="1" CLASS="CALSTABLE" ><TBODY ><TR ><TD ALIGN="LEFT" VALIGN="TOP" ><TT CLASS="LITERAL" >SDL_SWSURFACE</TT ></TD ><TD ALIGN="LEFT" VALIGN="TOP" >SDL will create the surface in system memory. This improves the performance of pixel level access, however you may not be able to take advantage of some types of hardware blitting.</TD ></TR ><TR ><TD ALIGN="LEFT" VALIGN="TOP" ><TT CLASS="LITERAL" >SDL_HWSURFACE</TT ></TD ><TD ALIGN="LEFT" VALIGN="TOP" >SDL will attempt to create the surface in video memory. This will allow SDL to take advantage of Video->Video blits (which are often accelerated).</TD ></TR ><TR ><TD ALIGN="LEFT" VALIGN="TOP" ><TT CLASS="LITERAL" >SDL_SRCCOLORKEY</TT ></TD ><TD ALIGN="LEFT" VALIGN="TOP" >With this flag SDL will attempt to find the best location for this surface, either in system memory or video memory, to obtain hardware colorkey blitting support.</TD ></TR ><TR ><TD ALIGN="LEFT" VALIGN="TOP" ><TT CLASS="LITERAL" >SDL_SRCALPHA</TT ></TD ><TD ALIGN="LEFT" VALIGN="TOP" >With this flag SDL will attempt to find the best location for this surface, either in system memory or video memory, to obtain hardware alpha support</TD ></TR ></TBODY ></TABLE ><P ></P ></DIV ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN1357" ></A ><H2 >See Also</H2 ><P ><A HREF="sdlcreatergbsurfacefrom.html" ><TT CLASS="FUNCTION" >SDL_CreateRGBSurfaceFrom</TT ></A >, <A HREF="sdlfreesurface.html" ><TT CLASS="FUNCTION" >SDL_FreeSurface</TT ></A >, <A HREF="sdlsetvideomode.html" ><TT CLASS="FUNCTION" >SDL_SetVideoMode</TT ></A >, <A HREF="sdllocksurface.html" ><TT CLASS="FUNCTION" >SDL_LockSurface</TT ></A >, <A HREF="sdlpixelformat.html" ><SPAN CLASS="STRUCTNAME" >SDL_PixelFormat</SPAN ></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="sdlgetrgba.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="sdlcreatergbsurfacefrom.html" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >SDL_GetRGBA</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="video.html" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >SDL_CreateRGBSurfaceFrom</TD ></TR ></TABLE ></DIV ></BODY ></HTML >