Wiki Page Content

SDL_SaveBMP_RW

Use this function to save a surface to a seekable SDL data stream (memory or file) in BMP format.

Syntax

int SDL_SaveBMP_RW(SDL_Surface* surface,
                   SDL_RWops*   dst,
                   int          freedst)

Function Parameters

surface

the SDL_Surface structure containing the image to be saved

dst

a data stream to save to

freedst

non-zero to close the stream after being written

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Code Examples

You can add your code example here

Remarks

Surfaces with a 24-bit, 32-bit and paletted 8-bit format get saved in the BMP directly. Other RGB formats with 8-bit or higher get converted to a 24-bit surface or, if they have an alpha mask or a colorkey, to a 32-bit surface before they are saved. YUV and paletted 1-bit and 4-bit formats are not supported.


CategoryAPI, CategorySurface

None: SDL_SaveBMP_RW (last edited 2016-10-08 22:35:29 by PhilippWiesemann)

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