Mercurial > sdl-ios-xcode
annotate docs/html/sdlcreatergbsurfacefrom.html @ 181:e5bc29de3f0a
Updated from the SDL Documentation Project
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Fri, 14 Sep 2001 02:41:09 +0000 |
parents | 55f1f1b3e27d |
children | 355632dca928 |
rev | line source |
---|---|
0 | 1 <HTML |
2 ><HEAD | |
3 ><TITLE | |
4 >SDL_CreateRGBSurfaceFrom</TITLE | |
5 ><META | |
6 NAME="GENERATOR" | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.64 |
0 | 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_CreateRGBSurface" | |
17 HREF="sdlcreatergbsurface.html"><LINK | |
18 REL="NEXT" | |
19 TITLE="SDL_FreeSurface" | |
20 HREF="sdlfreesurface.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 WIDTH="100%" | |
32 BORDER="0" | |
33 CELLPADDING="0" | |
34 CELLSPACING="0" | |
35 ><TR | |
36 ><TH | |
37 COLSPAN="3" | |
38 ALIGN="center" | |
39 >SDL Library Documentation</TH | |
40 ></TR | |
41 ><TR | |
42 ><TD | |
43 WIDTH="10%" | |
44 ALIGN="left" | |
45 VALIGN="bottom" | |
46 ><A | |
47 HREF="sdlcreatergbsurface.html" | |
48 >Prev</A | |
49 ></TD | |
50 ><TD | |
51 WIDTH="80%" | |
52 ALIGN="center" | |
53 VALIGN="bottom" | |
54 ></TD | |
55 ><TD | |
56 WIDTH="10%" | |
57 ALIGN="right" | |
58 VALIGN="bottom" | |
59 ><A | |
60 HREF="sdlfreesurface.html" | |
61 >Next</A | |
62 ></TD | |
63 ></TR | |
64 ></TABLE | |
65 ><HR | |
66 ALIGN="LEFT" | |
67 WIDTH="100%"></DIV | |
68 ><H1 | |
69 ><A | |
70 NAME="SDLCREATERGBSURFACEFROM" | |
71 >SDL_CreateRGBSurfaceFrom</A | |
72 ></H1 | |
73 ><DIV | |
74 CLASS="REFNAMEDIV" | |
75 ><A | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
76 NAME="AEN1472" |
0 | 77 ></A |
78 ><H2 | |
79 >Name</H2 | |
80 >SDL_CreateRGBSurfaceFrom -- Create an SDL_Surface from pixel data</DIV | |
81 ><DIV | |
82 CLASS="REFSYNOPSISDIV" | |
83 ><A | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
84 NAME="AEN1475" |
0 | 85 ></A |
86 ><H2 | |
87 >Synopsis</H2 | |
88 ><DIV | |
89 CLASS="FUNCSYNOPSIS" | |
90 ><A | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
91 NAME="AEN1476" |
0 | 92 ></A |
93 ><P | |
94 ></P | |
95 ><PRE | |
96 CLASS="FUNCSYNOPSISINFO" | |
97 >#include "SDL.h"</PRE | |
98 ><P | |
99 ><CODE | |
100 ><CODE | |
101 CLASS="FUNCDEF" | |
102 >SDL_Surface *<B | |
103 CLASS="FSFUNC" | |
104 >SDL_CreateRGBSurfaceFrom</B | |
105 ></CODE | |
106 >(void *pixels, int width, int height, int depth, int pitch, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask);</CODE | |
107 ></P | |
108 ><P | |
109 ></P | |
110 ></DIV | |
111 ></DIV | |
112 ><DIV | |
113 CLASS="REFSECT1" | |
114 ><A | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
115 NAME="AEN1482" |
0 | 116 ></A |
117 ><H2 | |
118 >Description</H2 | |
119 ><P | |
120 >Creates an SDL_Surface from the provided pixel data.</P | |
121 ><P | |
122 >The data stored in <TT | |
123 CLASS="PARAMETER" | |
124 ><I | |
125 >pixels</I | |
126 ></TT | |
127 > is assumed to be of the <TT | |
128 CLASS="PARAMETER" | |
129 ><I | |
130 >depth</I | |
131 ></TT | |
132 > specified in the parameter list. The pixel data is not copied into the <SPAN | |
133 CLASS="STRUCTNAME" | |
134 >SDL_Surface</SPAN | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
135 > structure so it should not be freed until the surface has been freed with a called to <A |
0 | 136 HREF="sdlfreesurface.html" |
137 >SDL_FreeSurface</A | |
138 >. <TT | |
139 CLASS="PARAMETER" | |
140 ><I | |
141 >pitch</I | |
142 ></TT | |
143 > is the length of each scanline in bytes. </P | |
144 ><P | |
145 >See <A | |
146 HREF="sdlcreatergbsurface.html" | |
147 ><TT | |
148 CLASS="FUNCTION" | |
149 >SDL_CreateRGBSurface</TT | |
150 ></A | |
151 > for a more detailed description of the other parameters.</P | |
152 ></DIV | |
153 ><DIV | |
154 CLASS="REFSECT1" | |
155 ><A | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
156 NAME="AEN1494" |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
157 ></A |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
158 ><H2 |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
159 >Return Value</H2 |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
160 ><P |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
161 >Returns the created surface, or <SPAN |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
162 CLASS="RETURNVALUE" |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
163 >NULL</SPAN |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
164 > upon error.</P |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
165 ></DIV |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
166 ><DIV |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
167 CLASS="REFSECT1" |
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
168 ><A |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
169 NAME="AEN1498" |
0 | 170 ></A |
171 ><H2 | |
172 >See Also</H2 | |
173 ><P | |
174 ><A | |
175 HREF="sdlcreatergbsurface.html" | |
176 ><TT | |
177 CLASS="FUNCTION" | |
178 >SDL_CreateRGBSurface</TT | |
179 ></A | |
180 >, | |
181 <A | |
182 HREF="sdlfreesurface.html" | |
183 ><TT | |
184 CLASS="FUNCTION" | |
185 >SDL_FreeSurface</TT | |
186 ></A | |
187 ></P | |
188 ></DIV | |
189 ><DIV | |
190 CLASS="NAVFOOTER" | |
191 ><HR | |
192 ALIGN="LEFT" | |
193 WIDTH="100%"><TABLE | |
194 WIDTH="100%" | |
195 BORDER="0" | |
196 CELLPADDING="0" | |
197 CELLSPACING="0" | |
198 ><TR | |
199 ><TD | |
200 WIDTH="33%" | |
201 ALIGN="left" | |
202 VALIGN="top" | |
203 ><A | |
204 HREF="sdlcreatergbsurface.html" | |
205 >Prev</A | |
206 ></TD | |
207 ><TD | |
208 WIDTH="34%" | |
209 ALIGN="center" | |
210 VALIGN="top" | |
211 ><A | |
212 HREF="index.html" | |
213 >Home</A | |
214 ></TD | |
215 ><TD | |
216 WIDTH="33%" | |
217 ALIGN="right" | |
218 VALIGN="top" | |
219 ><A | |
220 HREF="sdlfreesurface.html" | |
221 >Next</A | |
222 ></TD | |
223 ></TR | |
224 ><TR | |
225 ><TD | |
226 WIDTH="33%" | |
227 ALIGN="left" | |
228 VALIGN="top" | |
229 >SDL_CreateRGBSurface</TD | |
230 ><TD | |
231 WIDTH="34%" | |
232 ALIGN="center" | |
233 VALIGN="top" | |
234 ><A | |
235 HREF="video.html" | |
236 >Up</A | |
237 ></TD | |
238 ><TD | |
239 WIDTH="33%" | |
240 ALIGN="right" | |
241 VALIGN="top" | |
242 >SDL_FreeSurface</TD | |
243 ></TR | |
244 ></TABLE | |
245 ></DIV | |
246 ></BODY | |
247 ></HTML | |
248 > |