This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
SDL_ConvertSurface.3
1
.TH "SDL_ConvertSurface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
2
.SH "NAME"
3
SDL_ConvertSurface \- Converts a surface to the same format as another surface\&.
4
5
.SH "SYNOPSIS"
.PP
6
\fB#include "SDL/SDL\&.h"
7
8
9
10
11
12
13
14
15
.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\&.
16
17
.PP
This function can only be called after SDL_Init\&.
18
19
20
21
22
23
.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
24
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01