docs/man3/SDL_CreateRGBSurfaceFrom.3
author Sam Lantinga <slouken@libsdl.org>
Wed, 08 Mar 2006 18:30:12 +0000
changeset 1486 9d77fc9d0ace
parent 181 e5bc29de3f0a
child 2283 546f7c1eb755
permissions -rw-r--r--
Re-added C runtime support for Visual C++ 5,6
slouken@181
     1
.TH "SDL_CreateRGBSurfaceFrom" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" 
slouken@0
     2
.SH "NAME"
slouken@0
     3
SDL_CreateRGBSurfaceFrom\- Create an SDL_Surface from pixel data
slouken@0
     4
.SH "SYNOPSIS"
slouken@0
     5
.PP
slouken@0
     6
\fB#include "SDL\&.h"
slouken@0
     7
.sp
slouken@0
     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);
slouken@0
     9
.SH "DESCRIPTION"
slouken@0
    10
.PP
slouken@0
    11
Creates an SDL_Surface from the provided pixel data\&.
slouken@0
    12
.PP
slouken@55
    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\&. 
slouken@0
    14
.PP
slouken@0
    15
See \fI\fBSDL_CreateRGBSurface\fP\fR for a more detailed description of the other parameters\&.
slouken@55
    16
.SH "RETURN VALUE"
slouken@55
    17
.PP
slouken@55
    18
Returns the created surface, or \fBNULL\fR upon error\&.
slouken@0
    19
.SH "SEE ALSO"
slouken@0
    20
.PP
slouken@0
    21
\fI\fBSDL_CreateRGBSurface\fP\fR, \fI\fBSDL_FreeSurface\fP\fR
slouken@181
    22
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01