• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_CreateRGBSurfaceFrom</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_CreateRGBSurface"
17HREF="sdlcreatergbsurface.html"><LINK
18REL="NEXT"
19TITLE="SDL_FreeSurface"
20HREF="sdlfreesurface.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="sdlcreatergbsurface.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="sdlfreesurface.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLCREATERGBSURFACEFROM"
74></A
75>SDL_CreateRGBSurfaceFrom</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN1856"
80></A
81><H2
82>Name</H2
83>SDL_CreateRGBSurfaceFrom&nbsp;--&nbsp;Create an SDL_Surface from pixel data</DIV
84><DIV
85CLASS="REFSYNOPSISDIV"
86><A
87NAME="AEN1859"
88></A
89><H2
90>Synopsis</H2
91><DIV
92CLASS="FUNCSYNOPSIS"
93><A
94NAME="AEN1860"
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_CreateRGBSurfaceFrom</B
108></CODE
109>(void *pixels, int width, int height, int depth, int pitch, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask);</CODE
110></P
111><P
112></P
113></DIV
114></DIV
115><DIV
116CLASS="REFSECT1"
117><A
118NAME="AEN1866"
119></A
120><H2
121>Description</H2
122><P
123>Creates an SDL_Surface from the provided pixel data.</P
124><P
125>The data stored in <TT
126CLASS="PARAMETER"
127><I
128>pixels</I
129></TT
130> is assumed to be of the <TT
131CLASS="PARAMETER"
132><I
133>depth</I
134></TT
135> specified in the parameter list. The pixel data is not copied into the <SPAN
136CLASS="STRUCTNAME"
137>SDL_Surface</SPAN
138> structure so it should not be freed until the surface has been freed with a called to <A
139HREF="sdlfreesurface.html"
140>SDL_FreeSurface</A
141>. <TT
142CLASS="PARAMETER"
143><I
144>pitch</I
145></TT
146> is the length of each scanline in bytes.  </P
147><P
148>See <A
149HREF="sdlcreatergbsurface.html"
150><TT
151CLASS="FUNCTION"
152>SDL_CreateRGBSurface</TT
153></A
154> for a more detailed description of the other parameters.</P
155></DIV
156><DIV
157CLASS="REFSECT1"
158><A
159NAME="AEN1878"
160></A
161><H2
162>Return Value</H2
163><P
164>Returns the created surface, or <SPAN
165CLASS="RETURNVALUE"
166>NULL</SPAN
167> upon error.</P
168></DIV
169><DIV
170CLASS="REFSECT1"
171><A
172NAME="AEN1882"
173></A
174><H2
175>See Also</H2
176><P
177><A
178HREF="sdlcreatergbsurface.html"
179><TT
180CLASS="FUNCTION"
181>SDL_CreateRGBSurface</TT
182></A
183>,
184<A
185HREF="sdlfreesurface.html"
186><TT
187CLASS="FUNCTION"
188>SDL_FreeSurface</TT
189></A
190></P
191></DIV
192><DIV
193CLASS="NAVFOOTER"
194><HR
195ALIGN="LEFT"
196WIDTH="100%"><TABLE
197SUMMARY="Footer navigation table"
198WIDTH="100%"
199BORDER="0"
200CELLPADDING="0"
201CELLSPACING="0"
202><TR
203><TD
204WIDTH="33%"
205ALIGN="left"
206VALIGN="top"
207><A
208HREF="sdlcreatergbsurface.html"
209ACCESSKEY="P"
210>Prev</A
211></TD
212><TD
213WIDTH="34%"
214ALIGN="center"
215VALIGN="top"
216><A
217HREF="index.html"
218ACCESSKEY="H"
219>Home</A
220></TD
221><TD
222WIDTH="33%"
223ALIGN="right"
224VALIGN="top"
225><A
226HREF="sdlfreesurface.html"
227ACCESSKEY="N"
228>Next</A
229></TD
230></TR
231><TR
232><TD
233WIDTH="33%"
234ALIGN="left"
235VALIGN="top"
236>SDL_CreateRGBSurface</TD
237><TD
238WIDTH="34%"
239ALIGN="center"
240VALIGN="top"
241><A
242HREF="video.html"
243ACCESSKEY="U"
244>Up</A
245></TD
246><TD
247WIDTH="33%"
248ALIGN="right"
249VALIGN="top"
250>SDL_FreeSurface</TD
251></TR
252></TABLE
253></DIV
254></BODY
255></HTML
256>