view docs/man3/SDL_ConvertSurface.3 @ 3164:c5b2884c26b4

Added an ifdef so that if you #define SDL_NO_COMPAT before you include SDL.h then SDL_compat.h will never be included in your code. This is useful for making sure that your code uses only SDL 1.3 features. It is also handy for finding things that are in SDL_compat.h that belong elsewhere.
author Bob Pendleton <bob@pendleton.com>
date Thu, 04 Jun 2009 21:00:45 +0000
parents 546f7c1eb755
children 1238da4a7112
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