IMG_SaveTyped_IO - Man Page

Save an SDL_Surface into formatted image data, via an SDL_IOStream.

Synopsis

#include <SDL3_image/SDL_image.h>

bool IMG_SaveTyped_IO(SDL_Surface *surface, SDL_IOStream *dst, bool closeio, const char *type);

Description

If you just want to save to a filename, you can use IMG_Save() instead.

If closeio is true, dst will be closed before returning, whether this function succeeds or not.

For formats that accept a quality, a default quality of 90 will be used.

Function Parameters

surface

the SDL surface to save.

dst

the SDL_IOStream to save the image data to.

closeio

true to close/free the SDL_IOStream before returning, false to leave it open.

type

a filename extension that represent this data ("BMP", "GIF", "PNG", etc).

Return Value

Returns true on success or false on failure; call SDL_GetError() for more information.

Availability

This function is available since SDL_image 3.4.0.

See Also

IMG_Save(3), IMG_SaveAVIF_IO(3), IMG_SaveBMP_IO(3), IMG_SaveCUR_IO(3), IMG_SaveGIF_IO(3), IMG_SaveICO_IO(3), IMG_SaveJPG_IO(3), IMG_SavePNG_IO(3), IMG_SaveTGA_IO(3), IMG_SaveWEBP_IO(3)

Referenced By

IMG_Save(3).

SDL_image 3.4.0 SDL_image3 FUNCTIONS