Wiki Page Content

Revision 9 as of 2011-01-05 19:00:42

Clear message

SDL_ConvertSurface

Use this function to copy an existing surface into a new one that is optimized for blitting to a surface of a specified pixel format.

Syntax

SDL_Surface* SDL_ConvertSurface(SDL_Surface*     src,
                                SDL_PixelFormat* fmt,
                                Uint32           flags)

Function Parameters

src

the existing SDL_Surface structure to convert

fmt

the SDL_PixelFormat structure that the new surface is optimized for

flags

unused; set to 0

Return Value

Returns the new SDL_Surface structure that is created or NULL if it fails; call SDL_GetError() for more information.

Code Examples

You can add your code example here

Remarks

This function is used to optimize images for faster repeat blitting. Rather than converting with each blit this function stores the output of an initial blit requiring conversion as a new surface that then becomes the source for future blits.

This function creates an intermediate surface of an optimized format allowing the future blits to be as fast as possible.

You can add useful comments here


CategoryAPI, CategorySurface

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit