e14743d1 |
1 | .TH "SDL_CreateRGBSurfaceFrom" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" |
2 | .SH "NAME" |
3 | SDL_CreateRGBSurfaceFrom \- Create an SDL_Surface from pixel data |
4 | .SH "SYNOPSIS" |
5 | .PP |
6 | \fB#include "SDL\&.h" |
7 | .sp |
8 | \fBSDL_Surface *\fBSDL_CreateRGBSurfaceFrom\fP\fR(\fBvoid *pixels, int width, int height, int depth, int pitch, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask\fR); |
9 | .SH "DESCRIPTION" |
10 | .PP |
11 | Creates an SDL_Surface from the provided pixel data\&. |
12 | .PP |
13 | The data stored in \fBpixels\fR is assumed to be of the \fBdepth\fR specified in the parameter list\&. The pixel data is not copied into the \fBSDL_Surface\fR structure so it should not be freed until the surface has been freed with a called to \fISDL_FreeSurface\fR\&. \fBpitch\fR is the length of each scanline in bytes\&. |
14 | .PP |
15 | See \fI\fBSDL_CreateRGBSurface\fP\fR for a more detailed description of the other parameters\&. |
16 | .SH "RETURN VALUE" |
17 | .PP |
18 | Returns the created surface, or \fBNULL\fR upon error\&. |
19 | .SH "SEE ALSO" |
20 | .PP |
21 | \fI\fBSDL_CreateRGBSurface\fP\fR, \fI\fBSDL_FreeSurface\fP\fR |
22 | .\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 |