Mercurial > sdl-ios-xcode
view docs/man3/SDL_ConvertSurface.3 @ 1662:782fd950bd46 SDL-1.3
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
WARNING: None of the video drivers have been updated for the new API yet! The API is still under design and very fluid.
The code is now run through a consistent indent format:
indent -i4 -nut -nsc -br -ce
The headers are being converted to automatically generate doxygen documentation.
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Sun, 28 May 2006 13:04:16 +0000 |
parents | e5bc29de3f0a |
children | 546f7c1eb755 |
line wrap: on
line source
.TH "SDL_ConvertSurface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" .SH "NAME" SDL_ConvertSurface\- Converts a surface to the same format as another surface\&. .SH "SYNOPSIS" .PP \fB#include "SDL/SDL\&.h" .sp \fBSDL_Surface *\fBSDL_ConvertSurface\fP\fR(\fBSDL_Surface *src, SDL_PixelFormat *fmt, Uint32 flags\fR); .SH "DESCRIPTION" .PP Creates a new surface of the specified format, and then copies and maps the given surface to it\&. If this function fails, it returns \fBNULL\fP\&. .PP The \fBflags\fR parameter is passed to \fI\fBSDL_CreateRGBSurface\fP\fR and has those semantics\&. .PP This function is used internally by \fI\fBSDL_DisplayFormat\fP\fR\&. .PP This function can only be called after SDL_Init\&. .SH "RETURN VALUE" .PP Returns either a pointer to the new surface, or \fBNULL\fP on error\&. .SH "SEE ALSO" .PP \fI\fBSDL_CreateRGBSurface\fP\fR, \fI\fBSDL_DisplayFormat\fP\fR, \fI\fBSDL_PixelFormat\fR\fR, \fI\fBSDL_Surface\fR\fR ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01