Mercurial > sdl-ios-xcode
view docs/man3/SDL_DisplayFormat.3 @ 4440:7bb8f748a14d SDL-1.2
Fixed bug 978
Yann Leprince 2010-03-31 11:07:53 PDT
Please add a #serial line as below to sdl.m4 and increase the serial number
with each revision of this file. This allows using aclocal --install, thereby
enabling automatic updating of sdl.m4 in SDL-based packages that distribute it.
# serial 1
The complete documentation and rationale for #serial can be found in the
Automake documentation:
<http://www.gnu.org/software/automake/manual/html_node/Serials.html>.
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Fri, 23 Apr 2010 02:19:19 -0700 |
parents | 1238da4a7112 |
children |
line wrap: on
line source
.TH "SDL_DisplayFormat" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" .SH "NAME" SDL_DisplayFormat \- Convert a surface to the display format .SH "SYNOPSIS" .PP \fB#include "SDL\&.h" .sp \fBSDL_Surface *\fBSDL_DisplayFormat\fP\fR(\fBSDL_Surface *surface\fR); .SH "DESCRIPTION" .PP This function takes a surface and copies it to a new surface of the pixel format and colors of the video framebuffer, suitable for fast blitting onto the display surface\&. It calls \fISDL_ConvertSurface\fR .PP If you want to take advantage of hardware colorkey or alpha blit acceleration, you should set the colorkey and alpha value before calling this function\&. .PP If you want an alpha channel, see \fISDL_DisplayFormatAlpha\fR\&. .SH "RETURN VALUE" .PP If the conversion fails or runs out of memory, it returns \fBNULL\fR .SH "SEE ALSO" .PP \fI\fBSDL_ConvertSurface\fP\fR, \fI\fBSDL_DisplayFormatAlpha\fP\fR \fI\fBSDL_SetAlpha\fP\fR, \fI\fBSDL_SetColorKey\fP\fR, \fI\fBSDL_Surface\fR\fR .\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01