DragonFly On-Line Manual Pages

Search: Section:  


SDL_DisplayFormat(3)	       SDL API Reference	  SDL_DisplayFormat(3)

NAME

SDL_DisplayFormat - Convert a surface to the display format

SYNOPSIS

#include "SDL.h" SDL_Surface *SDL_DisplayFormat(SDL_Surface *surface);

DESCRIPTION

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 SDL_ConvertSurface If you want to take advantage of hardware colorkey or alpha blit accel- eration, you should set the colorkey and alpha value before calling this function. If you want an alpha channel, see SDL_DisplayFormatAlpha.

RETURN VALUE

If the conversion fails or runs out of memory, it returns NULL

SEE ALSO

SDL_ConvertSurface, SDL_DisplayFormatAlpha SDL_SetAlpha, SDL_SetCol- orKey, SDL_Surface SDL Tue 11 Sep 2001, 23:01 SDL_DisplayFormat(3)

Search: Section: