mirror of
https://github.com/joel16/SDL2.git
synced 2024-12-14 23:09:55 +00:00
23 lines
966 B
Groff
23 lines
966 B
Groff
.TH "SDL_ConvertSurface" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference"
|
|
.SH "NAME"
|
|
SDL_ConvertSurface\- Converts a surface to the same format as another surface\&.
|
|
.SH "SYNOPSIS"
|
|
.PP
|
|
\fB#include "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\&.
|
|
.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, Mon 12 Mar 2001, 01:04
|