SDL Wiki
[ front page | index | search | recent changes | git repo | offline html ]

SDL_LoadPNG

Load a PNG image from a file.

Header File

Defined in <SDL3/SDL_surface.h>

Syntax

SDL_Surface * SDL_LoadPNG(const char *file);

Function Parameters

const char * file the PNG file to load.

Return Value

(SDL_Surface *) Returns a pointer to a new SDL_Surface structure or NULL on failure; call SDL_GetError() for more information.

Remarks

This is intended as a convenience function for loading images from trusted sources. If you want to load arbitrary images you should use libpng or another image loading library designed with security in mind.

The new surface should be freed with SDL_DestroySurface(). Not doing so will result in a memory leak.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.4.0.

See Also


CategoryAPI, CategoryAPIFunction, CategorySurface


[ edit | delete | history | feedback | raw ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.