Header file for SDL_image library. More...

Classes
struct	SDL::AnimationBase
	Animated image support. More...

struct	SDL::AnimationRef
	Handle to a non owned animation. More...

struct	SDL::Animation
	Handle to an owned animation. More...

Macros
#define	SDL_IMAGE_VERSION
	This is the version number macro for the current SDL_image version.

#define	SDL_IMAGE_VERSION_ATLEAST(X, Y, Z)
	This macro will evaluate to true if compiled with SDL_image at least X.Y.Z.

Functions
int	SDL::IMG_Version ()
	This function gets the version of the dynamically linked SDL_image library.

Surface	SDL::LoadSurface (IOStreamBase &src, StringParam type)
	Load an image from an SDL data source into a software surface.

Surface	SDL::LoadSurface (StringParam file)
	Load an image from a filesystem path into a software surface.

Surface	SDL::LoadSurface (IOStreamBase &src)
	Load an image from an SDL data source into a software surface.

Texture	SDL::LoadTexture (RendererBase &renderer, StringParam file)
	Load an image from a filesystem path into a GPU texture.

Texture	SDL::LoadTexture (RendererBase &renderer, IOStreamBase &src)
	Load an image from an SDL data source into a GPU texture.

Texture	SDL::LoadTexture (RendererBase &renderer, IOStreamBase &src, StringParam type)
	Load an image from an SDL data source into a GPU texture.

bool	SDL::isAVIF (IOStreamBase &src)
	Detect AVIF image data on a readable/seekable IOStreamBase.

bool	SDL::isICO (IOStreamBase &src)
	Detect ICO image data on a readable/seekable IOStreamBase.

bool	SDL::isCUR (IOStreamBase &src)
	Detect CUR image data on a readable/seekable IOStreamBase.

bool	SDL::isBMP (IOStreamBase &src)
	Detect BMP image data on a readable/seekable IOStreamBase.

bool	SDL::isGIF (IOStreamBase &src)
	Detect GIF image data on a readable/seekable IOStreamBase.

bool	SDL::isJPG (IOStreamBase &src)
	Detect JPG image data on a readable/seekable IOStreamBase.

bool	SDL::isJXL (IOStreamBase &src)
	Detect JXL image data on a readable/seekable IOStreamBase.

bool	SDL::isLBM (IOStreamBase &src)
	Detect LBM image data on a readable/seekable IOStreamBase.

bool	SDL::isPCX (IOStreamBase &src)
	Detect PCX image data on a readable/seekable IOStreamBase.

bool	SDL::isPNG (IOStreamBase &src)
	Detect PNG image data on a readable/seekable IOStreamBase.

bool	SDL::isPNM (IOStreamBase &src)
	Detect PNM image data on a readable/seekable IOStreamBase.

bool	SDL::isSVG (IOStreamBase &src)
	Detect SVG image data on a readable/seekable IOStreamBase.

bool	SDL::isQOI (IOStreamBase &src)
	Detect QOI image data on a readable/seekable IOStreamBase.

bool	SDL::isTIF (IOStreamBase &src)
	Detect TIFF image data on a readable/seekable IOStreamBase.

bool	SDL::isXCF (IOStreamBase &src)
	Detect XCF image data on a readable/seekable IOStreamBase.

bool	SDL::isXPM (IOStreamBase &src)
	Detect XPM image data on a readable/seekable IOStreamBase.

bool	SDL::isXV (IOStreamBase &src)
	Detect XV image data on a readable/seekable IOStreamBase.

bool	SDL::isWEBP (IOStreamBase &src)
	Detect WEBP image data on a readable/seekable IOStreamBase.

Surface	SDL::LoadAVIF (IOStreamBase &src)
	Load a AVIF image directly.

Surface	SDL::LoadICO (IOStreamBase &src)
	Load a ICO image directly.

Surface	SDL::LoadCUR (IOStreamBase &src)
	Load a CUR image directly.

Surface	SDL::LoadGIF (IOStreamBase &src)
	Load a GIF image directly.

Surface	SDL::LoadJPG (IOStreamBase &src)
	Load a JPG image directly.

Surface	SDL::LoadJXL (IOStreamBase &src)
	Load a JXL image directly.

Surface	SDL::LoadLBM (IOStreamBase &src)
	Load a LBM image directly.

Surface	SDL::LoadPCX (IOStreamBase &src)
	Load a PCX image directly.

Surface	SDL::LoadPNG (IOStreamBase &src)
	Load a PNG image directly.

Surface	SDL::LoadPNM (IOStreamBase &src)
	Load a PNM image directly.

Surface	SDL::LoadSVG (IOStreamBase &src)
	Load a SVG image directly.

Surface	SDL::LoadQOI (IOStreamBase &src)
	Load a QOI image directly.

Surface	SDL::LoadTGA (IOStreamBase &src)
	Load a TGA image directly.

Surface	SDL::LoadTIF (IOStreamBase &src)
	Load a TIFF image directly.

Surface	SDL::LoadXCF (IOStreamBase &src)
	Load a XCF image directly.

Surface	SDL::LoadXPM (IOStreamBase &src)
	Load a XPM image directly.

Surface	SDL::LoadXV (IOStreamBase &src)
	Load a XV image directly.

Surface	SDL::LoadWEBP (IOStreamBase &src)
	Load a WEBP image directly.

Surface	SDL::LoadSizedSVG (IOStreamBase &src, int width, int height)
	Load an SVG image, scaled to a specific size.

Surface	SDL::ReadXPMFromArray (char **xpm)
	Load an XPM image from a memory array.

Surface	SDL::ReadXPMFromArrayToRGB888 (char **xpm)
	Load an XPM image from a memory array.

void	SDL::SaveAVIF (SurfaceBase &surface, StringParam file, int quality)
	Save an SurfaceBase into a AVIF image file.

void	SDL::SaveAVIF (SurfaceRef surface, IOStreamBase &dst, int quality)
	Save an SurfaceBase into AVIF image data, via an IOStreamBase.

void	SDL::SavePNG (SurfaceBase &surface, StringParam file)
	Save an SurfaceBase into a PNG image file.

void	SDL::SavePNG (SurfaceRef surface, IOStreamBase &dst)
	Save an SurfaceBase into PNG image data, via an IOStreamBase.

void	SDL::SaveJPG (SurfaceBase &surface, StringParam file, int quality)
	Save an SurfaceBase into a JPEG image file.

void	SDL::SaveJPG (SurfaceRef surface, IOStreamBase &dst, int quality)
	Save an SurfaceBase into JPEG image data, via an IOStreamBase.

Animation	SDL::LoadGIFAnimation (IOStreamBase &src)
	Load a GIF animation directly.

Animation	SDL::LoadWEBPAnimation (IOStreamBase &src)
	Load a WEBP animation directly.

Detailed Description

A simple library to load images of various formats as SDL surfaces

Macro Definition Documentation

◆ SDL_IMAGE_VERSION

#define SDL_IMAGE_VERSION

Value:

SDL_VERSIONNUM( \

SDL_IMAGE_MAJOR_VERSION, SDL_IMAGE_MINOR_VERSION, SDL_IMAGE_MICRO_VERSION)

SDL_VERSIONNUM

#define SDL_VERSIONNUM(major, minor, patch)

This macro turns the version numbers into a numeric value.

Definition SDL3pp_version.h:59

◆ SDL_IMAGE_VERSION_ATLEAST

#define SDL_IMAGE_VERSION_ATLEAST	(	X,
		Y,
		Z
	)

Value:

  ((SDL_IMAGE_MAJOR_VERSION >= X) &&                                           \
   (SDL_IMAGE_MAJOR_VERSION > X || SDL_IMAGE_MINOR_VERSION >= Y) &&            \
   (SDL_IMAGE_MAJOR_VERSION > X || SDL_IMAGE_MINOR_VERSION > Y ||              \
    SDL_IMAGE_MICRO_VERSION >= Z))

Function Documentation

◆ IMG_Version()

int SDL::IMG_Version ( )

inline

Returns: SDL_image version.

Since: This function is available since SDL_image 3.0.0.

◆ isAVIF()

bool SDL::isAVIF ( IOStreamBase & src )

inline

This function attempts to determine if a file is a given filetype, reading the least amount possible from the IOStreamBase (usually a few bytes).

There is no distinction made between "not the filetype in question" and basic i/o errors.

This function will always attempt to seek src back to where it started when this function was called, but it will not report any errors in doing so, but assuming seeking works, this means you can immediately use this with a different IMG_isTYPE function, or load the image without further seeking.

You do not need to call this function to load data; SDL_image can work to determine file type in many cases in its standard load functions.

Parameters

src	a seekable/readable IOStreamBase to provide image data.

Returns: non-zero if this is AVIF data, zero otherwise.

Since: This function is available since SDL_image 3.0.0.

See also: isAVIF; isICO; isCUR; isBMP; isGIF; isJPG; isJXL; isLBM; isPCX; isPNG; isPNM; isSVG; isQOI; isTIF; isXCF; isXPM; isXV; isWEBP

◆ isBMP()

bool SDL::isBMP ( IOStreamBase & src )

inline

This function attempts to determine if a file is a given filetype, reading the least amount possible from the IOStreamBase (usually a few bytes).

There is no distinction made between "not the filetype in question" and basic i/o errors.

This function will always attempt to seek src back to where it started when this function was called, but it will not report any errors in doing so, but assuming seeking works, this means you can immediately use this with a different IMG_isTYPE function, or load the image without further seeking.

You do not need to call this function to load data; SDL_image can work to determine file type in many cases in its standard load functions.

Parameters

src	a seekable/readable IOStreamBase to provide image data.

Returns: non-zero if this is BMP data, zero otherwise.

Since: This function is available since SDL_image 3.0.0.

See also: isAVIF; isICO; isCUR; isGIF; isJPG; isJXL; isLBM; isPCX; isPNG; isPNM; isSVG; isQOI; isTIF; isXCF; isXPM; isXV; isWEBP

◆ isCUR()

bool SDL::isCUR ( IOStreamBase & src )

inline

This function attempts to determine if a file is a given filetype, reading the least amount possible from the IOStreamBase (usually a few bytes).

There is no distinction made between "not the filetype in question" and basic i/o errors.

This function will always attempt to seek src back to where it started when this function was called, but it will not report any errors in doing so, but assuming seeking works, this means you can immediately use this with a different IMG_isTYPE function, or load the image without further seeking.

You do not need to call this function to load data; SDL_image can work to determine file type in many cases in its standard load functions.

Parameters

src	a seekable/readable IOStreamBase to provide image data.

Returns: non-zero if this is CUR data, zero otherwise.

Since: This function is available since SDL_image 3.0.0.

See also: isAVIF; isICO; isBMP; isGIF; isJPG; isJXL; isLBM; isPCX; isPNG; isPNM; isSVG; isQOI; isTIF; isXCF; isXPM; isXV; isWEBP

◆ isGIF()

bool SDL::isGIF ( IOStreamBase & src )

inline

This function attempts to determine if a file is a given filetype, reading the least amount possible from the IOStreamBase (usually a few bytes).

There is no distinction made between "not the filetype in question" and basic i/o errors.

This function will always attempt to seek src back to where it started when this function was called, but it will not report any errors in doing so, but assuming seeking works, this means you can immediately use this with a different IMG_isTYPE function, or load the image without further seeking.

You do not need to call this function to load data; SDL_image can work to determine file type in many cases in its standard load functions.

Parameters

src	a seekable/readable IOStreamBase to provide image data.

Returns: non-zero if this is GIF data, zero otherwise.

Since: This function is available since SDL_image 3.0.0.

See also: isAVIF; isICO; isCUR; isBMP; isJPG; isJXL; isLBM; isPCX; isPNG; isPNM; isSVG; isQOI; isTIF; isXCF; isXPM; isXV; isWEBP

◆ isICO()

bool SDL::isICO ( IOStreamBase & src )

inline

This function attempts to determine if a file is a given filetype, reading the least amount possible from the IOStreamBase (usually a few bytes).

There is no distinction made between "not the filetype in question" and basic i/o errors.

This function will always attempt to seek src back to where it started when this function was called, but it will not report any errors in doing so, but assuming seeking works, this means you can immediately use this with a different IMG_isTYPE function, or load the image without further seeking.

You do not need to call this function to load data; SDL_image can work to determine file type in many cases in its standard load functions.

Parameters

src	a seekable/readable IOStreamBase to provide image data.

Returns: non-zero if this is ICO data, zero otherwise.

Since: This function is available since SDL_image 3.0.0.

See also: isAVIF; isCUR; isBMP; isGIF; isJPG; isJXL; isLBM; isPCX; isPNG; isPNM; isSVG; isQOI; isTIF; isXCF; isXPM; isXV; isWEBP

◆ isJPG()

bool SDL::isJPG ( IOStreamBase & src )

inline

This function attempts to determine if a file is a given filetype, reading the least amount possible from the IOStreamBase (usually a few bytes).

There is no distinction made between "not the filetype in question" and basic i/o errors.

This function will always attempt to seek src back to where it started when this function was called, but it will not report any errors in doing so, but assuming seeking works, this means you can immediately use this with a different IMG_isTYPE function, or load the image without further seeking.

You do not need to call this function to load data; SDL_image can work to determine file type in many cases in its standard load functions.

Parameters

src	a seekable/readable IOStreamBase to provide image data.

Returns: non-zero if this is JPG data, zero otherwise.

Since: This function is available since SDL_image 3.0.0.

See also: isAVIF; isICO; isCUR; isBMP; isGIF; isJXL; isLBM; isPCX; isPNG; isPNM; isSVG; isQOI; isTIF; isXCF; isXPM; isXV; isWEBP

◆ isJXL()

bool SDL::isJXL ( IOStreamBase & src )

inline

This function attempts to determine if a file is a given filetype, reading the least amount possible from the IOStreamBase (usually a few bytes).

There is no distinction made between "not the filetype in question" and basic i/o errors.

This function will always attempt to seek src back to where it started when this function was called, but it will not report any errors in doing so, but assuming seeking works, this means you can immediately use this with a different IMG_isTYPE function, or load the image without further seeking.

You do not need to call this function to load data; SDL_image can work to determine file type in many cases in its standard load functions.

Parameters

src	a seekable/readable IOStreamBase to provide image data.

Returns: non-zero if this is JXL data, zero otherwise.

Since: This function is available since SDL_image 3.0.0.

See also: isAVIF; isICO; isCUR; isBMP; isGIF; isJPG; isLBM; isPCX; isPNG; isPNM; isSVG; isQOI; isTIF; isXCF; isXPM; isXV; isWEBP

◆ isLBM()

bool SDL::isLBM ( IOStreamBase & src )

inline

This function attempts to determine if a file is a given filetype, reading the least amount possible from the IOStreamBase (usually a few bytes).

There is no distinction made between "not the filetype in question" and basic i/o errors.

This function will always attempt to seek src back to where it started when this function was called, but it will not report any errors in doing so, but assuming seeking works, this means you can immediately use this with a different IMG_isTYPE function, or load the image without further seeking.

You do not need to call this function to load data; SDL_image can work to determine file type in many cases in its standard load functions.

Parameters

src	a seekable/readable IOStreamBase to provide image data.

Returns: non-zero if this is LBM data, zero otherwise.

Since: This function is available since SDL_image 3.0.0.

See also: isAVIF; isICO; isCUR; isBMP; isGIF; isJPG; isJXL; isPCX; isPNG; isPNM; isSVG; isQOI; isTIF; isXCF; isXPM; isXV; isWEBP

◆ isPCX()

bool SDL::isPCX ( IOStreamBase & src )

inline

This function attempts to determine if a file is a given filetype, reading the least amount possible from the IOStreamBase (usually a few bytes).

There is no distinction made between "not the filetype in question" and basic i/o errors.

This function will always attempt to seek src back to where it started when this function was called, but it will not report any errors in doing so, but assuming seeking works, this means you can immediately use this with a different IMG_isTYPE function, or load the image without further seeking.

You do not need to call this function to load data; SDL_image can work to determine file type in many cases in its standard load functions.

Parameters

src	a seekable/readable IOStreamBase to provide image data.

Returns: non-zero if this is PCX data, zero otherwise.

Since: This function is available since SDL_image 3.0.0.

See also: isAVIF; isICO; isCUR; isBMP; isGIF; isJPG; isJXL; isLBM; isPNG; isPNM; isSVG; isQOI; isTIF; isXCF; isXPM; isXV; isWEBP

◆ isPNG()

bool SDL::isPNG ( IOStreamBase & src )

inline

This function attempts to determine if a file is a given filetype, reading the least amount possible from the IOStreamBase (usually a few bytes).

There is no distinction made between "not the filetype in question" and basic i/o errors.

This function will always attempt to seek src back to where it started when this function was called, but it will not report any errors in doing so, but assuming seeking works, this means you can immediately use this with a different IMG_isTYPE function, or load the image without further seeking.

You do not need to call this function to load data; SDL_image can work to determine file type in many cases in its standard load functions.

Parameters

src	a seekable/readable IOStreamBase to provide image data.

Returns: non-zero if this is PNG data, zero otherwise.

Since: This function is available since SDL_image 3.0.0.

See also: isAVIF; isICO; isCUR; isBMP; isGIF; isJPG; isJXL; isLBM; isPCX; isPNM; isSVG; isQOI; isTIF; isXCF; isXPM; isXV; isWEBP

◆ isPNM()

bool SDL::isPNM ( IOStreamBase & src )

inline

This function attempts to determine if a file is a given filetype, reading the least amount possible from the IOStreamBase (usually a few bytes).

There is no distinction made between "not the filetype in question" and basic i/o errors.

This function will always attempt to seek src back to where it started when this function was called, but it will not report any errors in doing so, but assuming seeking works, this means you can immediately use this with a different IMG_isTYPE function, or load the image without further seeking.

You do not need to call this function to load data; SDL_image can work to determine file type in many cases in its standard load functions.

Parameters

src	a seekable/readable IOStreamBase to provide image data.

Returns: non-zero if this is PNM data, zero otherwise.

Since: This function is available since SDL_image 3.0.0.

See also: isAVIF; isICO; isCUR; isBMP; isGIF; isJPG; isJXL; isLBM; isPCX; isPNG; isSVG; isQOI; isTIF; isXCF; isXPM; isXV; isWEBP

◆ isQOI()

bool SDL::isQOI ( IOStreamBase & src )

inline

This function attempts to determine if a file is a given filetype, reading the least amount possible from the IOStreamBase (usually a few bytes).

There is no distinction made between "not the filetype in question" and basic i/o errors.

This function will always attempt to seek src back to where it started when this function was called, but it will not report any errors in doing so, but assuming seeking works, this means you can immediately use this with a different IMG_isTYPE function, or load the image without further seeking.

You do not need to call this function to load data; SDL_image can work to determine file type in many cases in its standard load functions.

Parameters

src	a seekable/readable IOStreamBase to provide image data.

Returns: non-zero if this is QOI data, zero otherwise.

Since: This function is available since SDL_image 3.0.0.

See also: isAVIF; isICO; isCUR; isBMP; isGIF; isJPG; isJXL; isLBM; isPCX; isPNG; isPNM; isSVG; isTIF; isXCF; isXPM; isXV; isWEBP

◆ isSVG()

bool SDL::isSVG ( IOStreamBase & src )

inline

This function attempts to determine if a file is a given filetype, reading the least amount possible from the IOStreamBase (usually a few bytes).

There is no distinction made between "not the filetype in question" and basic i/o errors.

This function will always attempt to seek src back to where it started when this function was called, but it will not report any errors in doing so, but assuming seeking works, this means you can immediately use this with a different IMG_isTYPE function, or load the image without further seeking.

You do not need to call this function to load data; SDL_image can work to determine file type in many cases in its standard load functions.

Parameters

src	a seekable/readable IOStreamBase to provide image data.

Returns: non-zero if this is SVG data, zero otherwise.

Since: This function is available since SDL_image 3.0.0.

See also: isAVIF; isICO; isCUR; isBMP; isGIF; isJPG; isJXL; isLBM; isPCX; isPNG; isPNM; isQOI; isTIF; isXCF; isXPM; isXV; isWEBP

◆ isTIF()

bool SDL::isTIF ( IOStreamBase & src )

inline

This function attempts to determine if a file is a given filetype, reading the least amount possible from the IOStreamBase (usually a few bytes).

There is no distinction made between "not the filetype in question" and basic i/o errors.

This function will always attempt to seek src back to where it started when this function was called, but it will not report any errors in doing so, but assuming seeking works, this means you can immediately use this with a different IMG_isTYPE function, or load the image without further seeking.

You do not need to call this function to load data; SDL_image can work to determine file type in many cases in its standard load functions.

Parameters

src	a seekable/readable IOStreamBase to provide image data.

Returns: non-zero if this is TIFF data, zero otherwise.

Since: This function is available since SDL_image 3.0.0.

See also: isAVIF; isICO; isCUR; isBMP; isGIF; isJPG; isJXL; isLBM; isPCX; isPNG; isPNM; isSVG; isQOI; isXCF; isXPM; isXV; isWEBP

◆ isWEBP()

bool SDL::isWEBP ( IOStreamBase & src )

inline

This function attempts to determine if a file is a given filetype, reading the least amount possible from the IOStreamBase (usually a few bytes).

There is no distinction made between "not the filetype in question" and basic i/o errors.

This function will always attempt to seek src back to where it started when this function was called, but it will not report any errors in doing so, but assuming seeking works, this means you can immediately use this with a different IMG_isTYPE function, or load the image without further seeking.

You do not need to call this function to load data; SDL_image can work to determine file type in many cases in its standard load functions.

Parameters

src	a seekable/readable IOStreamBase to provide image data.

Returns: non-zero if this is WEBP data, zero otherwise.

Since: This function is available since SDL_image 3.0.0.

See also: isAVIF; isICO; isCUR; isBMP; isGIF; isJPG; isJXL; isLBM; isPCX; isPNG; isPNM; isSVG; isQOI; isTIF; isXCF; isXPM; isXV

◆ isXCF()

bool SDL::isXCF ( IOStreamBase & src )

inline

This function attempts to determine if a file is a given filetype, reading the least amount possible from the IOStreamBase (usually a few bytes).

There is no distinction made between "not the filetype in question" and basic i/o errors.

This function will always attempt to seek src back to where it started when this function was called, but it will not report any errors in doing so, but assuming seeking works, this means you can immediately use this with a different IMG_isTYPE function, or load the image without further seeking.

You do not need to call this function to load data; SDL_image can work to determine file type in many cases in its standard load functions.

Parameters

src	a seekable/readable IOStreamBase to provide image data.

Returns: non-zero if this is XCF data, zero otherwise.

Since: This function is available since SDL_image 3.0.0.

See also: isAVIF; isICO; isCUR; isBMP; isGIF; isJPG; isJXL; isLBM; isPCX; isPNG; isPNM; isSVG; isQOI; isTIF; isXPM; isXV; isWEBP

◆ isXPM()

bool SDL::isXPM ( IOStreamBase & src )

inline

This function attempts to determine if a file is a given filetype, reading the least amount possible from the IOStreamBase (usually a few bytes).

There is no distinction made between "not the filetype in question" and basic i/o errors.

This function will always attempt to seek src back to where it started when this function was called, but it will not report any errors in doing so, but assuming seeking works, this means you can immediately use this with a different IMG_isTYPE function, or load the image without further seeking.

You do not need to call this function to load data; SDL_image can work to determine file type in many cases in its standard load functions.

Parameters

src	a seekable/readable IOStreamBase to provide image data.

Returns: non-zero if this is XPM data, zero otherwise.

Since: This function is available since SDL_image 3.0.0.

See also: isAVIF; isICO; isCUR; isBMP; isGIF; isJPG; isJXL; isLBM; isPCX; isPNG; isPNM; isSVG; isQOI; isTIF; isXCF; isXV; isWEBP

◆ isXV()

bool SDL::isXV ( IOStreamBase & src )

inline

This function attempts to determine if a file is a given filetype, reading the least amount possible from the IOStreamBase (usually a few bytes).

There is no distinction made between "not the filetype in question" and basic i/o errors.

This function will always attempt to seek src back to where it started when this function was called, but it will not report any errors in doing so, but assuming seeking works, this means you can immediately use this with a different IMG_isTYPE function, or load the image without further seeking.

You do not need to call this function to load data; SDL_image can work to determine file type in many cases in its standard load functions.

Parameters

src	a seekable/readable IOStreamBase to provide image data.

Returns: non-zero if this is XV data, zero otherwise.

Since: This function is available since SDL_image 3.0.0.

See also: isAVIF; isICO; isCUR; isBMP; isGIF; isJPG; isJXL; isLBM; isPCX; isPNG; isPNM; isSVG; isQOI; isTIF; isXCF; isXPM; isWEBP

◆ LoadAVIF()

Surface SDL::LoadAVIF ( IOStreamBase & src )

inline

If you know you definitely have a AVIF image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase to load image data from.

Returns: SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadICO; LoadCUR; LoadBMP; LoadGIF; LoadJPG; LoadJXL; LoadLBM; LoadPCX; LoadPNG; LoadPNM; LoadSVG; LoadQOI; LoadTGA; LoadTIF; LoadXCF; LoadXPM; LoadXV; LoadWEBP

◆ LoadCUR()

Surface SDL::LoadCUR ( IOStreamBase & src )

inline

If you know you definitely have a CUR image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase to load image data from.

Returns: SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadAVIF; LoadICO; LoadBMP; LoadGIF; LoadJPG; LoadJXL; LoadLBM; LoadPCX; LoadPNG; LoadPNM; LoadSVG; LoadQOI; LoadTGA; LoadTIF; LoadXCF; LoadXPM; LoadXV; LoadWEBP

◆ LoadGIF()

Surface SDL::LoadGIF ( IOStreamBase & src )

inline

If you know you definitely have a GIF image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase to load image data from.

Returns: SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadAVIF; LoadICO; LoadCUR; LoadBMP; LoadJPG; LoadJXL; LoadLBM; LoadPCX; LoadPNG; LoadPNM; LoadSVG; LoadQOI; LoadTGA; LoadTIF; LoadXCF; LoadXPM; LoadXV; LoadWEBP

◆ LoadGIFAnimation()

Animation SDL::LoadGIFAnimation ( IOStreamBase & src )

inline

If you know you definitely have a GIF image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase that data will be read from.

Returns: a new AnimationBase, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: AnimationBase.AnimationBase; AnimationRef.reset

◆ LoadICO()

Surface SDL::LoadICO ( IOStreamBase & src )

inline

If you know you definitely have a ICO image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase to load image data from.

Returns: SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadAVIF; LoadCUR; LoadBMP; LoadGIF; LoadJPG; LoadJXL; LoadLBM; LoadPCX; LoadPNG; LoadPNM; LoadSVG; LoadQOI; LoadTGA; LoadTIF; LoadXCF; LoadXPM; LoadXV; LoadWEBP

◆ LoadJPG()

Surface SDL::LoadJPG ( IOStreamBase & src )

inline

If you know you definitely have a JPG image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase to load image data from.

Returns: SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadAVIF; LoadICO; LoadCUR; LoadBMP; LoadGIF; LoadJXL; LoadLBM; LoadPCX; LoadPNG; LoadPNM; LoadSVG; LoadQOI; LoadTGA; LoadTIF; LoadXCF; LoadXPM; LoadXV; LoadWEBP

◆ LoadJXL()

Surface SDL::LoadJXL ( IOStreamBase & src )

inline

If you know you definitely have a JXL image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase to load image data from.

Returns: SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadAVIF; LoadICO; LoadCUR; LoadBMP; LoadGIF; LoadJPG; LoadLBM; LoadPCX; LoadPNG; LoadPNM; LoadSVG; LoadQOI; LoadTGA; LoadTIF; LoadXCF; LoadXPM; LoadXV; LoadWEBP

◆ LoadLBM()

Surface SDL::LoadLBM ( IOStreamBase & src )

inline

If you know you definitely have a LBM image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase to load image data from.

Returns: SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadAVIF; LoadICO; LoadCUR; LoadBMP; LoadGIF; LoadJPG; LoadJXL; LoadPCX; LoadPNG; LoadPNM; LoadSVG; LoadQOI; LoadTGA; LoadTIF; LoadXCF; LoadXPM; LoadXV; LoadWEBP

◆ LoadPCX()

Surface SDL::LoadPCX ( IOStreamBase & src )

inline

If you know you definitely have a PCX image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase to load image data from.

Returns: SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadAVIF; LoadICO; LoadCUR; LoadBMP; LoadGIF; LoadJPG; LoadJXL; LoadLBM; LoadPNG; LoadPNM; LoadSVG; LoadQOI; LoadTGA; LoadTIF; LoadXCF; LoadXPM; LoadXV; LoadWEBP

◆ LoadPNG()

Surface SDL::LoadPNG ( IOStreamBase & src )

inline

If you know you definitely have a PNG image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase to load image data from.

Returns: SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadAVIF; LoadICO; LoadCUR; LoadBMP; LoadGIF; LoadJPG; LoadJXL; LoadLBM; LoadPCX; LoadPNM; LoadSVG; LoadQOI; LoadTGA; LoadTIF; LoadXCF; LoadXPM; LoadXV; LoadWEBP

◆ LoadPNM()

Surface SDL::LoadPNM ( IOStreamBase & src )

inline

If you know you definitely have a PNM image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase to load image data from.

Returns: SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadAVIF; LoadICO; LoadCUR; LoadBMP; LoadGIF; LoadJPG; LoadJXL; LoadLBM; LoadPCX; LoadPNG; LoadSVG; LoadQOI; LoadTGA; LoadTIF; LoadXCF; LoadXPM; LoadXV; LoadWEBP

◆ LoadQOI()

Surface SDL::LoadQOI ( IOStreamBase & src )

inline

If you know you definitely have a QOI image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase to load image data from.

Returns: SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadAVIF; LoadICO; LoadCUR; LoadBMP; LoadGIF; LoadJPG; LoadJXL; LoadLBM; LoadPCX; LoadPNG; LoadPNM; LoadSVG; LoadTGA; LoadTIF; LoadXCF; LoadXPM; LoadXV; LoadWEBP

◆ LoadSizedSVG()

Surface SDL::LoadSizedSVG	(	IOStreamBase &	src,
		int	width,
		int	height
	)

inline

Since SVG files are resolution-independent, you specify the size you would like the output image to be and it will be generated at those dimensions.

Either width or height may be 0 and the image will be auto-sized to preserve aspect ratio.

When done with the returned surface, the app should dispose of it with a call to SurfaceRef.reset().

Parameters

src	an IOStreamBase to load SVG data from.
width	desired width of the generated surface, in pixels.
height	desired height of the generated surface, in pixels.

Returns: a new SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

◆ LoadSurface() [1/3]

Surface SDL::LoadSurface ( IOStreamBase & src )

inline

An SurfaceBase is a buffer of pixels in memory accessible by the CPU. Use this if you plan to hand the data to something else or manipulate it further in code.

There are no guarantees about what format the new SurfaceBase data will be; in many cases, SDL_image will attempt to supply a surface that exactly matches the provided image, but in others it might have to convert (either because the image is in a format that SDL doesn't directly support or because it's compressed data that could reasonably uncompress to various formats and SDL_image had to pick one). You can inspect an SurfaceBase for its specifics, and use SurfaceBase.Convert to then migrate to any supported format.

If the image format supports a transparent pixel, SDL will set the colorkey for the surface. You can enable RLE acceleration on the surface afterwards by calling: SurfaceBase.SetColorKey(image, SDL_RLEACCEL, image->format->colorkey);

There is a separate function to read files from disk without having to deal with IOStreamBase: LoadSurface("filename.jpg") will call this function and manage those details for you, determining the file type from the filename's extension.

There is also LoadSurface(), which is equivalent to this function except a file extension (like "BMP", "JPG", etc) can be specified, in case SDL_image cannot autodetect the file format.

If you are using SDL's 2D rendering API, there is an equivalent call to load images directly into an TextureBase for use by the GPU without using a software surface: call LoadTexture() instead.

Parameters

src	an IOStreamBase that data will be read from.

Returns: a new SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadSurface; LoadSurface; SurfaceRef.reset

◆ LoadSurface() [2/3]

Surface SDL::LoadSurface	(	IOStreamBase &	src,
		StringParam	type
	)

inline

An SurfaceBase is a buffer of pixels in memory accessible by the CPU. Use this if you plan to hand the data to something else or manipulate it further in code.

There are no guarantees about what format the new SurfaceBase data will be; in many cases, SDL_image will attempt to supply a surface that exactly matches the provided image, but in others it might have to convert (either because the image is in a format that SDL doesn't directly support or because it's compressed data that could reasonably uncompress to various formats and SDL_image had to pick one). You can inspect an SurfaceBase for its specifics, and use SurfaceBase.Convert to then migrate to any supported format.

If the image format supports a transparent pixel, SDL will set the colorkey for the surface. You can enable RLE acceleration on the surface afterwards by calling: SurfaceBase.SetColorKey(image, SDL_RLEACCEL, image->format->colorkey);

Even though this function accepts a file type, SDL_image may still try other decoders that are capable of detecting file type from the contents of the image data, but may rely on the caller-provided type string for formats that it cannot autodetect. If type is nullptr, SDL_image will rely solely on its ability to guess the format.

There is a separate function to read files from disk without having to deal with IOStreamBase: LoadSurface("filename.jpg") will call this function and manage those details for you, determining the file type from the filename's extension.

There is also LoadSurface(), which is equivalent to this function except that it will rely on SDL_image to determine what type of data it is loading, much like passing a nullptr for type.

If you are using SDL's 2D rendering API, there is an equivalent call to load images directly into an TextureBase for use by the GPU without using a software surface: call LoadTexture() instead.

Parameters

src	an IOStreamBase that data will be read from.
type	a filename extension that represent this data ("BMP", "GIF", "PNG", etc).

Returns: a new SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadSurface; LoadSurface

◆ LoadSurface() [3/3]

Surface SDL::LoadSurface ( StringParam file )

inline

An SurfaceBase is a buffer of pixels in memory accessible by the CPU. Use this if you plan to hand the data to something else or manipulate it further in code.

There are no guarantees about what format the new SDL_Surface data will be; in many cases, SDL_image will attempt to supply a surface that exactly matches the provided image, but in others it might have to convert (either because the image is in a format that SDL doesn't directly support or because it's compressed data that could reasonably uncompress to various formats and SDL_image had to pick one). You can inspect an SurfaceBase for its specifics, and use SurfaceBase::Convert() to then migrate to any supported format.

If the image format supports a transparent pixel, SDL will set the colorkey for the surface. You can enable RLE acceleration on the surface afterwards by calling: SurfaceBase::SetColorKey(image, SDL_RLEACCEL, image->format->colorkey);

There is a separate function to read files from an SDL_IOStream, if you need an i/o abstraction to provide data from anywhere instead of a simple filesystem read; that function is Load(SDL_IOStream*,bool).

If you are using SDL's 2D rendering API, there is an equivalent call to load images directly into an Texture for use by the GPU without using a software surface: call LoadTexture() instead.

Parameters

file	a path on the filesystem to load an image from.

Returns: a new SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

◆ LoadSVG()

Surface SDL::LoadSVG ( IOStreamBase & src )

inline

If you know you definitely have a SVG image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase to load image data from.

Returns: SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadAVIF; LoadICO; LoadCUR; LoadBMP; LoadGIF; LoadJPG; LoadJXL; LoadLBM; LoadPCX; LoadPNG; LoadPNM; LoadQOI; LoadTGA; LoadTIF; LoadXCF; LoadXPM; LoadXV; LoadWEBP

◆ LoadTexture() [1/3]

Texture SDL::LoadTexture	(	RendererBase &	renderer,
		IOStreamBase &	src
	)

inline

An TextureBase represents an image in GPU memory, usable by SDL's 2D Render API. This can be significantly more efficient than using a CPU-bound SurfaceBase if you don't need to manipulate the image directly after loading it.

If the loaded image has transparency or a colorkey, a texture with an alpha channel will be created. Otherwise, SDL_image will attempt to create an TextureBase in the most format that most reasonably represents the image data (but in many cases, this will just end up being 32-bit RGB or 32-bit RGBA).

There is a separate function to read files from disk without having to deal with IOStreamBase: LoadTexture(renderer, "filename.jpg") will call this function and manage those details for you, determining the file type from the filename's extension.

There is also LoadTexture(), which is equivalent to this function except a file extension (like "BMP", "JPG", etc) can be specified, in case SDL_image cannot autodetect the file format.

If you would rather decode an image to an SurfaceBase (a buffer of pixels in CPU memory), call LoadSurface() instead.

Parameters

renderer	the RendererBase to use to create the GPU texture.
src	an IOStreamBase that data will be read from.

Returns: a new texture, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

◆ LoadTexture() [2/3]

Texture SDL::LoadTexture	(	RendererBase &	renderer,
		IOStreamBase &	src,
		StringParam	type
	)

inline

An TextureBase represents an image in GPU memory, usable by SDL's 2D Render API. This can be significantly more efficient than using a CPU-bound SurfaceBase if you don't need to manipulate the image directly after loading it.

If the loaded image has transparency or a colorkey, a texture with an alpha channel will be created. Otherwise, SDL_image will attempt to create an TextureBase in the most format that most reasonably represents the image data (but in many cases, this will just end up being 32-bit RGB or 32-bit RGBA).

Even though this function accepts a file type, SDL_image may still try other decoders that are capable of detecting file type from the contents of the image data, but may rely on the caller-provided type string for formats that it cannot autodetect. If type is nullptr, SDL_image will rely solely on its ability to guess the format.

There is a separate function to read files from disk without having to deal with IOStreamBase: LoadTexture("filename.jpg") will call this function and manage those details for you, determining the file type from the filename's extension.

There is also LoadTexture(), which is equivalent to this function except that it will rely on SDL_image to determine what type of data it is loading, much like passing a nullptr for type.

If you would rather decode an image to an SurfaceBase (a buffer of pixels in CPU memory), call LoadSurface() instead.

Parameters

renderer	the RendererBase to use to create the GPU texture.
src	an IOStreamBase that data will be read from.
type	a filename extension that represent this data ("BMP", "GIF", "PNG", etc).

Returns: a new texture, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

◆ LoadTexture() [3/3]

Texture SDL::LoadTexture	(	RendererBase &	renderer,
		StringParam	file
	)

inline

A Texture represents an image in GPU memory, usable by SDL's 2D Render API. This can be significantly more efficient than using a CPU-bound Surface if you don't need to manipulate the image directly after loading it.

If the loaded image has transparency or a colorkey, a texture with an alpha channel will be created. Otherwise, SDL_image will attempt to create an Texture in the most format that most reasonably represents the image data (but in many cases, this will just end up being 32-bit RGB or 32-bit RGBA).

If you would rather decode an image to an Surface (a buffer of pixels in CPU memory), call LoadSurface() instead.

Parameters

renderer	the RendererBase to use to create the GPU texture.
file	a path on the filesystem to load an image from.

Returns: a new texture, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

◆ LoadTGA()

Surface SDL::LoadTGA ( IOStreamBase & src )

inline

If you know you definitely have a TGA image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase to load image data from.

Returns: SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadAVIF; LoadICO; LoadCUR; LoadBMP; LoadGIF; LoadJPG; LoadJXL; LoadLBM; LoadPCX; LoadPNG; LoadPNM; LoadSVG; LoadQOI; LoadTIF; LoadXCF; LoadXPM; LoadXV; LoadWEBP

◆ LoadTIF()

Surface SDL::LoadTIF ( IOStreamBase & src )

inline

If you know you definitely have a TIFF image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase to load image data from.

Returns: SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadAVIF; LoadICO; LoadCUR; LoadBMP; LoadGIF; LoadJPG; LoadJXL; LoadLBM; LoadPCX; LoadPNG; LoadPNM; LoadSVG; LoadQOI; LoadTGA; LoadXCF; LoadXPM; LoadXV; LoadWEBP

◆ LoadWEBP()

Surface SDL::LoadWEBP ( IOStreamBase & src )

inline

If you know you definitely have a WEBP image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase to load image data from.

Returns: SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadAVIF; LoadICO; LoadCUR; LoadBMP; LoadGIF; LoadJPG; LoadJXL; LoadLBM; LoadPCX; LoadPNG; LoadPNM; LoadSVG; LoadQOI; LoadTGA; LoadTIF; LoadXCF; LoadXPM; LoadXV

◆ LoadWEBPAnimation()

Animation SDL::LoadWEBPAnimation ( IOStreamBase & src )

inline

If you know you definitely have a WEBP image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase that data will be read from.

Returns: a new AnimationBase, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: AnimationBase.AnimationBase

◆ LoadXCF()

Surface SDL::LoadXCF ( IOStreamBase & src )

inline

If you know you definitely have a XCF image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase to load image data from.

Returns: SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadAVIF; LoadICO; LoadCUR; LoadBMP; LoadGIF; LoadJPG; LoadJXL; LoadLBM; LoadPCX; LoadPNG; LoadPNM; LoadSVG; LoadQOI; LoadTGA; LoadTIF; LoadXPM; LoadXV; LoadWEBP

◆ LoadXPM()

Surface SDL::LoadXPM ( IOStreamBase & src )

inline

If you know you definitely have a XPM image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase to load image data from.

Returns: SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadAVIF; LoadICO; LoadCUR; LoadBMP; LoadGIF; LoadJPG; LoadJXL; LoadLBM; LoadPCX; LoadPNG; LoadPNM; LoadSVG; LoadQOI; LoadTGA; LoadTIF; LoadXCF; LoadXV; LoadWEBP

◆ LoadXV()

Surface SDL::LoadXV ( IOStreamBase & src )

inline

If you know you definitely have a XV image, you can call this function, which will skip SDL_image's file format detection routines. Generally it's better to use the abstract interfaces; also, there is only an IOStreamBase interface available here.

Parameters

src	an IOStreamBase to load image data from.

Returns: SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: LoadAVIF; LoadICO; LoadCUR; LoadBMP; LoadGIF; LoadJPG; LoadJXL; LoadLBM; LoadPCX; LoadPNG; LoadPNM; LoadSVG; LoadQOI; LoadTGA; LoadTIF; LoadXCF; LoadXPM; LoadWEBP

◆ ReadXPMFromArray()

Surface SDL::ReadXPMFromArray ( char ** xpm )

inline

The returned surface will be an 8bpp indexed surface, if possible, otherwise it will be 32bpp. If you always want 32-bit data, use IMG_ReadXPMFromArrayToRGB888() instead.

When done with the returned surface, the app should dispose of it with a call to SDL_DestroySurface().

Parameters

xpm	a nullptr-terminated array of strings that comprise XPM data.

Returns: a new SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: ReadXPMFromArrayToRGB888

◆ ReadXPMFromArrayToRGB888()

Surface SDL::ReadXPMFromArrayToRGB888 ( char ** xpm )

inline

The returned surface will always be a 32-bit RGB surface. If you want 8-bit indexed colors (and the XPM data allows it), use IMG_ReadXPMFromArray() instead.

When done with the returned surface, the app should dispose of it with a call to SDL_DestroySurface().

Parameters

xpm	a nullptr-terminated array of strings that comprise XPM data.

Returns: a new SDL surface, or nullptr on error.

Since: This function is available since SDL_image 3.0.0.

See also: ReadXPMFromArray

◆ SaveAVIF() [1/2]

void SDL::SaveAVIF	(	SurfaceBase &	surface,
		StringParam	file,
		int	quality
	)

inline

If the file already exists, it will be overwritten.

Parameters

surface	the SDL surface to save.
file	path on the filesystem to write new file to.
quality	the desired quality, ranging between 0 (lowest) and 100 (highest).

Exceptions

Error on failure.

Since: This function is available since SDL_image 3.0.0.

◆ SaveAVIF() [2/2]

void SDL::SaveAVIF	(	SurfaceRef	surface,
		IOStreamBase &	dst,
		int	quality
	)

inline

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

Parameters

surface	the SDL surface to save.
dst	the IOStreamBase to save the image data to.
quality	the desired quality, ranging between 0 (lowest) and 100 (highest).

Exceptions

Error on failure.

Since: This function is available since SDL_image 3.0.0.

◆ SaveJPG() [1/2]

void SDL::SaveJPG	(	SurfaceBase &	surface,
		StringParam	file,
		int	quality
	)

inline

If the file already exists, it will be overwritten.

Parameters

surface	the SDL surface to save.
file	path on the filesystem to write new file to.
quality	[0; 33] is Lowest quality, [34; 66] is Middle quality, [67; 100] is Highest quality.

Exceptions

Error on failure.

Since: This function is available since SDL_image 3.0.0.

◆ SaveJPG() [2/2]

void SDL::SaveJPG	(	SurfaceRef	surface,
		IOStreamBase &	dst,
		int	quality
	)

inline

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

Parameters

surface	the SDL surface to save.
dst	the IOStreamBase to save the image data to.
quality	[0; 33] is Lowest quality, [34; 66] is Middle quality, [67; 100] is Highest quality.

Exceptions

Error on failure.

Since: This function is available since SDL_image 3.0.0.

◆ SavePNG() [1/2]

void SDL::SavePNG	(	SurfaceBase &	surface,
		StringParam	file
	)

inline

If the file already exists, it will be overwritten.

Parameters

surface	the SDL surface to save.
file	path on the filesystem to write new file to.

Exceptions

Error on failure.

Since: This function is available since SDL_image 3.0.0.

See also: SavePNG

◆ SavePNG() [2/2]

void SDL::SavePNG	(	SurfaceRef	surface,
		IOStreamBase &	dst
	)

inline

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

Parameters

surface	the SDL surface to save.
dst	the IOStreamBase to save the image data to.

Exceptions

Error on failure.

Since: This function is available since SDL_image 3.0.0.

Classes

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ SDL_IMAGE_VERSION

◆ SDL_IMAGE_VERSION_ATLEAST

Function Documentation

◆ IMG_Version()

◆ isAVIF()

◆ isBMP()

◆ isCUR()

◆ isGIF()

◆ isICO()

◆ isJPG()

◆ isJXL()

◆ isLBM()

◆ isPCX()

◆ isPNG()

◆ isPNM()

◆ isQOI()

◆ isSVG()

◆ isTIF()

◆ isWEBP()

◆ isXCF()

◆ isXPM()

◆ isXV()

◆ LoadAVIF()

◆ LoadCUR()

◆ LoadGIF()

◆ LoadGIFAnimation()

◆ LoadICO()

◆ LoadJPG()

◆ LoadJXL()

◆ LoadLBM()

◆ LoadPCX()

◆ LoadPNG()

◆ LoadPNM()

◆ LoadQOI()

◆ LoadSizedSVG()

◆ LoadSurface() [1/3]

◆ LoadSurface() [2/3]

◆ LoadSurface() [3/3]

◆ LoadSVG()

◆ LoadTexture() [1/3]

◆ LoadTexture() [2/3]

◆ LoadTexture() [3/3]

◆ LoadTGA()

◆ LoadTIF()

◆ LoadWEBP()

◆ LoadWEBPAnimation()

◆ LoadXCF()

◆ LoadXPM()

◆ LoadXV()

◆ ReadXPMFromArray()

◆ ReadXPMFromArrayToRGB888()

◆ SaveAVIF() [1/2]

◆ SaveAVIF() [2/2]

◆ SaveJPG() [1/2]

◆ SaveJPG() [2/2]

◆ SavePNG() [1/2]

◆ SavePNG() [2/2]