Mercurial > sdl-ios-xcode

comparison docs/man3/SDL_CreateRGBSurfaceFrom.3 @ 55:55f1f1b3e27d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added new docs for SDL 1.2.1
author Sam Lantinga <slouken@lokigames.com>
date Sun, 10 Jun 2001 19:31:57 +0000
parents 74212992fb08
children e5bc29de3f0a
comparison
equal deleted inserted replaced
54:028447a8a758 55:55f1f1b3e27d
1 .TH "SDL_CreateRGBSurfaceFrom" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" 1 .TH "SDL_CreateRGBSurfaceFrom" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
2 .SH "NAME" 2 .SH "NAME"
3 SDL_CreateRGBSurfaceFrom\- Create an SDL_Surface from pixel data 3 SDL_CreateRGBSurfaceFrom\- Create an SDL_Surface from pixel data
4 .SH "SYNOPSIS" 4 .SH "SYNOPSIS"
5 .PP 5 .PP
6 \fB#include "SDL\&.h" 6 \fB#include "SDL\&.h"
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); 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" 9 .SH "DESCRIPTION"
10 .PP 10 .PP
11 Creates an SDL_Surface from the provided pixel data\&. 11 Creates an SDL_Surface from the provided pixel data\&.
12 .PP 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 no 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\&. 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 14 .PP
15 See \fI\fBSDL_CreateRGBSurface\fP\fR for a more detailed description of the other parameters\&. 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\&.
16 .SH "SEE ALSO" 19 .SH "SEE ALSO"
17 .PP 20 .PP
18 \fI\fBSDL_CreateRGBSurface\fP\fR, \fI\fBSDL_FreeSurface\fP\fR 21 \fI\fBSDL_CreateRGBSurface\fP\fR, \fI\fBSDL_FreeSurface\fP\fR
19 ...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 22 ...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41