DRAFT

SDL_FreeSurface

Use this function to allocate and free an RGB surface.

Syntax

void SDL_FreeSurface(SDL_Surface* surface)

Function Parameters

surface

a pointer to the [[SDL_Surface]] to free --or-- *a pointer to the surface to delete; it is safe to pass NULL as surface, may be NULL in which case SDL_FreeSurface() will do nothing*

Code Examples

You can add your code example here

Remarks

You can add useful comments here

I don't think this note applies to this function but this function was listed with the group below in the header so I'll leave it because it's easier to delete than add when we're editing. If the depth is 4 or 8 bits, an empty palette is allocated for the surface. If the depth is greater than 8 bits, the pixel format is set using the flags '[RGB]mask'.

*
Frees the resources used by a previously created SDL_Surface. If the surface was created using SDL_CreateRGBSurfaceFrom() then the pixel data is not freed.
*


CategoryAPI, CategorySurface

SDL_FreeSurface (last edited 2010-08-23 18:01:45 by SheenaSmith)